OrientationMethodBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# OrientationMethodBuilder Class

class `NXOpen.GeometricUtilities.``OrientationMethodBuilder`

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

  Represents a `NXOpen.GeometricUtilities.OrientationMethodBuilder`

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
AngularLaw | Returns the angular law.
Faces | Returns the faces that provide normal direction for alignment of second axis of local coordinate system.
NormalFaceList | Returns the normal face list.
OrientationCurve | Returns the orientation curve.
OrientationOption | Returns or sets the orientation option.
OrientationPoint | Returns or sets the orientation point.
OrientationVector | Returns or sets the orientation vector.
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

OrientationMethodBuilderOrientationOptions Enumeration | This enum represents the orientation option.

# Property Detail

## AngularLaw

`OrientationMethodBuilder.``AngularLaw`

  Returns the angular law.

  For orientation by an Angular Law, the section rotation along the guide curve is governed by the input law.

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

  Getter Method

  Signature `AngularLaw`

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

  New in version NX5.0.0.

  License requirements: None.

## Faces

`OrientationMethodBuilder.``Faces`

  Returns the faces that provide normal direction for alignment of second axis of local coordinate system.

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

  Getter Method

  Signature `Faces`

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

  New in version NX12.0.0.

  License requirements: None.

## NormalFaceList

`OrientationMethodBuilder.``NormalFaceList`

  Returns the normal face list.

  For orientation by Face Normals, the second axis of the local coordinate system is aligned with the resultant of normals of the input faces.

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

  Getter Method

  Signature `NormalFaceList`

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

  New in version NX5.0.0.

  Deprecated since version NX12.0.0: Use `NXOpen.GeometricUtilities.OrientationMethodBuilder.Faces()`

  License requirements: None.

## OrientationCurve

`OrientationMethodBuilder.``OrientationCurve`

  Returns the orientation curve.

  For orientation by Another Curve, the second axis of the local coordinate system is obtained by joining corresponding points on the guide and the input section.

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

  Getter Method

  Signature `OrientationCurve`

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

  New in version NX5.0.0.

  License requirements: None.

## OrientationOption

`OrientationMethodBuilder.``OrientationOption`

  Returns or sets the orientation option.

  Except for Fixed orientation method, additional parameters and/or inputs are required.

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

  Getter Method

  Signature `OrientationOption`

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

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `OrientationOption`

  Parameters: | orientationOption (`NXOpen.GeometricUtilities.OrientationMethodBuilderOrientationOptions`) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## OrientationPoint

`OrientationMethodBuilder.``OrientationPoint`

  Returns or sets the orientation point.

  For orientation by a Point, the second axis is obtained with the equivalent of a three-sided ruled sheet between the guide string and the input point.

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

  Getter Method

  Signature `OrientationPoint`

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

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `OrientationPoint`

  Parameters: | orientationPoint (`NXOpen.Point`) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## OrientationVector

`OrientationMethodBuilder.``OrientationVector`

  Returns or sets the orientation vector.

  For orientation by Vector, the second axis of the local coordinate system is aligned with the input vector.

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

  Getter Method

  Signature `OrientationVector`

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

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `OrientationVector`

  Parameters: | orientationVector (`NXOpen.Direction`) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

# Method Detail

## Validate

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