NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Routing::TransformPathBuilder Class Reference

Builder for the "Transform Path" operation. More...

Inheritance diagram for NXOpen::Routing::TransformPathBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

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.
void AddConnectedPartsInBuilder ()
 Add object in transform object list of builder as per list updated by Routing::TransformPathBuilder::UpdateConnectedPartList
Created in NX8.0.0.
void AttachSelectedPath ()
 Attaches the selected path back to the path it was originally attached to before the call to Routing::TransformPathBuilder::DetachSelectedPath.
bool CheckForDuplicates ()
 Returns the flag that indicates whether or not to check for duplicate objects after the copy or transform.
NXOpen::Routing::TransformPathBuilder::CopyAttributes CopyAttributesDefaultOrUserspecified ()
 Returns a enum indicating what attributes to copy during Transform Path
Created in NX8.0.0.
bool CopyConnectedParts ()
 Returns the method indicates whether connected parts get copied or not.
void DestroyAllPreviewObjects ()
 Destroys all preview objects associated with this operation.
void DetachSelectedPath ()
 Detaches the selected path ends from the connected routing segments.
void DragByTransform (const NXOpen::Vector3d &translation, const NXOpen::Matrix3x3 &rotation)
 Drag the selected objects by the given translation and rotation.
NXOpen::Routing::CharacteristicListGetCopiedAttributes ()
 Get attributes to be copied.
void GetIthSetOfObjects (int ith, std::vector< NXOpen::NXObject * > &objects)
 Gets the set of objects created for the "ith" copy during the commit method.
NXOpen::Routing::CharacteristicListGetOptionalCharacteristics ()
 Returns the Routing::CharacteristicList that contains optional characteristics common to all the selected objects.
NXOpen::Routing::CharacteristicListGetRequiredCharacteristics ()
 Returns the Routing::CharacteristicList that contains required characteristics common to all the selected objects.
NXOpen::Routing::TransformPathBuilder::TransformOption MoveOrCopyOption ()
 Returns the operation to perform during the commit method.
bool MoveWithExtensionSegments ()
 Returns a message stating whether or not to move the selected segments with extension segments.
int NumberOfCopies ()
 Returns the number of copies to create in the commit method for the option Routing::TransformPathBuilder::TransformOptionCopyOriginal .
NXOpen::Routing::RouteObjectCollectorPathSelection ()
 Returns the path selection.
void RemoveConnectedPartsInBuilder ()
 Remove object from transform object list of builder as per list updated by Routing::TransformPathBuilder::UpdateConnectedPartList
Created in NX8.0.0.
void SetAcrossAssemblies (bool acrossAssemblies)
 Sets the flag that indicates whether or not to transform.
void SetCheckForDuplicates (bool checkForDups)
 Sets the flag that indicates whether or not to check for duplicate objects after the copy or transform.
void SetCollisionObject (NXOpen::NXObject *object)
 Sets collision object during the preview
Created in NX8.0.0.
void SetCopiedAttributes (NXOpen::Routing::CharacteristicList *charxData)
 Set ttributes to be copied.
void SetCopyAttributesDefaultOrUserspecified (NXOpen::Routing::TransformPathBuilder::CopyAttributes copyAttributes)
 Sets a enum indicating what attributes to copy during Transform Path
Created in NX8.0.0.
void SetCopyConnectedParts (bool copyConnectedParts)
 Sets the method indicates whether connected parts get copied or not.
void SetCopyTransform (const NXOpen::Vector3d &translation, const NXOpen::Matrix3x3 &rotation)
 Sets the transform to use for the copy operation.
void SetMoveOrCopyOption (NXOpen::Routing::TransformPathBuilder::TransformOption moveOption)
 Sets the operation to perform during the commit method.
void SetMoveWithExtensionSegments (bool moveWithExtSeg)
 Sets a message stating whether or not to move the selected segments with extension segments.
