MovePathBuilder Class¶
-
class
NXOpen.MechanicalRouting.MovePathBuilder¶ Bases:
NXOpen.BuilderRepresents
NXOpen.MechanicalRouting.MovePathBuilder.Allows the user to perform transform of routing objects. If run from a non-interactive session it will return None.
To create a new instance of this class, use
NXOpen.MechanicalRouting.BuilderFactory.CreateMovePathBuilder()Default values.
Property Value Motion.DeltaEnum ReferenceWcsWorkPart Motion.DeltaXc.Value 0.0 Motion.DeltaYc.Value 0.0 Motion.DeltaZc.Value 0.0 New in version NX11.0.0.
Properties¶
| Property | Description |
|---|---|
| DetachType | Returns or sets the detach type setting. |
| MaintainLength | Returns or sets the maintain length setting. |
| Motion | Returns the transformation to apply to the selected routing objects. |
| PathSelection | Returns the objects that make up the path that needs to be transformed. |
| Preview | Returns or sets the preview setting |
| 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. |
| DragObjects | Perform a drag operation. |
| 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. |
| ResetDrag | Reset a drag operation |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| StartDrag | Begin a drag operation. |
| StopDrag | End a drag operation |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
| MovePathBuilderDetachTypes Enumeration | Specifies the options that will allow the user to enforce the transformation by detaching the routing objects (if necessary) from objects that stop the selected object from moving. |
Property Detail¶
DetachType¶
-
MovePathBuilder.DetachType¶ Returns or sets the detach type setting.
Allows the user to specify acceptable detach types for objects that prevent the transformation of the selected objects.
-------------------------------------Getter Method
Signature
DetachTypeReturns: Return type: NXOpen.MechanicalRouting.MovePathBuilderDetachTypesNew in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------Setter Method
Signature
DetachTypeParameters: detachType ( NXOpen.MechanicalRouting.MovePathBuilderDetachTypes) –New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
MaintainLength¶
-
MovePathBuilder.MaintainLength¶ Returns or sets the maintain length setting.
This keeps the length of the selected segments constant through the transform operation. The adjacent segments will be modified and reconnected to the end of the moving segments as required. If this option is turned off, the segments that are moved may extend or trim back to connect to adjacent segments.
-------------------------------------Getter Method
Signature
MaintainLengthReturns: Return type: bool New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------Setter Method
Signature
MaintainLengthParameters: maintainLength (bool) – New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
Motion¶
-
MovePathBuilder.Motion¶ Returns the transformation to apply to the selected routing objects.
-------------------------------------Getter Method
Signature
MotionReturns: Return type: NXOpen.GeometricUtilities.ModlMotionNew in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
PathSelection¶
-
MovePathBuilder.PathSelection¶ Returns the objects that make up the path that needs to be transformed.
The objects can be segments, routing control points and routing components that have properties that make them suitable to be moved by the routing application.
-------------------------------------Getter Method
Signature
PathSelectionReturns: Return type: NXOpen.Routing.RouteObjectCollectorNew in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
Preview¶
-
MovePathBuilder.Preview¶ Returns or sets the preview setting
-------------------------------------Getter Method
Signature
PreviewReturns: Return type: bool New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------Setter Method
Signature
PreviewParameters: preview (bool) – New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
Method Detail¶
DragObjects¶
-
MovePathBuilder.DragObjects¶ Perform a drag operation.
Signature
DragObjects()New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
ResetDrag¶
-
MovePathBuilder.ResetDrag¶ Reset a drag operation
Signature
ResetDrag()New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
StartDrag¶
-
MovePathBuilder.StartDrag¶ Begin a drag operation.
Signature
StartDrag()New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
StopDrag¶
-
MovePathBuilder.StopDrag¶ End a drag operation
Signature
StopDrag()New in version NX11.0.0.
License requirements: routing_base (“Routing Basic”)
Validate¶
-
MovePathBuilder.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.