NXOpen.Routing.QuickPathBuilder Class Reference

Builder for creating a path between user selected points. More...

Inheritance diagram for NXOpen.Routing.QuickPathBuilder:

Public Member Functions
unsafe void	SetListOfPointsToDraw (int index, NXOpen.Point3d point)
	Save a point or extension point to the list of all points to draw on the screen. More...
unsafe void	SetListOfPointsToDrawCount (int count)
	Set the number of elements in the list of all points to draw on the screen. 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 NXOpen.ErrorList	PathErrors [get]
	Returns the errors associated with this path. More...
unsafe NXOpen.Routing.LinearPathSettings	PathSettings [get]
	Returns the linear path settings for this path. More...
unsafe NXOpen.PointList	PointList [get]
	Returns the list of path points. More...
unsafe NXOpen.Curve	RouteSegment [get]
	Returns the routing segment managed by the builder, if it exists. More...
unsafe NXOpen.Routing.PathStockBuilder	StockSettings [get]
	Returns the stock settings for this path. 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 creating a path between user selected points.

After invoking the commit method, invoke the NXOpen.Routing.QuickPathBuilder.PathErrors method to find out which sections between points contained errors.

To create a new instance of this class, use NXOpen.Routing.RouteManager.CreateQuickPathBuilder

Default values.

Property	Value
PathSettings.LockToSelectedObject	True

Created in NX6.0.0

Member Function Documentation

unsafe void NXOpen.Routing.QuickPathBuilder.SetListOfPointsToDraw ( int  index, NXOpen.Point3d  point  )

inline

Save a point or extension point to the list of all points to draw on the screen.

Created in NX8.5.3

License requirements: routing_base ("Routing Basic")

Parameters

index	The index in the list of points to draw.
point	Point representing the position.

unsafe void NXOpen.Routing.QuickPathBuilder.SetListOfPointsToDrawCount ( int  count )

inline

Set the number of elements in the list of all points to draw on the screen.

Created in NX10.0.2

License requirements: routing_base ("Routing Basic")

Parameters

count

The number of points in list.

Property Documentation

unsafe NXOpen.ErrorList NXOpen.Routing.QuickPathBuilder.PathErrors

get

Returns the errors associated with this path.

The list will be a null reference (Nothing in Visual Basic) if the commit method has not been invoked yet.

Created in NX6.0.0

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

unsafe NXOpen.Routing.LinearPathSettings NXOpen.Routing.QuickPathBuilder.PathSettings

get

Returns the linear path settings for this path.

Created in NX6.0.0

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

unsafe NXOpen.PointList NXOpen.Routing.QuickPathBuilder.PointList

get

Returns the list of path points.

Created in NX6.0.0

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

unsafe NXOpen.Curve NXOpen.Routing.QuickPathBuilder.RouteSegment

get

Returns the routing segment managed by the builder, if it exists.

Created in NX6.0.0

License requirements: routing_base ("Routing Basic")

unsafe NXOpen.Routing.PathStockBuilder NXOpen.Routing.QuickPathBuilder.StockSettings

get

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