AlongSpineBuilder Class¶
-
class
NXOpen.GeometricUtilities.
AlongSpineBuilder
¶ Bases:
NXOpen.TaggedObject
,NXOpen.GeometricUtilities.IComponentBuilder
Represents a
NXOpen.GeometricUtilities.AlongSpineBuilder
New in version NX5.0.0.
Properties¶
Property | Description |
---|---|
FeatureSpine | Returns the Spine set by the owning feature of the law |
Spine | Returns the Spine |
SpineOption | Returns or sets the alongSpineOption. |
SpinePointList | Returns the list of spine points. |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
CreateSpinePoint | Creates a new spine point @return OnPathDimWithValueBuilder Object |
GetSpinePoints | Returns the all SpinePointData objects |
ResetSpine | Reset the spine |
SetFeatureSpine | Set the spine sent by the owning feaure dynamically into builder |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
AlongSpineBuilderRetainSpineOption Enumeration | Represents the Spine option. |
Property Detail¶
FeatureSpine¶
-
AlongSpineBuilder.
FeatureSpine
¶ Returns the Spine set by the owning feature of the law
-------------------------------------
Getter Method
Signature
FeatureSpine()
Returns: Section object Return type: NXOpen.Section
New in version NX5.0.0.
License requirements: None.
Spine¶
-
AlongSpineBuilder.
Spine
¶ Returns the Spine
-------------------------------------
Getter Method
Signature
Spine()
Returns: Section object Return type: NXOpen.Section
New in version NX5.0.0.
License requirements: None.
SpineOption¶
-
AlongSpineBuilder.
SpineOption
¶ Returns or sets the alongSpineOption.
This will be used only during the edit of Pre NX3 feature Parms
-------------------------------------
Getter Method
Signature
SpineOption()
Returns: Return type: NXOpen.GeometricUtilities.AlongSpineBuilderRetainSpineOption
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SpineOption(spineOption)
Parameters: spineOption ( NXOpen.GeometricUtilities.AlongSpineBuilderRetainSpineOption
) –New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”)
SpinePointList¶
-
AlongSpineBuilder.
SpinePointList
¶ Returns the list of spine points.
-------------------------------------
Getter Method
Signature
SpinePointList()
Returns: Return type: NXOpen.ObjectList
New in version NX5.0.0.
License requirements: None.
Method Detail¶
CreateSpinePoint¶
-
AlongSpineBuilder.
CreateSpinePoint
¶ Creates a new spine point
Signature
CreateSpinePoint()
Returns: OnPathDimWithValueBuilder Object Return type: NXOpen.GeometricUtilities.OnPathDimWithValueBuilder
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”)
GetSpinePoints¶
-
AlongSpineBuilder.
GetSpinePoints
¶ Returns the all SpinePointData objects
Signature
GetSpinePoints()
Returns: Array of SpinePointData Objects Return type: list of NXOpen.GeometricUtilities.OnPathDimWithValueBuilder
New in version NX5.0.0.
License requirements: None.
ResetSpine¶
-
AlongSpineBuilder.
ResetSpine
¶ Reset the spine
Signature
ResetSpine()
New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”)
SetFeatureSpine¶
-
AlongSpineBuilder.
SetFeatureSpine
¶ Set the spine sent by the owning feaure dynamically into builder
Signature
SetFeatureSpine(featureSpine)
Parameters: featureSpine ( NXOpen.Section
) – Set the Spine into builderNew in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”)
Validate¶
-
AlongSpineBuilder.
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.