DirectionByRotationSequence 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 directions by applying a sequence of axis rotations to a starting vector. More...

Inheritance diagram for DirectionByRotationSequence:

Public Member Functions
override DirectionDefinitionBase	Clone ()
	Creates a new object that is a copy of the current instance.
override Vector3D	CorrespondingVector3D ()
	Gets the vector resulting from the implemented direction definition.
	DirectionByRotationSequence ()
	Default constructor. Creates an empty list that represents no rotations at all.
	DirectionByRotationSequence (DirectionByRotationSequence rotationSequence)
	Copy constructor.
	DirectionByRotationSequence (List< SimpleRotation > rotationList, AxisDirection referenceAxis=AxisDirection.Z)
	Constructor that gets a list of simple rotations (SimpleRotation) and the flag indicating whether the rotation axes are fix.
override bool	Equals (object otherObject, EqualityIntent 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.
override string	ToString ()
	Overridden ToString method.

Properties
int	Count [get]
	Gets the number of rotations.
override DirectionDefinitionType	DefinitionType [get]
	Gets the DirectionDefinitionType.
AxisDirection	ReferenceAxis [get, set]
	The reference axis the rotation sequence is applied to.
List< SimpleRotation >	RotationSequenceList [get, set]
	Get or set the complete list of simple rotations.
SimpleRotation	this[int index] [get, set]
	Indexer to get or set the rotation for a certain index.

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 directions by applying a sequence of axis rotations to a starting vector.

Constructor & Destructor Documentation

DirectionByRotationSequence() [1/2]

DirectionByRotationSequence	(	List< SimpleRotation >	rotationList,
		AxisDirection	referenceAxis = AxisDirection::Z
	)

Constructor that gets a list of simple rotations (SimpleRotation) and the flag indicating whether the rotation axes are fix.

Parameters

rotationList	List of simple rotations determining the rotation sequence
referenceAxis	Axis the rotation sequence shall be applied to.

DirectionByRotationSequence() [2/2]

DirectionByRotationSequence

(

DirectionByRotationSequence

rotationSequence

)

Copy constructor.

Parameters

rotationSequence

Rotation sequence to copy

Member Function Documentation

Clone()

override DirectionDefinitionBase Clone

(

)

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

Returns

A new object that is a copy of this instance.

CorrespondingVector3D()

override Vector3D CorrespondingVector3D

(

)

Gets the vector resulting from the implemented direction definition.

Returns

The vector resulting from the implemented direction 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 direction of this and the otherObject shall be compared, a comparison of CorrespondingVector3D should be done.

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.

Property Documentation

this[int index]

SimpleRotation this[int index]

getset

Indexer to get or set the rotation for a certain index.

Parameters

index

The index of the rotation.

Returns

The rotation with the given index.