Centerline2dBuilder Class¶
-
class
NXOpen.Annotations.Centerline2dBuilder¶ Bases:
NXOpen.Annotations.CenterlineBuilderBuilder for creating 2D Centerline.
It creates or edits 2D Centerlines To create a new instance of this class, use
NXOpen.Annotations.CenterlineCollection.CreateCenterline2dBuilder()Default values.
Property Value OffsetDistance 0 OffsetMethod None 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 Type FromCurves New in version NX6.0.0.
Properties¶
| Property | Description |
|---|---|
| Inherit | Returns the inherit object |
| OffsetDistance | Returns or sets the offset distance for centerline by points |
| OffsetMethod | Returns or sets the offset method for centerline by points |
| OffsetObject | Returns the offset object for centerline by points |
| Point1 | Returns the point 1 of 2D Centerline for centerline by points |
| Point2 | Returns the point 2 of 2D Centerline for centerline by points |
| Settings | Returns the settings builder |
| Side1 | Returns the side 1 of 2D Centerline for centerline from curves |
| Side2 | Returns the side 2 of 2D Centerline for centerline from curves |
| Tag | Returns the Tag for this object. |
| Type | Returns or sets the type |
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¶
| Centerline2dBuilderOffset Enumeration | the valid types of 2D Centerline offset method |
| Centerline2dBuilderTypes Enumeration | the valid types of 2D Centerline, applicable only for creation |
Property Detail¶
Inherit¶
-
Centerline2dBuilder.Inherit¶ Returns the inherit object
-------------------------------------Getter Method
Signature
Inherit()Returns: Return type: NXOpen.SelectNXObjectNew in version NX6.0.0.
License requirements: None.
OffsetDistance¶
-
Centerline2dBuilder.OffsetDistance¶ Returns or sets the offset distance for centerline by points
-------------------------------------Getter Method
Signature
OffsetDistance()Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
OffsetDistance(offsetDistance)Parameters: offsetDistance (float) – New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
OffsetMethod¶
-
Centerline2dBuilder.OffsetMethod¶ Returns or sets the offset method for centerline by points
-------------------------------------Getter Method
Signature
OffsetMethod()Returns: Return type: NXOpen.Annotations.Centerline2dBuilderOffsetNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
OffsetMethod(offsetMethod)Parameters: offsetMethod ( NXOpen.Annotations.Centerline2dBuilderOffset) –New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
OffsetObject¶
-
Centerline2dBuilder.OffsetObject¶ Returns the offset object for centerline by points
-------------------------------------Getter Method
Signature
OffsetObject()Returns: Return type: NXOpen.SelectNXObjectNew in version NX6.0.0.
License requirements: None.
Point1¶
-
Centerline2dBuilder.Point1¶ Returns the point 1 of 2D Centerline for centerline by points
-------------------------------------Getter Method
Signature
Point1()Returns: Return type: NXOpen.SelectNXObjectNew in version NX6.0.0.
License requirements: None.
Point2¶
-
Centerline2dBuilder.Point2¶ Returns the point 2 of 2D Centerline for centerline by points
-------------------------------------Getter Method
Signature
Point2()Returns: Return type: NXOpen.SelectNXObjectNew in version NX6.0.0.
License requirements: None.
Settings¶
-
Centerline2dBuilder.Settings¶ Returns the settings builder
-------------------------------------Getter Method
Signature
Settings()Returns: Return type: NXOpen.Annotations.Centerline2dSettingsBuilderNew in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
Side1¶
-
Centerline2dBuilder.Side1¶ Returns the side 1 of 2D Centerline for centerline from curves
-------------------------------------Getter Method
Signature
Side1()Returns: Return type: NXOpen.SelectNXObjectNew in version NX6.0.0.
License requirements: None.
Side2¶
-
Centerline2dBuilder.Side2¶ Returns the side 2 of 2D Centerline for centerline from curves
-------------------------------------Getter Method
Signature
Side2()Returns: Return type: NXOpen.SelectNXObjectNew in version NX6.0.0.
License requirements: None.
Type¶
-
Centerline2dBuilder.Type¶ Returns or sets the type
-------------------------------------Getter Method
Signature
Type()Returns: Return type: NXOpen.Annotations.Centerline2dBuilderTypesNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Type(type)Parameters: type ( NXOpen.Annotations.Centerline2dBuilderTypes) –New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
Method Detail¶
Validate¶
-
Centerline2dBuilder.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.