Represents a NXOpen.Motion.RoadBuilder More...

Inheritance diagram for NXOpen.Motion.RoadBuilder:

Public Types
enum	PathDatatypeChoices { SplineCurves, Segments, FileImport }
	data type attribute of the path data More...

enum	ReferenceObjectId { SurfaceFile, PathFile }
	the enum for external file reference object id of road More...

enum	SplineDatatypeChoices { Function, Profile2D }
	data type attribute of the spline data More...

enum	SurfaceDatatypeChoices { SplineCurve, SplineSurface, Rsm1000, Rsm1002, Rsm2000, Rsm3000, OpenCRG, RoadDataFile, Profile2D }
	data type attribute of the surface data More...

enum	TypeChoices { Surface, Path }
	type attribute of the road More...

Public Member Functions
unsafe NXOpen.Motion.SegmentBuilder	CreateSegmentBuilder ()
	Creates a new segment builder for the road object of type path More...

unsafe NXOpen.ExternalFileReferenceAdapter	EstablishReference (int referenceObjectId, NXOpen.ExternalFileReferenceAdapter.Type referenceType, string externalFileSpec)
	Establish the external reference to the given file specification. More...

unsafe string	GetExternalFileDefinitionKey (NXOpen.ExternalFileReferenceAdapter adapter)
	Gets the file definition to use for external file adapter. More...

unsafe NXOpen.ExternalFileReferenceAdapter	GetExternalFileReferenceAdapter (int referenceObjectId)
	Returns the external file reference object. More...

unsafe NXOpen.Motion.SegmentBuilder	GetSegmentBuilder (int segmentBuilderIndex)
	Get a specific segment builder from the list More...

unsafe void	RemoveAllSegmentBuilders ()
	Remove a segment More...

unsafe void	RemoveSegmentBuilder (NXOpen.Motion.SegmentBuilder segment)
	Remove a segment More...

unsafe void	SetExternalFileReferenceAdapter (int referenceObjectId, NXOpen.ExternalFileReferenceAdapter adapter)
	Sets the external file reference object. 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 motion body object More...

unsafe NXOpen.Motion.ParamOverrideState	CsysOvrCtrl `[get, set]`
	Returns or sets the override state of the coordinate system 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 motion body object More...

unsafe NXOpen.Motion.ParamOverrideState	LinkOvrCtrl `[get, set]`
	Returns or sets the override state of the action motion body 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 NXOpen.Point	ReferencePoint `[get, set]`
	Returns or sets the reference point of the optional motion body object More...

unsafe NXOpen.Motion.ParamOverrideState	ReferencePointOvrCtrl `[get, set]`
	Returns or sets the override state of the action point 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 data type of the road object 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...

Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder	PreviewBuilder `[get]`
	Returns the preview builder subobject. More...

Properties inherited from NXOpen.TaggedObject
Tag	Tag `[get]`
	Returns the tag of this object. More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> 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

enum NXOpen.Motion.RoadBuilder.PathDatatypeChoices

data type attribute of the path data

Enumerator
SplineCurves	Spline Curves
Segments	Segments
FileImport	FileImport

enum NXOpen.Motion.RoadBuilder.ReferenceObjectId

the enum for external file reference object id of road

Enumerator
SurfaceFile
PathFile

enum NXOpen.Motion.RoadBuilder.SplineDatatypeChoices

data type attribute of the spline data

Enumerator
Function	Function
Profile2D	Profile 2D

enum NXOpen.Motion.RoadBuilder.SurfaceDatatypeChoices

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

enum NXOpen.Motion.RoadBuilder.TypeChoices

type attribute of the road

Enumerator
Surface	Surface
Path	Path

Member Function Documentation

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

inline

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.ExternalFileReferenceAdapter NXOpen.Motion.RoadBuilder.EstablishReference	(	int	referenceObjectId,
		NXOpen.ExternalFileReferenceAdapter.Type	referenceType,
		string	externalFileSpec
	)

inline

Establish the external reference to the given file specification.

Created in NX1847.0.0

License requirements: None.

Parameters

referenceObjectId	the unique identifier to use for this reference if referencer has multiple external references
referenceType	the kind of reference to establish
externalFileSpec	the external file specification.

Returns: external file reference object

Implements NXOpen.IExternalFileReferencer.

unsafe string NXOpen.Motion.RoadBuilder.GetExternalFileDefinitionKey ( NXOpen.ExternalFileReferenceAdapter adapter )

inline

Gets the file definition to use for external file adapter.

Created in NX1847.0.0

License requirements: None.

Parameters

adapter external file reference object

Returns

Implements NXOpen.IExternalFileReferencer.

unsafe NXOpen.ExternalFileReferenceAdapter NXOpen.Motion.RoadBuilder.GetExternalFileReferenceAdapter ( int referenceObjectId )

inline

Returns the external file reference object.

In case the referencer object has multiple external references, use referenceObjectId to return the correct external file adapter.

Created in NX1847.0.0

License requirements: None.

Parameters

referenceObjectId the unique identifier of the external reference required in case where referencer has multiple external references

Returns: external file reference object

Implements NXOpen.IExternalFileReferencer.

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

inline

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

inline

Remove a segment

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")

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

inline

Remove a segment

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")

Parameters

segment

unsafe void NXOpen.Motion.RoadBuilder.SetExternalFileReferenceAdapter	(	int	referenceObjectId,
		NXOpen.ExternalFileReferenceAdapter	adapter
	)

inline

Sets the external file reference object.

In case the referencer object has multiple external references, use referenceObjectId to set the correct reference.

Created in NX1847.0.0

License requirements: None.

Parameters

referenceObjectId	the unique identifier of the external reference required in case where referencer has multiple external references
adapter	external file reference object

Implements NXOpen.IExternalFileReferencer.

unsafe void NXOpen.Motion.RoadBuilder.SwapSegment	(	NXOpen.Motion.SegmentBuilder	firstSegment,
		NXOpen.Motion.SegmentBuilder	secondSegment
	)

inline

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 motion body 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.ParamOverrideState NXOpen.Motion.RoadBuilder.CsysOvrCtrl

getset

Returns or sets the override state of the coordinate system

It should only be used for occurrences

Created in NX1847.0.0

License requirements to get this property: None.

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 motion body object

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.ParamOverrideState NXOpen.Motion.RoadBuilder.LinkOvrCtrl

getset

Returns or sets the override state of the action motion body

It should only be used for occurrences

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: 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 NXOpen.Point NXOpen.Motion.RoadBuilder.ReferencePoint

getset

Returns or sets the reference point of the optional motion body 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.ParamOverrideState NXOpen.Motion.RoadBuilder.ReferencePointOvrCtrl

getset

Returns or sets the override state of the action point

It should only be used for occurrences

Created in NX1847.0.0

License requirements to get this property: None.

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 data type 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 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:

Motion_RoadBuilder.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation