CenterlineBuilder Class¶
-
class
NXOpen.Annotations.
CenterlineBuilder
¶ Bases:
NXOpen.Annotations.BaseSymbolBuilder
Represents a Base Centerline Builder for all types of centerlines
This is an abstract class, and cannot be instantiated.
New in version NX6.0.0.
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. |
Method Detail¶
AddEndExtensions¶
-
CenterlineBuilder.
AddEndExtensions
¶ Adds extensions only at ends
Signature
AddEndExtensions(start, end)
Parameters: - start (float) – Default start extension value
- end (float) – Default end extension value
New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
AddExtension¶
-
CenterlineBuilder.
AddExtension
¶ Adds extension based on select object index
Signature
AddExtension(index, defaultValue)
Parameters: - index (int) – Index of the selected object
- defaultValue (float) – Default extension value
New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
GetAllExtensions¶
-
CenterlineBuilder.
GetAllExtensions
¶ Returns all extensions.
If the builder is a
NXOpen.Annotations.BoltCircleCenterlineBuilder
orNXOpen.Annotations.CircularCenterlineBuilder
andNXOpen.Annotations.CircleCenterlineSettingsBuilder.IndividualDistance()
is false, this will method will return no extensions.Signature
GetAllExtensions()
Returns: Extension values as output Return type: list of float New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
GetAllIndividualExtensions¶
-
CenterlineBuilder.
GetAllIndividualExtensions
¶ Returns individual extensions.
This method is applicable only for
NXOpen.Annotations.CenterMark
andNXOpen.Annotations.CircleCenterline
.If the builder is a
NXOpen.Annotations.BoltCircleCenterlineBuilder
orNXOpen.Annotations.CircularCenterlineBuilder
andNXOpen.Annotations.CircleCenterlineSettingsBuilder.IndividualDistance()
is false, this will method will return no extensions.Signature
GetAllIndividualExtensions()
Returns: Extension values as output Return type: list of float New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
GetEndExtensions¶
-
CenterlineBuilder.
GetEndExtensions
¶ Returns end extensions only.
The first and the last extension of the centerline.
If the builder is a
NXOpen.Annotations.BoltCircleCenterlineBuilder
orNXOpen.Annotations.CircularCenterlineBuilder
andNXOpen.Annotations.CircleCenterlineSettingsBuilder.IndividualDistance()
is false, this will method will return no extensions.Signature
GetEndExtensions()
Returns: Extension values as output Return type: list of float New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
RemoveEndExtensions¶
-
CenterlineBuilder.
RemoveEndExtensions
¶ Removes extensions only at ends
Signature
RemoveEndExtensions()
New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
RemoveExtension¶
-
CenterlineBuilder.
RemoveExtension
¶ Removes extension based on select object index
Signature
RemoveExtension(index)
Parameters: index (int) – Index of the selected object New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
ResetAllExtensions¶
-
CenterlineBuilder.
ResetAllExtensions
¶ Reset all extensions by the supplied defaultValue
Signature
ResetAllExtensions(defaultValue)
Parameters: defaultValue (float) – New extension value New in version NX6.0.1.
License requirements: drafting (“DRAFTING”)
SetAllIndividualExtensions¶
-
CenterlineBuilder.
SetAllIndividualExtensions
¶ Sets all individual extensions
Signature
SetAllIndividualExtensions(extensionValues)
Parameters: extensionValues (list of float) – Extension values as input New in version NX8.0.1.
License requirements: drafting (“DRAFTING”)
SetEndExtensions¶
-
CenterlineBuilder.
SetEndExtensions
¶ Modifies end extensions only
Signature
SetEndExtensions(start, end)
Parameters: - start (float) – New extension value at one end
- end (float) – New extension value at one end
New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
SetIndividualExtensions¶
-
CenterlineBuilder.
SetIndividualExtensions
¶ Modifies extensions based on select object index
Signature
SetIndividualExtensions(index, value1, value2)
Parameters: - index (int) – Index of the selected object
- value1 (float) – New extension value at one end
- value2 (float) – New extension value at other end
New in version NX6.0.0.
License requirements: drafting (“DRAFTING”)
Validate¶
-
CenterlineBuilder.
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.