StudioSplineBuilderEx Class¶
-
class
NXOpen.Features.
StudioSplineBuilderEx
¶ Bases:
NXOpen.Features.FeatureBuilder
Studio Spline builder class.
To create a new instance of this class, use
NXOpen.Features.FeatureCollection.CreateStudioSplineBuilderEx()
Default values.
Property Value DrawingPlaneOption View Extender.EndExtensionOption None Extender.EndValue.Value 0 (millimeters part), 0 (inches part) Extender.StartExtensionOption None Extender.StartValue.Value 0 (millimeters part), 0 (inches part) InputCurveOption Hide MatchKnotsType None MovementMethod View Type ThroughPoints WCSOption X New in version NX8.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 |
Curve | Returns the spline curve |
Degree | Returns or sets the degree |
DrawingPlane | Returns or sets the drawing plane |
DrawingPlaneOption | Returns or sets a drawing plane option |
Extender | Returns the extension option |
HasPlaneConstraint | Returns or sets the flag indicating if spline has plane constraint |
HasProportionalUpdate | Returns or sets the flag indicating if free or non attached defining points or poles should be moved proportionally during update of the spline feature |
InputCurveOption | Returns or sets the input curve option |
IsAssociative | Returns or sets the flag indicating if a feature should be created |
IsPeriodic | Returns or sets the periodicity |
IsSingleSegment | Returns or sets a flag indicating if single segment by pole spline is to be created |
MatchKnotsType | Returns or sets a constraint to match knots at the defining points for a through point spline |
MovementMethod | Returns or sets the movement method |
MovementPlane | Returns or sets the movement plane |
MovementVector | Returns or sets the movement vector |
OrientExpress | Returns the orient express object |
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. |
Type | Returns or sets the spline method |
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. |
EditSpline | Sets a non-parametric spline for editing |
Evaluate | Evaluates the spline |
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. |
GetKnots | Queries the knot sequence for by pole spline |
GetObject | Returns the object currently being edited by this builder. |
GetParameters | Queries the parameters at defining points for a through point spline |
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited. |
InsertKnot | Inserts knot at a closest point on the spline |
InsertPole | Inserts a pole in the middle of a control polygon segment |
SetKnots | Sets the optional knot sequence for by pole spline |
SetParameters | Sets the optional parameters at defining points for a through point spline |
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 spline based on constraint plane |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
StudioSplineBuilderExDrawingPlaneOptions Enumeration | Drawing plane options |
StudioSplineBuilderExInputCurveOptions Enumeration | Options of the actions to be taken on an input non-parametric spline after its editing is done. |
StudioSplineBuilderExMatchKnotsTypes Enumeration | Options for creating knots at the defining points in case of through point spline |
StudioSplineBuilderExMovementMethodType Enumeration | Points movement types |
StudioSplineBuilderExTypes Enumeration | Spline methods. |
StudioSplineBuilderExWCSOptionType Enumeration | WCS principal axis or plane types |
Property Detail¶
CanUseOrientationTool¶
-
StudioSplineBuilderEx.
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 NX8.5.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
CanUseOrientationTool
Parameters: useOrientationTool (bool) – New in version NX8.5.1.
License requirements: features_modeling (“FEATURES MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)
ConstraintManager¶
-
StudioSplineBuilderEx.
ConstraintManager
¶ Returns the constraint manager
-------------------------------------
Getter Method
Signature
ConstraintManager
Returns: Return type: NXOpen.Features.GeometricConstraintDataManager
New in version NX8.0.0.
License requirements: None.
ConstraintPlane¶
-
StudioSplineBuilderEx.
ConstraintPlane
¶ Returns or sets the coordinate system defining plane constraint
-------------------------------------
Getter Method
Signature
ConstraintPlane
Returns: Return type: NXOpen.CoordinateSystem
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ConstraintPlane
Parameters: coordinateSystem ( NXOpen.CoordinateSystem
) –New in version NX8.0.0.
License requirements: features_modeling (“FEATURES MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)
Curve¶
-
StudioSplineBuilderEx.
Curve
¶ Returns the spline curve
-------------------------------------
Getter Method
Signature
Curve
Returns: Return type: NXOpen.Spline
New in version NX8.0.0.
License requirements: None.
Degree¶
-
StudioSplineBuilderEx.
Degree
¶ Returns or sets the degree
-------------------------------------
Getter Method
Signature
Degree
Returns: Return type: int New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Degree
Parameters: degree (int) – New in version NX8.0.0.
License requirements: features_modeling (“FEATURES MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)
DrawingPlane¶
-
StudioSplineBuilderEx.
DrawingPlane
¶ Returns or sets the drawing plane
-------------------------------------
Getter Method
Signature
DrawingPlane
Returns: Return type: NXOpen.Plane
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DrawingPlane
Parameters: drawingPlane ( NXOpen.Plane
) –New in version NX8.0.0.
License requirements: features_modeling (“FEATURES MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)
DrawingPlaneOption¶
-
StudioSplineBuilderEx.
DrawingPlaneOption
¶ Returns or sets a drawing plane option
-------------------------------------
Getter Method
Signature
DrawingPlaneOption
Returns: Return type: NXOpen.Features.StudioSplineBuilderExDrawingPlaneOptions
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DrawingPlaneOption
Parameters: planeOption ( NXOpen.Features.StudioSplineBuilderExDrawingPlaneOptions
) –New in version NX8.0.0.
License requirements: features_modeling (“FEATURES MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)
Extender¶
-
StudioSplineBuilderEx.
Extender
¶ Returns the extension option
-------------------------------------
Getter Method
Signature
Extender
Returns: Return type: NXOpen.GeometricUtilities.SplineExtensionBuilder
New in version NX8.0.0.
License requirements: None.
HasPlaneConstraint¶
-
StudioSplineBuilderEx.
HasPlaneConstraint
¶ Returns or sets the flag indicating if spline has plane constraint
-------------------------------------
Getter Method
Signature
HasPlaneConstraint
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
HasPlaneConstraint
Parameters: hasConstraint (bool) – New in version NX8.0.0.
License requirements: features_modeling (“FEATURES MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)
HasProportionalUpdate¶
-
StudioSplineBuilderEx.
HasProportionalUpdate
¶ Returns or sets the flag indicating if free or non attached defining points or poles should be moved proportionally during update of the spline feature
-------------------------------------
Getter Method
Signature
HasProportionalUpdate
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
HasProportionalUpdate
Parameters: hasProportionalUpdate (bool) – New in version NX8.0.0.
License requirements: features_modeling (“FEATURES MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)
InputCurveOption¶
-
StudioSplineBuilderEx.
InputCurveOption
¶ Returns or sets the input curve option
-------------------------------------
Getter Method
Signature
InputCurveOption
Returns: Return type: NXOpen.Features.StudioSplineBuilderExInputCurveOptions
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
InputCurveOption
Parameters: option ( NXOpen.Features.StudioSplineBuilderExInputCurveOptions
) –New in version NX8.0.0.
License requirements: features_modeling (“FEATURES MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)
IsAssociative¶
-
StudioSplineBuilderEx.
IsAssociative
¶ Returns or sets the flag indicating if a feature should be created
-------------------------------------
Getter Method
Signature
IsAssociative
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsAssociative
Parameters: associative (bool) – New in version NX8.0.0.
License requirements: features_modeling (“FEATURES MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)
IsPeriodic¶
-
StudioSplineBuilderEx.
IsPeriodic
¶ Returns or sets the periodicity
-------------------------------------
Getter Method
Signature
IsPeriodic
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsPeriodic
Parameters: periodicity (bool) – New in version NX8.0.0.
License requirements: features_modeling (“FEATURES MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)
IsSingleSegment¶
-
StudioSplineBuilderEx.
IsSingleSegment
¶ Returns or sets a flag indicating if single segment by pole spline is to be created
-------------------------------------
Getter Method
Signature
IsSingleSegment
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsSingleSegment
Parameters: isSingleSegment (bool) – New in version NX8.0.0.
License requirements: features_modeling (“FEATURES MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)
MatchKnotsType¶
-
StudioSplineBuilderEx.
MatchKnotsType
¶ Returns or sets a constraint to match knots at the defining points for a through point spline
-------------------------------------
Getter Method
Signature
MatchKnotsType
Returns: Return type: NXOpen.Features.StudioSplineBuilderExMatchKnotsTypes
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MatchKnotsType
Parameters: matchKnotsType ( NXOpen.Features.StudioSplineBuilderExMatchKnotsTypes
) –New in version NX8.0.0.
License requirements: features_modeling (“FEATURES MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)
MovementMethod¶
-
StudioSplineBuilderEx.
MovementMethod
¶ Returns or sets the movement method
-------------------------------------
Getter Method
Signature
MovementMethod
Returns: Return type: NXOpen.Features.StudioSplineBuilderExMovementMethodType
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MovementMethod
Parameters: movementMethod ( NXOpen.Features.StudioSplineBuilderExMovementMethodType
) –New in version NX8.0.0.
License requirements: features_modeling (“FEATURES MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)
MovementPlane¶
-
StudioSplineBuilderEx.
MovementPlane
¶ Returns or sets the movement plane
-------------------------------------
Getter Method
Signature
MovementPlane
Returns: Return type: NXOpen.Plane
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MovementPlane
Parameters: movementPlane ( NXOpen.Plane
) –New in version NX8.0.0.
License requirements: features_modeling (“FEATURES MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)
MovementVector¶
-
StudioSplineBuilderEx.
MovementVector
¶ Returns or sets the movement vector
-------------------------------------
Getter Method
Signature
MovementVector
Returns: Return type: NXOpen.Direction
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MovementVector
Parameters: movementVector ( NXOpen.Direction
) –New in version NX8.0.0.
License requirements: features_modeling (“FEATURES MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)
OrientExpress¶
-
StudioSplineBuilderEx.
OrientExpress
¶ Returns the orient express object
-------------------------------------
Getter Method
Signature
OrientExpress
Returns: Return type: NXOpen.GeometricUtilities.OrientXpressBuilder
New in version NX8.0.0.
License requirements: None.
Type¶
-
StudioSplineBuilderEx.
Type
¶ Returns or sets the spline method
-------------------------------------
Getter Method
Signature
Type
Returns: Return type: NXOpen.Features.StudioSplineBuilderExTypes
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Type
Parameters: type ( NXOpen.Features.StudioSplineBuilderExTypes
) –New in version NX8.0.0.
License requirements: features_modeling (“FEATURES MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)
WCSOption¶
-
StudioSplineBuilderEx.
WCSOption
¶ Returns or sets the WCS option
-------------------------------------
Getter Method
Signature
WCSOption
Returns: Return type: NXOpen.Features.StudioSplineBuilderExWCSOptionType
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
WCSOption
Parameters: wcsOption ( NXOpen.Features.StudioSplineBuilderExWCSOptionType
) –New in version NX8.0.0.
License requirements: features_modeling (“FEATURES MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)
Method Detail¶
EditSpline¶
-
StudioSplineBuilderEx.
EditSpline
¶ Sets a non-parametric spline for editing
Signature
EditSpline(spline)
Parameters: spline ( NXOpen.NXObject
) –New in version NX8.0.0.
License requirements: features_modeling (“FEATURES MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)
Evaluate¶
-
StudioSplineBuilderEx.
Evaluate
¶ Evaluates the spline
Signature
Evaluate()
New in version NX8.0.0.
License requirements: features_modeling (“FEATURES MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)
GetKnots¶
-
StudioSplineBuilderEx.
GetKnots
¶ Queries the knot sequence for by pole spline
Signature
GetKnots()
Returns: The knot sequence Return type: list of float New in version NX8.0.0.
License requirements: None.
GetParameters¶
-
StudioSplineBuilderEx.
GetParameters
¶ Queries the parameters at defining points for a through point spline
Signature
GetParameters()
Returns: The parameters Return type: list of float New in version NX8.0.0.
License requirements: None.
InsertKnot¶
-
StudioSplineBuilderEx.
InsertKnot
¶ Inserts knot at a closest point on the spline
Signature
InsertKnot(point)
Parameters: point ( NXOpen.Point3d
) – Point at which knot to be insertedNew in version NX8.0.0.
License requirements: features_modeling (“FEATURES MODELING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)
InsertPole¶
-
StudioSplineBuilderEx.
InsertPole
¶ Inserts a pole in the middle of a control polygon segment
Signature
InsertPole(afterIndex)
Parameters: afterIndex (int) – Index of a pole after which to insert new pole New in version NX8.0.0.
License requirements: features_modeling (“FEATURES MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)
SetKnots¶
-
StudioSplineBuilderEx.
SetKnots
¶ Sets the optional knot sequence for by pole spline
Signature
SetKnots(knots)
Parameters: knots (list of float) – The knot sequence New in version NX8.0.0.
License requirements: features_modeling (“FEATURES MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)
SetParameters¶
-
StudioSplineBuilderEx.
SetParameters
¶ Sets the optional parameters at defining points for a through point spline
Signature
SetParameters(parameters)
Parameters: parameters (list of float) – The parameters New in version NX8.0.0.
License requirements: features_modeling (“FEATURES MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)
UpdateOnConstraintPlane¶
-
StudioSplineBuilderEx.
UpdateOnConstraintPlane
¶ Updates spline based on constraint plane
Signature
UpdateOnConstraintPlane()
New in version NX8.0.0.
License requirements: features_modeling (“FEATURES MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)
Validate¶
-
StudioSplineBuilderEx.
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.