LayoutRepositionBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# LayoutRepositionBuilder Class

class `NXOpen.Tooling.``LayoutRepositionBuilder`

  Bases: `NXOpen.Builder`

  Represents a Tooling::LayoutRepositionBuilder builder

  To create a new instance of this class, use `NXOpen.Tooling.MWLayoutCollection.CreateLayoutRepositionBuilder()`

  Default values.

  Property | Value
  --- | ---
  DimX.Value | 0 (millimeters part), 0 (inches part)
  DimY.Value | 0 (millimeters part), 0 (inches part)
  RepositionType | Move
  RotateAngle.Value | 180

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
DimX | Returns the distance dimension in X-axis
DimY | Returns the distance dimension in Y-axis
PointFrom | Returns or sets the transform start point
PointTo | Returns or sets the transform end point
RepositionMethod | Returns or sets the reposition method
RepositionType | Returns or sets the reposition type
RotateAngle | Returns the rotate angle
RotatePoint | Returns or sets the rotate point
SelectInstance | Returns the select instance
Tag | Returns the Tag for this object.

# 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.
GetObject | Returns the object currently being edited by this builder.
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.

# Enumerations

LayoutRepositionBuilderMethod Enumeration | Represents the type of layout transform.
LayoutRepositionBuilderType Enumeration | Represents the method of layout transform.

# Property Detail

## DimX

`LayoutRepositionBuilder.``DimX`

  Returns the distance dimension in X-axis

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

  Getter Method

  Signature `DimX`

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

  New in version NX6.0.0.

  License requirements: None.

## DimY

`LayoutRepositionBuilder.``DimY`

  Returns the distance dimension in Y-axis

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

  Getter Method

  Signature `DimY`

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

  New in version NX6.0.0.

  License requirements: None.

## PointFrom

`LayoutRepositionBuilder.``PointFrom`

  Returns or sets the transform start point

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

  Getter Method

  Signature `PointFrom`

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

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `PointFrom`

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

  New in version NX6.0.0.

  License requirements: None.

## PointTo

`LayoutRepositionBuilder.``PointTo`

  Returns or sets the transform end point

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

  Getter Method

  Signature `PointTo`

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

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `PointTo`

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

  New in version NX6.0.0.

  License requirements: None.

## RepositionMethod

`LayoutRepositionBuilder.``RepositionMethod`

  Returns or sets the reposition method

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

  Getter Method

  Signature `RepositionMethod`

  Returns: |
  Return type: | `NXOpen.Tooling.LayoutRepositionBuilderMethod`

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `RepositionMethod`

  Parameters: | enumRepositionmethod (`NXOpen.Tooling.LayoutRepositionBuilderMethod`) –

  New in version NX6.0.0.

  License requirements: None.

## RepositionType

`LayoutRepositionBuilder.``RepositionType`

  Returns or sets the reposition type

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

  Getter Method

  Signature `RepositionType`

  Returns: |
  Return type: | `NXOpen.Tooling.LayoutRepositionBuilderType`

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `RepositionType`

  Parameters: | enumRepositiontype (`NXOpen.Tooling.LayoutRepositionBuilderType`) –

  New in version NX6.0.0.

  License requirements: None.

## RotateAngle

`LayoutRepositionBuilder.``RotateAngle`

  Returns the rotate angle

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

  Getter Method

  Signature `RotateAngle`

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

  New in version NX6.0.0.

  License requirements: None.

## RotatePoint

`LayoutRepositionBuilder.``RotatePoint`

  Returns or sets the rotate point

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

  Getter Method

  Signature `RotatePoint`

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

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `RotatePoint`

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

  New in version NX6.0.0.

  License requirements: None.

## SelectInstance

`LayoutRepositionBuilder.``SelectInstance`

  Returns the select instance

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

  Getter Method

  Signature `SelectInstance`

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

  New in version NX6.0.0.

  License requirements: None.

# Method Detail

## Validate

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