OrientationByMatrix 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 via rotation matrix. More...

Inheritance diagram for OrientationByMatrix:

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.
	OrientationByMatrix ()
	Default constructor. Creates an identity rotation matrix.
	OrientationByMatrix (Matrix3x3D rotationMatrix)
	Constructor which gets a rotation matrix.
	OrientationByMatrix (OrientationByMatrix oMatrix)
	Copy constructor.
override string	ToString ()
	Overridden ToString method.
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
override OrientationDefinitionType	DefinitionType [get]
	Gets the OrientationDefinitionType associated with the current implementation of IOrientationDefinition.
override List< SimpleRotation >	ListOfRotations [get]
	Gets a list of simple rotations, describing the orientation as a rotation sequence.
Matrix3x3D	RotationMatrix [get, set]
	The 3x3-matrix which defines the rotation.
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 via rotation matrix.

Constructor & Destructor Documentation

OrientationByMatrix() [1/2]

OrientationByMatrix

(

Matrix3x3D

rotationMatrix

)

Constructor which gets a rotation matrix.

Parameters

rotationMatrix

Rotation matrix which describes the orientation.

OrientationByMatrix() [2/2]

OrientationByMatrix

(

OrientationByMatrix

oMatrix

)

Copy constructor.

Parameters

oMatrix

Object to be copied.

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

override string ToString

(

)

Overridden ToString method.

Returns

A System.String that represents this instance.