PoleSmoothingBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# PoleSmoothingBuilder Class

class `NXOpen.Features.``PoleSmoothingBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a `NXOpen.Features.PoleSmoothing` builder

  To create a new instance of this class, use `NXOpen.Features.FeatureCollection.CreatePoleSmoothingBuilder()`

  Default values.

  Property | Value
  --- | ---
  ApplyConstraintsToAll | 0
  ModificationPercentage | 100
  MoveOnlySelectedPoles | 0
  SmoothingFactor | 1
  UseSpecificDirection | 0

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
ApplyConstraintsToAll | Returns or sets the indicator to apply the same constraint to all
ModificationPercentage | Returns or sets the modification percentage
MoveOnlySelectedPoles | Returns or sets the indicator to move only selected poles
MovementVector | Returns or sets the movement direction vector, this is used only when `UseSpecificDirection`()` is true.
NumberPolesSelected | Returns or sets the number of poles selected
ParentFeatureInternal | Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal
PatchSolutionFlag | Returns or sets the patch solution flag
PatchSurfaceFilename | Returns or sets the patch surface filename
Poles | Returns the selected poles, this is used only when `MoveOnlySelectedPoles`()` is true
SmoothingFactor | Returns or sets the smoothing factor, the min and max values for this are (1 to 100)
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
TargetFace | Returns the target face
UMaxConstraint | Returns the u maximum continuity constraint
UMinConstraint | Returns the u minimum continuity constraint
UseSpecificDirection | Returns or sets the specific moving direction
VMaxConstraint | Returns the v maximum continuity constraint
VMinConstraint | Returns the v minimum continuity constraint

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CommitFeature | Commits the feature parameters and creates the feature
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetCreateNewCopy | Returns the indicator for creating a new copy
GetFeature | Returns the feature currently being edited by this builder.
GetObject | Returns the object currently being edited by this builder.
GetSelectedPolesIndex | Returns the index of selected poles
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited.
RemoveFeatureParameters | Removes parameters of a owning feature of a face to be smoothed
SetCreateNewCopy | Sets the indicator for creating a new copy
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited
SetSelectedPolesIndex | Sets the index of selected poles
ShowInternalParentFeatureForEdit | Unsuppress an internal parent feature (a slave feature) so it can be edited.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UnsetParentFeatureInternal | Set the internal parent feature of the feature being edited to external
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Property Detail

## ApplyConstraintsToAll

`PoleSmoothingBuilder.``ApplyConstraintsToAll`

  Returns or sets the indicator to apply the same constraint to all

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

  Getter Method

  Signature `ApplyConstraintsToAll`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

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

  Setter Method

  Signature `ApplyConstraintsToAll`

  Parameters: | applyConstraintsToAll (bool) –

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

## ModificationPercentage

`PoleSmoothingBuilder.``ModificationPercentage`

  Returns or sets the modification percentage

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

  Getter Method

  Signature `ModificationPercentage`

  Returns: |
  Return type: | int

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

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

  Setter Method

  Signature `ModificationPercentage`

  Parameters: | modificationPercentage (int) –

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

## MoveOnlySelectedPoles

`PoleSmoothingBuilder.``MoveOnlySelectedPoles`

  Returns or sets the indicator to move only selected poles

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

  Getter Method

  Signature `MoveOnlySelectedPoles`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

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

  Setter Method

  Signature `MoveOnlySelectedPoles`

  Parameters: | moveOnlySelectedPoles (bool) –

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

## MovementVector

`PoleSmoothingBuilder.``MovementVector`

  Returns or sets the movement direction vector, this is used only when `UseSpecificDirection`()` is true.

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

  Getter Method

  Signature `MovementVector`

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

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

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

  Setter Method

  Signature `MovementVector`

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

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

## NumberPolesSelected

`PoleSmoothingBuilder.``NumberPolesSelected`

  Returns or sets the number of poles selected

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

  Getter Method

  Signature `NumberPolesSelected`

  Returns: |
  Return type: | int

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

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

  Setter Method

  Signature `NumberPolesSelected`

  Parameters: | numbePolesSelected (int) –

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

## Poles

`PoleSmoothingBuilder.``Poles`

  Returns the selected poles, this is used only when `MoveOnlySelectedPoles`()` is true

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

  Getter Method

  Signature `Poles`

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

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

## SmoothingFactor

`PoleSmoothingBuilder.``SmoothingFactor`

  Returns or sets the smoothing factor, the min and max values for this are (1 to 100)

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

  Getter Method

  Signature `SmoothingFactor`

  Returns: |
  Return type: | int

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

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

  Setter Method

  Signature `SmoothingFactor`

  Parameters: | smoothingFactor (int) –

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

## TargetFace

`PoleSmoothingBuilder.``TargetFace`

  Returns the target face

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

  Getter Method

  Signature `TargetFace`

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

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

## UMaxConstraint

`PoleSmoothingBuilder.``UMaxConstraint`

  Returns the u maximum continuity constraint

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

  Getter Method

  Signature `UMaxConstraint`

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

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

## UMinConstraint

`PoleSmoothingBuilder.``UMinConstraint`

  Returns the u minimum continuity constraint

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

  Getter Method

  Signature `UMinConstraint`

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

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

## UseSpecificDirection

`PoleSmoothingBuilder.``UseSpecificDirection`

  Returns or sets the specific moving direction

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

  Getter Method

  Signature `UseSpecificDirection`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

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

  Setter Method

  Signature `UseSpecificDirection`

  Parameters: | useSpecificDirection (bool) –

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

## VMaxConstraint

`PoleSmoothingBuilder.``VMaxConstraint`

  Returns the v maximum continuity constraint

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

  Getter Method

  Signature `VMaxConstraint`

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

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

## VMinConstraint

`PoleSmoothingBuilder.``VMinConstraint`

  Returns the v minimum continuity constraint

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

  Getter Method

  Signature `VMinConstraint`

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

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

# Method Detail

## GetCreateNewCopy

`PoleSmoothingBuilder.``GetCreateNewCopy`

  Returns the indicator for creating a new copy

  Signature `GetCreateNewCopy()`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

## GetSelectedPolesIndex

`PoleSmoothingBuilder.``GetSelectedPolesIndex`

  Returns the index of selected poles

  Signature `GetSelectedPolesIndex()`

  Returns: |
  Return type: | list of int

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

## RemoveFeatureParameters

`PoleSmoothingBuilder.``RemoveFeatureParameters`

  Removes parameters of a owning feature of a face to be smoothed

  Signature `RemoveFeatureParameters(face)`

  Parameters: | face (`NXOpen.Face`) – Face to be used for feature parameter removal

  New in version NX8.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

## SetCreateNewCopy

`PoleSmoothingBuilder.``SetCreateNewCopy`

  Sets the indicator for creating a new copy

  Signature `SetCreateNewCopy(createNewCopy)`

  Parameters: | createNewCopy (bool) –

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

## SetSelectedPolesIndex

`PoleSmoothingBuilder.``SetSelectedPolesIndex`

  Sets the index of selected poles

  Signature `SetSelectedPolesIndex(selectedPolesIndex)`

  Parameters: | selectedPolesIndex (list of int) –

  New in version NX6.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

## Validate

`PoleSmoothingBuilder.``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.