OrientationBySphereAngles 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 sphere angles. More...

Inheritance diagram for OrientationBySphereAngles:

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.
	OrientationBySphereAngles ()
	Default constructor, setting all angles to zero.
	OrientationBySphereAngles (double phi, double theta)
	Constructor with sphere angles only.
	OrientationBySphereAngles (double phi, double theta, double zeta)
	Constructor with all angles.
	OrientationBySphereAngles (double phi, double theta, double zeta, bool sphereAnglesApplicationBeforeZetaRotation)
	Constructor with all parameters.
	OrientationBySphereAngles (OrientationBySphereAngles orientationToCopy)
	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
double	AnglePhi [get, set]
	Gets and sets the sphere angle phi, measured in the x-y-plane from the x-axis. It represents a rotation about the z-axis. In case of SphereAnglesApplicationBeforeZetaRotation == false the flag PhiRefersToRotatedXAxis determines, whether this angle is measured from the old x-axis or the new x'-axis.
double	AngleTheta [get, set]
	Gets and sets the sphere angle theta, measured from the z-axis in a plane constructed by rotating the x-z-plane by the other sphere angle phi.
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 sphere angles, which is defined by SphereAnglesApplicationBeforeZetaRotation. If this rotation is performed first, the flag PhiRefersToRotatedXAxis indicates, if the AnglePhi refers to the not rotated x-axis anyway.
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]
bool	SphereAnglesApplicationBeforeZetaRotation [get, set]
	Gets or sets if the inclination of the z-axis by applying the sphere angles shall be done before the rotation about the z-axis (by AngleZeta).
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 sphere angles.

Constructor & Destructor Documentation

OrientationBySphereAngles() [1/4]

OrientationBySphereAngles	(	double	phi,
		double	theta
	)

Constructor with sphere angles only.

Parameters

phi	sphere angle phi, measured in the x-y-plane from the x-axis. It represents a rotation about the z-axis.
theta	sphere angle theta, measured from the z-axis in a plane constructed by rotating the x-z-plane by the other sphere angle phi.

OrientationBySphereAngles() [2/4]

OrientationBySphereAngles	(	double	phi,
		double	theta,
		double	zeta
	)

Constructor with all angles.

Parameters

phi	sphere angle phi, measured in the x-y-plane from the x-axis. It represents a rotation about the z-axis.
theta	sphere angle theta, measured from the z-axis in a plane constructed by rotating the x-z-plane by the other sphere angle phi.
zeta	angle zeta which is a rotation about the z-axis.

OrientationBySphereAngles() [3/4]

OrientationBySphereAngles	(	double	phi,
		double	theta,
		double	zeta,
		bool	sphereAnglesApplicationBeforeZetaRotation
	)

Constructor with all parameters.

Parameters

phi	sphere angle phi, measured in the x-y-plane from the x-axis. It represents a rotation about the z-axis.
theta	sphere angle theta, measured from the z-axis in a plane constructed by rotating the x-z-plane by the other sphere angle phi.
zeta	angle zeta which is a rotation about the z-axis.
sphereAnglesApplicationBeforeZetaRotation	flag, indicating if the inclination of the z-axis by applying the sphere angles shall be done before the rotation about the z-axis (by AngleZeta).

OrientationBySphereAngles() [4/4]

OrientationBySphereAngles

(

OrientationBySphereAngles

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

override string ToString

(

)

Overridden ToString method.

Returns

A System.String that represents this instance.