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

Inheritance diagram for NXOpen::Routing::TransformPathBuilder:

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 builder attribute that is no longer required hence removed

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::CharacteristicList *	GetCopiedAttributes ()
	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::CharacteristicList *	GetOmittedAttributes ()
	Get attributes to be omitted.

NXOpen::Routing::CharacteristicList *	GetOptionalCharacteristics ()
	Deprecated.

NXOpen::Routing::CharacteristicList *	GetRequiredCharacteristics ()
	Deprecated.

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::RouteObjectCollector *	PathSelection ()
	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 attributes to be copied.

void	SetCopyAttributesDefaultOrUserspecified (NXOpen::Routing::TransformPathBuilder::CopyAttributes copyAttributes)
	Sets a builder attribute that is no longer required hence removed

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	SetOmittedAttributes (NXOpen::Routing::CharacteristicList *charxData)
	Set attributes to be omitted.

void	StartDrag ()
	Begin a drag operation.

void	StopDrag ()
	End a drag operation.

NXOpen::GeometricUtilities::ModlMotion *	Transform ()
	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.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

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

enum NXOpen::Routing::TransformPathBuilder::CopyAttributes

Specifies what attributes to copy during Transform Path.

Enumerator:

CopyAttributesDefaults	Copy Attributes as per defaults.
CopyAttributesUserSpecified	Copy Attributes as per user defined.

enum NXOpen::Routing::TransformPathBuilder::TransformOption

Tranform operation to perform.

Enumerator:

TransformOptionMoveOriginal	Move the selected entities.
TransformOptionCopyOriginal	Copy the selected entities.

Member Function Documentation

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")

bool NXOpen::Routing::TransformPathBuilder::CheckForDuplicates ( )

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_base ("Routing Basic")

NXOpen::Routing::TransformPathBuilder::CopyAttributes NXOpen::Routing::TransformPathBuilder::CopyAttributesDefaultOrUserspecified ( )

Returns a builder attribute that is no longer required hence removed

Deprecated:: Deprecated in NX8.5.0.

This builder attribute is no longer required.

Created in NX8.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 @link Routing::TransformPathBuilder::AttachSelectedPath Routing::TransformPathBuilder::AttachSelectedPath@endlink

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")

Parameters

translation	The translation to be applied.
rotation	The rotation to be applied

NXOpen::Routing::CharacteristicList* NXOpen::Routing::TransformPathBuilder::GetCopiedAttributes ( )

Get attributes to be copied.

Returns: Created in NX8.0.0.

License requirements : routing_base ("Routing Basic")

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")

Parameters

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.

Returns: Created in NX8.5.0.

License requirements : routing_base ("Routing Basic")

NXOpen::Routing::CharacteristicList* NXOpen::Routing::TransformPathBuilder::GetOptionalCharacteristics ( )

Deprecated.

as this builder attribute no longer required hence removed

Returns: The characteristics

Deprecated:: Deprecated in NX8.5.0. This builder attribute is no longer required.

Created in NX8.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::Routing::CharacteristicList* NXOpen::Routing::TransformPathBuilder::GetRequiredCharacteristics ( )

Deprecated.

as this builder attribute no longer required hence removed

Returns: The characteristics .

Deprecated:: Deprecated in NX8.5.0. This builder attribute is no longer required.

Created in NX8.0.0.

License requirements : routing_base ("Routing Basic")

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")

Parameters

acrossAssemblies across assemblies

void NXOpen::Routing::TransformPathBuilder::SetCheckForDuplicates ( bool checkForDups )

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_base ("Routing Basic")

Parameters

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")

Parameters

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")

Parameters

charxData charx data

void NXOpen::Routing::TransformPathBuilder::SetCopyAttributesDefaultOrUserspecified ( NXOpen::Routing::TransformPathBuilder::CopyAttributes copyAttributes )

Sets a builder attribute that is no longer required hence removed

Deprecated:: Deprecated in NX8.5.0.

This builder attribute is no longer required.

Created in NX8.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

copyAttributes copyattributes

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")

Parameters

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")

Parameters

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")

Parameters

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")

Parameters

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")

Parameters

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")

Parameters

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")

Parameters

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")

The documentation for this class was generated from the following file:

Routing_TransformPathBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation