CircleCenterlineBuilder Class¶
-
class
NXOpen.Annotations.CircleCenterlineBuilder¶ Bases:
NXOpen.Annotations.CenterlineBuilderRepresents a CircleCenterline Builder
This is an abstract class.
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 NX6.0.0.
Properties¶
| Property | Description |
|---|---|
| FullCircle | Returns or sets the method which returns full or partial circle flag |
| Inherit | Returns the inherit object |
| Locations | Returns the selction object of the centerline |
| Settings | Returns the settings builder object for the centerline |
| Tag | Returns the Tag for this object. |
| Type | Returns or sets the method which returns type of centerline |
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 |
| RemoveLocation | Removes location object for a given index from the Select Object List. |
| 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¶
| CircleCenterlineBuilderTypes Enumeration | the valid enumeration used for the creation types, applicable only while creation Once created type centerpoint will be set for all bolt circle/circular centerline |
Property Detail¶
FullCircle¶
-
CircleCenterlineBuilder.FullCircle¶ Returns or sets the method which returns full or partial circle flag
-------------------------------------Getter Method
Signature
FullCircleReturns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
FullCircleParameters: fullType (bool) – New in version NX6.0.0.
License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)
Inherit¶
-
CircleCenterlineBuilder.Inherit¶ Returns the inherit object
-------------------------------------Getter Method
Signature
InheritReturns: Return type: NXOpen.SelectNXObjectNew in version NX6.0.0.
License requirements: None.
Locations¶
-
CircleCenterlineBuilder.Locations¶ Returns the selction object of the centerline
-------------------------------------Getter Method
Signature
LocationsReturns: Return type: NXOpen.SelectNXObjectListNew in version NX6.0.0.
License requirements: None.
Settings¶
-
CircleCenterlineBuilder.Settings¶ Returns the settings builder object for the centerline
-------------------------------------Getter Method
Signature
SettingsReturns: Return type: NXOpen.Annotations.CircleCenterlineSettingsBuilderNew in version NX6.0.0.
License requirements: None.
Type¶
-
CircleCenterlineBuilder.Type¶ Returns or sets the method which returns type of centerline
-------------------------------------Getter Method
Signature
TypeReturns: Return type: NXOpen.Annotations.CircleCenterlineBuilderTypesNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
TypeParameters: method ( NXOpen.Annotations.CircleCenterlineBuilderTypes) –New in version NX6.0.0.
License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)
Method Detail¶
RemoveLocation¶
-
CircleCenterlineBuilder.RemoveLocation¶ Removes location object for a given index from the Select Object List.
This method is required for the retained circle centerline case , however the method can be used for removing any object from select object list for the Circle Centerline.
Signature
RemoveLocation(index)Parameters: index (int) – Index of the object in the select object list New in version NX6.0.0.
License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)
Validate¶
-
CircleCenterlineBuilder.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.