Builder for creating a path between user selected points. More...
Public Member Functions | |
| NXOpen::ErrorList * | PathErrors () |
| Returns the errors associated with this path. More... | |
| NXOpen::Routing::LinearPathSettings * | PathSettings () |
| Returns the linear path settings for this path. More... | |
| NXOpen::PointList * | PointList () |
| Returns the list of path points. More... | |
| NXOpen::Curve * | RouteSegment () |
| Returns the routing segment managed by the builder, if it exists. More... | |
| void | SetListOfPointsToDraw (int index, const NXOpen::Point3d &point) |
| Save a point or extension point to the list of all points to draw on the screen. More... | |
| void | SetListOfPointsToDrawCount (int count) |
| Set the number of elements in the list of all points to draw on the screen. More... | |
| NXOpen::Routing::PathStockBuilder * | StockSettings () |
| Returns the stock settings for this path. 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
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
| 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 path points.
Created in NX6.0.0.
License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
| NXOpen::Curve* NXOpen::Routing::QuickPathBuilder::RouteSegment | ( | ) |
Returns the routing segment managed by the builder, if it exists.
Created in NX6.0.0.
License requirements : routing_base ("Routing Basic")
| void NXOpen::Routing::QuickPathBuilder::SetListOfPointsToDraw | ( | int | index, |
| const NXOpen::Point3d & | point | ||
| ) |
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.
| void NXOpen::Routing::QuickPathBuilder::SetListOfPointsToDrawCount | ( | int | count | ) |
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.
| 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