MovePoleBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# MovePoleBuilder Class

class `NXOpen.GeometricUtilities.``MovePoleBuilder`

  Bases: `NXOpen.TaggedObject`, `NXOpen.GeometricUtilities.IComponentBuilder`

  This class manages the control poles movements for a surface or curve.

  New in version NX8.5.0.

# Properties

Property | Description
--- | ---
ControlPoleManager | Returns the control pole manager
DegreesAndPatches | Returns the degrees and patches
Entity | Returns or sets the entity
MoveMethod | Returns or sets the control pole move method
Plane | Returns or sets the plane
Tag | Returns the Tag for this object.
Vector | Returns or sets the vector
WCSDirection | Returns or sets the fixed direction

# Methods

Method | Description
--- | ---
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

MovePoleBuilderMoveMethodType Enumeration | Move Pole types
MovePoleBuilderWCSDirectionType Enumeration | WCS direction

# Property Detail

## ControlPoleManager

`MovePoleBuilder.``ControlPoleManager`

  Returns the control pole manager

  `-------------------------------------`

  Getter Method

  Signature `ControlPoleManager`

  Returns: |
  Return type: | `NXOpen.GeometricUtilities.ControlPoleManagerData`

  New in version NX8.5.0.

  License requirements: None.

## DegreesAndPatches

`MovePoleBuilder.``DegreesAndPatches`

  Returns the degrees and patches

  `-------------------------------------`

  Getter Method

  Signature `DegreesAndPatches`

  Returns: |
  Return type: | `NXOpen.GeometricUtilities.DegreesAndSegmentsOrPatchesBuilder`

  New in version NX8.5.0.

  License requirements: None.

## Entity

`MovePoleBuilder.``Entity`

  Returns or sets the entity

  `-------------------------------------`

  Getter Method

  Signature `Entity`

  Returns: |
  Return type: | `NXOpen.NXObject`

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Entity`

  Parameters: | entity (`NXOpen.NXObject`) –

  New in version NX8.5.0.

  License requirements: None.

## MoveMethod

`MovePoleBuilder.``MoveMethod`

  Returns or sets the control pole move method

  `-------------------------------------`

  Getter Method

  Signature `MoveMethod`

  Returns: |
  Return type: | `NXOpen.GeometricUtilities.MovePoleBuilderMoveMethodType`

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `MoveMethod`

  Parameters: | moveMethod (`NXOpen.GeometricUtilities.MovePoleBuilderMoveMethodType`) –

  New in version NX8.5.0.

  License requirements: None.

## Plane

`MovePoleBuilder.``Plane`

  Returns or sets the plane

  `-------------------------------------`

  Getter Method

  Signature `Plane`

  Returns: |
  Return type: | `NXOpen.Plane`

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Plane`

  Parameters: | plane (`NXOpen.Plane`) –

  New in version NX8.5.0.

  License requirements: None.

## Vector

`MovePoleBuilder.``Vector`

  Returns or sets the vector

  `-------------------------------------`

  Getter Method

  Signature `Vector`

  Returns: |
  Return type: | `NXOpen.Direction`

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Vector`

  Parameters: | vector (`NXOpen.Direction`) –

  New in version NX8.5.0.

  License requirements: None.

## WCSDirection

`MovePoleBuilder.``WCSDirection`

  Returns or sets the fixed direction

  `-------------------------------------`

  Getter Method

  Signature `WCSDirection`

  Returns: |
  Return type: | `NXOpen.GeometricUtilities.MovePoleBuilderWCSDirectionType`

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `WCSDirection`

  Parameters: | wcsDirection (`NXOpen.GeometricUtilities.MovePoleBuilderWCSDirectionType`) –

  New in version NX8.5.0.

  License requirements: None.

# Method Detail

## Validate

`MovePoleBuilder.``Validate`

  Validate whether the inputs to the component are sufficient for commit to be called.

  If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

  Signature `Validate()`

  Returns: | Was self validation successful
  Return type: | bool

  New in version NX3.0.1.

  License requirements: None.