NXOpen .NET Reference  12.0.0
Public Types | Public Member Functions | Properties | List of all members
NXOpen.Motion.RoadBuilder Class Reference

Represents a NXOpen.Motion.RoadBuilder More...

Inheritance diagram for NXOpen.Motion.RoadBuilder:
NXOpen.Motion.MotionBuilder NXOpen.Builder NXOpen.GeometricUtilities.IComponentBuilder

Public Types

enum  TypeChoices { Surface, Path }
 type attribute of the road More...
 
enum  SurfaceDatatypeChoices {
  SplineCurve, SplineSurface, Rsm1000, Rsm1002,
  Rsm2000, Rsm3000, OpenCRG, RoadDataFile,
  Profile2D
}
 data type attribute of the surface data More...
 
enum  PathDatatypeChoices { SplineCurves, Segments, FileImport }
 data type attribute of the path data More...
 
enum  SplineDatatypeChoices { Function, Profile2D }
 data type attribute of the spline data More...
 

Public Member Functions

unsafe NXOpen.Motion.SegmentBuilder CreateSegmentBuilder ()
 Creates a new segment builder for the road object of type path More...
 
unsafe NXOpen.Motion.SegmentBuilder GetSegmentBuilder (int segmentBuilderIndex)
 Get a specific segment builder from the list More...
 
unsafe void RemoveSegmentBuilder (NXOpen.Motion.SegmentBuilder segment)
 Remove a segment More...
 
unsafe void RemoveAllSegmentBuilders ()
 Remove a segment More...
 
unsafe void SwapSegment (NXOpen.Motion.SegmentBuilder firstSegment, NXOpen.Motion.SegmentBuilder secondSegment)
 Swap two segments More...
 

Properties

unsafe NXOpen.Motion.MotionFunction BankAngleCurve [get, set]
 Returns or sets the bank angle spline curve for the road object of path type More...
 
unsafe
NXOpen.Motion.SelectFieldData 
BankAngleCurveProfile [get]
 Returns the bank angle spline curve defined by a profile for the road object of path type More...
 
unsafe NXOpen.NXColor Color [get, set]
 Returns or sets the color More...
 
unsafe NXOpen.CoordinateSystem Csys [get, set]
 Returns or sets the coordinate system of the optional link object More...
 
unsafe NXOpen.Expression GridDensity [get]
 Returns the grid density More...
 
unsafe NXOpen.Expression Length [get]
 Returns the length More...
 
unsafe NXOpen.Motion.SelectLink Link [get]
 Returns the optional link object More...
 
unsafe string Name [get, set]
 Returns or sets the name of the road object selected from motion objects More...
 
unsafe
NXOpen.Motion.RoadBuilder.PathDatatypeChoices 
PathDatatype [get, set]
 Returns or sets the path datatype of the road object More...
 
unsafe string PathFileName [get, set]
 Returns or sets the path and file name of the path curve More...
 
unsafe NXOpen.Point ReferencePoint [get, set]
 Returns or sets the reference point of the optional link object More...
 
unsafe NXOpen.Motion.Road RoadObject [get, set]
 Returns or sets the road object selected from motion objects More...
 
unsafe
NXOpen.Motion.RoadBuilder.TypeChoices 
RoadType [get, set]
 Returns or sets the road type More...
 
unsafe
NXOpen.Motion.SegmentBuilderList 
SegmentBuilderList [get]
 Returns the segment builder list for the road object of type path More...
 
unsafe bool ShowVisualization [get, set]
 Returns or sets the show visualization More...
 
unsafe NXOpen.Motion.MotionFunction SplineCurve [get, set]
 Returns or sets the spline curve of the road object of surface type More...
 
unsafe
NXOpen.Motion.SelectFieldData 
SplineCurveProfile [get]
 Returns the spline profile of the road object of surface type More...
 
unsafe
NXOpen.Motion.RoadBuilder.SplineDatatypeChoices 
SplineType [get, set]
 Returns or sets the spline type More...
 
unsafe
NXOpen.Motion.RoadBuilder.SurfaceDatatypeChoices 
SurfaceDatatype [get, set]
 Returns or sets the surface datatype of the road object More...
 
