BaseLinearDimensionBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# BaseLinearDimensionBuilder Class

class `NXOpen.Annotations.``BaseLinearDimensionBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Annotations.Dimension` builder

  This is an abstract class and cannot be instantiated.

  New in version NX9.0.0.

# Properties

Property | Description
--- | ---
AppendedText | Returns the appended text
DimensionSet | Returns the dimension set
FirstAssociativity | Returns the first associativity.
Inherit | Returns the inherit
IsAutoplaced | Returns or sets a flag to indicate if auto placement turned on.
Measurement | Returns the measurement
MeasurementType | Returns or sets the measurement type
Origin | Returns the origin
SecondAssociativity | Returns the second associativity.
Style | Returns the style
Tag | Returns the Tag for this object.
UseBaseline | Returns or sets a treat first associativity as a baseline

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
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.
GetNthSecondaryArrowheadOrientation | The arrowhead orientation for nth secondary dimensions
GetNthSecondaryOrigin | The origin for nth secondary dimensions
GetObject | Returns the object currently being edited by this builder.
GetSecondaryCallouts | The secondary callouts
SetNthSecondaryArrowheadOrientation | The arrowhead orientation for nth secondary dimensions
SetNthSecondaryOrigin | The origin for nth secondary dimensions
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.

# Property Detail

## AppendedText

`BaseLinearDimensionBuilder.``AppendedText`

  Returns the appended text

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

  Getter Method

  Signature `AppendedText`

  Returns: |
  Return type: | `NXOpen.Annotations.AppendedTextBuilder`

  New in version NX9.0.0.

  License requirements: None.

## DimensionSet

`BaseLinearDimensionBuilder.``DimensionSet`

  Returns the dimension set

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

  Getter Method

  Signature `DimensionSet`

  Returns: |
  Return type: | `NXOpen.Annotations.DimensionSetBuilder`

  New in version NX9.0.0.

  License requirements: None.

## FirstAssociativity

`BaseLinearDimensionBuilder.``FirstAssociativity`

  Returns the first associativity.

  Supported object types include Feature and DisplayableObject.

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

  Getter Method

  Signature `FirstAssociativity`

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

  New in version NX9.0.0.

  License requirements: None.

## Inherit

`BaseLinearDimensionBuilder.``Inherit`

  Returns the inherit

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

  Getter Method

  Signature `Inherit`

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

  New in version NX9.0.0.

  License requirements: None.

## IsAutoplaced

`BaseLinearDimensionBuilder.``IsAutoplaced`

  Returns or sets a flag to indicate if auto placement turned on.

  This is used to compute origins for secondary dimensions

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

  Getter Method

  Signature `IsAutoplaced`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `IsAutoplaced`

  Parameters: | isAutoplaced (bool) –

  New in version NX11.0.0.

  License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

## Measurement

`BaseLinearDimensionBuilder.``Measurement`

  Returns the measurement

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

  Getter Method

  Signature `Measurement`

  Returns: |
  Return type: | `NXOpen.Annotations.DimensionMeasurementBuilder`

  New in version NX9.0.0.

  License requirements: None.

## MeasurementType

`BaseLinearDimensionBuilder.``MeasurementType`

  Returns or sets the measurement type

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

  Getter Method

  Signature `MeasurementType`

  Returns: |
  Return type: | `NXOpen.Annotations.DimensionMeasurementTypes`

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `MeasurementType`

  Parameters: | measurementType (`NXOpen.Annotations.DimensionMeasurementTypes`) –

  New in version NX10.0.0.

  License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

## Origin

`BaseLinearDimensionBuilder.``Origin`

  Returns the origin

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

  Getter Method

  Signature `Origin`

  Returns: |
  Return type: | `NXOpen.Annotations.OriginBuilder`

  New in version NX9.0.0.

  License requirements: None.

## SecondAssociativity

`BaseLinearDimensionBuilder.``SecondAssociativity`

  Returns the second associativity.

  Supported object types include Feature and DisplayableObject.

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

  Getter Method

  Signature `SecondAssociativity`

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

  New in version NX9.0.0.

  License requirements: None.

## Style

`BaseLinearDimensionBuilder.``Style`

  Returns the style

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

  Getter Method

  Signature `Style`

  Returns: |
  Return type: | `NXOpen.Annotations.StyleBuilder`

  New in version NX9.0.0.

  License requirements: None.

## UseBaseline

`BaseLinearDimensionBuilder.``UseBaseline`

  Returns or sets a treat first associativity as a baseline

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

  Getter Method

  Signature `UseBaseline`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `UseBaseline`

  Parameters: | useBaseline (bool) –

  New in version NX9.0.0.

  License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”) OR solid_modeling (“SOLIDS MODELING”)

# Method Detail

## GetNthSecondaryArrowheadOrientation

`BaseLinearDimensionBuilder.``GetNthSecondaryArrowheadOrientation`

  The arrowhead orientation for nth secondary dimensions

  Signature `GetNthSecondaryArrowheadOrientation(nth)`

  Parameters: | nth (int) –
  Returns: |
  Return type: | `NXOpen.Annotations.TextPlacement`

  New in version NX11.0.0.

  License requirements: None.

## GetNthSecondaryOrigin

`BaseLinearDimensionBuilder.``GetNthSecondaryOrigin`

  The origin for nth secondary dimensions

  Signature `GetNthSecondaryOrigin(nth)`

  Parameters: | nth (int) –
  Returns: |
  Return type: | `NXOpen.Point3d`

  New in version NX11.0.0.

  License requirements: None.

## GetSecondaryCallouts

`BaseLinearDimensionBuilder.``GetSecondaryCallouts`

  The secondary callouts

  Signature `GetSecondaryCallouts()`

  Returns: |
  Return type: | list of `NXOpen.Annotations.Dimension`

  New in version NX11.0.0.

  License requirements: None.

## SetNthSecondaryArrowheadOrientation

`BaseLinearDimensionBuilder.``SetNthSecondaryArrowheadOrientation`

  The arrowhead orientation for nth secondary dimensions

  Signature `SetNthSecondaryArrowheadOrientation(nth, secondaryArrowheadOrientation)`

  Parameters:

  - nth (int) –
  - secondaryArrowheadOrientation (`NXOpen.Annotations.TextPlacement`) –

  New in version NX11.0.0.

  License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

## SetNthSecondaryOrigin

`BaseLinearDimensionBuilder.``SetNthSecondaryOrigin`

  The origin for nth secondary dimensions

  Signature `SetNthSecondaryOrigin(nth, secondaryOrigin)`

  Parameters:

  - nth (int) –
  - secondaryOrigin (`NXOpen.Point3d`) –

  New in version NX11.0.0.

  License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

## Validate

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