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
abstract OrientationDefinitionBase	Clone ()
	Deep copy of this. More...

abstract Quaternion	CorrespondingQuaternion ()
	Gets the quaternion corresponding to this orientation definition. More...

virtual bool	IsEquivalent (OrientationDefinitionBase orientationDefinitionToCompare)
	// Gets the rotation matrix corresponding to this orientation definition. // More...

	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. More...

Properties
abstract OrientationDefinitionType	DefinitionType `[get]`
	Gets the OrientationDefinitionType associated with the current implementation of IOrientationDefinition

abstract List< SimpleRotation >	ListOfRotations `[get]`
	Gets a list of simple rotations, describing the complete rotation as a sequence

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

◆ Clone()

abstract OrientationDefinitionBase Clone ( )

pure virtual

Deep copy of this.

Returns

Implemented in AxisRotationSequence, OrientationByCartesianAngles, OrientationByDirectionAngles, OrientationByEulerAngles, OrientationByMatrix, and OrientationBySphereAngles.

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

abstract Quaternion CorrespondingQuaternion ( )

pure virtual

Gets the quaternion corresponding to this orientation definition.

Returns: The quaternion corresponding to this orientation definition.

Implemented in AxisRotationSequence, OrientationByCartesianAngles, OrientationByDirectionAngles, OrientationByEulerAngles, OrientationByMatrix, and OrientationBySphereAngles.

◆ IsEquivalent()

virtual bool IsEquivalent ( OrientationDefinitionBase orientationDefinitionToCompare )

virtual

// Gets the rotation matrix corresponding to this orientation definition. //

//

Returns: Rotation matrix corresponding to this orientation definition.

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.

Public Member Functions