OrientationDefinitionBase Class Reference

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Base for all classes that describe a rotation definition. More...

Inheritance diagram for OrientationDefinitionBase:

Public Member Functions
Quaternion	CorrespondingQuaternion ()
	Gets the quaternion corresponding to this orientation definition.
virtual bool	IsEquivalent (OrientationDefinitionBase orientationDefinitionToCompare)
	Determines whether another orientation definition is equivalent.
	OrientationDefinitionBase ()
	Default constructor.

Static Public Member Functions
static OrientationDefinitionBase	ConvertOrientationDefinition (OrientationDefinitionBase sourceOrientation, OrientationDefinitionType targetType)
	Help method which converts any orientation definition object into an equivalent definition object of another type.

Properties
OrientationDefinitionType	DefinitionType [get]
	Gets the OrientationDefinitionType associated with the current implementation of IOrientationDefinition.
List< SimpleRotation >	ListOfRotations [get]
	Gets a list of simple rotations, describing the complete rotation as a sequence.
virtual List< Parameter >	ParameterRunParameters [get]

Detailed Description

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Base for all classes that describe a rotation definition.

Member Function Documentation

ConvertOrientationDefinition()

static OrientationDefinitionBase ConvertOrientationDefinition ( OrientationDefinitionBase  sourceOrientation, OrientationDefinitionType  targetType  )

static

Help method which converts any orientation definition object into an equivalent definition object of another type.

Parameters

sourceOrientation	Orientation definition to be converted.
targetType	Type of the orientation needed.

Returns

Converted orientation definition.

CorrespondingQuaternion()

Quaternion CorrespondingQuaternion ( )

abstract

Gets the quaternion corresponding to this orientation definition.

Returns

The quaternion corresponding to this orientation definition.

IsEquivalent()

virtual bool IsEquivalent ( OrientationDefinitionBase  orientationDefinitionToCompare )

virtual

Determines whether another orientation definition is equivalent.

Parameters

orientationDefinitionToCompare

IOrientationDefinition which has to be compared.

Returns

True, if the two objects are equivalent, false otherwise.

Reimplemented in AxisRotationSequence.