StudioSplineBuilder Class¶
-
class
NXOpen.Features.
StudioSplineBuilder
¶ Bases:
NXOpen.Features.FeatureBuilder
Studio Spline builder class.
To create a new instance of this class, use
NXOpen.Features.FeatureCollection.CreateStudioSplineBuilder()
New in version NX5.0.0.
Deprecated since version NX8.0.0: Use
NXOpen.Features.StudioSplineBuilderEx
instead.
Properties¶
Property | Description |
---|---|
Associative | Returns or sets the associative or non associative way of spline creation |
ConstraintManager | Returns the constraint manager |
Curve | Returns the spline curve |
Degree | Returns or sets the degree |
InputCurveOption | Returns or sets the input curve option |
IsPeriodic | Returns or sets the periodicity |
MatchKnots | Returns or sets a constraint to match knots at the defining points for a through point spline |
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 |
SplineMethod | Returns or sets the spline method |
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
Tag | Returns the Tag for this object. |
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. |
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 @return The knot sequence |
GetObject | Returns the object currently being edited by this builder. |
GetParameters | Queries the parameters at defining points for a through point spline @return The parameters |
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited. |
SetKnots | Sets the optional knot sequence for by pole spline |
SetNonParametricSpline | Sets a non-parametric spline for editing |
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 |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
StudioSplineBuilderCurveOption Enumeration | Options of the actions to be taken on an input non-parametric spline after its editing is done. |
StudioSplineBuilderMatchKnotsType Enumeration | Options for creating knots at the defining points in case of through point spline |
StudioSplineBuilderMethod Enumeration | Spline methods. |
Property Detail¶
Associative¶
-
StudioSplineBuilder.
Associative
¶ Returns or sets the associative or non associative way of spline creation
-------------------------------------
Getter Method
Signature
Associative()
Returns: Return type: bool New in version NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”)
-------------------------------------
Setter Method
Signature
Associative(associative)
Parameters: associative (bool) – New in version NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”)
ConstraintManager¶
-
StudioSplineBuilder.
ConstraintManager
¶ Returns the constraint manager
-------------------------------------
Getter Method
Signature
ConstraintManager()
Returns: Return type: NXOpen.Features.GeometricConstraintDataManager
New in version NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”)
Curve¶
-
StudioSplineBuilder.
Curve
¶ Returns the spline curve
-------------------------------------
Getter Method
Signature
Curve()
Returns: Return type: NXOpen.Spline
New in version NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”)
Degree¶
-
StudioSplineBuilder.
Degree
¶ Returns or sets the degree
-------------------------------------
Getter Method
Signature
Degree()
Returns: Return type: int New in version NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”)
-------------------------------------
Setter Method
Signature
Degree(degree)
Parameters: degree (int) – New in version NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”)
InputCurveOption¶
-
StudioSplineBuilder.
InputCurveOption
¶ Returns or sets the input curve option
-------------------------------------
Getter Method
Signature
InputCurveOption()
Returns: Return type: NXOpen.Features.StudioSplineBuilderCurveOption
New in version NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”)
-------------------------------------
Setter Method
Signature
InputCurveOption(option)
Parameters: option ( NXOpen.Features.StudioSplineBuilderCurveOption
) –New in version NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”)
IsPeriodic¶
-
StudioSplineBuilder.
IsPeriodic
¶ Returns or sets the periodicity
-------------------------------------
Getter Method
Signature
IsPeriodic()
Returns: Return type: bool New in version NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”)
-------------------------------------
Setter Method
Signature
IsPeriodic(periodicity)
Parameters: periodicity (bool) – New in version NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”)
MatchKnots¶
-
StudioSplineBuilder.
MatchKnots
¶ Returns or sets a constraint to match knots at the defining points for a through point spline
-------------------------------------
Getter Method
Signature
MatchKnots()
Returns: Return type: NXOpen.Features.StudioSplineBuilderMatchKnotsType
New in version NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”)
-------------------------------------
Setter Method
Signature
MatchKnots(matchKnots)
Parameters: matchKnots ( NXOpen.Features.StudioSplineBuilderMatchKnotsType
) –New in version NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”)
SplineMethod¶
-
StudioSplineBuilder.
SplineMethod
¶ Returns or sets the spline method
-------------------------------------
Getter Method
Signature
SplineMethod()
Returns: Return type: NXOpen.Features.StudioSplineBuilderMethod
New in version NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”)
-------------------------------------
Setter Method
Signature
SplineMethod(method)
Parameters: method ( NXOpen.Features.StudioSplineBuilderMethod
) –New in version NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”)
Method Detail¶
GetKnots¶
-
StudioSplineBuilder.
GetKnots
¶ Queries the knot sequence for by pole spline
Signature
GetKnots()
Returns: The knot sequence Return type: list of float New in version NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”)
GetParameters¶
-
StudioSplineBuilder.
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 NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”)
SetKnots¶
-
StudioSplineBuilder.
SetKnots
¶ Sets the optional knot sequence for by pole spline
Signature
SetKnots(knots)
Parameters: knots (list of float) – The knot sequence New in version NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”)
SetNonParametricSpline¶
-
StudioSplineBuilder.
SetNonParametricSpline
¶ Sets a non-parametric spline for editing
Signature
SetNonParametricSpline(spline, method)
Parameters: - spline (
NXOpen.Spline
) – Non parameteric spline - method (
NXOpen.Features.StudioSplineBuilderMethod
) – Spline method for parameterization
New in version NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”)
- spline (
SetParameters¶
-
StudioSplineBuilder.
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 NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”)
Validate¶
-
StudioSplineBuilder.
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.