Builder for creating a collision free path between points. More...

Inheritance diagram for NXOpen::Routing::QuickPathBuilder:

Public Member Functions
void	AssignExtension (NXOpen::Point *point, const NXOpen::Vector3d &direction, double backValue, double fwdValue)
	Assigns a direction as well as a forward and backward distance to the given point.

NXOpen::Expression *	Clearance ()
	Returns the obstacle clearance value.

int	MaximumNumberOfBends ()
	Returns the maximum number of bends in a path.

NXOpen::Expression *	MinimumStraightLength ()
	Returns the minimum straight length value.

NXOpen::ErrorList *	PathErrors ()
	Returns the errors associated with this path.

NXOpen::Routing::LinearPathSettings *	PathSettings ()
	Returns the linear path settings for this path.

NXOpen::PointList *	PointList ()
	Returns the list of goal path points.

int	Seed ()
	Returns the seed number to use for the random number generator.

void	SetMaximumNumberOfBends (int maximumNumberOfBends)
	Sets the maximum number of bends in a path.

void	SetPathSettings (NXOpen::Routing::LinearPathSettings *pathSettings)
	Sets the linear path settings for this path.

void	SetSeed (int seed)
	Sets the seed number to use for the random number generator.

void	SetStockSettings (NXOpen::Routing::PathStockBuilder *stockBuilder)
	Sets the stock settings for this path.

NXOpen::Routing::PathStockBuilder *	StockSettings ()
	Returns the stock settings for this path.

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 creating a collision free path between points.

    This builder takes a list of points and a stock and builds a 
    collision-free path through those points.  The built path is created
    as linear segments with bend corners (or elbows) depending on
    the settings chosen by the user (@link Routing::LinearPathSettings Routing::LinearPathSettings@endlink )).

    After invoking the commit method, invoke the 
    @link Routing::QuickPathBuilder::PathErrors Routing::QuickPathBuilder::PathErrors@endlink  method to find
    out which sections between points contained errors.  
 <br> To create a new instance of this class, use @link Routing::RouteManager::CreateQuickPathBuilder  Routing::RouteManager::CreateQuickPathBuilder @endlink  <br>

Default values.

Property

Value

Clearance.Value

0.0 (millimeters part), 0.0 (inches part)

MaximumNumberOfBends

10

MinimumStraightLength.Value

0.0 (millimeters part), 0.0 (inches part)

PathSettings.LockToSelectedObject

True

Created in NX6.0.0.

Member Function Documentation

void NXOpen::Routing::QuickPathBuilder::AssignExtension	(	NXOpen::Point *	point,
		const NXOpen::Vector3d &	direction,
		double	backValue,
		double	fwdValue
	)

Assigns a direction as well as a forward and backward distance to the given point.

Quick Path will treat this as a collision-free reserved space and will ensure there is a segment going through the point along the given direction. The forward and backward values define the minimimum starting and ending locations, the path will include those locations but may extend past those locations.

Created in NX6.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

point	point
direction	direction
backValue	back value
fwdValue	fwd value

NXOpen::Expression* NXOpen::Routing::QuickPathBuilder::Clearance ( )

Returns the obstacle clearance value.

This value specifies the desired minimum distance between the path and obstacles in the assembly. This is a soft constraint so it is possible that the returned path will have sections that violate the clearance value.
Created in NX6.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

int NXOpen::Routing::QuickPathBuilder::MaximumNumberOfBends ( )

Returns the maximum number of bends in a path.

This value specifies the desired maximum number of bends. This is a soft constraint so it is possible that the returned path may have more than this number of bends. The number must be >= 0.
Created in NX6.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

NXOpen::Expression* NXOpen::Routing::QuickPathBuilder::MinimumStraightLength ( )

Returns the minimum straight length value.

This value specifies the desired minimum value between bend corner points. This is a soft constraint so it is possible that the returned path will have sections that violate the minimum straight length.
Created in NX6.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

NXOpen::ErrorList* NXOpen::Routing::QuickPathBuilder::PathErrors ( )

Returns the errors associated with this path.

The list will be NULL if the commit method has not been invoked yet.

Created in NX6.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

NXOpen::Routing::LinearPathSettings* NXOpen::Routing::QuickPathBuilder::PathSettings ( )

Returns the linear path settings for this path.

Created in NX6.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

NXOpen::PointList* NXOpen::Routing::QuickPathBuilder::PointList ( )

Returns the list of goal path points.

Created in NX6.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

int NXOpen::Routing::QuickPathBuilder::Seed ( )

Returns the seed number to use for the random number generator.

Quick Path uses the random number generator for finding random sample points in space.
Created in NX6.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

void NXOpen::Routing::QuickPathBuilder::SetMaximumNumberOfBends ( int maximumNumberOfBends )

Sets the maximum number of bends in a path.

This value specifies the desired maximum number of bends. This is a soft constraint so it is possible that the returned path may have more than this number of bends. The number must be >= 0.
Created in NX6.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

maximumNumberOfBends maximum number of bends

void NXOpen::Routing::QuickPathBuilder::SetPathSettings ( NXOpen::Routing::LinearPathSettings * pathSettings )

Sets the linear path settings for this path.

Created in NX6.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

pathSettings path settings

void NXOpen::Routing::QuickPathBuilder::SetSeed ( int seed )

Sets the seed number to use for the random number generator.

Quick Path uses the random number generator for finding random sample points in space.
Created in NX6.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

seed seed

void NXOpen::Routing::QuickPathBuilder::SetStockSettings ( NXOpen::Routing::PathStockBuilder * stockBuilder )

Sets the stock settings for this path.

Created in NX6.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

stockBuilder stock builder

NXOpen::Routing::PathStockBuilder* NXOpen::Routing::QuickPathBuilder::StockSettings ( )

Returns the stock settings for this path.

Created in NX6.0.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

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

Routing_QuickPathBuilder.hxx

Public Member Functions

Detailed Description

Member Function Documentation