Class DirectionByRotationMatrix

Namespace

VirtualLabAPI.Core.Numerics

Assembly

VirtualLabAPI.dll

A class for defining directions by applying a rotation matrix to a starting vector.

[Serializable]
public class DirectionByRotationMatrix : DirectionDefinitionBase, IEquatable<IObjectBase>, ICloneable, ISerializable, IDeserializationCallback

Inheritance

object

ObjectBase

SerializableObjectBase

ManualSerialization

DirectionDefinitionBase

DirectionByRotationMatrix

Implements

IEquatable<IObjectBase>

ICloneable

ISerializable

IDeserializationCallback

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Constructors

DirectionByRotationMatrix()

Default constructor. Creates an identity rotation matrix.

public DirectionByRotationMatrix()

DirectionByRotationMatrix(DirectionByRotationMatrix)

Copy constructor.

public DirectionByRotationMatrix(DirectionByRotationMatrix oMatrix)

Parameters

oMatrix DirectionByRotationMatrix

Object to be copied.

DirectionByRotationMatrix(Matrix3x3D, AxisDirection)

Constructor which gets a rotation matrix.

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

Parameters

rotationMatrix Matrix3x3D

Rotation matrix which describes the orientation.

referenceAxis AxisDirection

Axis the matrix shall be applied on.

Properties

DefinitionType

Gets the DirectionDefinitionType.

public override DirectionDefinitionType DefinitionType { get; }

Property Value

DirectionDefinitionType

ReferenceAxis

The reference axis the matrix is applied to.

public AxisDirection ReferenceAxis { get; set; }

Property Value

AxisDirection

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

Returns

DirectionDefinitionBase

A new object that is a copy of this instance.

CorrespondingVector3D()

Gets the vector resulting from the implemented direction definition.

public override Vector3D CorrespondingVector3D()

Returns

Vector3D

The vector resulting from the implemented direction definition.

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

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.