Class OrientationDefinitionBase

Namespace

VirtualLabAPI.Core.Numerics

Assembly

VirtualLabAPI.dll

Base for all classes that describe a rotation definition.

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

Inheritance

object

ObjectBase

SerializableObjectBase

ManualSerialization

OrientationDefinitionBase

Implements

IEquatable<IObjectBase>

ISerializable

IDeserializationCallback

ICloneable

Derived

AxisRotationSequence

OrientationByCartesianAngles

OrientationByDirectionAngles

OrientationByEulerAngles

OrientationByMatrix

OrientationBySphereAngles

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

OrientationDefinitionBase()

Default constructor

public OrientationDefinitionBase()

Properties

DefinitionType

Gets the OrientationDefinitionType associated this orientation.

public abstract OrientationDefinitionType DefinitionType { get; }

Property Value

OrientationDefinitionType

ListOfRotations

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

public abstract 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 virtual List<Parameter> ParameterRunParameters { get; }

Property Value

List<Parameter>

Methods

ConvertOrientationDefinition(OrientationDefinitionBase, OrientationDefinitionType)

Method which converts any orientation definition object into an equivalent definition object of another type.

public static OrientationDefinitionBase ConvertOrientationDefinition(OrientationDefinitionBase sourceOrientation, OrientationDefinitionType targetType)

Parameters

sourceOrientation OrientationDefinitionBase

Orientation definition to be converted.

targetType OrientationDefinitionType

Type of the orientation needed.

Returns

OrientationDefinitionBase

Converted orientation definition.

CorrespondingQuaternion()

Gets the quaternion corresponding to this orientation definition.

public abstract Quaternion CorrespondingQuaternion()

Returns

Quaternion

The quaternion corresponding to this orientation definition.

IsEquivalent(OrientationDefinitionBase)

Determines whether another orientation definition is equivalent.

public virtual bool IsEquivalent(OrientationDefinitionBase orientationDefinitionToCompare)

Parameters

orientationDefinitionToCompare OrientationDefinitionBase

IOrientationDefinition which has to be compared.

Returns

bool

True, if the two objects are equivalent, false otherwise.