TransformPathBuilder Class¶
-
class
NXOpen.Routing.
TransformPathBuilder
¶ Bases:
NXOpen.Builder
Builder for the “Transform Path” operation.
Allows the user to perform either a “Transform” or “Copy” of Routing objects.
To create a new instance of this class, use
NXOpen.Routing.RouteManager.CreateTransformPathBuilder()
Default values.
Property Value Transform.DeltaEnum ReferenceWcsWorkPart Transform.DeltaXc.Value 0.0 Transform.DeltaYc.Value 0.0 Transform.DeltaZc.Value 0.0 New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
AcrossAssemblies | Returns or sets the flag that indicates whether or not to transform. |
AttributeReferenceSelection | Returns the selection which is used to choose the object from which source object attributes should be copied when copying attributes during a Transform Path operation. |
CheckForDuplicates | Returns or sets the flag that indicates whether or not to check for duplicate segments after the copy or transform. |
CopyAttributesDefaultOrUserspecified | Returns or sets a builder attribute that is no longer required hence removed |
CopyConnectedParts | Returns or sets the method indicates whether connected parts get copied or not. |
MoveOrCopyOption | Returns or sets the operation to perform during the commit method. |
MoveWithExtensionSegments | Returns or sets a message stating whether or not to move the selected segments with extension segments. |
NumberOfCopies | Returns or sets the number of copies to create in the commit method for the option Routing.TransformPathBuilderTransformOption.CopyOriginal . |
PathSelection | Returns the path selection. |
Tag | Returns the Tag for this object. |
Transform | Returns the motion or transform. |
Methods¶
Method | Description |
---|---|
AddConnectedPartsInBuilder | Add object in transform object list of builder as per list updated by Routing.TransformPathBuilder.UpdateConnectedPartList() |
AttachSelectedPath | Attaches the selected path back to the path it was originally attached to before the call to Routing.TransformPathBuilder.DetachSelectedPath() |
Commit | Commits any edits that have been applied to the builder. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
DestroyAllPreviewObjects | Destroys all preview objects associated with this operation. |
DetachSelectedPath | Detaches the selected path ends from the connected routing segments. |
DragByTransform | Drag the selected objects by the given translation and rotation. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetCopiedAttributes | Get attributes to be copied. |
GetIthSetOfObjects | Gets the set of objects created for the ith copy during the commit method. |
GetObject | Returns the object currently being edited by this builder. |
GetOmittedAttributes | Get attributes to be omitted. |
RemoveConnectedPartsInBuilder | Remove object from transform object list of builder as per list updated by Routing.TransformPathBuilder.UpdateConnectedPartList() |
SetCollisionObject | Sets collision object during the preview |
SetCopiedAttributes | Set attributes to be copied. |
SetCopyTransform | Sets the transform to use for the copy operation. |
SetOmittedAttributes | Set attributes to be omitted. |
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. |
UpdateConnectedPartList | Update connected part list in builder as per selection or deselection of object |
UpdateSelObjectsVector | Adds selected objects into vector during selection |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
TransformPathBuilderCopyAttributes Enumeration | Specifies what attributes to copy during Transform Path |
TransformPathBuilderTransformOption Enumeration | Tranform operation to perform. |
Property Detail¶
AcrossAssemblies¶
-
TransformPathBuilder.
AcrossAssemblies
¶ Returns or sets the flag that indicates whether or not to transform.
across the assemblies
-------------------------------------
Getter Method
Signature
AcrossAssemblies()
Returns: Return type: bool New in version NX8.0.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
AcrossAssemblies(acrossAssemblies)
Parameters: acrossAssemblies (bool) – New in version NX8.0.0.
License requirements: routing_base (“Routing Basic”)
AttributeReferenceSelection¶
-
TransformPathBuilder.
AttributeReferenceSelection
¶ Returns the selection which is used to choose the object from which source object attributes should be copied when copying attributes during a Transform Path operation.
-------------------------------------
Getter Method
Signature
AttributeReferenceSelection()
Returns: Return type: NXOpen.Routing.RouteObjectCollector
New in version NX10.0.0.
License requirements: routing_base (“Routing Basic”)
CheckForDuplicates¶
-
TransformPathBuilder.
CheckForDuplicates
¶ Returns or sets the flag that indicates whether or not to check for duplicate segments after the copy or transform.
It applies only to segments and not to control points.
-------------------------------------
Getter Method
Signature
CheckForDuplicates()
Returns: Return type: bool New in version NX6.0.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
CheckForDuplicates(checkForDups)
Parameters: checkForDups (bool) – New in version NX6.0.0.
License requirements: routing_base (“Routing Basic”)
CopyAttributesDefaultOrUserspecified¶
-
TransformPathBuilder.
CopyAttributesDefaultOrUserspecified
¶ Returns or sets a builder attribute that is no longer required hence removed
-------------------------------------
Getter Method
Signature
CopyAttributesDefaultOrUserspecified()
Returns: Return type: NXOpen.Routing.TransformPathBuilderCopyAttributes
New in version NX8.0.0.
Deprecated since version NX8.5.0: This builder attribute is no longer required.
License requirements: routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
CopyAttributesDefaultOrUserspecified(copyAttributes)
Parameters: copyAttributes ( NXOpen.Routing.TransformPathBuilderCopyAttributes
) –New in version NX8.0.0.
Deprecated since version NX8.5.0: This builder attribute is no longer required.
License requirements: routing_base (“Routing Basic”)
CopyConnectedParts¶
-
TransformPathBuilder.
CopyConnectedParts
¶ Returns or sets the method indicates whether connected parts get copied or not.
-------------------------------------
Getter Method
Signature
CopyConnectedParts()
Returns: Return type: bool New in version NX8.0.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
CopyConnectedParts(copyConnectedParts)
Parameters: copyConnectedParts (bool) – New in version NX8.0.0.
License requirements: routing_base (“Routing Basic”)
MoveOrCopyOption¶
-
TransformPathBuilder.
MoveOrCopyOption
¶ Returns or sets the operation to perform during the commit method.
-------------------------------------
Getter Method
Signature
MoveOrCopyOption()
Returns: Return type: NXOpen.Routing.TransformPathBuilderTransformOption
New in version NX6.0.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
MoveOrCopyOption(moveOption)
Parameters: moveOption ( NXOpen.Routing.TransformPathBuilderTransformOption
) –New in version NX6.0.0.
License requirements: routing_base (“Routing Basic”)
MoveWithExtensionSegments¶
-
TransformPathBuilder.
MoveWithExtensionSegments
¶ Returns or sets a message stating whether or not to move the selected segments with extension segments.
-------------------------------------
Getter Method
Signature
MoveWithExtensionSegments()
Returns: Return type: bool New in version NX8.0.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
MoveWithExtensionSegments(moveWithExtSeg)
Parameters: moveWithExtSeg (bool) – New in version NX8.0.0.
License requirements: routing_base (“Routing Basic”)
NumberOfCopies¶
-
TransformPathBuilder.
NumberOfCopies
¶ Returns or sets the number of copies to create in the commit method for the option
Routing.TransformPathBuilderTransformOption.CopyOriginal
.-------------------------------------
Getter Method
Signature
NumberOfCopies()
Returns: Return type: int New in version NX6.0.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------
Setter Method
Signature
NumberOfCopies(numberOfCopies)
Parameters: numberOfCopies (int) – New in version NX6.0.0.
License requirements: routing_base (“Routing Basic”)
PathSelection¶
-
TransformPathBuilder.
PathSelection
¶ Returns the path selection.
Stores the objects to be transformed or copied.
-------------------------------------
Getter Method
Signature
PathSelection()
Returns: Return type: NXOpen.Routing.RouteObjectCollector
New in version NX6.0.0.
License requirements: routing_base (“Routing Basic”)
Transform¶
-
TransformPathBuilder.
Transform
¶ Returns the motion or transform.
The transformation to apply to the selected or copied objects.
-------------------------------------
Getter Method
Signature
Transform()
Returns: Return type: NXOpen.GeometricUtilities.ModlMotion
New in version NX6.0.0.
License requirements: routing_base (“Routing Basic”)
Method Detail¶
AddConnectedPartsInBuilder¶
-
TransformPathBuilder.
AddConnectedPartsInBuilder
¶ Add object in transform object list of builder as per list updated by
Routing.TransformPathBuilder.UpdateConnectedPartList()
Signature
AddConnectedPartsInBuilder()
New in version NX8.0.0.
License requirements: routing_base (“Routing Basic”)
AttachSelectedPath¶
-
TransformPathBuilder.
AttachSelectedPath
¶ Attaches the selected path back to the path it was originally attached to before the call to
Routing.TransformPathBuilder.DetachSelectedPath()
Signature
AttachSelectedPath()
New in version NX8.0.0.
License requirements: routing_base (“Routing Basic”)
DestroyAllPreviewObjects¶
-
TransformPathBuilder.
DestroyAllPreviewObjects
¶ Destroys all preview objects associated with this operation.
Caller must call update to complete the deletion of the preview objects.
Signature
DestroyAllPreviewObjects()
New in version NX6.0.0.
License requirements: routing_base (“Routing Basic”)
DetachSelectedPath¶
-
TransformPathBuilder.
DetachSelectedPath
¶ Detaches the selected path ends from the connected routing segments.
The detached path can be attached back to the previously connected routing segments by using
Routing.TransformPathBuilder.AttachSelectedPath()
Signature
DetachSelectedPath()
New in version NX8.0.0.
License requirements: routing_base (“Routing Basic”)
DragByTransform¶
-
TransformPathBuilder.
DragByTransform
¶ Drag the selected objects by the given translation and rotation.
Only call after invoking the
Routing.TransformPathBuilder.StartDrag()
method. After finished dragging, callRouting.TransformPathBuilder.StopDrag()
.Signature
DragByTransform(translation, rotation)
Parameters: - translation (
NXOpen.Vector3d
) – The translation to be applied. - rotation (
NXOpen.Matrix3x3
) – The rotation to be applied
New in version NX6.0.0.
License requirements: routing_base (“Routing Basic”)
- translation (
GetCopiedAttributes¶
-
TransformPathBuilder.
GetCopiedAttributes
¶ Get attributes to be copied.
Signature
GetCopiedAttributes()
Returns: Return type: NXOpen.Routing.CharacteristicList
New in version NX8.0.0.
License requirements: routing_base (“Routing Basic”)
GetIthSetOfObjects¶
-
TransformPathBuilder.
GetIthSetOfObjects
¶ Gets the set of objects created for the “ith” copy during the commit method.
The 0th element is the original set of objects to copy.
Signature
GetIthSetOfObjects(ith)
Parameters: ith (int) – Which set of copy objects to retrieve, must be in the range 0 to the number of copies minus 1. Returns: Copied objects. Return type: list of NXOpen.NXObject
New in version NX6.0.0.
License requirements: routing_base (“Routing Basic”)
GetOmittedAttributes¶
-
TransformPathBuilder.
GetOmittedAttributes
¶ Get attributes to be omitted.
Signature
GetOmittedAttributes()
Returns: Return type: NXOpen.Routing.CharacteristicList
New in version NX8.5.0.
License requirements: routing_base (“Routing Basic”)
RemoveConnectedPartsInBuilder¶
-
TransformPathBuilder.
RemoveConnectedPartsInBuilder
¶ Remove object from transform object list of builder as per list updated by
Routing.TransformPathBuilder.UpdateConnectedPartList()
Signature
RemoveConnectedPartsInBuilder()
New in version NX8.0.0.
License requirements: routing_base (“Routing Basic”)
SetCollisionObject¶
-
TransformPathBuilder.
SetCollisionObject
¶ Sets collision object during the preview
Signature
SetCollisionObject(object)
Parameters: object ( NXOpen.NXObject
) – Routing objectNew in version NX8.0.0.
License requirements: routing_base (“Routing Basic”)
SetCopiedAttributes¶
-
TransformPathBuilder.
SetCopiedAttributes
¶ Set attributes to be copied.
Signature
SetCopiedAttributes(charxData)
Parameters: charxData ( NXOpen.Routing.CharacteristicList
) –New in version NX8.0.0.
License requirements: routing_base (“Routing Basic”)
SetCopyTransform¶
-
TransformPathBuilder.
SetCopyTransform
¶ Sets the transform to use for the copy operation.
Signature
SetCopyTransform(translation, rotation)
Parameters: - translation (
NXOpen.Vector3d
) – The translation to be applied. - rotation (
NXOpen.Matrix3x3
) – The rotation to be applied
New in version NX6.0.0.
License requirements: routing_base (“Routing Basic”)
- translation (
SetOmittedAttributes¶
-
TransformPathBuilder.
SetOmittedAttributes
¶ Set attributes to be omitted.
Signature
SetOmittedAttributes(charxData)
Parameters: charxData ( NXOpen.Routing.CharacteristicList
) –New in version NX8.5.0.
License requirements: routing_base (“Routing Basic”)
StartDrag¶
-
TransformPathBuilder.
StartDrag
¶ Begin a drag operation.
Signature
StartDrag()
New in version NX6.0.0.
License requirements: routing_base (“Routing Basic”)
StopDrag¶
-
TransformPathBuilder.
StopDrag
¶ End a drag operation.
Signature
StopDrag()
New in version NX6.0.0.
License requirements: routing_base (“Routing Basic”)
UpdateConnectedPartList¶
-
TransformPathBuilder.
UpdateConnectedPartList
¶ Update connected part list in builder as per selection or deselection of object
Signature
UpdateConnectedPartList(selectedObject, deselectedObject)
Parameters: - selectedObject (list of
NXOpen.NXObject
) – Routing objects (segments, control points, components, etc.) to transform - deselectedObject (list of
NXOpen.NXObject
) – Routing objects (segments, control points, components, etc.) to transform
New in version NX8.0.0.
License requirements: routing_base (“Routing Basic”)
- selectedObject (list of
UpdateSelObjectsVector¶
-
TransformPathBuilder.
UpdateSelObjectsVector
¶ Adds selected objects into vector during selection
Signature
UpdateSelObjectsVector()
New in version NX8.0.0.
License requirements: routing_base (“Routing Basic”)
Validate¶
-
TransformPathBuilder.
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.