Represents NXOpen::MechanicalRouting::PathTransitionBuilder . More...

Inheritance diagram for NXOpen::MechanicalRouting::PathTransitionBuilder:

Public Types
enum	HealOrientation { HealOrientationWcs, HealOrientationAbsolute, HealOrientationStart, HealOrientationEnd, HealOrientationNewCsys }
	The box orientation for heal transition traversal order. More...

enum	TraversalOrder { TraversalOrderXyz, TraversalOrderXzy, TraversalOrderYzx, TraversalOrderYxz, TraversalOrderZxy, TraversalOrderZyx, TraversalOrderInvalid }
	The heal transition traversal order the path takes to reach the transition end point. More...

enum	Type { TypeDirect, TypeHeal, TypeIntersect }
	The type of transition the path takes to reach the transition end point. More...

Public Member Functions
bool	AddExtensionToggle ()
	Returns the toggle to set forward/backward extensions for this transition. More...

NXOpen::Expression *	BackwardExtension ()
	Returns the backward extension length for this transition. More...

NXOpen::MechanicalRouting::PathTransitionBuilder::HealOrientation	BoxOrientation ()
	Returns the box orientation for heal transition traversal order. More...

NXOpen::NXObject *	ConnectedObject ()
	Returns the object that the end point of this path transition connects to. More...

NXOpen::Point *	EndPoint ()
	Returns the end point that defines the end of the path transition. More...

NXOpen::Direction *	ExtensionVector ()
	Returns the direction for extension segments. More...

NXOpen::Expression *	ForwardExtension ()
	Returns the forward extension length for this transition. More...

NXOpen::CoordinateSystem *	HealSolutionCsys ()
	Returns the user-defined coordinate system for the NXOpen::MechanicalRouting::PathTransitionBuilder::HealOrientationNewCsys heal box orientation. More...

NXOpen::MechanicalRouting::PathTransitionBuilder::TraversalOrder	HealTraversalOrder ()
	Returns the heal transition traversal order the path takes to reach the transition end point. More...

bool	PathForwardThroughExtensionVector ()
	Returns the toggle setting to define whether the path passes forward through the extension vector, or backward. More...

void	SetAddExtensionToggle (bool extensionToggle)
	Sets the toggle to set forward/backward extensions for this transition. More...

void	SetBackwardExtension (NXOpen::Expression *backwardExtension)
	Sets the backward extension length for this transition. More...

void	SetBoxOrientation (NXOpen::MechanicalRouting::PathTransitionBuilder::HealOrientation boxOrientation)
	Sets the box orientation for heal transition traversal order. More...

void	SetConnectedObject (NXOpen::NXObject *connectedObject)
	Sets the object that the end point of this path transition connects to. More...

void	SetEndPoint (NXOpen::Point *endPoint)
	Sets the end point that defines the end of the path transition. More...

void	SetExtensionVector (NXOpen::Direction *extensionVector)
	Sets the direction for extension segments. More...

void	SetForwardExtension (NXOpen::Expression *forwardExtension)
	Sets the forward extension length for this transition. More...

void	SetHealSolutionCsys (NXOpen::CoordinateSystem *coordinateSystem)
	Sets the user-defined coordinate system for the NXOpen::MechanicalRouting::PathTransitionBuilder::HealOrientationNewCsys heal box orientation. More...

void	SetHealTraversalOrder (NXOpen::MechanicalRouting::PathTransitionBuilder::TraversalOrder healTraversalOrder)
	Sets the heal transition traversal order the path takes to reach the transition end point. More...

void	SetPathForwardThroughExtensionVector (bool isPathForwardThroughExtensionVector)
	Sets the toggle setting to define whether the path passes forward through the extension vector, or backward. More...

void	SetTransitionType (NXOpen::MechanicalRouting::PathTransitionBuilder::Type transitionType)
	Sets the type of transition the path takes to reach the transition end point. More...

NXOpen::MechanicalRouting::PathTransitionBuilder::Type	TransitionType ()
	Returns the type of transition the path takes to reach the transition end point. 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...

Detailed Description

Represents NXOpen::MechanicalRouting::PathTransitionBuilder .

Allows the user to create a routing path transition.
To create a new instance of this class, use NXOpen::MechanicalRouting::PathTransitionListManagerBuilder::CreatePathTransitionBuilder

Created in NX11.0.0.

Member Enumeration Documentation

enum NXOpen::MechanicalRouting::PathTransitionBuilder::HealOrientation

The box orientation for heal transition traversal order.

Enumerator
HealOrientationWcs	wcs
HealOrientationAbsolute	absolute
HealOrientationStart	start
HealOrientationEnd	end
HealOrientationNewCsys	new csys

enum NXOpen::MechanicalRouting::PathTransitionBuilder::TraversalOrder

The heal transition traversal order the path takes to reach the transition end point.

Enumerator
TraversalOrderXyz	xyz
TraversalOrderXzy	xzy
TraversalOrderYzx	yzx
TraversalOrderYxz	yxz
TraversalOrderZxy	zxy
TraversalOrderZyx	zyx
TraversalOrderInvalid	invalid

enum NXOpen::MechanicalRouting::PathTransitionBuilder::Type

The type of transition the path takes to reach the transition end point.

