Centerline3dBuilder Class¶
-
class
NXOpen.Annotations.Centerline3dBuilder¶ Bases:
NXOpen.Annotations.BaseCenterline3dBuilderBuilder for creating 3D Centerline.
It creates or edits 3D Centerlines To create a new instance of this class, use
NXOpen.Annotations.CenterlineCollection.CreateCenterline3dBuilder()Default values.
Property Value AlignedCenterlines false OffsetDistance 0 OffsetMethod None New in version NX6.0.0.
Properties¶
| Property | Description |
|---|---|
| AlignedCenterlines | Returns or sets the aligned centerlines, applicable only for creation |
| Face | Returns the face |
| Inherit | Returns the inherit object |
| OffsetDistance | Returns or sets the offset distance, it is used only when aligned centerlines toggle is off |
| OffsetMethod | Returns or sets the offset method , it is used only when aligned centerlines toggle is off |
| OffsetObject | Returns the offset object, it is used only when aligned centerlines toggle is off |
| ReferenceIndex | Returns or sets the reference index |
| Settings | Returns the settings builder |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| AddEndExtensions | Adds extensions only at ends |
| AddExtension | Adds extension based on select object index |
| Commit | Commits any edits that have been applied to the builder. |
| Destroy | Deletes the builder, and cleans up any objects created by the builder. |
| GetAllExtensions | Returns all extensions. |
| GetAllIndividualExtensions | Returns individual extensions. |
| GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
| GetEndExtensions | Returns end extensions only. |
| GetObject | Returns the object currently being edited by this builder. |
| RemoveEndExtensions | Removes extensions only at ends |
| RemoveExtension | Removes extension based on select object index |
| ResetAllExtensions | Reset all extensions by the supplied defaultValue |
| SetAllIndividualExtensions | Sets all individual extensions |
| SetEndExtensions | Modifies end extensions only |
| SetIndividualExtensions | Modifies extensions based on select object index |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
| Centerline3dBuilderOffset Enumeration | the valid types of 3D Centerline offset method |
Property Detail¶
AlignedCenterlines¶
-
Centerline3dBuilder.AlignedCenterlines¶ Returns or sets the aligned centerlines, applicable only for creation
-------------------------------------Getter Method
Signature
AlignedCenterlinesReturns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AlignedCenterlinesParameters: alignedCenterlines (bool) – New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
Inherit¶
-
Centerline3dBuilder.Inherit¶ Returns the inherit object
-------------------------------------Getter Method
Signature
InheritReturns: Return type: NXOpen.SelectNXObjectNew in version NX6.0.0.
License requirements: None.
OffsetDistance¶
-
Centerline3dBuilder.OffsetDistance¶ Returns or sets the offset distance, it is used only when aligned centerlines toggle is off
-------------------------------------Getter Method
Signature
OffsetDistanceReturns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
OffsetDistanceParameters: offsetDistance (float) – New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
OffsetMethod¶
-
Centerline3dBuilder.OffsetMethod¶ Returns or sets the offset method , it is used only when aligned centerlines toggle is off
-------------------------------------Getter Method
Signature
OffsetMethodReturns: Return type: NXOpen.Annotations.Centerline3dBuilderOffsetNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
OffsetMethodParameters: offsetMethod ( NXOpen.Annotations.Centerline3dBuilderOffset) –New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
OffsetObject¶
-
Centerline3dBuilder.OffsetObject¶ Returns the offset object, it is used only when aligned centerlines toggle is off
-------------------------------------Getter Method
Signature
OffsetObjectReturns: Return type: NXOpen.SelectNXObjectNew in version NX6.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
Centerline3dBuilder.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.