PositionedLine Class Reference

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Class for objects that describe positioned lines in space More...

Inheritance diagram for PositionedLine:

Public Member Functions
	PositionedLine (Position position, Vector3D direction)
	Constructor that defines the line by parameters. More...
	PositionedLine (PositionedLine line)
	Copy constructor. More...
void	SetPositioningReference (IProvidesPositioningReferences referenceProvider, string key)
	Method to set the PositioningReferenceProvider and the key for the coordinate system that serves as positioning reference. More...

Properties
Vector3D	Direction [get, set]
	Direction vector of the line
CartesianCoordinateSystem	GetPositioningReference [get]
	Property to get the coordinate system that serves as reference for this object.
bool	IsDefinedAbsolutely [get]
	Are the line position and direction defined in absolute coordinates?
Position	Position [get, set]
	One point that lies on the line
string	PositioningReferenceKey [get]
	Get the key of the reference coordinate system for this object.
IProvidesPositioningReferences	PositioningReferenceProvider [get]
	Get the object that provides the reference coordinate system for this object.

Detailed Description

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Class for objects that describe positioned lines in space

Constructor & Destructor Documentation

PositionedLine() [1/2]

PositionedLine	(	Position	position,
		Vector3D	direction
	)

Constructor that defines the line by parameters.

Parameters

position	One point that lies on the line.
direction	Direction vector of the line.

PositionedLine() [2/2]

PositionedLine

(

PositionedLine

line

)

Copy constructor.

Parameters

line	Line to be copied.

Member Function Documentation

SetPositioningReference()

void SetPositioningReference	(	IProvidesPositioningReferences	referenceProvider,
		string	key
	)

Method to set the PositioningReferenceProvider and the key for the coordinate system that serves as positioning reference.

Parameters

referenceProvider	Object which provides the coordinate system that serves as reference for this position.
key	Key for the coordinate system (contained by PositioningReferenceProvider) which shall serve as reference for this position.