Table of Contents

Class OrientationByMatrix

Namespace
VirtualLabAPI.Core.Numerics
Assembly
VirtualLabAPI.dll

A class for defining orientations via a rotation matrix.

[Serializable]
public class OrientationByMatrix : OrientationDefinitionBase, IEquatable<IObjectBase>, ISerializable, IDeserializationCallback, ICloneable
Inheritance
ObjectBase
SerializableObjectBase
ManualSerialization
OrientationByMatrix
Implements
IEquatable<IObjectBase>
Inherited Members

Constructors

OrientationByMatrix()

Default constructor. Creates an identity rotation matrix.

public OrientationByMatrix()

OrientationByMatrix(Matrix3x3D)

Constructor which gets a rotation matrix.

public OrientationByMatrix(Matrix3x3D rotationMatrix)

Parameters

rotationMatrix Matrix3x3D

Rotation matrix which describes the orientation.

OrientationByMatrix(OrientationByMatrix)

Copy constructor.

public OrientationByMatrix(OrientationByMatrix oMatrix)

Parameters

oMatrix OrientationByMatrix

Object to be copied.

Properties

DefinitionType

Gets the OrientationDefinitionType associated this orientation.

public override OrientationDefinitionType DefinitionType { get; }

Property Value

OrientationDefinitionType

ListOfRotations

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

public override List<SimpleRotation> ListOfRotations { get; }

Property Value

List<SimpleRotation>

RotationMatrix

The 3x3-matrix which defines the rotation.

public Matrix3x3D RotationMatrix { get; set; }

Property Value

Matrix3x3D

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

Overridden ToString method.

public override string ToString()

Returns

string

A string that represents this instance.