AssociativeArcBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# AssociativeArcBuilder Class

class `NXOpen.Features.``AssociativeArcBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a `NXOpen.Features.AssociativeArc` builder

  To create a new instance of this class, use `NXOpen.Features.BaseFeatureCollection.CreateAssociativeArcBuilder()`

  Default values.

  Property | Value
  --- | ---
  Associative | True
  Limits.EndLimit.LimitOption | AtPoint
  SupportPlaneData.SupportPlaneLockStatus | No

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
Associative | Returns or sets the associative
CenterPoint | Returns the center point - this should be a smart point created using one of `NXOpen.PointCollection.CreatePoint()`
CenterPointReference | Returns or sets the center point reference
CenterPointReferenceCsys | Returns the center point reference coordinate system
CenterRadiusLockedPlaneDirection | Returns or sets the plane direction for arc type center radius when lock status is `NXOpen.GeometricUtilities.SupportPlaneDataLockPlaneStatus.CenterPointDirection`
Diameter | Returns the diameter of arc
EndInferredConstraint | Returns the end inferred constraint
EndPoint | Returns the end point - this should be a smart point created using one of `NXOpen.PointCollection.CreatePoint()`
EndPointOptions | Returns or sets the end point options
EndPointReference | Returns or sets the end point reference
EndReferenceCsys | Returns the end reference coordinate system
EndTangent | Returns the end tangent - point can be passed in SELECT_OBJECT which is used in case of multiple solutions
Limits | Returns the limits
MidInferredConstraint | Returns the mid inferred constraint
MidPoint | Returns the mid point - this should be a smart point created using one of `NXOpen.PointCollection.CreatePoint()`
MidPointOptions | Returns or sets the mid point options
MidPointReference | Returns or sets the mid point reference
MidReferenceCsys | Returns the mid reference coordinate system
MidTangent | Returns the mid tangent - point can be passed in SELECT_OBJECT which is used in case of multiple solutions
ParentFeatureInternal | Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal
PatchSolutionFlag | Returns or sets the patch solution flag
PatchSurfaceFilename | Returns or sets the patch surface filename
Radius | Returns the radius of arc
StartInferredConstraint | Returns the start inferred constraint
StartPoint | Returns the start point - this should be a smart point created using one of `NXOpen.PointCollection.CreatePoint()`
StartPointOptions | Returns or sets the start point options
StartPointReference | Returns or sets the start point reference
StartReferenceCsys | Returns the start reference coordinate system
StartTangent | Returns the start tangent - point can be passed in SELECT_OBJECT which is used in case of multiple solutions
SupportPlaneData | Returns the support plane data
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
Type | Returns or sets the type option
ZonePoint | Returns or sets the zone point is required when arc has multiple solutions in following conditions: 1.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CommitFeature | Commits the feature parameters and creates the feature
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetFeature | Returns the feature currently being edited by this builder.
GetObject | Returns the object currently being edited by this builder.
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited.
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited
ShowInternalParentFeatureForEdit | Unsuppress an internal parent feature (a slave feature) so it can be edited.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UnsetParentFeatureInternal | Set the internal parent feature of the feature being edited to external
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

AssociativeArcBuilderCenterReference Enumeration | Represents references for center point
AssociativeArcBuilderEndOption Enumeration | Represents end point options type
AssociativeArcBuilderEndReference Enumeration | Represents references for end point
AssociativeArcBuilderMidOption Enumeration | Represents mid point options type
AssociativeArcBuilderMidReference Enumeration | Represents references for mid point
AssociativeArcBuilderStartOption Enumeration | Represents start point options type
AssociativeArcBuilderStartReference Enumeration | Represents references for start point
AssociativeArcBuilderTypes Enumeration | Represents arc type.

# Property Detail

## Associative

`AssociativeArcBuilder.``Associative`

  Returns or sets the associative

  `-------------------------------------`

  Getter Method

  Signature `Associative`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Associative`

  Parameters: | associative (bool) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)

## CenterPoint

`AssociativeArcBuilder.``CenterPoint`

  Returns the center point - this should be a smart point created using one of `NXOpen.PointCollection.CreatePoint()`

  `-------------------------------------`

  Getter Method

  Signature `CenterPoint`

  Returns: |
  Return type: | `NXOpen.SelectPoint`

  New in version NX5.0.0.

  License requirements: None.

## CenterPointReference

`AssociativeArcBuilder.``CenterPointReference`

  Returns or sets the center point reference

  `-------------------------------------`

  Getter Method

  Signature `CenterPointReference`

  Returns: |
  Return type: | `NXOpen.Features.AssociativeArcBuilderCenterReference`

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `CenterPointReference`

  Parameters: | centerPointReference (`NXOpen.Features.AssociativeArcBuilderCenterReference`) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)

## CenterPointReferenceCsys

