CageManipulatorData Class¶
-
class
NXOpen.Features.Subdivision.
CageManipulatorData
¶ Bases:
NXOpen.Features.Subdivision.SelectCageObjectData
Subdivision cage manipulation tool.
New in version NX9.0.0.
Properties¶
Property | Description |
---|---|
CanDeselectObjectsAutomatically | Returns or sets the flag indicating if previously selected objects can be de-selected during selection of new objects. |
SelectionList | Returns the object list. |
Tag | Returns the Tag for this object. |
Transformer | Returns the transformation tool. |
Methods¶
Method | Description |
---|---|
ClearAndAdd | Clears the currently present objects and adds new objects. |
EndMove | Releases the data prepared at the beginning of the move. |
Move | Moves the objects by dragging. |
PrepareToMove | Prepares data to move the objects. |
ResetTransformerToCentroidOfSelection | Repositions the NXOpen.GeometricUtilities.TransformerData to the centroid of the selected entities. |
SetCursorLocation | Sets the cursor location in absolute coordinates. |
SetTransformerToObject | Repositions the NXOpen.GeometricUtilities.TransformerData to the specified entity. |
SetViewDirection | Sets the view direction. |
StepMove | Moves the objects by step value. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Structs¶
CageManipulatorDataObjectMoveData_Struct Struct | Contains object movement information. |
CageManipulatorDataObjectSelectionData_Struct Struct | Contains object selection information. |
Property Detail¶
Transformer¶
-
CageManipulatorData.
Transformer
¶ Returns the transformation tool.
-------------------------------------
Getter Method
Signature
Transformer()
Returns: Return type: NXOpen.GeometricUtilities.TransformerData
New in version NX9.0.0.
License requirements: None.
Method Detail¶
EndMove¶
-
CageManipulatorData.
EndMove
¶ Releases the data prepared at the beginning of the move.
Signature
EndMove()
New in version NX9.0.0.
License requirements: nx_subdivision (” NX SUBDIVISION”)
Move¶
-
CageManipulatorData.
Move
¶ Overloaded method Move
Move(moveToPoint, isSnapGesture)
Move(moveToPoint, point, isSnapGesture)
-------------------------------------
Moves the objects by dragging.
Signature
Move(moveToPoint, isSnapGesture)
Parameters: - moveToPoint (
NXOpen.Point3d
) – - isSnapGesture (bool) – Are we processing a snap gesture.
New in version NX9.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Features.Subdivision.CageManipulatorData.Move()
with optional constraint point instead.License requirements: nx_subdivision (” NX SUBDIVISION”)
-------------------------------------
Moves the objects by dragging. A constraint point can be assigned when moving a vertex.
Signature
Move(moveToPoint, point, isSnapGesture)
Parameters: - moveToPoint (
NXOpen.Point3d
) – - point (
NXOpen.Point
) – Optional constraint point - isSnapGesture (bool) – Are we processing a snap gesture.
New in version NX10.0.0.
License requirements: nx_subdivision (” NX SUBDIVISION”)
-------------------------------------
PrepareToMove¶
-
CageManipulatorData.
PrepareToMove
¶ Prepares data to move the objects.
Signature
PrepareToMove(moveData)
Parameters: moveData ( NXOpen.Features.Subdivision.CageManipulatorDataObjectMoveData_Struct
) –New in version NX9.0.0.
License requirements: nx_subdivision (” NX SUBDIVISION”)
ResetTransformerToCentroidOfSelection¶
-
CageManipulatorData.
ResetTransformerToCentroidOfSelection
¶ Repositions the
NXOpen.GeometricUtilities.TransformerData
to the centroid of the selected entities.Signature
ResetTransformerToCentroidOfSelection()
New in version NX9.0.0.
License requirements: nx_subdivision (” NX SUBDIVISION”)
SetTransformerToObject¶
-
CageManipulatorData.
SetTransformerToObject
¶ Repositions the
NXOpen.GeometricUtilities.TransformerData
to the specified entity.Signature
SetTransformerToObject(selectionData)
Parameters: selectionData ( NXOpen.Features.Subdivision.CageManipulatorDataObjectSelectionData_Struct
) –New in version NX9.0.0.
License requirements: nx_subdivision (” NX SUBDIVISION”)
StepMove¶
-
CageManipulatorData.
StepMove
¶ Moves the objects by step value.
Signature
StepMove(step)
Parameters: step (float) – New in version NX9.0.0.
License requirements: nx_subdivision (” NX SUBDIVISION”)
Validate¶
-
CageManipulatorData.
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.