Enumerator
TypeDirect	direct
TypeHeal	heal
TypeIntersect	intersect

Member Function Documentation

bool NXOpen::MechanicalRouting::PathTransitionBuilder::AddExtensionToggle ( )

Returns the toggle to set forward/backward extensions for this transition.

Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::Expression* NXOpen::MechanicalRouting::PathTransitionBuilder::BackwardExtension ( )

Returns the backward extension length for this transition.

Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::MechanicalRouting::PathTransitionBuilder::HealOrientation NXOpen::MechanicalRouting::PathTransitionBuilder::BoxOrientation ( )

Returns the box orientation for heal transition traversal order.

Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::NXObject* NXOpen::MechanicalRouting::PathTransitionBuilder::ConnectedObject ( )

Returns the object that the end point of this path transition connects to.

If the transition connects to a port or a routing control point, it is required to set that object as the connected object to build connectivity.
Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::Point* NXOpen::MechanicalRouting::PathTransitionBuilder::EndPoint ( )

Returns the end point that defines the end of the path transition.

Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::Direction* NXOpen::MechanicalRouting::PathTransitionBuilder::ExtensionVector ( )

Returns the direction for extension segments.

Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::Expression* NXOpen::MechanicalRouting::PathTransitionBuilder::ForwardExtension ( )

Returns the forward extension length for this transition.

Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::CoordinateSystem* NXOpen::MechanicalRouting::PathTransitionBuilder::HealSolutionCsys ( )

Returns the user-defined coordinate system for the NXOpen::MechanicalRouting::PathTransitionBuilder::HealOrientationNewCsys heal box orientation.

Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

NXOpen::MechanicalRouting::PathTransitionBuilder::TraversalOrder NXOpen::MechanicalRouting::PathTransitionBuilder::HealTraversalOrder ( )

Returns the heal transition traversal order the path takes to reach the transition end point.

Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

bool NXOpen::MechanicalRouting::PathTransitionBuilder::PathForwardThroughExtensionVector ( )

Returns the toggle setting to define whether the path passes forward through the extension vector, or backward.

Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

void NXOpen::MechanicalRouting::PathTransitionBuilder::SetAddExtensionToggle ( bool extensionToggle )

Sets the toggle to set forward/backward extensions for this transition.

Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

extensionToggle extensiontoggle

void NXOpen::MechanicalRouting::PathTransitionBuilder::SetBackwardExtension ( NXOpen::Expression * backwardExtension )

Sets the backward extension length for this transition.

Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

backwardExtension backwardextension

void NXOpen::MechanicalRouting::PathTransitionBuilder::SetBoxOrientation ( NXOpen::MechanicalRouting::PathTransitionBuilder::HealOrientation boxOrientation )

Sets the box orientation for heal transition traversal order.

Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

boxOrientation boxorientation

void NXOpen::MechanicalRouting::PathTransitionBuilder::SetConnectedObject ( NXOpen::NXObject * connectedObject )

Sets the object that the end point of this path transition connects to.

If the transition connects to a port or a routing control point, it is required to set that object as the connected object to build connectivity.
Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

connectedObject connectedobject

void NXOpen::MechanicalRouting::PathTransitionBuilder::SetEndPoint ( NXOpen::Point * endPoint )

Sets the end point that defines the end of the path transition.

Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

endPoint endpoint

void NXOpen::MechanicalRouting::PathTransitionBuilder::SetExtensionVector ( NXOpen::Direction * extensionVector )

Sets the direction for extension segments.

Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

extensionVector extensionvector

void NXOpen::MechanicalRouting::PathTransitionBuilder::SetForwardExtension ( NXOpen::Expression * forwardExtension )

Sets the forward extension length for this transition.

Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

forwardExtension forwardextension

void NXOpen::MechanicalRouting::PathTransitionBuilder::SetHealSolutionCsys ( NXOpen::CoordinateSystem * coordinateSystem )

Sets the user-defined coordinate system for the NXOpen::MechanicalRouting::PathTransitionBuilder::HealOrientationNewCsys heal box orientation.

Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

coordinateSystem coordinatesystem

void NXOpen::MechanicalRouting::PathTransitionBuilder::SetHealTraversalOrder ( NXOpen::MechanicalRouting::PathTransitionBuilder::TraversalOrder healTraversalOrder )

Sets the heal transition traversal order the path takes to reach the transition end point.

Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

healTraversalOrder healtraversalorder

void NXOpen::MechanicalRouting::PathTransitionBuilder::SetPathForwardThroughExtensionVector ( bool isPathForwardThroughExtensionVector )

Sets the toggle setting to define whether the path passes forward through the extension vector, or backward.

Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

isPathForwardThroughExtensionVector ispathforwardthroughextensionvector

void NXOpen::MechanicalRouting::PathTransitionBuilder::SetTransitionType ( NXOpen::MechanicalRouting::PathTransitionBuilder::Type transitionType )

Sets the type of transition the path takes to reach the transition end point.

Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

transitionType transitiontype

NXOpen::MechanicalRouting::PathTransitionBuilder::Type NXOpen::MechanicalRouting::PathTransitionBuilder::TransitionType ( )

Returns the type of transition the path takes to reach the transition end point.

Created in NX11.0.0.

License requirements : routing_base ("Routing Basic")

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

MechanicalRouting_PathTransitionBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation