Click or drag to resize

ElementaryRotation Structure

Represents a rotation about a principal axis. This represents an 'alias' rotation which transforms coordinates by modifying the underlying coordinate basis, rather than modifying the coordinates themselves. To transform a Cartesian with this rotation, see Rotate(UnitQuaternion).

Namespace:  AGI.Foundation.Coordinates
Assembly:  AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 19.2.399.0 (19.2.399.0)
Syntax
public struct ElementaryRotation : IEquatable<ElementaryRotation>

The ElementaryRotation type exposes the following members.

Constructors
  NameDescription
Public methodElementaryRotation
Initializes an ElementaryRotation from the provided values.
Top
Properties
  NameDescription
Public propertyAngle
Gets the angle of rotation.
Public propertyAxis
Gets the axis of rotation.
Top
Methods
  NameDescription
Public methodEquals(Object)
Indicates whether another object is exactly equal to this instance.
(Overrides ValueTypeEquals(Object).)
Public methodEquals(ElementaryRotation)
Indicates whether another instance of this type is exactly equal to this instance.
Public methodEqualsEpsilon
Returns true if all of the elements of this rotation are within epsilon of the same elements of the specified rotation. That is, in order for the rotations to be considered equal (and for this function to return true), the absolute value of the difference between each of their elements must be less than or equal to epsilon.
Public methodGetHashCode
Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
(Overrides ValueTypeGetHashCode.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInvert
Inverts this instance, yielding a new ElementaryRotation.
Public methodMultiply(Double)
Multiplies this instance by a scalar, yielding a new ElementaryRotation.
Public methodMultiply(ElementaryRotation)
Multiplies this instance by the specified ElementaryRotation, yielding a Matrix3By3.
Public methodMultiply(Matrix3By3)
Multiplies this instance by the specified Matrix3By3, yielding a Matrix3By3.
Public methodMultiply(UnitQuaternion)
Multiplies this instance by the specified UnitQuaternion, yielding a UnitQuaternion.
Public methodToString
Returns the value of this set of ElementaryRotation coordinates in the form "axis, angle"
(Overrides ValueTypeToString.)
Top
Operators
  NameDescription
Public operatorStatic memberEquality
Returns if the two instances are exactly equal.
Public operatorStatic memberInequality
Returns if the two instances are not exactly equal.
Public operatorStatic memberMultiply(Double, ElementaryRotation)
Multiplies a scalar by a specified ElementaryRotation, yielding a new ElementaryRotation.
Public operatorStatic memberMultiply(ElementaryRotation, ElementaryRotation)
Multiplies a specified ElementaryRotation by a specified ElementaryRotation, yielding a new Matrix3By3.
Public operatorStatic memberMultiply(ElementaryRotation, Matrix3By3)
Multiplies a specified ElementaryRotation by a specified Matrix3By3, yielding a new Matrix3By3.
Public operatorStatic memberMultiply(ElementaryRotation, UnitQuaternion)
Multiplies a specified ElementaryRotation by a specified UnitQuaternion, yielding a new Quaternion.
Public operatorStatic memberMultiply(ElementaryRotation, Double)
Multiplies a specified ElementaryRotation by a scalar, yielding a new ElementaryRotation.
Top
Remarks
For more information, see the Coordinates topic.
See Also