CircularCenterlineBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# CircularCenterlineBuilder Class

class `NXOpen.Annotations.``CircularCenterlineBuilder`

  Bases: `NXOpen.Annotations.CircleCenterlineBuilder`

  Represents a CircularCenterlineBuilder Builder

  To create a new instance of this class, use `NXOpen.Annotations.CenterlineCollection.CreateCircularCenterlineBuilder()`

  Default values.

  Property | Value
  --- | ---
  FullCircle | true
  Type | Through3Points

  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.

# Method Detail

## Validate

`CircularCenterlineBuilder.``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.