`AssociativeArcBuilder.``CenterPointReferenceCsys`

  Returns the center point reference coordinate system

  `-------------------------------------`

  Getter Method

  Signature `CenterPointReferenceCsys`

  Returns: |
  Return type: | `NXOpen.SelectCartesianCoordinateSystem`

  New in version NX5.0.0.

  License requirements: None.

## CenterRadiusLockedPlaneDirection

`AssociativeArcBuilder.``CenterRadiusLockedPlaneDirection`

  Returns or sets the plane direction for arc type center radius when lock status is `NXOpen.GeometricUtilities.SupportPlaneDataLockPlaneStatus.CenterPointDirection`

  `-------------------------------------`

  Getter Method

  Signature `CenterRadiusLockedPlaneDirection`

  Returns: |
  Return type: | `NXOpen.Vector3d`

  New in version NX7.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `CenterRadiusLockedPlaneDirection`

  Parameters: | direction (`NXOpen.Vector3d`) –

  New in version NX7.5.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)

## Diameter

`AssociativeArcBuilder.``Diameter`

  Returns the diameter of arc

  `-------------------------------------`

  Getter Method

  Signature `Diameter`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX7.5.0.

  License requirements: None.

## EndInferredConstraint

`AssociativeArcBuilder.``EndInferredConstraint`

  Returns the end inferred constraint

  `-------------------------------------`

  Getter Method

  Signature `EndInferredConstraint`

  Returns: |
  Return type: | `NXOpen.SelectObject`

  New in version NX5.0.0.

  License requirements: None.

## EndPoint

`AssociativeArcBuilder.``EndPoint`

  Returns the end point - this should be a smart point created using one of `NXOpen.PointCollection.CreatePoint()`

  `-------------------------------------`

  Getter Method

  Signature `EndPoint`

  Returns: |
  Return type: | `NXOpen.SelectPoint`

  New in version NX5.0.0.

  License requirements: None.

## EndPointOptions

`AssociativeArcBuilder.``EndPointOptions`

  Returns or sets the end point options

  `-------------------------------------`

  Getter Method

  Signature `EndPointOptions`

  Returns: |
  Return type: | `NXOpen.Features.AssociativeArcBuilderEndOption`

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `EndPointOptions`

  Parameters: | endPointOptions (`NXOpen.Features.AssociativeArcBuilderEndOption`) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)

## EndPointReference

`AssociativeArcBuilder.``EndPointReference`

  Returns or sets the end point reference

  `-------------------------------------`

  Getter Method

  Signature `EndPointReference`

  Returns: |
  Return type: | `NXOpen.Features.AssociativeArcBuilderEndReference`

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `EndPointReference`

  Parameters: | endPointReference (`NXOpen.Features.AssociativeArcBuilderEndReference`) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)

## EndReferenceCsys

`AssociativeArcBuilder.``EndReferenceCsys`

  Returns the end reference coordinate system

  `-------------------------------------`

  Getter Method

  Signature `EndReferenceCsys`

  Returns: |
  Return type: | `NXOpen.SelectCartesianCoordinateSystem`

  New in version NX5.0.0.

  License requirements: None.

## EndTangent

`AssociativeArcBuilder.``EndTangent`

  Returns the end tangent - point can be passed in SELECT_OBJECT which is used in case of multiple solutions

  `-------------------------------------`

  Getter Method

  Signature `EndTangent`

  Returns: |
  Return type: | `NXOpen.SelectDisplayableObject`

  New in version NX5.0.0.

  License requirements: None.

## Limits

`AssociativeArcBuilder.``Limits`

  Returns the limits

  `-------------------------------------`

  Getter Method

  Signature `Limits`

  Returns: |
  Return type: | `NXOpen.GeometricUtilities.CurveLimitsData`

  New in version NX5.0.0.

  License requirements: None.

## MidInferredConstraint

`AssociativeArcBuilder.``MidInferredConstraint`

  Returns the mid inferred constraint

  `-------------------------------------`

  Getter Method

  Signature `MidInferredConstraint`

  Returns: |
  Return type: | `NXOpen.SelectObject`

  New in version NX5.0.0.

  License requirements: None.

## MidPoint

`AssociativeArcBuilder.``MidPoint`

  Returns the mid point - this should be a smart point created using one of `NXOpen.PointCollection.CreatePoint()`

  `-------------------------------------`

  Getter Method

  Signature `MidPoint`

  Returns: |
  Return type: | `NXOpen.SelectPoint`

  New in version NX5.0.0.

  License requirements: None.

## MidPointOptions

`AssociativeArcBuilder.``MidPointOptions`

  Returns or sets the mid point options

  `-------------------------------------`

  Getter Method

  Signature `MidPointOptions`

  Returns: |
  Return type: | `NXOpen.Features.AssociativeArcBuilderMidOption`

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `MidPointOptions`

  Parameters: | midPointOptions (`NXOpen.Features.AssociativeArcBuilderMidOption`) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)

## MidPointReference

