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

Inheritance diagram for NXOpen.Routing.TransformPathBuilder:

Public Types
enum	CopyAttributes { Defaults, UserSpecified }
	Specifies what attributes to copy during Transform Path More...

enum	TransformOption { MoveOriginal, CopyOriginal }
	Tranform operation to perform. More...

Public Member Functions
unsafe void	AddConnectedPartsInBuilder ()
	Add object in transform object list of builder as per list updated by Routing.TransformPathBuilder.UpdateConnectedPartList More...

unsafe void	AttachSelectedPath ()
	Attaches the selected path back to the path it was originally attached to before the call to Routing.TransformPathBuilder.DetachSelectedPath More...

unsafe void	DestroyAllPreviewObjects ()
	Destroys all preview objects associated with this operation. More...

unsafe void	DetachSelectedPath ()
	Detaches the selected path ends from the connected routing segments. More...

unsafe void	DragByTransform (NXOpen.Vector3d translation, NXOpen.Matrix3x3 rotation)
	Drag the selected objects by the given translation and rotation. More...

unsafe NXOpen.Routing.CharacteristicList	GetCopiedAttributes ()
	Get attributes to be copied. More...

unsafe void	GetIthSetOfObjects (int ith, out NXOpen.NXObject[] objects)
	Gets the set of objects created for the "ith" copy during the commit method. More...

unsafe NXOpen.Routing.CharacteristicList	GetOmittedAttributes ()
	Get attributes to be omitted. More...

unsafe void	RemoveConnectedPartsInBuilder ()
	Remove object from transform object list of builder as per list updated by Routing.TransformPathBuilder.UpdateConnectedPartList More...

unsafe void	SetCollisionObject (NXOpen.NXObject @object)
	Sets collision object during the preview More...

unsafe void	SetCopiedAttributes (NXOpen.Routing.CharacteristicList charxData)
	Set attributes to be copied. More...

unsafe void	SetCopyTransform (NXOpen.Vector3d translation, NXOpen.Matrix3x3 rotation)
	Sets the transform to use for the copy operation. More...

unsafe void	SetOmittedAttributes (NXOpen.Routing.CharacteristicList charxData)
	Set attributes to be omitted. More...

unsafe void	StartDrag ()
	Begin a drag operation. More...

unsafe void	StopDrag ()
	End a drag operation. More...

unsafe void	UpdateConnectedPartList (NXOpen.NXObject[] selectedObject, NXOpen.NXObject[] deselectedObject)
	Update connected part list in builder as per selection or deselection of object More...

unsafe void	UpdateSelObjectsVector ()
	Adds selected objects into vector during selection More...

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

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

unsafe NXOpen.NXObject[]	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

unsafe NXOpen.NXObject	GetObject ()
	Returns the object currently being edited by this builder. More...

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

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

Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

override string	ToString ()
	Returns a String that represents the current Object. More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
unsafe bool	AcrossAssemblies `[get, set]`
	Returns or sets the flag that indicates whether or not to transform. More...

unsafe NXOpen.Routing.RouteObjectCollector	AttributeReferenceSelection `[get]`
	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...

unsafe bool	CheckForDuplicates `[get, set]`
	Returns or sets the flag that indicates whether or not to check for duplicate segments after the copy or transform. More...

unsafe bool	CopyConnectedParts `[get, set]`
	Returns or sets the method indicates whether connected parts get copied or not. More...

unsafe NXOpen.Routing.TransformPathBuilder.TransformOption	MoveOrCopyOption `[get, set]`
	Returns or sets the operation to perform during the commit method. More...

unsafe bool	MoveWithExtensionSegments `[get, set]`
	Returns or sets a message stating whether or not to move the selected segments with extension segments. More...

unsafe int	NumberOfCopies `[get, set]`
	Returns or sets the number of copies to create in the commit method for the option Routing.TransformPathBuilder.TransformOption.CopyOriginal . More...

unsafe NXOpen.Routing.RouteObjectCollector	PathSelection `[get]`
	Returns the path selection. More...

unsafe NXOpen.GeometricUtilities.ModlMotion	Transform `[get]`
	Returns the motion or transform. More...

Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder	PreviewBuilder `[get]`
	Returns the preview builder subobject. More...

Properties inherited from NXOpen.TaggedObject
Tag	Tag `[get]`
	Returns the tag of this object. More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

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

Member Enumeration Documentation

enum NXOpen.Routing.TransformPathBuilder.CopyAttributes

Specifies what attributes to copy during Transform Path

Enumerator
Defaults	Copy Attributes as per defaults.
UserSpecified	Copy Attributes as per user defined.

enum NXOpen.Routing.TransformPathBuilder.TransformOption

Tranform operation to perform.

Enumerator
MoveOriginal	Move the selected entities.
CopyOriginal	Copy the selected entities.

Member Function Documentation

unsafe void NXOpen.Routing.TransformPathBuilder.AddConnectedPartsInBuilder ( )

inline

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

unsafe void NXOpen.Routing.TransformPathBuilder.AttachSelectedPath ( )

inline

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

unsafe void NXOpen.Routing.TransformPathBuilder.DestroyAllPreviewObjects ( )

inline

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

unsafe void NXOpen.Routing.TransformPathBuilder.DetachSelectedPath ( )

