MoveObjectBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# MoveObjectBuilder Class

class `NXOpen.Features.``MoveObjectBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Features.MoveObjectBuilder`.

  Inputs to this class can be convergent objects. To create a new instance of this class, use `NXOpen.Features.BaseFeatureCollection.CreateMoveObjectBuilder()`

  Default values.

  Property | Value
  --- | ---
  Associative | false
  CreateTraceLines | false
  Divisions | 1
  LayerOption | Original
  MoveObjectResult | MoveOriginal
  MoveParents | true
  NumberOfCopies | 1
  TransformMotion.DeltaEnum | ReferenceWcsWorkPart
  TransformMotion.DeltaXc.Value | 0.0
  TransformMotion.DeltaYc.Value | 0.0
  TransformMotion.DeltaZc.Value | 0.0
  TransformMotion.Option | Dynamic

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
Associative | Returns or sets the associative flag.
CreateTraceLines | Returns or sets the create trace lines flag
Divisions | Returns or sets the distance or angle divisions
Layer | Returns or sets the layer
LayerOption | Returns or sets the layer option
MoveObjectResult | Returns or sets the move rotate result
MoveParents | Returns or sets the move parents flag.
NumberOfCopies | Returns or sets the number of copies
ObjectToMoveObject | Returns the objects to move-rotate
Tag | Returns the Tag for this object.
TransformMotion | Returns the transform

# 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

MoveObjectBuilderLayerOptionType Enumeration | Indicates the layer on which moved or copied objects will be placed
MoveObjectBuilderMoveObjectResultOptions Enumeration | Indicates whether to move or copy objects

# Property Detail

## Associative

`MoveObjectBuilder.``Associative`

  Returns or sets the associative flag.

  A Move Object feature is created only when Move Parents flag is false.

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

  Getter Method

  Signature `Associative`

  Returns: |
  Return type: | bool

  New in version NX6.0.2.

  License requirements: None.

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

  Setter Method

  Signature `Associative`

  Parameters: | associative (bool) –

  New in version NX6.0.2.

  License requirements: None.

## CreateTraceLines

`MoveObjectBuilder.``CreateTraceLines`

  Returns or sets the create trace lines flag

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

  Getter Method

  Signature `CreateTraceLines`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `CreateTraceLines`

  Parameters: | createTraceLines (bool) –

  New in version NX6.0.0.

  License requirements: None.

## Divisions

`MoveObjectBuilder.``Divisions`

  Returns or sets the distance or angle divisions

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

  Getter Method

  Signature `Divisions`

  Returns: |
  Return type: | int

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Divisions`

  Parameters: | distanceOrAngleDivisions (int) –

  New in version NX6.0.0.

  License requirements: None.

## Layer

`MoveObjectBuilder.``Layer`

  Returns or sets the layer

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

  Getter Method

  Signature `Layer`

  Returns: |
  Return type: | int

  New in version NX6.0.2.

  License requirements: None.

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

  Setter Method

  Signature `Layer`

  Parameters: | layer (int) –

  New in version NX6.0.2.

  License requirements: None.

## LayerOption

`MoveObjectBuilder.``LayerOption`

  Returns or sets the layer option

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

  Getter Method

  Signature `LayerOption`

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

  New in version NX6.0.2.

  License requirements: None.

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

  Setter Method

  Signature `LayerOption`

  Parameters: | layerOptionType (`NXOpen.Features.MoveObjectBuilderLayerOptionType`) –

  New in version NX6.0.2.

  License requirements: None.

## MoveObjectResult

`MoveObjectBuilder.``MoveObjectResult`

  Returns or sets the move rotate result

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

  Getter Method

  Signature `MoveObjectResult`

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

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `MoveObjectResult`

  Parameters: | moveObjectResult (`NXOpen.Features.MoveObjectBuilderMoveObjectResultOptions`) –

  New in version NX6.0.0.

  License requirements: None.

## MoveParents

`MoveObjectBuilder.``MoveParents`

  Returns or sets the move parents flag.

  The parents of selected objects will be moved only when Associative flag is false.

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

  Getter Method

  Signature `MoveParents`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `MoveParents`

  Parameters: | moveParents (bool) –

  New in version NX6.0.0.

  License requirements: None.

## NumberOfCopies

`MoveObjectBuilder.``NumberOfCopies`

  Returns or sets the number of copies

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

  Getter Method

  Signature `NumberOfCopies`

  Returns: |
  Return type: | int

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `NumberOfCopies`

  Parameters: | numCopies (int) –

  New in version NX6.0.0.

  License requirements: None.

## ObjectToMoveObject

`MoveObjectBuilder.``ObjectToMoveObject`

  Returns the objects to move-rotate

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

  Getter Method

  Signature `ObjectToMoveObject`

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

  New in version NX6.0.0.

  License requirements: None.

## TransformMotion

`MoveObjectBuilder.``TransformMotion`

  Returns the transform

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

  Getter Method

  Signature `TransformMotion`

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

  New in version NX6.0.0.

  License requirements: None.

# Method Detail

## Validate

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