void SetNumberOfCopies (int numberOfCopies)
 Sets the number of copies to create in the commit method for the option Routing::TransformPathBuilder::TransformOptionCopyOriginal .
void StartDrag ()
 Begin a drag operation.
void StopDrag ()
 End a drag operation.
NXOpen::GeometricUtilities::ModlMotionTransform ()
 Returns the motion or transform.
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.
void UpdateSelObjectsVector ()
 Adds selected objects into vector during selection
Created in NX8.0.0.

Detailed Description

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 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.


Member Enumeration Documentation

Specifies what attributes to copy during Transform Path.

Enumerator:
CopyAttributesDefaults 

Copy Attributes as per defaults.

CopyAttributesUserSpecified 

Copy Attributes as per user defined.

Tranform operation to perform.

Enumerator:
TransformOptionMoveOriginal 

Move the selected entities.

TransformOptionCopyOriginal 

Copy the selected entities.


Member Function Documentation

Returns the flag that indicates whether or not to transform.

across the assemblies
Created in NX8.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Add object in transform object list of builder as per list updated by Routing::TransformPathBuilder::UpdateConnectedPartList
Created in NX8.0.0.



License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")

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_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")

Returns the flag that indicates whether or not to check for duplicate objects after the copy or transform.


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns a enum indicating what attributes to copy during Transform Path
Created in NX8.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the method indicates whether connected parts get copied or not.


Created in NX8.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")

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_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")

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_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")

Parameters:
translationThe translation to be applied.
rotationThe rotation to be applied

Get attributes to be copied.

Returns:

Created in NX8.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
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_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")

Parameters:
ithWhich set of copy objects to retrieve, must be in the range 0 to the number of copies minus 1.
objectsCopied objects.

Returns the Routing::CharacteristicList that contains optional characteristics common to all the selected objects.

Returns:
The characteristics
Created in NX8.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the Routing::CharacteristicList that contains required characteristics common to all the selected objects.

Returns:
The characteristics .
Created in NX8.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the operation to perform during the commit method.


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns a message stating whether or not to move the selected segments with extension segments.


Created in NX8.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the path selection.

Stores the objects to be transformed or copied.
Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Remove object from transform object list of builder as per list updated by Routing::TransformPathBuilder::UpdateConnectedPartList
Created in NX8.0.0.



License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")

Sets the flag that indicates whether or not to transform.

across the assemblies
Created in NX8.0.0.

License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")

Parameters:
acrossAssembliesacross assemblies

Sets the flag that indicates whether or not to check for duplicate objects after the copy or transform.


Created in NX6.0.0.

License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")

Parameters:
checkForDupscheck for dups

Sets collision object during the preview
Created in NX8.0.0.



License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")

Parameters:
objectRouting object

Set ttributes to be copied.


Created in NX8.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
charxDatacharx data

Sets a enum indicating what attributes to copy during Transform Path
Created in NX8.0.0.



License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")

Parameters:
copyAttributescopyattributes

Sets the method indicates whether connected parts get copied or not.


Created in NX8.0.0.

License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")

Parameters:
copyConnectedPartscopy connected parts

Sets the transform to use for the copy operation.


Created in NX6.0.0.

License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")

Parameters:
translationThe translation to be applied.
rotationThe rotation to be applied

Sets the operation to perform during the commit method.


Created in NX6.0.0.

License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")

Parameters:
moveOptionmove option

Sets a message stating whether or not to move the selected segments with extension segments.


Created in NX8.0.0.

License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")

Parameters:
moveWithExtSegmove with ext seg

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_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")

Parameters:
numberOfCopiesnumber of copies

Begin a drag operation.


Created in NX6.0.0.

License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")

End a drag operation.


Created in NX6.0.0.

License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")

Returns the motion or transform.

The transformation to apply to the selected or copied objects.
Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
selectedObjectRouting objects (segments, control points, components, etc.) to transform
deselectedObjectRouting objects (segments, control points, components, etc.) to transform

Adds selected objects into vector during selection
Created in NX8.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.