unsafe string SurfaceFileName [get, set]
 Returns or sets the path and file name of the surface curve More...
 
unsafe
NXOpen.Motion.SelectFieldData 
SurfaceProfile [get]
 Returns the path and file name of the surface curve More...
 
unsafe NXOpen.Expression Width [get]
 Returns the width More...
 
unsafe NXOpen.Motion.MotionFunction XCurve [get, set]
 Returns or sets the x spline curve for the road object of path type More...
 
unsafe
NXOpen.Motion.SelectFieldData 
XCurveProfile [get]
 Returns the x spline curve defined by a profile for the road object of path type More...
 
unsafe NXOpen.Expression XSegmentOriginCoord [get]
 Returns the x origin coord for the segments for the road object of type path More...
 
unsafe NXOpen.Motion.MotionFunction YCurve [get, set]
 Returns or sets the y spline curve for the road object of path type More...
 
unsafe
NXOpen.Motion.SelectFieldData 
YCurveProfile [get]
 Returns the y spline curve defined by a profile for the road object of path type More...
 
unsafe NXOpen.Expression YSegmentOriginCoord [get]
 Returns the y origin coord for the segments for the road object of type path More...
 
unsafe NXOpen.Motion.MotionFunction ZCurve [get, set]
 Returns or sets the z spline curve for the road object of path type More...
 
unsafe
NXOpen.Motion.SelectFieldData 
ZCurveProfile [get]
 Returns the z spline curve defined by a profile for the road object of path type More...
 
unsafe NXOpen.Expression ZSegmentOriginCoord [get]
 Returns the z origin coord for the segments for the road object of type path More...
 
- Properties inherited from NXOpen.Motion.MotionBuilder
unsafe double DisplayScale [get, set]
 Returns or sets the icon display scale More...
 
unsafe string GroupName [get, set]
 Returns or sets the group name More...
 
unsafe
NXOpen.Motion.MotionObject.GroupType 
GroupType [get, set]
 Returns or sets the group type More...
 

Detailed Description

Represents a NXOpen.Motion.RoadBuilder

To create a new instance of this class, use NXOpen.Motion.RoadCollection.CreateRoadBuilder

Created in NX11.0.0

Member Enumeration Documentation

data type attribute of the path data

Enumerator
SplineCurves 

Spline Curves

Segments 

Segments

FileImport 

FileImport

data type attribute of the spline data

Enumerator
Function 

Function

Profile2D 

Profile 2D

data type attribute of the surface data

Enumerator
SplineCurve 

Function

SplineSurface 

Spline Surface defined by 3D Profile

Rsm1000 

RSM1000

Rsm1002 

RSM1002

Rsm2000 

RSM2000

Rsm3000 

RSM3000

OpenCRG 

OpenCRG

RoadDataFile 

Road Data File

Profile2D 

Profile 2D

type attribute of the road

Enumerator
Surface 

Surface

Path 

Path

Member Function Documentation

unsafe NXOpen.Motion.SegmentBuilder NXOpen.Motion.RoadBuilder.CreateSegmentBuilder ( )

Creates a new segment builder for the road object of type path

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")

Returns
SegmentBuilder object
unsafe NXOpen.Motion.SegmentBuilder NXOpen.Motion.RoadBuilder.GetSegmentBuilder ( int  segmentBuilderIndex)

Get a specific segment builder from the list

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")

Parameters
segmentBuilderIndex
Returns
unsafe void NXOpen.Motion.RoadBuilder.RemoveAllSegmentBuilders ( )

Remove a segment

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")

unsafe void NXOpen.Motion.RoadBuilder.RemoveSegmentBuilder ( NXOpen.Motion.SegmentBuilder  segment)

Remove a segment

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")

Parameters
segment
unsafe 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")

Parameters
firstSegment
secondSegment

Property Documentation

unsafe NXOpen.Motion.MotionFunction NXOpen.Motion.RoadBuilder.BankAngleCurve
getset

Returns or sets the bank angle spline curve for the road object of path type

Created in NX11.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.SelectFieldData NXOpen.Motion.RoadBuilder.BankAngleCurveProfile
get

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")

unsafe NXOpen.NXColor NXOpen.Motion.RoadBuilder.Color
getset

