OrientationByEulerAngles Class Reference

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
A class for defining orientations by Euler angles. More...

Inheritance diagram for OrientationByEulerAngles:

Public Member Functions
override object	Clone ()
	Creates a new object that is a copy of the current instance.
override Quaternion	CorrespondingQuaternion ()
	Gets the quaternion corresponding to this orientation definition.
override bool	Equals (object otherObject, EqualityIntent equalityIntent)
	Determines whether the specified Object is equal to this instance. Please note: If just the resulting orientation of this and the otherObject shall be compared, the method IsEquivalent of the base class should be used.
	OrientationByEulerAngles ()
	Default constructor, setting all Euler angles to zero.
	OrientationByEulerAngles (double eulerPsi, double eulerTheta, double eulerPhi)
	Constructor with three angles to be set as Euler angles.
	OrientationByEulerAngles (EulerAnglesSet eulerAnglesSet)
	Constructor that gets Euler angles as one set.
	OrientationByEulerAngles (OrientationByEulerAngles orientationToCopy)
	Copy constructor.
override string	ToString ()
	Converts a OrientationByEulerAngles into a string of format (Psi; Theta; Phi). For the creation of the string the default number of digits specified in Globals.DefaultDigitPrecision will be used.
string	ToString (int digitPrecision)
	Converts a OrientationByEulerAngles into a string of format (Psi; Theta; Phi).
Public Member Functions inherited from OrientationDefinitionBase
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.

Properties
double	AngleEulerPhi [get, set]
	Gets or sets the value of the Euler angle phi.
double	AngleEulerPsi [get, set]
	Gets or sets the value of the Euler angle psi.
double	AngleEulerTheta [get, set]
	Gets or sets the value of the Euler angle theta.
override OrientationDefinitionType	DefinitionType [get]
	Gets the OrientationDefinitionType associated with the current implementation of IOrientationDefinition.
EulerAnglesSet	EulerAngles [get, set]
	Gets and sets the Euler angles which define a rotation.
override List< SimpleRotation >	ListOfRotations [get]
	Gets a list of simple rotations, describing the complete rotation as a sequence.
override List< Parameter >	ParameterRunParameters [get]
Properties inherited from OrientationDefinitionBase
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]

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

Detailed Description

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
A class for defining orientations by Euler angles.

Constructor & Destructor Documentation

OrientationByEulerAngles() [1/3]

OrientationByEulerAngles

(

EulerAnglesSet

eulerAnglesSet

)

Constructor that gets Euler angles as one set.

Parameters

eulerAnglesSet

Set of Euler angles.

OrientationByEulerAngles() [2/3]

OrientationByEulerAngles	(	double	eulerPsi,
		double	eulerTheta,
		double	eulerPhi )

Constructor with three angles to be set as Euler angles.

Parameters

eulerPsi	Angle between old x-axis and line of nodes
eulerTheta	Angle between old and new z-axis
eulerPhi	Angle between line of nodes and new x-axis

OrientationByEulerAngles() [3/3]

OrientationByEulerAngles

(

OrientationByEulerAngles

orientationToCopy

)

Copy constructor.

Parameters

orientationToCopy

orientation object to copy

Member Function Documentation

Clone()

override object Clone

(

)

Creates a new object that is a copy of the current instance.

Returns

A new object that is a copy of this instance.

CorrespondingQuaternion()

override Quaternion CorrespondingQuaternion

(

)

Gets the quaternion corresponding to this orientation definition.

Returns

The quaternion corresponding to this orientation definition.

Equals()

override bool Equals	(	object	otherObject,
		EqualityIntent	equalityIntent )

Determines whether the specified Object is equal to this instance. Please note: If just the resulting orientation of this and the otherObject shall be compared, the method IsEquivalent of the base class should be used.

Parameters

otherObject	The Object to compare with this instance.
equalityIntent	Defines what kind of equality you want to check when comparing two objects, for example all values or physical equality.

Returns

true if the specified Object is equal to this instance; otherwise, false.

ToString() [1/2]

override string ToString

(

)

Converts a OrientationByEulerAngles into a string of format (Psi; Theta; Phi). For the creation of the string the default number of digits specified in Globals.DefaultDigitPrecision will be used.

Returns

String containing the Euler angles information.

ToString() [2/2]

string ToString

(

int

digitPrecision

)

Converts a OrientationByEulerAngles into a string of format (Psi; Theta; Phi).

Parameters

digitPrecision

number of digits the values are rounded to.

Returns

String containing the Euler angles information.