inline

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

unsafe void NXOpen.Routing.TransformPathBuilder.DragByTransform	(	NXOpen.Vector3d	translation,
		NXOpen.Matrix3x3	rotation
	)

inline

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

unsafe NXOpen.Routing.CharacteristicList NXOpen.Routing.TransformPathBuilder.GetCopiedAttributes ( )

inline

Get attributes to be copied.

Created in NX8.0.0

License requirements: routing_base ("Routing Basic")

Returns

unsafe void NXOpen.Routing.TransformPathBuilder.GetIthSetOfObjects	(	int	ith,
		out NXOpen.NXObject[]	objects
	)

inline

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.

unsafe NXOpen.Routing.CharacteristicList NXOpen.Routing.TransformPathBuilder.GetOmittedAttributes ( )

inline

Get attributes to be omitted.

Created in NX8.5.0

License requirements: routing_base ("Routing Basic")

Returns

unsafe void NXOpen.Routing.TransformPathBuilder.RemoveConnectedPartsInBuilder ( )

inline

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

unsafe void NXOpen.Routing.TransformPathBuilder.SetCollisionObject ( NXOpen.NXObject @ object )

inline

Sets collision object during the preview

Created in NX8.0.0

License requirements: routing_base ("Routing Basic")

Parameters

object Routing object

unsafe void NXOpen.Routing.TransformPathBuilder.SetCopiedAttributes ( NXOpen.Routing.CharacteristicList charxData )

inline

Set attributes to be copied.

Created in NX8.0.0

License requirements: routing_base ("Routing Basic")

Parameters

charxData

unsafe void NXOpen.Routing.TransformPathBuilder.SetCopyTransform	(	NXOpen.Vector3d	translation,
		NXOpen.Matrix3x3	rotation
	)

inline

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

unsafe void NXOpen.Routing.TransformPathBuilder.SetOmittedAttributes ( NXOpen.Routing.CharacteristicList charxData )

inline

Set attributes to be omitted.

Created in NX8.5.0

License requirements: routing_base ("Routing Basic")

Parameters

charxData

unsafe void NXOpen.Routing.TransformPathBuilder.StartDrag ( )

inline

Begin a drag operation.

Created in NX6.0.0

License requirements: routing_base ("Routing Basic")

unsafe void NXOpen.Routing.TransformPathBuilder.StopDrag ( )

inline

End a drag operation.

Created in NX6.0.0

License requirements: routing_base ("Routing Basic")

unsafe void NXOpen.Routing.TransformPathBuilder.UpdateConnectedPartList	(	NXOpen.NXObject[]	selectedObject,
		NXOpen.NXObject[]	deselectedObject
	)

inline

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

unsafe void NXOpen.Routing.TransformPathBuilder.UpdateSelObjectsVector ( )

inline

Adds selected objects into vector during selection

Created in NX8.0.0

License requirements: routing_base ("Routing Basic")

Property Documentation

unsafe bool NXOpen.Routing.TransformPathBuilder.AcrossAssemblies

getset

Returns or sets the flag that indicates whether or not to transform.

across the assemblies

Created in NX8.0.0

License requirements to get this property: routing_base ("Routing Basic")

License requirements to set this property: routing_base ("Routing Basic")

unsafe NXOpen.Routing.RouteObjectCollector NXOpen.Routing.TransformPathBuilder.AttributeReferenceSelection

get

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

unsafe bool NXOpen.Routing.TransformPathBuilder.CheckForDuplicates

getset

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.

Created in NX6.0.0

License requirements to get this property: routing_base ("Routing Basic")

License requirements to set this property: routing_base ("Routing Basic")

unsafe bool NXOpen.Routing.TransformPathBuilder.CopyConnectedParts

getset

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

Created in NX8.0.0

License requirements to get this property: routing_base ("Routing Basic")

License requirements to set this property: routing_base ("Routing Basic")

unsafe NXOpen.Routing.TransformPathBuilder.TransformOption NXOpen.Routing.TransformPathBuilder.MoveOrCopyOption

getset

Returns or sets the operation to perform during the commit method.

Created in NX6.0.0

License requirements to get this property: routing_base ("Routing Basic")

License requirements to set this property: routing_base ("Routing Basic")

unsafe bool NXOpen.Routing.TransformPathBuilder.MoveWithExtensionSegments

getset

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

Created in NX8.0.0

License requirements to get this property: routing_base ("Routing Basic")

License requirements to set this property: routing_base ("Routing Basic")

unsafe int NXOpen.Routing.TransformPathBuilder.NumberOfCopies

getset

Returns or sets the number of copies to create in the commit method for the option Routing.TransformPathBuilder.TransformOption.CopyOriginal .

Created in NX6.0.0

License requirements to get this property: routing_base ("Routing Basic")

License requirements to set this property: routing_base ("Routing Basic")

unsafe NXOpen.Routing.RouteObjectCollector NXOpen.Routing.TransformPathBuilder.PathSelection

get

Returns the path selection.

Stores the objects to be transformed or copied.

Created in NX6.0.0

License requirements: routing_base ("Routing Basic")

unsafe NXOpen.GeometricUtilities.ModlMotion NXOpen.Routing.TransformPathBuilder.Transform

get

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

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

Routing_TransformPathBuilder.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation