PolylineBuilder Class¶
-
class
NXOpen.Features.
PolylineBuilder
¶ Bases:
NXOpen.Features.FeatureBuilder
Polyline builder class.
To create a new instance of this class, use
NXOpen.Features.FreeformCurveCollection.CreatePolylineBuilder()
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 @return |
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. |
Enumerations¶
PolylineBuilderDrawingPlaneOptions Enumeration | Drawing plane options |
PolylineBuilderMovementMethodType Enumeration | Points movement types |
PolylineBuilderWCSOptionType Enumeration | WCS principal axis or plane types |
Property Detail¶
CanUseOrientationTool¶
-
PolylineBuilder.
CanUseOrientationTool
¶ Returns or sets the flag indicating if WCS like tool should be deployed when a point or pole handle is selected
-------------------------------------
Getter Method
Signature
CanUseOrientationTool()
Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CanUseOrientationTool(useOrientationTool)
Parameters: useOrientationTool (bool) – New in version NX10.0.0.
License requirements: features_modeling (“FEATURES MODELING”)
ConstraintManager¶
-
PolylineBuilder.
ConstraintManager
¶ Returns the constraint manager
-------------------------------------
Getter Method
Signature
ConstraintManager()
Returns: Return type: NXOpen.Features.GeometricConstraintDataManager
New in version NX10.0.0.
License requirements: None.
ConstraintPlane¶
-
PolylineBuilder.
ConstraintPlane
¶ Returns or sets the coordinate system defining plane constraint
-------------------------------------
Getter Method
Signature
ConstraintPlane()
Returns: Return type: NXOpen.CoordinateSystem
New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ConstraintPlane(coordinateSystem)
Parameters: coordinateSystem ( NXOpen.CoordinateSystem
) –New in version NX10.0.0.
License requirements: features_modeling (“FEATURES MODELING”)
DrawingPlane¶
-
PolylineBuilder.
DrawingPlane
¶ Returns or sets the drawing plane
-------------------------------------
Getter Method
Signature
DrawingPlane()
Returns: Return type: NXOpen.Plane
New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DrawingPlane(drawingPlane)
Parameters: drawingPlane ( NXOpen.Plane
) –New in version NX10.0.0.
License requirements: features_modeling (“FEATURES MODELING”)
DrawingPlaneOption¶
-
PolylineBuilder.
DrawingPlaneOption
¶ Returns or sets a drawing plane option
-------------------------------------
Getter Method
Signature
DrawingPlaneOption()
Returns: Return type: NXOpen.Features.PolylineBuilderDrawingPlaneOptions
New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DrawingPlaneOption(planeOption)
Parameters: planeOption ( NXOpen.Features.PolylineBuilderDrawingPlaneOptions
) –New in version NX10.0.0.
License requirements: features_modeling (“FEATURES MODELING”)
HasPlaneConstraint¶
-
PolylineBuilder.
HasPlaneConstraint
¶ Returns or sets the flag indicating if polyline has plane constraint
-------------------------------------
Getter Method
Signature
HasPlaneConstraint()
Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
HasPlaneConstraint(hasConstraint)
Parameters: hasConstraint (bool) – New in version NX10.0.0.
License requirements: features_modeling (“FEATURES MODELING”)
IsPeriodic¶
-
PolylineBuilder.
IsPeriodic
¶ Returns or sets the periodicity
-------------------------------------
Getter Method
Signature
IsPeriodic()
Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsPeriodic(periodicity)
Parameters: periodicity (bool) – New in version NX10.0.0.
License requirements: features_modeling (“FEATURES MODELING”)
MovementMethod¶
-
PolylineBuilder.
MovementMethod
¶ Returns or sets the movement method
-------------------------------------
Getter Method
Signature
MovementMethod()
Returns: Return type: NXOpen.Features.PolylineBuilderMovementMethodType
New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MovementMethod(movementMethod)
Parameters: movementMethod ( NXOpen.Features.PolylineBuilderMovementMethodType
) –New in version NX10.0.0.
License requirements: features_modeling (“FEATURES MODELING”)
MovementPlane¶
-
PolylineBuilder.
MovementPlane
¶ Returns or sets the movement plane
-------------------------------------
Getter Method
Signature
MovementPlane()
Returns: Return type: NXOpen.Plane
New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MovementPlane(movementPlane)
Parameters: movementPlane ( NXOpen.Plane
) –New in version NX10.0.0.
License requirements: features_modeling (“FEATURES MODELING”)
MovementVector¶
-
PolylineBuilder.
MovementVector
¶ Returns or sets the movement vector
-------------------------------------
Getter Method
Signature
MovementVector()
Returns: Return type: NXOpen.Direction
New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MovementVector(movementVector)
Parameters: movementVector ( NXOpen.Direction
) –New in version NX10.0.0.
License requirements: features_modeling (“FEATURES MODELING”)
Transformer¶
-
PolylineBuilder.
Transformer
¶ Returns the transformation tool.
-------------------------------------
Getter Method
Signature
Transformer()
Returns: Return type: NXOpen.GeometricUtilities.TransformerData
New in version NX10.0.0.
License requirements: None.
WCSOption¶
-
PolylineBuilder.
WCSOption
¶ Returns or sets the WCS option
-------------------------------------
Getter Method
Signature
WCSOption()
Returns: Return type: NXOpen.Features.PolylineBuilderWCSOptionType
New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
WCSOption(wcsOption)
Parameters: wcsOption ( NXOpen.Features.PolylineBuilderWCSOptionType
) –New in version NX10.0.0.
License requirements: features_modeling (“FEATURES MODELING”)
Method Detail¶
EditPolyline¶
-
PolylineBuilder.
EditPolyline
¶ Sets a non-parametric polyline for editing
Signature
EditPolyline(polyline)
Parameters: polyline ( NXOpen.NXObject
) –New in version NX10.0.0.
License requirements: features_modeling (“FEATURES MODELING”)
Evaluate¶
-
PolylineBuilder.
Evaluate
¶ Evaluates the polyline
Signature
Evaluate()
New in version NX10.0.0.
License requirements: features_modeling (“FEATURES MODELING”)
InsertPoint¶
-
PolylineBuilder.
InsertPoint
¶ Inserts a point in the middle of a segment
Signature
InsertPoint(afterIndex)
Parameters: afterIndex (int) – Index of a point after which to insert new point New in version NX10.0.0.
License requirements: features_modeling (“FEATURES MODELING”)
UpdateOnConstraintPlane¶
-
PolylineBuilder.
UpdateOnConstraintPlane
¶ Updates polyline based on constraint plane
Signature
UpdateOnConstraintPlane()
New in version NX10.0.0.
License requirements: features_modeling (“FEATURES MODELING”)
Validate¶
-
PolylineBuilder.
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.