CagePolylineBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# CagePolylineBuilder Class

class `NXOpen.Features.Subdivision.``CagePolylineBuilder`

  Bases: `NXOpen.Features.PolylineBuilder`

  Cage polyline builder class.

  To create a new instance of this class, use `NXOpen.Features.Subdivision.SubdivisionBodyCollection.CreateCagePolylineBuilder()`

  Default values.

  Property | Value
  --- | ---
  DrawingPlaneOption | View
  MovementMethod | View
  WCSOption | X

  New in version NX10.0.0.

# Properties

Property | Description
--- | ---
CanUseOrientationTool | Returns or sets the flag indicating if WCS like tool should be deployed when a point or pole handle is selected
ConstraintManager | Returns the constraint manager
ConstraintPlane | Returns or sets the coordinate system defining plane constraint
DrawingPlane | Returns or sets the drawing plane
DrawingPlaneOption | Returns or sets a drawing plane option
HasPlaneConstraint | Returns or sets the flag indicating if polyline has plane constraint
IsPeriodic | Returns or sets the periodicity
MovementMethod | Returns or sets the movement method
MovementPlane | Returns or sets the movement plane
MovementVector | Returns or sets the movement vector
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
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
Transformer | Returns the transformation tool.
WCSOption | Returns or sets the WCS option

# 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.
EditPolyline | Sets a non-parametric polyline for editing
Evaluate | Evaluates the polyline
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetFeature | Returns the feature currently being edited by this builder.
GetObject | Returns the object currently being edited by this builder.
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited.
InsertPoint | Inserts a point in the middle of a segment
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited
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
UpdateOnConstraintPlane | Updates polyline based on constraint plane
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Method Detail

## Validate

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