Returns or sets the color

Created in NX11.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.CoordinateSystem NXOpen.Motion.RoadBuilder.Csys
getset

Returns or sets the coordinate system of the optional link object

Created in NX11.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.Expression NXOpen.Motion.RoadBuilder.GridDensity
get

Returns the grid density

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")

unsafe NXOpen.Expression NXOpen.Motion.RoadBuilder.Length
get

Returns the length

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.SelectLink NXOpen.Motion.RoadBuilder.Link
get

Returns the optional link object

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")

unsafe string NXOpen.Motion.RoadBuilder.Name
getset

Returns or sets the name of the road object selected from motion objects

Created in NX11.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.RoadBuilder.PathDatatypeChoices NXOpen.Motion.RoadBuilder.PathDatatype
getset

Returns or sets the path datatype of the road object

Created in NX11.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe string NXOpen.Motion.RoadBuilder.PathFileName
getset

Returns or sets the path and file name of the path curve

Created in NX11.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.Point NXOpen.Motion.RoadBuilder.ReferencePoint
getset

Returns or sets the reference point of the optional link object

Created in NX11.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.Road NXOpen.Motion.RoadBuilder.RoadObject
getset

Returns or sets the road object selected from motion objects

Created in NX11.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.RoadBuilder.TypeChoices NXOpen.Motion.RoadBuilder.RoadType
getset

Returns or sets the road type

Created in NX11.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.SegmentBuilderList NXOpen.Motion.RoadBuilder.SegmentBuilderList
get

Returns the segment builder list for the road object of type path

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")

unsafe bool NXOpen.Motion.RoadBuilder.ShowVisualization
getset

Returns or sets the show visualization

Created in NX11.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.MotionFunction NXOpen.Motion.RoadBuilder.SplineCurve
getset

Returns or sets the spline curve of the road object of surface type

Created in NX11.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.SelectFieldData NXOpen.Motion.RoadBuilder.SplineCurveProfile
get

Returns the spline profile of the road object of surface type

Created in NX12.0.0

License requirements: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.RoadBuilder.SplineDatatypeChoices NXOpen.Motion.RoadBuilder.SplineType
getset

Returns or sets the spline type

Created in NX12.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.RoadBuilder.SurfaceDatatypeChoices NXOpen.Motion.RoadBuilder.SurfaceDatatype
getset

Returns or sets the surface datatype of the road object

Created in NX11.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe string NXOpen.Motion.RoadBuilder.SurfaceFileName
getset

Returns or sets the path and file name of the surface curve

Created in NX11.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.SelectFieldData NXOpen.Motion.RoadBuilder.SurfaceProfile
get

Returns the path and file name of the surface curve

Created in NX12.0.0

License requirements: mechanisms ("MECHANISMS")

unsafe NXOpen.Expression NXOpen.Motion.RoadBuilder.Width
get

Returns the width

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.MotionFunction NXOpen.Motion.RoadBuilder.XCurve
getset

Returns or sets the x spline curve for the road object of path type

Created in NX11.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.SelectFieldData NXOpen.Motion.RoadBuilder.XCurveProfile
get

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")

unsafe NXOpen.Expression NXOpen.Motion.RoadBuilder.XSegmentOriginCoord
get

Returns the x origin coord for the segments for the road object of type path

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.MotionFunction NXOpen.Motion.RoadBuilder.YCurve
getset

Returns or sets the y spline curve for the road object of path type

Created in NX11.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.SelectFieldData NXOpen.Motion.RoadBuilder.YCurveProfile
get

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")

unsafe NXOpen.Expression NXOpen.Motion.RoadBuilder.YSegmentOriginCoord
get

Returns the y origin coord for the segments for the road object of type path

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.MotionFunction NXOpen.Motion.RoadBuilder.ZCurve
getset

Returns or sets the z spline curve for the road object of path type

Created in NX11.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.SelectFieldData NXOpen.Motion.RoadBuilder.ZCurveProfile
get

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")

unsafe NXOpen.Expression NXOpen.Motion.RoadBuilder.ZSegmentOriginCoord
get

Returns the z origin coord for the segments for the road object of type path

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.