CopyCageBuilder Class¶
-
class
NXOpen.Features.Subdivision.CopyCageBuilder¶ Bases:
NXOpen.BuilderRepresents a
NXOpen.Features.Subdivision.CopyCageBuilderbuilder.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
CanMoveToolOnlyReturns: Return type: bool New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CanMoveToolOnlyParameters: 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
CanRelocateToolToSelectionReturns: Return type: bool New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CanRelocateToolToSelectionParameters: 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
CanReorientToolToSelectionReturns: Return type: bool New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CanReorientToolToSelectionParameters: 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
NumberOfCopiesReturns: Return type: int New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
NumberOfCopiesParameters: 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
ObjectsReturns: Return type: NXOpen.Features.Subdivision.SelectCageObjectDataNew in version NX10.0.0.
License requirements: None.
Transformer¶
-
CopyCageBuilder.Transformer¶ Returns the transformation tool.
-------------------------------------Getter Method
Signature
TransformerReturns: Return type: NXOpen.GeometricUtilities.TransformerDataNew in version NX10.0.0.
License requirements: None.
Method Detail¶
ResetTransformerToCentroidOfSelection¶
-
CopyCageBuilder.ResetTransformerToCentroidOfSelection¶ Repositions the
NXOpen.GeometricUtilities.TransformerDatato 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.TransformerDatato 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.