QuickPathBuilder Class

class NXOpen.Routing.QuickPathBuilder

Bases: NXOpen.Builder

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

New in version NX6.0.0.

Properties

Property Description
PathErrors Returns the errors associated with this path.
PathSettings Returns the linear path settings for this path.
PointList Returns the list of path points.
RouteSegment Returns the routing segment managed by the builder, if it exists.
StockSettings Returns the stock settings for this path.
Tag Returns the Tag for this object.

Methods

Method Description
Commit Commits any edits that have been applied to the builder.
Destroy Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects For builders that create more than one object, this method returns the objects that are created by commit.
GetObject Returns the object currently being edited by this builder.
SetListOfPointsToDraw Save a point or extension point to the list of all points to draw on the screen.
SetListOfPointsToDrawCount Set the number of elements in the list of all points to draw on the screen.
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

PathErrors

QuickPathBuilder.PathErrors

Returns the errors associated with this path.

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

-------------------------------------

Getter Method

Signature PathErrors

Returns:The list of errors.
Return type:NXOpen.ErrorList

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

PathSettings

QuickPathBuilder.PathSettings

Returns the linear path settings for this path.

-------------------------------------

Getter Method

Signature PathSettings

Returns:
Return type:NXOpen.Routing.LinearPathSettings

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

PointList

QuickPathBuilder.PointList

Returns the list of path points.

-------------------------------------

Getter Method

Signature PointList

Returns:
Return type:NXOpen.PointList

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

RouteSegment

QuickPathBuilder.RouteSegment

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

-------------------------------------

Getter Method

Signature RouteSegment

Returns:Visible Routing BCurve Segment
Return type:NXOpen.Curve

New in version NX6.0.0.

License requirements: routing_base (“Routing Basic”)

StockSettings

QuickPathBuilder.StockSettings

Returns the stock settings for this path.

-------------------------------------

Getter Method

Signature StockSettings

Returns:
Return type:NXOpen.Routing.PathStockBuilder

New in version NX6.0.0.

License requirements: routing_advanced (“Routing Advanced”), routing_base (“Routing Basic”)

Method Detail

SetListOfPointsToDraw

QuickPathBuilder.SetListOfPointsToDraw

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

Signature SetListOfPointsToDraw(index, point)

Parameters:
  • index (int) – The index in the list of points to draw.
  • point (NXOpen.Point3d) – Point representing the position.

New in version NX8.5.3.

License requirements: routing_base (“Routing Basic”)

SetListOfPointsToDrawCount

QuickPathBuilder.SetListOfPointsToDrawCount

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

Signature SetListOfPointsToDrawCount(count)

Parameters:count (int) – The number of points in list.

New in version NX10.0.2.

License requirements: routing_base (“Routing Basic”)

Validate

QuickPathBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful
Return type:bool

New in version NX3.0.1.

License requirements: None.