Class OrientationByEulerAngles

Namespace

VirtualLabAPI.Core.Numerics

Assembly

VirtualLabAPI.dll

A class for defining orientations by Euler angles.

[Serializable]
public class OrientationByEulerAngles : OrientationDefinitionBase, IEquatable<IObjectBase>, ISerializable, IDeserializationCallback, ICloneable

Inheritance

object

ObjectBase

SerializableObjectBase

ManualSerialization

OrientationDefinitionBase

OrientationByEulerAngles

Implements

IEquatable<IObjectBase>

ISerializable

IDeserializationCallback

ICloneable

Inherited Members

OrientationDefinitionBase.IsEquivalent(OrientationDefinitionBase)

OrientationDefinitionBase.ConvertOrientationDefinition(OrientationDefinitionBase, OrientationDefinitionType)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Constructors

OrientationByEulerAngles()

Default constructor, setting all Euler angles to zero.

public OrientationByEulerAngles()

OrientationByEulerAngles(double, double, double)

Constructor with three angles to be set as Euler angles.

public OrientationByEulerAngles(double eulerPsi, double eulerTheta, double eulerPhi)

Parameters

eulerPsi double

Angle between old x-axis and line of nodes

eulerTheta double

Angle between old and new z-axis

eulerPhi double

Angle between line of nodes and new x-axis

OrientationByEulerAngles(EulerAnglesSet)

Constructor that gets Euler angles as one set.

public OrientationByEulerAngles(EulerAnglesSet eulerAnglesSet)

Parameters

eulerAnglesSet EulerAnglesSet

Set of Euler angles.

OrientationByEulerAngles(OrientationByEulerAngles)

Copy constructor.

public OrientationByEulerAngles(OrientationByEulerAngles orientationToCopy)

Parameters

orientationToCopy OrientationByEulerAngles

Orientation object to copy.

Properties

AngleEulerPhi

Gets or sets the value of the Euler angle phi.

public double AngleEulerPhi { get; set; }

Property Value

double

AngleEulerPsi

Gets or sets the value of the Euler angle psi.

public double AngleEulerPsi { get; set; }

Property Value

double

AngleEulerTheta

Gets or sets the value of the Euler angle theta.

public double AngleEulerTheta { get; set; }

Property Value

double

DefinitionType

Gets the OrientationDefinitionType associated this orientation.

public override OrientationDefinitionType DefinitionType { get; }

Property Value

OrientationDefinitionType

EulerAngles

Gets and sets the Euler angles which define a rotation.

public EulerAnglesSet EulerAngles { get; set; }

Property Value

EulerAnglesSet

ListOfRotations

Gets a list of simple rotations, describing the complete rotation as a sequence.

public override List<SimpleRotation> ListOfRotations { get; }

Property Value

List<SimpleRotation>

ParameterRunParameters

Gets all available parameters. For variable parameters (i.e. those double and int parameters which can be used in the Parameter Run, Parametric Optimization and so on) add a VaryParameterInfo object (derived from Parameter class) to the returned list.

public override List<Parameter> ParameterRunParameters { get; }

Property Value

List<Parameter>

Methods

Clone()

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

public override object Clone()

Returns

object

A new object that is a copy of this instance.

CorrespondingQuaternion()

Gets the quaternion corresponding to this orientation definition.

public override Quaternion CorrespondingQuaternion()

Returns

Quaternion

The quaternion corresponding to this orientation definition.

Equals(object, 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.

public override bool Equals(object otherObject, EqualityIntent equalityIntent)

Parameters

otherObject object

The object to compare with this instance.

equalityIntent EqualityIntent

Defines what kind of equality you want to check when comparing two objects, for example all values or physical equality.

Returns

bool

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

ToString()

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

public override string ToString()

Returns

string

String containing the Euler angles information.

ToString(int)

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

public string ToString(int digitPrecision)

Parameters

digitPrecision int

number of digits the values are rounded to.

Returns

string

String containing the Euler angles information.