OriginBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# OriginBuilder Class

class `NXOpen.Annotations.``OriginBuilder`

  Bases: `NXOpen.TaggedObject`, `NXOpen.GeometricUtilities.IComponentBuilder`

  Represents a `NXOpen.Annotations.OriginBuilder`

  This is a sub-builder class and cannot be directly instantiated

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
Anchor | Returns or sets the anchor location of the origin on the annotation
AnnotationView | Returns the view of the annotation (drafting member views only)
Origin | Returns the origin
OriginPoint | Returns or sets the origin point
Plane | Returns the plane
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
GetAssociativeOrigin | Gets the data that specifies the origin’s associativity
SetAssociativeOrigin | Associates the annotation’s origin to the specified objects
SetInferRelativeToGeometry | Infers a relative to geometry associative on commit if no other associativity has been applied
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

OriginBuilderAlignmentPosition Enumeration | alignment position on the annotation

# Property Detail

## Anchor

`OriginBuilder.``Anchor`

  Returns or sets the anchor location of the origin on the annotation

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

  Getter Method

  Signature `Anchor`

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

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Anchor`

  Parameters: | anchor (`NXOpen.Annotations.OriginBuilderAlignmentPosition`) –

  New in version NX6.0.0.

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

## AnnotationView

`OriginBuilder.``AnnotationView`

  Returns the view of the annotation (drafting member views only)

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

  Getter Method

  Signature `AnnotationView`

  Returns: |
  Return type: | `NXOpen.Drawings.SelectDraftingView`

  New in version NX6.0.0.

  License requirements: None.

## Origin

`OriginBuilder.``Origin`

  Returns the origin

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

  Getter Method

  Signature `Origin`

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

  New in version NX6.0.0.

  License requirements: None.

## OriginPoint

`OriginBuilder.``OriginPoint`

  Returns or sets the origin point

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

  Getter Method

  Signature `OriginPoint`

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

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `OriginPoint`

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

  New in version NX6.0.0.

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

## Plane

`OriginBuilder.``Plane`

  Returns the plane

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

  Getter Method

  Signature `Plane`

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

  New in version NX6.0.0.

  License requirements: None.

# Method Detail

## GetAssociativeOrigin

`OriginBuilder.``GetAssociativeOrigin`

  Gets the data that specifies the origin’s associativity

  Signature `GetAssociativeOrigin()`

  Returns: | associativity data
  Return type: | `NXOpen.Annotations.AnnotationAssociativeOriginData_Struct`

  New in version NX6.0.0.

  License requirements: None.

## SetAssociativeOrigin

`OriginBuilder.``SetAssociativeOrigin`

  Associates the annotation’s origin to the specified objects

  Signature `SetAssociativeOrigin(assocOrigin)`

  Parameters: | assocOrigin (`NXOpen.Annotations.AnnotationAssociativeOriginData_Struct`) – associativity data

  New in version NX6.0.0.

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

## SetInferRelativeToGeometry

`OriginBuilder.``SetInferRelativeToGeometry`

  Infers a relative to geometry associative on commit if no other associativity has been applied

  Signature `SetInferRelativeToGeometry(inferRelativeToGeometry)`

  Parameters: | inferRelativeToGeometry (bool) – relative to geometry flag

  New in version NX6.0.1.

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

## Validate

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