BaseCenterline3dBuilder Class¶
-
class
NXOpen.Annotations.BaseCenterline3dBuilder¶ Bases:
NXOpen.Annotations.CenterlineBuilderRepresents a Base Centerline3d Builder for pmi and drafting 3D centerlines
This is an abstract class, and cannot be instantiated.
Default values.
Property Value Settings.Extension 6.35 (millimeters part), 0.25 (inches part) Settings.Gap 1.5875 (millimeters part), 0.0625 (inches part) Settings.IndividualDistance 0 Settings.Size 3.175 (millimeters part), 0.125 (inches part) Settings.Width Thin New in version NX7.5.0.
Properties¶
| Property | Description |
|---|---|
| Face | Returns the face |
| 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. |
Property Detail¶
Face¶
-
BaseCenterline3dBuilder.Face¶ Returns the face
-------------------------------------Getter Method
Signature
FaceReturns: Return type: NXOpen.SelectNXObjectListNew in version NX6.0.0.
License requirements: None.
ReferenceIndex¶
-
BaseCenterline3dBuilder.ReferenceIndex¶ Returns or sets the reference index
-------------------------------------Getter Method
Signature
ReferenceIndexReturns: Return type: int New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ReferenceIndexParameters: referenceIndex (int) – New in version NX6.0.0.
License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)
Settings¶
-
BaseCenterline3dBuilder.Settings¶ Returns the settings builder
-------------------------------------Getter Method
Signature
SettingsReturns: Return type: NXOpen.Annotations.Centerline3dSettingsBuilderNew in version NX6.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
BaseCenterline3dBuilder.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.