OrientationByCartesianAngles 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 Cartesian angles, i.e. the angles between the projection of the direction to be defined onto the x-z-plane and the z-axis (alpha), and between the projection of the direction to be defined onto the y-z-plane and the z-axis (beta). More...

Inheritance diagram for OrientationByCartesianAngles:

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.
	OrientationByCartesianAngles ()
	Default constructor, setting alpha, beta and zeta to zero.
	OrientationByCartesianAngles (double alpha, double beta)
	Constructor with the Cartesian angles only.
	OrientationByCartesianAngles (double alpha, double beta, double zeta)
	Constructor with all angles.
	OrientationByCartesianAngles (double alpha, double beta, double zeta, bool cartesianAnglesApplicationBeforeZetaRotation)
	Constructor with all parameters.
	OrientationByCartesianAngles (OrientationByCartesianAngles orientationToCopy)
	Copy constructor.
void	SetCartesianAngles (double alpha, double beta)
	Sets the direction angles alpha, beta and gamma. The squared cosines of alpha, beta and gamma have to sum to 1.
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
double	AngleAlpha [get, set]
	Gets and sets the Cartesian angle alpha, which is the angle between the z-axis and the projection of the direction to be defined onto the x-z-plane.
double	AngleBeta [get, set]
	Gets and sets the Cartesian angle beta, which is the angle between the projection of the direction to be defined onto the y-z-plane and the z-axis.
double	AngleZeta [get, set]
	Gets and sets the angle zeta which is a rotation about the z-axis. This rotation can be performed either before or after applying the direction angles, which is defined by CartesianAnglesApplicationBeforeZetaRotation. If this rotation is performed first, the flag AnglesReferToCSRotatedByZeta indicates, if the direction angles refer to the not rotated CS anyway.
bool	CartesianAnglesApplicationBeforeZetaRotation [get, set]
	Gets or sets if the inclination of the z-axis by applying the direction angles shall be done before the rotation about the z-axis (by AngleZeta).
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 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 Cartesian angles, i.e. the angles between the projection of the direction to be defined onto the x-z-plane and the z-axis (alpha), and between the projection of the direction to be defined onto the y-z-plane and the z-axis (beta).

Constructor & Destructor Documentation

OrientationByCartesianAngles() [1/4]

OrientationByCartesianAngles	(	double	alpha,
		double	beta
	)

Constructor with the Cartesian angles only.

Parameters

alpha	Angle between the projection of the direction to be defined onto the x-z-plane and the z-axis.
beta	Angle between the projection of the direction to be defined onto the y-z-plane and the z-axis.

OrientationByCartesianAngles() [2/4]

OrientationByCartesianAngles	(	double	alpha,
		double	beta,
		double	zeta
	)

Constructor with all angles.

Parameters

alpha	Angle between the projection of the direction to be defined onto the x-z-plane and the z-axis.
beta	Angle between the projection of the direction to be defined onto the y-z-plane and the z-axis.
zeta	angle zeta which is a rotation about the z-axis.

OrientationByCartesianAngles() [3/4]

OrientationByCartesianAngles	(	double	alpha,
		double	beta,
		double	zeta,
		bool	cartesianAnglesApplicationBeforeZetaRotation
	)

Constructor with all parameters.

Parameters

alpha	Angle between the projection of the direction to be defined onto the x-z-plane and the z-axis.
beta	Angle between the projection of the direction to be defined onto the y-z-plane and the z-axis.
zeta	angle zeta which is a rotation about the z-axis.
cartesianAnglesApplicationBeforeZetaRotation	flag, if the inclination of the z-axis by applying the direction angles shall be done before the rotation about the z-axis (by AngleZeta).

OrientationByCartesianAngles() [4/4]

OrientationByCartesianAngles

(

OrientationByCartesianAngles

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.

SetCartesianAngles()

void SetCartesianAngles	(	double	alpha,
		double	beta
	)

Sets the direction angles alpha, beta and gamma. The squared cosines of alpha, beta and gamma have to sum to 1.

Parameters

alpha	Angle between x-axis and the direction to define.
beta	Angle between y-axis and the direction to define.

ToString()

override string ToString

(

)

Overridden ToString method.

Returns

A System.String that represents this instance.