NX Open C++ Reference Guide
|
Represents a NXOpen::Motion::RoadBuilder
To create a new instance of this class, use NXOpen::Motion::RoadCollection::CreateRoadBuilder
Created in NX11.0.0.
More...
Public Types | |
enum | PathDatatypeChoices { PathDatatypeChoicesSplineCurves, PathDatatypeChoicesSegments, PathDatatypeChoicesFileImport } |
data type attribute of the path data More... | |
enum | SplineDatatypeChoices { SplineDatatypeChoicesFunction, SplineDatatypeChoicesProfile2D } |
data type attribute of the spline data More... | |
enum | SurfaceDatatypeChoices { SurfaceDatatypeChoicesSplineCurve, SurfaceDatatypeChoicesSplineSurface, SurfaceDatatypeChoicesRsm1000, SurfaceDatatypeChoicesRsm1002, SurfaceDatatypeChoicesRsm2000, SurfaceDatatypeChoicesRsm3000, SurfaceDatatypeChoicesOpenCRG, SurfaceDatatypeChoicesRoadDataFile, SurfaceDatatypeChoicesProfile2D } |
data type attribute of the surface data More... | |
enum | TypeChoices { TypeChoicesSurface, TypeChoicesPath } |
type attribute of the road More... | |
Public Member Functions | |
NXOpen::Motion::MotionFunction * | BankAngleCurve () |
Returns the bank angle spline curve for the road object of path type Created in NX11.0.0. More... | |
NXOpen::Motion::SelectFieldData * | BankAngleCurveProfile () |
Returns the bank angle spline curve defined by a profile for the road object of path type Created in NX12.0.0. More... | |
NXOpen::NXColor * | Color () |
Returns the color Created in NX11.0.0. More... | |
NXOpen::Motion::SegmentBuilder * | CreateSegmentBuilder () |
Creates a new segment builder for the road object of type path. More... | |
NXOpen::CoordinateSystem * | Csys () |
Returns the coordinate system of the optional link object Created in NX11.0.0. More... | |
NXOpen::Motion::SegmentBuilder * | GetSegmentBuilder (int segmentBuilderIndex) |
Get a specific segment builder from the list. More... | |
NXOpen::Expression * | GridDensity () |
Returns the grid density Created in NX11.0.0. More... | |
NXOpen::Expression * | Length () |
Returns the length Created in NX11.0.0. More... | |
NXOpen::Motion::SelectLink * | Link () |
Returns the optional link object Created in NX11.0.0. More... | |
NXString | Name () |
Returns the name of the road object selected from motion objects Created in NX11.0.0. More... | |
NXOpen::Motion::RoadBuilder::PathDatatypeChoices | PathDatatype () |
Returns the path datatype of the road object Created in NX11.0.0. More... | |
NXString | PathFileName () |
Returns the path and file name of the path curve Created in NX11.0.0. More... | |
NXOpen::Point * | ReferencePoint () |
Returns the reference point of the optional link object Created in NX11.0.0. More... | |
void | RemoveAllSegmentBuilders () |
Remove a segment Created in NX11.0.0. More... | |
void | RemoveSegmentBuilder (NXOpen::Motion::SegmentBuilder *segment) |
Remove a segment Created in NX11.0.0. More... | |
NXOpen::Motion::Road * | RoadObject () |
Returns the road object selected from motion objects Created in NX11.0.0. More... | |
NXOpen::Motion::RoadBuilder::TypeChoices | RoadType () |
Returns the road type Created in NX11.0.0. More... | |
NXOpen::Motion::SegmentBuilderList * | SegmentBuilderList () |
Returns the segment builder list for the road object of type path Created in NX11.0.0. More... | |
void | SetBankAngleCurve (NXOpen::Motion::MotionFunction *spline) |
Sets the bank angle spline curve for the road object of path type Created in NX11.0.0. More... | |
void | SetColor (NXOpen::NXColor *color) |
Sets the color Created in NX11.0.0. More... | |
void | SetCsys (NXOpen::CoordinateSystem *csys) |
Sets the coordinate system of the optional link object Created in NX11.0.0. More... | |
void | SetName (const NXString &name) |
Sets the name of the road object selected from motion objects Created in NX11.0.0. More... | |
void | SetName (const char *name) |
Sets the name of the road object selected from motion objects Created in NX11.0.0. More... | |
void | SetPathDatatype (NXOpen::Motion::RoadBuilder::PathDatatypeChoices pathdatatype) |
Sets the path datatype of the road object Created in NX11.0.0. More... | |
void | SetPathFileName (const NXString &filename) |
Sets the path and file name of the path curve Created in NX11.0.0. More... | |
void | SetPathFileName (const char *filename) |
Sets the path and file name of the path curve Created in NX11.0.0. More... | |
void | SetReferencePoint (NXOpen::Point *referencePoint) |
Sets the reference point of the optional link object Created in NX11.0.0. More... | |
void | SetRoadObject (NXOpen::Motion::Road *roadobject) |
Sets the road object selected from motion objects Created in NX11.0.0. More... | |
void | SetRoadType (NXOpen::Motion::RoadBuilder::TypeChoices roadtype) |
Sets the road type Created in NX11.0.0. More... | |
void | SetShowVisualization (bool showVisualization) |
Sets the show visualization Created in NX11.0.0. More... | |
void | SetSplineCurve (NXOpen::Motion::MotionFunction *spline) |
Sets the spline curve of the road object of surface type Created in NX11.0.0. More... | |
void | SetSplineType (NXOpen::Motion::RoadBuilder::SplineDatatypeChoices splineType) |
Sets the spline type Created in NX12.0.0. More... | |
void | SetSurfaceDatatype (NXOpen::Motion::RoadBuilder::SurfaceDatatypeChoices surfacedatatype) |
Sets the surface datatype of the road object Created in NX11.0.0. More... | |
void | SetSurfaceFileName (const NXString &filename) |
Sets the path and file name of the surface curve Created in NX11.0.0. More... | |
void | SetSurfaceFileName (const char *filename) |
Sets the path and file name of the surface curve Created in NX11.0.0. More... | |
void | SetXCurve (NXOpen::Motion::MotionFunction *spline) |
Sets the x spline curve for the road object of path type Created in NX11.0.0. More... | |
void | SetYCurve (NXOpen::Motion::MotionFunction *spline) |
Sets the y spline curve for the road object of path type Created in NX11.0.0. More... | |
void | SetZCurve (NXOpen::Motion::MotionFunction *spline) |
Sets the z spline curve for the road object of path type Created in NX11.0.0. More... | |
bool | ShowVisualization () |
Returns the show visualization Created in NX11.0.0. More... | |
NXOpen::Motion::MotionFunction * | SplineCurve () |
Returns the spline curve of the road object of surface type Created in NX11.0.0. More... | |
NXOpen::Motion::SelectFieldData * | SplineCurveProfile () |
Returns the spline profile of the road object of surface type Created in NX12.0.0. More... | |
NXOpen::Motion::RoadBuilder::SplineDatatypeChoices | SplineType () |
Returns the spline type Created in NX12.0.0. More... | |
NXOpen::Motion::RoadBuilder::SurfaceDatatypeChoices | SurfaceDatatype () |
Returns the surface datatype of the road object Created in NX11.0.0. More... | |
NXString | SurfaceFileName () |
Returns the path and file name of the surface curve Created in NX11.0.0. More... | |
NXOpen::Motion::SelectFieldData * | SurfaceProfile () |
Returns the path and file name of the surface curve Created in NX12.0.0. More... | |
void | SwapSegment (NXOpen::Motion::SegmentBuilder *firstSegment, NXOpen::Motion::SegmentBuilder *secondSegment) |
Swap two segments Created in NX11.0.0. More... | |
NXOpen::Expression * | Width () |
Returns the width Created in NX11.0.0. More... | |
NXOpen::Motion::MotionFunction * | XCurve () |
Returns the x spline curve for the road object of path type Created in NX11.0.0. More... | |
NXOpen::Motion::SelectFieldData * | XCurveProfile () |
Returns the x spline curve defined by a profile for the road object of path type Created in NX12.0.0. More... | |
NXOpen::Expression * | XSegmentOriginCoord () |
Returns the x origin coord for the segments for the road object of type path Created in NX11.0.0. More... | |
NXOpen::Motion::MotionFunction * | YCurve () |
Returns the y spline curve for the road object of path type Created in NX11.0.0. More... | |
NXOpen::Motion::SelectFieldData * | YCurveProfile () |
Returns the y spline curve defined by a profile for the road object of path type Created in NX12.0.0. More... | |
NXOpen::Expression * | YSegmentOriginCoord () |
Returns the y origin coord for the segments for the road object of type path Created in NX11.0.0. More... | |
NXOpen::Motion::MotionFunction * | ZCurve () |
Returns the z spline curve for the road object of path type Created in NX11.0.0. More... | |
NXOpen::Motion::SelectFieldData * | ZCurveProfile () |
Returns the z spline curve defined by a profile for the road object of path type Created in NX12.0.0. More... | |
NXOpen::Expression * | ZSegmentOriginCoord () |
Returns the z origin coord for the segments for the road object of type path Created in NX11.0.0. More... | |
Public Member Functions inherited from NXOpen::Motion::MotionBuilder | |
double | DisplayScale () |
Returns the icon display scale Created in NX5.0.0. More... | |
NXString | GroupName () |
Returns the group name Created in NX5.0.0. More... | |
NXOpen::Motion::MotionObject::GroupType | GroupType () |
Returns the group type Created in NX5.0.0. More... | |
void | SetDisplayScale (double displayScale) |
Sets the icon display scale Created in NX5.0.0. More... | |
void | SetGroupName (const NXString &groupName) |
Sets the group name Created in NX5.0.0. More... | |
void | SetGroupName (const char *groupName) |
Sets the group name Created in NX5.0.0. More... | |
void | SetGroupType (NXOpen::Motion::MotionObject::GroupType groupType) |
Sets the group type Created in NX5.0.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... | |
Represents a NXOpen::Motion::RoadBuilder
To create a new instance of this class, use NXOpen::Motion::RoadCollection::CreateRoadBuilder
Created in NX11.0.0.
data type attribute of the surface data
NXOpen::Motion::MotionFunction* NXOpen::Motion::RoadBuilder::BankAngleCurve | ( | ) |
Returns the bank angle spline curve for the road object of path type
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
NXOpen::Motion::SelectFieldData* NXOpen::Motion::RoadBuilder::BankAngleCurveProfile | ( | ) |
Returns the bank angle spline curve defined by a profile for the road object of path type
Created in NX12.0.0.
License requirements : mechanisms ("MECHANISMS")
NXOpen::NXColor* NXOpen::Motion::RoadBuilder::Color | ( | ) |
Returns the color
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
NXOpen::Motion::SegmentBuilder* NXOpen::Motion::RoadBuilder::CreateSegmentBuilder | ( | ) |
Creates a new segment builder for the road object of type path.
NXOpen::CoordinateSystem* NXOpen::Motion::RoadBuilder::Csys | ( | ) |
Returns the coordinate system of the optional link object
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
NXOpen::Motion::SegmentBuilder* NXOpen::Motion::RoadBuilder::GetSegmentBuilder | ( | int | segmentBuilderIndex | ) |
Get a specific segment builder from the list.
segmentBuilderIndex | segmentbuilderindex |
NXOpen::Expression* NXOpen::Motion::RoadBuilder::GridDensity | ( | ) |
Returns the grid density
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
NXOpen::Expression* NXOpen::Motion::RoadBuilder::Length | ( | ) |
Returns the length
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
NXOpen::Motion::SelectLink* NXOpen::Motion::RoadBuilder::Link | ( | ) |
Returns the optional link object
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
NXString NXOpen::Motion::RoadBuilder::Name | ( | ) |
Returns the name of the road object selected from motion objects
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
NXOpen::Motion::RoadBuilder::PathDatatypeChoices NXOpen::Motion::RoadBuilder::PathDatatype | ( | ) |
Returns the path datatype of the road object
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
NXString NXOpen::Motion::RoadBuilder::PathFileName | ( | ) |
Returns the path and file name of the path curve
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
NXOpen::Point* NXOpen::Motion::RoadBuilder::ReferencePoint | ( | ) |
Returns the reference point of the optional link object
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
void NXOpen::Motion::RoadBuilder::RemoveAllSegmentBuilders | ( | ) |
Remove a segment
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
void NXOpen::Motion::RoadBuilder::RemoveSegmentBuilder | ( | NXOpen::Motion::SegmentBuilder * | segment | ) |
Remove a segment
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
segment | segment |
NXOpen::Motion::Road* NXOpen::Motion::RoadBuilder::RoadObject | ( | ) |
Returns the road object selected from motion objects
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
NXOpen::Motion::RoadBuilder::TypeChoices NXOpen::Motion::RoadBuilder::RoadType | ( | ) |
Returns the road type
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
NXOpen::Motion::SegmentBuilderList* NXOpen::Motion::RoadBuilder::SegmentBuilderList | ( | ) |
Returns the segment builder list for the road object of type path
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
void NXOpen::Motion::RoadBuilder::SetBankAngleCurve | ( | NXOpen::Motion::MotionFunction * | spline | ) |
Sets the bank angle spline curve for the road object of path type
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
spline | spline |
void NXOpen::Motion::RoadBuilder::SetColor | ( | NXOpen::NXColor * | color | ) |
Sets the color
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
color | color |
void NXOpen::Motion::RoadBuilder::SetCsys | ( | NXOpen::CoordinateSystem * | csys | ) |
Sets the coordinate system of the optional link object
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
csys | csys |
void NXOpen::Motion::RoadBuilder::SetName | ( | const NXString & | name | ) |
Sets the name of the road object selected from motion objects
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
name | name |
void NXOpen::Motion::RoadBuilder::SetName | ( | const char * | name | ) |
Sets the name of the road object selected from motion objects
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
name | name |
void NXOpen::Motion::RoadBuilder::SetPathDatatype | ( | NXOpen::Motion::RoadBuilder::PathDatatypeChoices | pathdatatype | ) |
Sets the path datatype of the road object
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
pathdatatype | pathdatatype |
void NXOpen::Motion::RoadBuilder::SetPathFileName | ( | const NXString & | filename | ) |
Sets the path and file name of the path curve
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
filename | filename |
void NXOpen::Motion::RoadBuilder::SetPathFileName | ( | const char * | filename | ) |
Sets the path and file name of the path curve
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
filename | filename |
void NXOpen::Motion::RoadBuilder::SetReferencePoint | ( | NXOpen::Point * | referencePoint | ) |
Sets the reference point of the optional link object
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
referencePoint | referencepoint |
void NXOpen::Motion::RoadBuilder::SetRoadObject | ( | NXOpen::Motion::Road * | roadobject | ) |
Sets the road object selected from motion objects
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
roadobject | roadobject |
void NXOpen::Motion::RoadBuilder::SetRoadType | ( | NXOpen::Motion::RoadBuilder::TypeChoices | roadtype | ) |
Sets the road type
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
roadtype | roadtype |
void NXOpen::Motion::RoadBuilder::SetShowVisualization | ( | bool | showVisualization | ) |
Sets the show visualization
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
showVisualization | showvisualization |
void NXOpen::Motion::RoadBuilder::SetSplineCurve | ( | NXOpen::Motion::MotionFunction * | spline | ) |
Sets the spline curve of the road object of surface type
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
spline | spline |
void NXOpen::Motion::RoadBuilder::SetSplineType | ( | NXOpen::Motion::RoadBuilder::SplineDatatypeChoices | splineType | ) |
Sets the spline type
Created in NX12.0.0.
License requirements : mechanisms ("MECHANISMS")
splineType | splinetype |
void NXOpen::Motion::RoadBuilder::SetSurfaceDatatype | ( | NXOpen::Motion::RoadBuilder::SurfaceDatatypeChoices | surfacedatatype | ) |
Sets the surface datatype of the road object
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
surfacedatatype | surfacedatatype |
void NXOpen::Motion::RoadBuilder::SetSurfaceFileName | ( | const NXString & | filename | ) |
Sets the path and file name of the surface curve
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
filename | filename |
void NXOpen::Motion::RoadBuilder::SetSurfaceFileName | ( | const char * | filename | ) |
Sets the path and file name of the surface curve
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
filename | filename |
void NXOpen::Motion::RoadBuilder::SetXCurve | ( | NXOpen::Motion::MotionFunction * | spline | ) |
Sets the x spline curve for the road object of path type
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
spline | spline |
void NXOpen::Motion::RoadBuilder::SetYCurve | ( | NXOpen::Motion::MotionFunction * | spline | ) |
Sets the y spline curve for the road object of path type
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
spline | spline |
void NXOpen::Motion::RoadBuilder::SetZCurve | ( | NXOpen::Motion::MotionFunction * | spline | ) |
Sets the z spline curve for the road object of path type
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
spline | spline |
bool NXOpen::Motion::RoadBuilder::ShowVisualization | ( | ) |
Returns the show visualization
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
NXOpen::Motion::MotionFunction* NXOpen::Motion::RoadBuilder::SplineCurve | ( | ) |
Returns the spline curve of the road object of surface type
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
NXOpen::Motion::SelectFieldData* NXOpen::Motion::RoadBuilder::SplineCurveProfile | ( | ) |
Returns the spline profile of the road object of surface type
Created in NX12.0.0.
License requirements : mechanisms ("MECHANISMS")
NXOpen::Motion::RoadBuilder::SplineDatatypeChoices NXOpen::Motion::RoadBuilder::SplineType | ( | ) |
Returns the spline type
Created in NX12.0.0.
License requirements : mechanisms ("MECHANISMS")
NXOpen::Motion::RoadBuilder::SurfaceDatatypeChoices NXOpen::Motion::RoadBuilder::SurfaceDatatype | ( | ) |
Returns the surface datatype of the road object
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
NXString NXOpen::Motion::RoadBuilder::SurfaceFileName | ( | ) |
Returns the path and file name of the surface curve
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
NXOpen::Motion::SelectFieldData* NXOpen::Motion::RoadBuilder::SurfaceProfile | ( | ) |
Returns the path and file name of the surface curve
Created in NX12.0.0.
License requirements : mechanisms ("MECHANISMS")
void NXOpen::Motion::RoadBuilder::SwapSegment | ( | NXOpen::Motion::SegmentBuilder * | firstSegment, |
NXOpen::Motion::SegmentBuilder * | secondSegment | ||
) |
Swap two segments
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
firstSegment | firstsegment |
secondSegment | secondsegment |
NXOpen::Expression* NXOpen::Motion::RoadBuilder::Width | ( | ) |
Returns the width
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
NXOpen::Motion::MotionFunction* NXOpen::Motion::RoadBuilder::XCurve | ( | ) |
Returns the x spline curve for the road object of path type
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
NXOpen::Motion::SelectFieldData* NXOpen::Motion::RoadBuilder::XCurveProfile | ( | ) |
Returns the x spline curve defined by a profile for the road object of path type
Created in NX12.0.0.
License requirements : mechanisms ("MECHANISMS")
NXOpen::Expression* NXOpen::Motion::RoadBuilder::XSegmentOriginCoord | ( | ) |
Returns the x origin coord for the segments for the road object of type path
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
NXOpen::Motion::MotionFunction* NXOpen::Motion::RoadBuilder::YCurve | ( | ) |
Returns the y spline curve for the road object of path type
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
NXOpen::Motion::SelectFieldData* NXOpen::Motion::RoadBuilder::YCurveProfile | ( | ) |
Returns the y spline curve defined by a profile for the road object of path type
Created in NX12.0.0.
License requirements : mechanisms ("MECHANISMS")
NXOpen::Expression* NXOpen::Motion::RoadBuilder::YSegmentOriginCoord | ( | ) |
Returns the y origin coord for the segments for the road object of type path
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
NXOpen::Motion::MotionFunction* NXOpen::Motion::RoadBuilder::ZCurve | ( | ) |
Returns the z spline curve for the road object of path type
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
NXOpen::Motion::SelectFieldData* NXOpen::Motion::RoadBuilder::ZCurveProfile | ( | ) |
Returns the z spline curve defined by a profile for the road object of path type
Created in NX12.0.0.
License requirements : mechanisms ("MECHANISMS")
NXOpen::Expression* NXOpen::Motion::RoadBuilder::ZSegmentOriginCoord | ( | ) |
Returns the z origin coord for the segments for the road object of type path
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")