NX Open C++ Reference Guide
|
Builder for the "Transform Path" operation. More...
Public Types | |
enum | CopyAttributes { CopyAttributesDefaults, CopyAttributesUserSpecified } |
Specifies what attributes to copy during Transform Path. More... | |
enum | TransformOption { TransformOptionMoveOriginal, TransformOptionCopyOriginal } |
Tranform operation to perform. More... | |
Public Member Functions | |
bool | AcrossAssemblies () |
Returns the flag that indicates whether or not to transform. More... | |
void | AddConnectedPartsInBuilder () |
Add object in transform object list of builder as per list updated by Routing::TransformPathBuilder::UpdateConnectedPartList Created in NX8.0.0. More... | |
void | AttachSelectedPath () |
Attaches the selected path back to the path it was originally attached to before the call to Routing::TransformPathBuilder::DetachSelectedPath. More... | |
NXOpen::Routing::RouteObjectCollector * | 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. More... | |
bool | CheckForDuplicates () |
Returns the flag that indicates whether or not to check for duplicate segments after the copy or transform. More... | |
bool | CopyConnectedParts () |
Returns the method indicates whether connected parts get copied or not. More... | |
void | DestroyAllPreviewObjects () |
Destroys all preview objects associated with this operation. More... | |
void | DetachSelectedPath () |
Detaches the selected path ends from the connected routing segments. More... | |
void | DragByTransform (const NXOpen::Vector3d &translation, const NXOpen::Matrix3x3 &rotation) |
Drag the selected objects by the given translation and rotation. More... | |
NXOpen::Routing::CharacteristicList * | GetCopiedAttributes () |
Get attributes to be copied. More... | |
void | GetIthSetOfObjects (int ith, std::vector< NXOpen::NXObject * > &objects) |
Gets the set of objects created for the "ith" copy during the commit method. More... | |
NXOpen::Routing::CharacteristicList * | GetOmittedAttributes () |
Get attributes to be omitted. More... | |
NXOpen::Routing::TransformPathBuilder::TransformOption | MoveOrCopyOption () |
Returns the operation to perform during the commit method. More... | |
bool | MoveWithExtensionSegments () |
Returns a message stating whether or not to move the selected segments with extension segments. More... | |
int | NumberOfCopies () |
Returns the number of copies to create in the commit method for the option Routing::TransformPathBuilder::TransformOptionCopyOriginal . More... | |
NXOpen::Routing::RouteObjectCollector * | PathSelection () |
Returns the path selection. More... | |
void | RemoveConnectedPartsInBuilder () |
Remove object from transform object list of builder as per list updated by Routing::TransformPathBuilder::UpdateConnectedPartList Created in NX8.0.0. More... | |
void | SetAcrossAssemblies (bool acrossAssemblies) |
Sets the flag that indicates whether or not to transform. More... | |
void | SetCheckForDuplicates (bool checkForDups) |
Sets the flag that indicates whether or not to check for duplicate segments after the copy or transform. More... | |
void | SetCollisionObject (NXOpen::NXObject *object) |
Sets collision object during the preview Created in NX8.0.0. More... | |
void | SetCopiedAttributes (NXOpen::Routing::CharacteristicList *charxData) |
Set attributes to be copied. More... | |
void | SetCopyConnectedParts (bool copyConnectedParts) |
Sets the method indicates whether connected parts get copied or not. More... | |
void | SetCopyTransform (const NXOpen::Vector3d &translation, const NXOpen::Matrix3x3 &rotation) |
Sets the transform to use for the copy operation. More... | |
void | SetMoveOrCopyOption (NXOpen::Routing::TransformPathBuilder::TransformOption moveOption) |
Sets the operation to perform during the commit method. More... | |
void | SetMoveWithExtensionSegments (bool moveWithExtSeg) |
Sets a message stating whether or not to move the selected segments with extension segments. More... | |
void | SetNumberOfCopies (int numberOfCopies) |
Sets the number of copies to create in the commit method for the option Routing::TransformPathBuilder::TransformOptionCopyOriginal . More... | |
void | SetOmittedAttributes (NXOpen::Routing::CharacteristicList *charxData) |
Set attributes to be omitted. More... | |
void | StartDrag () |
Begin a drag operation. More... | |
void | StopDrag () |
End a drag operation. More... | |
NXOpen::GeometricUtilities::ModlMotion * | Transform () |
Returns the motion or transform. More... | |
void | UpdateConnectedPartList (const std::vector< NXOpen::NXObject * > &selectedObject, const std::vector< NXOpen::NXObject * > &deselectedObject) |
Update connected part list in builder as per selection or deselection of object Created in NX8.0.0. More... | |
void | UpdateSelObjectsVector () |
Adds selected objects into vector during selection Created in NX8.0.0. More... | |
Public Member Functions inherited from NXOpen::Builder | |
NXOpen::NXObject * | Commit () |
Commits any edits that have been applied to the builder. More... | |
void | Destroy () |
Deletes the builder, and cleans up any objects created by the builder. More... | |
std::vector< NXOpen::NXObject * > | GetCommittedObjects () |
For builders that create more than one object, this method returns the objects that are created by commit. More... | |
NXOpen::NXObject * | GetObject () |
Returns the object currently being edited by this builder. More... | |
void | ShowResults () |
Updates the model to reflect the result of an edit to the model for all builders that support showing results. More... | |
virtual bool | Validate () |
Validate whether the inputs to the component are sufficient for commit to be called. More... | |
Public Member Functions inherited from NXOpen::TaggedObject | |
tag_t | Tag () const |
Returns the tag of this object. More... | |
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 |
Created in NX6.0.0.
bool NXOpen::Routing::TransformPathBuilder::AcrossAssemblies | ( | ) |
Returns the flag that indicates whether or not to transform.
across the assemblies
Created in NX8.0.0.
License requirements : routing_base ("Routing Basic")
void NXOpen::Routing::TransformPathBuilder::AddConnectedPartsInBuilder | ( | ) |
Add object in transform object list of builder as per list updated by Routing::TransformPathBuilder::UpdateConnectedPartList
Created in NX8.0.0.
License requirements : routing_base ("Routing Basic")
void NXOpen::Routing::TransformPathBuilder::AttachSelectedPath | ( | ) |
Attaches the selected path back to the path it was originally attached to before the call to Routing::TransformPathBuilder::DetachSelectedPath.
Created in NX8.0.0.
License requirements : routing_base ("Routing Basic")
NXOpen::Routing::RouteObjectCollector* NXOpen::Routing::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.
Created in NX10.0.0.
License requirements : routing_base ("Routing Basic")
bool NXOpen::Routing::TransformPathBuilder::CheckForDuplicates | ( | ) |
Returns 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.
Created in NX6.0.0.
License requirements : routing_base ("Routing Basic")
bool NXOpen::Routing::TransformPathBuilder::CopyConnectedParts | ( | ) |
Returns the method indicates whether connected parts get copied or not.
Created in NX8.0.0.
License requirements : routing_base ("Routing Basic")
void NXOpen::Routing::TransformPathBuilder::DestroyAllPreviewObjects | ( | ) |
Destroys all preview objects associated with this operation.
Caller must call update to complete the deletion of the preview objects.
Created in NX6.0.0.
License requirements : routing_base ("Routing Basic")
void NXOpen::Routing::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
Created in NX8.0.0.
License requirements : routing_base ("Routing Basic")
void NXOpen::Routing::TransformPathBuilder::DragByTransform | ( | const NXOpen::Vector3d & | translation, |
const NXOpen::Matrix3x3 & | rotation | ||
) |
Drag the selected objects by the given translation and rotation.
Only call after invoking the Routing::TransformPathBuilder::StartDrag method. After finished dragging, call Routing::TransformPathBuilder::StopDrag .
Created in NX6.0.0.
License requirements : routing_base ("Routing Basic")
translation | The translation to be applied. |
rotation | The rotation to be applied |
NXOpen::Routing::CharacteristicList* NXOpen::Routing::TransformPathBuilder::GetCopiedAttributes | ( | ) |
Get attributes to be copied.
void NXOpen::Routing::TransformPathBuilder::GetIthSetOfObjects | ( | int | ith, |
std::vector< NXOpen::NXObject * > & | objects | ||
) |
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.
Created in NX6.0.0.
License requirements : routing_base ("Routing Basic")
ith | Which set of copy objects to retrieve, must be in the range 0 to the number of copies minus 1. |
objects | Copied objects. |
NXOpen::Routing::CharacteristicList* NXOpen::Routing::TransformPathBuilder::GetOmittedAttributes | ( | ) |
Get attributes to be omitted.
NXOpen::Routing::TransformPathBuilder::TransformOption NXOpen::Routing::TransformPathBuilder::MoveOrCopyOption | ( | ) |
Returns the operation to perform during the commit method.
Created in NX6.0.0.
License requirements : routing_base ("Routing Basic")
bool NXOpen::Routing::TransformPathBuilder::MoveWithExtensionSegments | ( | ) |
Returns a message stating whether or not to move the selected segments with extension segments.
Created in NX8.0.0.
License requirements : routing_base ("Routing Basic")
int NXOpen::Routing::TransformPathBuilder::NumberOfCopies | ( | ) |
Returns the number of copies to create in the commit method for the option Routing::TransformPathBuilder::TransformOptionCopyOriginal .
Created in NX6.0.0.
License requirements : routing_base ("Routing Basic")
NXOpen::Routing::RouteObjectCollector* NXOpen::Routing::TransformPathBuilder::PathSelection | ( | ) |
Returns the path selection.
Stores the objects to be transformed or copied.
Created in NX6.0.0.
License requirements : routing_base ("Routing Basic")
void NXOpen::Routing::TransformPathBuilder::RemoveConnectedPartsInBuilder | ( | ) |
Remove object from transform object list of builder as per list updated by Routing::TransformPathBuilder::UpdateConnectedPartList
Created in NX8.0.0.
License requirements : routing_base ("Routing Basic")
void NXOpen::Routing::TransformPathBuilder::SetAcrossAssemblies | ( | bool | acrossAssemblies | ) |
Sets the flag that indicates whether or not to transform.
across the assemblies
Created in NX8.0.0.
License requirements : routing_base ("Routing Basic")
acrossAssemblies | across assemblies |
void NXOpen::Routing::TransformPathBuilder::SetCheckForDuplicates | ( | bool | checkForDups | ) |
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.
Created in NX6.0.0.
License requirements : routing_base ("Routing Basic")
checkForDups | check for dups |
void NXOpen::Routing::TransformPathBuilder::SetCollisionObject | ( | NXOpen::NXObject * | object | ) |
Sets collision object during the preview
Created in NX8.0.0.
License requirements : routing_base ("Routing Basic")
object | Routing object |
void NXOpen::Routing::TransformPathBuilder::SetCopiedAttributes | ( | NXOpen::Routing::CharacteristicList * | charxData | ) |
Set attributes to be copied.
Created in NX8.0.0.
License requirements : routing_base ("Routing Basic")
charxData | charx data |
void NXOpen::Routing::TransformPathBuilder::SetCopyConnectedParts | ( | bool | copyConnectedParts | ) |
Sets the method indicates whether connected parts get copied or not.
Created in NX8.0.0.
License requirements : routing_base ("Routing Basic")
copyConnectedParts | copy connected parts |
void NXOpen::Routing::TransformPathBuilder::SetCopyTransform | ( | const NXOpen::Vector3d & | translation, |
const NXOpen::Matrix3x3 & | rotation | ||
) |
Sets the transform to use for the copy operation.
Created in NX6.0.0.
License requirements : routing_base ("Routing Basic")
translation | The translation to be applied. |
rotation | The rotation to be applied |
void NXOpen::Routing::TransformPathBuilder::SetMoveOrCopyOption | ( | NXOpen::Routing::TransformPathBuilder::TransformOption | moveOption | ) |
Sets the operation to perform during the commit method.
Created in NX6.0.0.
License requirements : routing_base ("Routing Basic")
moveOption | move option |
void NXOpen::Routing::TransformPathBuilder::SetMoveWithExtensionSegments | ( | bool | moveWithExtSeg | ) |
Sets a message stating whether or not to move the selected segments with extension segments.
Created in NX8.0.0.
License requirements : routing_base ("Routing Basic")
moveWithExtSeg | move with ext seg |
void NXOpen::Routing::TransformPathBuilder::SetNumberOfCopies | ( | int | numberOfCopies | ) |
Sets the number of copies to create in the commit method for the option Routing::TransformPathBuilder::TransformOptionCopyOriginal .
Created in NX6.0.0.
License requirements : routing_base ("Routing Basic")
numberOfCopies | number of copies |
void NXOpen::Routing::TransformPathBuilder::SetOmittedAttributes | ( | NXOpen::Routing::CharacteristicList * | charxData | ) |
Set attributes to be omitted.
Created in NX8.5.0.
License requirements : routing_base ("Routing Basic")
charxData | charx data |
void NXOpen::Routing::TransformPathBuilder::StartDrag | ( | ) |
Begin a drag operation.
Created in NX6.0.0.
License requirements : routing_base ("Routing Basic")
void NXOpen::Routing::TransformPathBuilder::StopDrag | ( | ) |
End a drag operation.
Created in NX6.0.0.
License requirements : routing_base ("Routing Basic")
NXOpen::GeometricUtilities::ModlMotion* NXOpen::Routing::TransformPathBuilder::Transform | ( | ) |
Returns the motion or transform.
The transformation to apply to the selected or copied objects.
Created in NX6.0.0.
License requirements : routing_base ("Routing Basic")
void NXOpen::Routing::TransformPathBuilder::UpdateConnectedPartList | ( | const std::vector< NXOpen::NXObject * > & | selectedObject, |
const std::vector< NXOpen::NXObject * > & | deselectedObject | ||
) |
Update connected part list in builder as per selection or deselection of object
Created in NX8.0.0.
License requirements : routing_base ("Routing Basic")
selectedObject | Routing objects (segments, control points, components, etc.) to transform |
deselectedObject | Routing objects (segments, control points, components, etc.) to transform |
void NXOpen::Routing::TransformPathBuilder::UpdateSelObjectsVector | ( | ) |
Adds selected objects into vector during selection
Created in NX8.0.0.
License requirements : routing_base ("Routing Basic")