CopyCageBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# CopyCageBuilder Class

class `NXOpen.Features.Subdivision.``CopyCageBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Features.Subdivision.CopyCageBuilder` builder.

  To create a new instance of this class, use `NXOpen.Features.Subdivision.SubdivisionBodyCollection.CreateCopyCageBuilder()`

  Default values.

  Property | Value
  --- | ---
  CanRelocateToolToSelection | 1
  CanReorientToolToSelection | 1
  NumberOfCopies | 1

  New in version NX10.0.0.

# Properties

Property | Description
--- | ---
CanMoveToolOnly | Returns or sets the flag indicating if tool can be moved alone without moving selected topology
CanRelocateToolToSelection | Returns or sets the flag indicating if tool should relocate to selection
CanReorientToolToSelection | Returns or sets the flag indicating if tool should reorient to selection
NumberOfCopies | Returns or sets the number of copies
Objects | Returns the objects to be copied
Tag | Returns the Tag for this object.
Transformer | Returns the transformation tool.

# 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.
ResetTransformerToCentroidOfSelection | Repositions the `NXOpen.GeometricUtilities.TransformerData` to the centroid of the selected entities.
SetTransformerToObject | Repositions the `NXOpen.GeometricUtilities.TransformerData` to the specified entity.
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

## CanMoveToolOnly

`CopyCageBuilder.``CanMoveToolOnly`

  Returns or sets the flag indicating if tool can be moved alone without moving selected topology

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

  Getter Method

  Signature `CanMoveToolOnly`

  Returns: |
  Return type: | bool

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `CanMoveToolOnly`

  Parameters: | canMoveToolOnly (bool) –

  New in version NX10.0.0.

  License requirements: nx_subdivision (” NX SUBDIVISION”)

## CanRelocateToolToSelection

`CopyCageBuilder.``CanRelocateToolToSelection`

  Returns or sets the flag indicating if tool should relocate to selection

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

  Getter Method

  Signature `CanRelocateToolToSelection`

  Returns: |
  Return type: | bool

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `CanRelocateToolToSelection`

  Parameters: | canRelocateToolToSelection (bool) –

  New in version NX10.0.0.

  License requirements: nx_subdivision (” NX SUBDIVISION”)

## CanReorientToolToSelection

`CopyCageBuilder.``CanReorientToolToSelection`

  Returns or sets the flag indicating if tool should reorient to selection

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

  Getter Method

  Signature `CanReorientToolToSelection`

  Returns: |
  Return type: | bool

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `CanReorientToolToSelection`

  Parameters: | canReorientToolToSelection (bool) –

  New in version NX10.0.0.

  License requirements: nx_subdivision (” NX SUBDIVISION”)

## NumberOfCopies

`CopyCageBuilder.``NumberOfCopies`

  Returns or sets the number of copies

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

  Getter Method

  Signature `NumberOfCopies`

  Returns: |
  Return type: | int

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `NumberOfCopies`

  Parameters: | numberOfCopies (int) –

  New in version NX10.0.0.

  License requirements: nx_subdivision (” NX SUBDIVISION”)

## Objects

`CopyCageBuilder.``Objects`

  Returns the objects to be copied

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

  Getter Method

  Signature `Objects`

  Returns: |
  Return type: | `NXOpen.Features.Subdivision.SelectCageObjectData`

  New in version NX10.0.0.

  License requirements: None.

## Transformer

`CopyCageBuilder.``Transformer`

  Returns the transformation tool.

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

  Getter Method

  Signature `Transformer`

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

  New in version NX10.0.0.

  License requirements: None.

# Method Detail

## ResetTransformerToCentroidOfSelection

`CopyCageBuilder.``ResetTransformerToCentroidOfSelection`

  Repositions the `NXOpen.GeometricUtilities.TransformerData` to the centroid of the selected entities.

  Signature `ResetTransformerToCentroidOfSelection()`

  New in version NX10.0.0.

  License requirements: nx_subdivision (” NX SUBDIVISION”)

## SetTransformerToObject

`CopyCageBuilder.``SetTransformerToObject`

  Repositions the `NXOpen.GeometricUtilities.TransformerData` to the specified entity.

  Signature `SetTransformerToObject(selectionData)`

  Parameters: | selectionData (`NXOpen.Features.Subdivision.CageManipulatorDataObjectSelectionData_Struct`) –

  New in version NX10.0.0.

  License requirements: nx_subdivision (” NX SUBDIVISION”)

## Validate

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