`AssociativeArcBuilder.``MidPointReference`

  Returns or sets the mid point reference

  `-------------------------------------`

  Getter Method

  Signature `MidPointReference`

  Returns: |
  Return type: | `NXOpen.Features.AssociativeArcBuilderMidReference`

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `MidPointReference`

  Parameters: | midPointReference (`NXOpen.Features.AssociativeArcBuilderMidReference`) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)

## MidReferenceCsys

`AssociativeArcBuilder.``MidReferenceCsys`

  Returns the mid reference coordinate system

  `-------------------------------------`

  Getter Method

  Signature `MidReferenceCsys`

  Returns: |
  Return type: | `NXOpen.SelectCartesianCoordinateSystem`

  New in version NX5.0.0.

  License requirements: None.

## MidTangent

`AssociativeArcBuilder.``MidTangent`

  Returns the mid tangent - point can be passed in SELECT_OBJECT which is used in case of multiple solutions

  `-------------------------------------`

  Getter Method

  Signature `MidTangent`

  Returns: |
  Return type: | `NXOpen.SelectDisplayableObject`

  New in version NX5.0.0.

  License requirements: None.

## Radius

`AssociativeArcBuilder.``Radius`

  Returns the radius of arc

  `-------------------------------------`

  Getter Method

  Signature `Radius`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX5.0.0.

  License requirements: None.

## StartInferredConstraint

`AssociativeArcBuilder.``StartInferredConstraint`

  Returns the start inferred constraint

  `-------------------------------------`

  Getter Method

  Signature `StartInferredConstraint`

  Returns: |
  Return type: | `NXOpen.SelectObject`

  New in version NX5.0.0.

  License requirements: None.

## StartPoint

`AssociativeArcBuilder.``StartPoint`

  Returns the start point - this should be a smart point created using one of `NXOpen.PointCollection.CreatePoint()`

  `-------------------------------------`

  Getter Method

  Signature `StartPoint`

  Returns: |
  Return type: | `NXOpen.SelectPoint`

  New in version NX5.0.0.

  License requirements: None.

## StartPointOptions

`AssociativeArcBuilder.``StartPointOptions`

  Returns or sets the start point options

  `-------------------------------------`

  Getter Method

  Signature `StartPointOptions`

  Returns: |
  Return type: | `NXOpen.Features.AssociativeArcBuilderStartOption`

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `StartPointOptions`

  Parameters: | startPointOptions (`NXOpen.Features.AssociativeArcBuilderStartOption`) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)

## StartPointReference

`AssociativeArcBuilder.``StartPointReference`

  Returns or sets the start point reference

  `-------------------------------------`

  Getter Method

  Signature `StartPointReference`

  Returns: |
  Return type: | `NXOpen.Features.AssociativeArcBuilderStartReference`

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `StartPointReference`

  Parameters: | startPointReference (`NXOpen.Features.AssociativeArcBuilderStartReference`) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)

## StartReferenceCsys

`AssociativeArcBuilder.``StartReferenceCsys`

  Returns the start reference coordinate system

  `-------------------------------------`

  Getter Method

  Signature `StartReferenceCsys`

  Returns: |
  Return type: | `NXOpen.SelectCartesianCoordinateSystem`

  New in version NX5.0.0.

  License requirements: None.

## StartTangent

`AssociativeArcBuilder.``StartTangent`

  Returns the start tangent - point can be passed in SELECT_OBJECT which is used in case of multiple solutions

  `-------------------------------------`

  Getter Method

  Signature `StartTangent`

  Returns: |
  Return type: | `NXOpen.SelectDisplayableObject`

  New in version NX5.0.0.

  License requirements: None.

## SupportPlaneData

`AssociativeArcBuilder.``SupportPlaneData`

  Returns the support plane data

  `-------------------------------------`

  Getter Method

  Signature `SupportPlaneData`

  Returns: |
  Return type: | `NXOpen.GeometricUtilities.SupportPlaneData`

  New in version NX5.0.0.

  License requirements: None.

## Type

`AssociativeArcBuilder.``Type`

  Returns or sets the type option

  `-------------------------------------`

  Getter Method

  Signature `Type`

  Returns: |
  Return type: | `NXOpen.Features.AssociativeArcBuilderTypes`

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Type`

  Parameters: | type (`NXOpen.Features.AssociativeArcBuilderTypes`) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)

## ZonePoint

`AssociativeArcBuilder.``ZonePoint`

  Returns or sets the zone point is required when arc has multiple solutions in following conditions: 1.

  Arc is defined with a radius constraint. 2. Arc is defined with two identical point constraints. 3. Arc is defined with the middle constraint as tangent constraint.

  `-------------------------------------`

  Getter Method

  Signature `ZonePoint`

  Returns: |
  Return type: | `NXOpen.Point3d`

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ZonePoint`

  Parameters: | zonePoint (`NXOpen.Point3d`) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)

# Method Detail

## Validate

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