DirectionByRotationMatrix 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 directions by applying a rotation matrix to a starting vector. More...

Inheritance diagram for DirectionByRotationMatrix:

Public Member Functions
override DirectionDefinitionBase	Clone ()
	Creates a new object that is a copy of the current instance. More...
override Vector3D	CorrespondingVector3D ()
	Gets the vector resulting from the implemented direction definition. More...
	DirectionByRotationMatrix ()
	Default constructor. Creates an identity rotation matrix.
	DirectionByRotationMatrix (DirectionByRotationMatrix oMatrix)
	Copy constructor More...
	DirectionByRotationMatrix (Matrix3x3D rotationMatrix, AxisDirection referenceAxis=AxisDirection.Z)
	Constructor which gets a rotation matrix. More...
override bool	Equals (object otherObject, EqualityIntent equalityIntent)
	Determines whether the specified Object is equal to this instance. Please note: If just the resulting direction of this and the otherObject shall be compared, a comparison of CorrespondingVector3D should be done. More...
override string	ToString ()
	Overridden ToString method. More...

Properties
override DirectionDefinitionType	DefinitionType [get]
	Gets the DirectionDefinitionType
AxisDirection	ReferenceAxis [get, set]
	The reference axis the matrix is applied to.
Matrix3x3D	RotationMatrix [get, set]
	The 3x3-matrix which defines the rotation

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 directions by applying a rotation matrix to a starting vector.

Constructor & Destructor Documentation

DirectionByRotationMatrix() [1/2]

DirectionByRotationMatrix	(	Matrix3x3D	rotationMatrix,
		AxisDirection	referenceAxis = AxisDirection.Z
	)

Constructor which gets a rotation matrix.

Parameters

rotationMatrix	Rotation matrix which describes the orientation.
referenceAxis	Axis the matrix shall be applied on.

DirectionByRotationMatrix() [2/2]

DirectionByRotationMatrix

(

DirectionByRotationMatrix

oMatrix

)

Copy constructor

Parameters

oMatrix

Object to be copied.

Member Function Documentation

Clone()

override DirectionDefinitionBase Clone

(

)

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

Returns

A new object that is a copy of this instance.

CorrespondingVector3D()

override Vector3D CorrespondingVector3D

(

)

Gets the vector resulting from the implemented direction definition.

Returns

The vector resulting from the implemented direction 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 direction of this and the otherObject shall be compared, a comparison of CorrespondingVector3D should be done.

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.