RoadBuilder Class¶
-
class
NXOpen.Motion.RoadBuilder¶ Bases:
NXOpen.Motion.MotionBuilderRepresents a
NXOpen.Motion.RoadBuilderTo create a new instance of this class, use
NXOpen.Motion.RoadCollection.CreateRoadBuilder()New in version NX11.0.0.
Properties¶
| Property | Description |
|---|---|
| BankAngleCurve | Returns or sets the bank angle spline curve for the road object of path type |
| Csys | Returns or sets the coordinate system of the optional link object |
| DisplayScale | Returns or sets the icon display scale |
| GroupName | Returns or sets the group name |
| GroupType | Returns or sets the group type |
| Link | Returns the optional link object |
| Name | Returns or sets the name of the road object selected from motion objects |
| PathDatatype | Returns or sets the path datatype of the road object |
| PathFileName | Returns or sets the path and file name of the path curve |
| ReferencePoint | Returns or sets the reference point of the optional link object |
| RoadObject | Returns or sets the road object selected from motion objects |
| RoadType | Returns or sets the road type |
| SegmentBuilderList | Returns the segment builder list for the road object of type path |
| SplineCurve | Returns or sets the spline curve of the road object of surface type |
| SurfaceDatatype | Returns or sets the surface datatype of the road object |
| SurfaceFileName | Returns or sets the path and file name of the surface curve |
| Tag | Returns the Tag for this object. |
| XCurve | Returns or sets the x spline curve for the road object of path type |
| XSegmentOriginCoord | Returns the x origin coord for the segments for the road object of type path |
| YCurve | Returns or sets the y spline curve for the road object of path type |
| YSegmentOriginCoord | Returns the y origin coord for the segments for the road object of type path |
| ZCurve | Returns or sets the z spline curve for the road object of path type |
| ZSegmentOriginCoord | Returns the z origin coord for the segments for the road object of type path |
Methods¶
| Method | Description |
|---|---|
| Commit | Commits any edits that have been applied to the builder. |
| CreateSegmentBuilder | Creates a new segment builder for the road object of type path @return SegmentBuilder object |
| 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. |
| GetSegmentBuilder | Get a specific segment builder from the list @return |
| RemoveAllSegmentBuilders | Remove a segment |
| RemoveSegmentBuilder | Remove a segment |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| SwapSegment | Swap two segments |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
| RoadBuilderPathDatatypeChoices Enumeration | data type attribute of the path data |
| RoadBuilderSurfaceDatatypeChoices Enumeration | data type attribute of the surface data |
| RoadBuilderTypeChoices Enumeration | type attribute of the road |
Property Detail¶
BankAngleCurve¶
-
RoadBuilder.BankAngleCurve¶ Returns or sets the bank angle spline curve for the road object of path type
-------------------------------------Getter Method
Signature
BankAngleCurve()Returns: Return type: NXOpen.Motion.MotionFunctionNew in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------Setter Method
Signature
BankAngleCurve(spline)Parameters: spline ( NXOpen.Motion.MotionFunction) –New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
Csys¶
-
RoadBuilder.Csys¶ Returns or sets the coordinate system of the optional link object
-------------------------------------Getter Method
Signature
Csys()Returns: Return type: NXOpen.CoordinateSystemNew in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------Setter Method
Signature
Csys(csys)Parameters: csys ( NXOpen.CoordinateSystem) –New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
Link¶
-
RoadBuilder.Link¶ Returns the optional link object
-------------------------------------Getter Method
Signature
Link()Returns: Return type: NXOpen.Motion.SelectLinkNew in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
Name¶
-
RoadBuilder.Name¶ Returns or sets the name of the road object selected from motion objects
-------------------------------------Getter Method
Signature
Name()Returns: Return type: str New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------Setter Method
Signature
Name(name)Parameters: name (str) – New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
PathDatatype¶
-
RoadBuilder.PathDatatype¶ Returns or sets the path datatype of the road object
-------------------------------------Getter Method
Signature
PathDatatype()Returns: Return type: NXOpen.Motion.RoadBuilderPathDatatypeChoicesNew in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------Setter Method
Signature
PathDatatype(pathdatatype)Parameters: pathdatatype ( NXOpen.Motion.RoadBuilderPathDatatypeChoices) –New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
PathFileName¶
-
RoadBuilder.PathFileName¶ Returns or sets the path and file name of the path curve
-------------------------------------Getter Method
Signature
PathFileName()Returns: Return type: str New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------Setter Method
Signature
PathFileName(filename)Parameters: filename (str) – New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
ReferencePoint¶
-
RoadBuilder.ReferencePoint¶ Returns or sets the reference point of the optional link object
-------------------------------------Getter Method
Signature
ReferencePoint()Returns: Return type: NXOpen.PointNew in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------Setter Method
Signature
ReferencePoint(referencePoint)Parameters: referencePoint ( NXOpen.Point) –New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
RoadObject¶
-
RoadBuilder.RoadObject¶ Returns or sets the road object selected from motion objects
-------------------------------------Getter Method
Signature
RoadObject()Returns: Return type: NXOpen.Motion.RoadNew in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------Setter Method
Signature
RoadObject(roadobject)Parameters: roadobject ( NXOpen.Motion.Road) –New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
RoadType¶
-
RoadBuilder.RoadType¶ Returns or sets the road type
-------------------------------------Getter Method
Signature
RoadType()Returns: Return type: NXOpen.Motion.RoadBuilderTypeChoicesNew in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------Setter Method
Signature
RoadType(roadtype)Parameters: roadtype ( NXOpen.Motion.RoadBuilderTypeChoices) –New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
SegmentBuilderList¶
-
RoadBuilder.SegmentBuilderList¶ Returns the segment builder list for the road object of type path
-------------------------------------Getter Method
Signature
SegmentBuilderList()Returns: Return type: NXOpen.Motion.SegmentBuilderListNew in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
SplineCurve¶
-
RoadBuilder.SplineCurve¶ Returns or sets the spline curve of the road object of surface type
-------------------------------------Getter Method
Signature
SplineCurve()Returns: Return type: NXOpen.Motion.MotionFunctionNew in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------Setter Method
Signature
SplineCurve(spline)Parameters: spline ( NXOpen.Motion.MotionFunction) –New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
SurfaceDatatype¶
-
RoadBuilder.SurfaceDatatype¶ Returns or sets the surface datatype of the road object
-------------------------------------Getter Method
Signature
SurfaceDatatype()Returns: Return type: NXOpen.Motion.RoadBuilderSurfaceDatatypeChoicesNew in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------Setter Method
Signature
SurfaceDatatype(surfacedatatype)Parameters: surfacedatatype ( NXOpen.Motion.RoadBuilderSurfaceDatatypeChoices) –New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
SurfaceFileName¶
-
RoadBuilder.SurfaceFileName¶ Returns or sets the path and file name of the surface curve
-------------------------------------Getter Method
Signature
SurfaceFileName()Returns: Return type: str New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------Setter Method
Signature
SurfaceFileName(filename)Parameters: filename (str) – New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
XCurve¶
-
RoadBuilder.XCurve¶ Returns or sets the x spline curve for the road object of path type
-------------------------------------Getter Method
Signature
XCurve()Returns: Return type: NXOpen.Motion.MotionFunctionNew in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------Setter Method
Signature
XCurve(spline)Parameters: spline ( NXOpen.Motion.MotionFunction) –New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
XSegmentOriginCoord¶
-
RoadBuilder.XSegmentOriginCoord¶ Returns the x origin coord for the segments for the road object of type path
-------------------------------------Getter Method
Signature
XSegmentOriginCoord()Returns: Return type: NXOpen.ExpressionNew in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
YCurve¶
-
RoadBuilder.YCurve¶ Returns or sets the y spline curve for the road object of path type
-------------------------------------Getter Method
Signature
YCurve()Returns: Return type: NXOpen.Motion.MotionFunctionNew in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------Setter Method
Signature
YCurve(spline)Parameters: spline ( NXOpen.Motion.MotionFunction) –New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
YSegmentOriginCoord¶
-
RoadBuilder.YSegmentOriginCoord¶ Returns the y origin coord for the segments for the road object of type path
-------------------------------------Getter Method
Signature
YSegmentOriginCoord()Returns: Return type: NXOpen.ExpressionNew in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
ZCurve¶
-
RoadBuilder.ZCurve¶ Returns or sets the z spline curve for the road object of path type
-------------------------------------Getter Method
Signature
ZCurve()Returns: Return type: NXOpen.Motion.MotionFunctionNew in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------Setter Method
Signature
ZCurve(spline)Parameters: spline ( NXOpen.Motion.MotionFunction) –New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
ZSegmentOriginCoord¶
-
RoadBuilder.ZSegmentOriginCoord¶ Returns the z origin coord for the segments for the road object of type path
-------------------------------------Getter Method
Signature
ZSegmentOriginCoord()Returns: Return type: NXOpen.ExpressionNew in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
Method Detail¶
CreateSegmentBuilder¶
-
RoadBuilder.CreateSegmentBuilder¶ Creates a new segment builder for the road object of type path
Signature
CreateSegmentBuilder()Returns: SegmentBuilder object Return type: NXOpen.Motion.SegmentBuilderNew in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
GetSegmentBuilder¶
-
RoadBuilder.GetSegmentBuilder¶ Get a specific segment builder from the list
Signature
GetSegmentBuilder(segmentBuilderIndex)Parameters: segmentBuilderIndex (int) – Returns: Return type: NXOpen.Motion.SegmentBuilderNew in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
RemoveAllSegmentBuilders¶
-
RoadBuilder.RemoveAllSegmentBuilders¶ Remove a segment
Signature
RemoveAllSegmentBuilders()New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
RemoveSegmentBuilder¶
-
RoadBuilder.RemoveSegmentBuilder¶ Remove a segment
Signature
RemoveSegmentBuilder(segment)Parameters: segment ( NXOpen.Motion.SegmentBuilder) –New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
SwapSegment¶
-
RoadBuilder.SwapSegment¶ Swap two segments
Signature
SwapSegment(firstSegment, secondSegment)Parameters: - firstSegment (
NXOpen.Motion.SegmentBuilder) – - secondSegment (
NXOpen.Motion.SegmentBuilder) –
New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
- firstSegment (
Validate¶
-
RoadBuilder.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.