Represents a NXOpen::Routing::HandrailBuilder Creates a handrail from a selected point. More...
Public Types | |
| enum | PostTypes { PostTypesStart, PostTypesIntermediate, PostTypesNone, PostTypesEnd } |
| The post type: Start, Intermediate, None, End. More... | |
Public Member Functions | |
| bool | AutoCloseOption () |
| Returns an option to automatically close the handrail Created in NX8.5.0. More... | |
| bool | HasHorizontalRails () |
| Returns an option to create horizontal rail stock Created in NX8.5.0. More... | |
| void | PlaceHandrail (const NXOpen::Point3d &postLocation) |
| Creates a handrail post, horizontal railings assembly components and places them in the appropriate orientation. More... | |
| NXOpen::Routing::HandrailBuilder::PostTypes | PostType () |
| Returns the type of post: Start, Intermediate, None, End Created in NX8.5.0. More... | |
| void | ReverseLastPost () |
| Reverses the orientation of the last placed post Created in NX8.5.0. More... | |
| void | SetAutoCloseOption (bool autoClose) |
| Sets an option to automatically close the handrail Created in NX8.5.0. More... | |
| void | SetHandrailPartCharx (NXOpen::Routing::CharacteristicList *partCharx) |
| Sets the handrail part characteristics Created in NX8.5.0. More... | |
| void | SetHasHorizontalRails (bool railOption) |
| Sets an option to create horizontal rail stock Created in NX8.5.0. More... | |
| void | SetPostType (NXOpen::Routing::HandrailBuilder::PostTypes postType) |
| Sets the type of post: Start, Intermediate, None, End Created in NX8.5.0. 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 a NXOpen::Routing::HandrailBuilder Creates a handrail from a selected point.
The handrail is created by optionally placing a post depending on the post type followed by placing the rails across the route control points corresponding to the posts.
To create a new instance of this class, use NXOpen::Routing::RouteManager::CreateHandrailBuilder
Created in NX8.5.0.
Member Enumeration Documentation
The post type: Start, Intermediate, None, End.
Start implies closing rails must be closed to the start post. Intermediate implies that the post is neither a start nor an end post but in the middle. None implies the post is intermediate with rails but without a post. End implies the post is the last of the posts.
| Enumerator | |
|---|---|
| PostTypesStart |
start |
| PostTypesIntermediate |
intermediate |
| PostTypesNone |
none |
| PostTypesEnd |
end |
Member Function Documentation
| bool NXOpen::Routing::HandrailBuilder::AutoCloseOption | ( | ) |
Returns an option to automatically close the handrail
Created in NX8.5.0.
License requirements : routing_platform ("Routing Platform")
| bool NXOpen::Routing::HandrailBuilder::HasHorizontalRails | ( | ) |
Returns an option to create horizontal rail stock
Created in NX8.5.0.
License requirements : routing_platform ("Routing Platform")
| void NXOpen::Routing::HandrailBuilder::PlaceHandrail | ( | const NXOpen::Point3d & | postLocation | ) |
Creates a handrail post, horizontal railings assembly components and places them in the appropriate orientation.
Created in NX8.5.0.
License requirements : routing_platform ("Routing Platform")
- Parameters
-
postLocation The point where the handrail is to be placed
| NXOpen::Routing::HandrailBuilder::PostTypes NXOpen::Routing::HandrailBuilder::PostType | ( | ) |
Returns the type of post: Start, Intermediate, None, End
Created in NX8.5.0.
License requirements : routing_platform ("Routing Platform")
| void NXOpen::Routing::HandrailBuilder::ReverseLastPost | ( | ) |
Reverses the orientation of the last placed post
Created in NX8.5.0.
License requirements : routing_platform ("Routing Platform")
| void NXOpen::Routing::HandrailBuilder::SetAutoCloseOption | ( | bool | autoClose | ) |
Sets an option to automatically close the handrail
Created in NX8.5.0.
License requirements : routing_platform ("Routing Platform")
- Parameters
-
autoClose autoclose
| void NXOpen::Routing::HandrailBuilder::SetHandrailPartCharx | ( | NXOpen::Routing::CharacteristicList * | partCharx | ) |
Sets the handrail part characteristics
Created in NX8.5.0.
License requirements : routing_platform ("Routing Platform")
- Parameters
-
partCharx The characteristics to use for the handrail posts
| void NXOpen::Routing::HandrailBuilder::SetHasHorizontalRails | ( | bool | railOption | ) |
Sets an option to create horizontal rail stock
Created in NX8.5.0.
License requirements : routing_platform ("Routing Platform")
- Parameters
-
railOption railoption
| void NXOpen::Routing::HandrailBuilder::SetPostType | ( | NXOpen::Routing::HandrailBuilder::PostTypes | postType | ) |
Sets the type of post: Start, Intermediate, None, End
Created in NX8.5.0.
License requirements : routing_platform ("Routing Platform")
- Parameters
-
postType posttype
The documentation for this class was generated from the following file:
- Routing_HandrailBuilder.hxx