Click or drag to resize

AngleAxisRotation Structure

Represents a rotation as a unit vector indicating the axis of rotation and an angle indicating the amount of rotation about the axis.

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 AngleAxisRotation : IEquatable<AngleAxisRotation>

The AngleAxisRotation type exposes the following members.

Constructors
  NameDescription
Public methodAngleAxisRotation(Double)
Initializes a set of AngleAxisRotation coordinates from the first 4 consecutive elements in the provided array.
Public methodAngleAxisRotation(ElementaryRotation)
Initializes a set of AngleAxisRotation coordinates from the provided ElementaryRotation.
Public methodAngleAxisRotation(EulerSequence)
Initializes a set of AngleAxisRotation coordinates from the provided EulerSequence.
Public methodAngleAxisRotation(Matrix3By3)
Initializes a set of AngleAxisRotation coordinates from the provided Matrix3By3.
Public methodAngleAxisRotation(UnitQuaternion)
Initializes a set of AngleAxisRotation coordinates from the provided UnitQuaternion.
Public methodAngleAxisRotation(YawPitchRoll)
Initializes a set of AngleAxisRotation coordinates from the provided YawPitchRoll.
Public methodAngleAxisRotation(Double, UnitCartesian)
Initializes a set of AngleAxisRotation coordinates from the provided values.
Public methodAngleAxisRotation(Double, Int32)
Initializes a set of AngleAxisRotation coordinates from the provided array.
Top
Properties
  NameDescription
Public propertyAngle
Gets the angle coordinate.
Public propertyAxis
Gets the unit vector representation the axis of rotation.
Public propertyItem
Gets the value of the specified element with 0, 1, 2, and 3 corresponding to the elements Angle, Axis.X, Axis.Y, and Axis.Z.
Public propertyLength
Gets the number of elements.
Public propertyStatic memberZero
Gets the set of AngleAxisRotation coordinates representing the zero vector.
Top
Methods
  NameDescription
Public methodEquals(Object)
Indicates whether another object is exactly equal to this instance.
(Overrides ValueTypeEquals(Object).)
Public methodEquals(AngleAxisRotation)
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 two items 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
Returns the inverse of this angle-axis rotation.
Public methodMultiply
Multiplies this instance by a scalar, yielding a new AngleAxisRotation.
Public methodToString
Returns the value of this set of AngleAxisRotation coordinates in the form "angle, axis"
(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, AngleAxisRotation)
Multiplies a scalar by a specified AngleAxisRotation, yielding a new AngleAxisRotation.
Public operatorStatic memberMultiply(AngleAxisRotation, Double)
Multiplies a specified AngleAxisRotation by a scalar, yielding a new AngleAxisRotation.
Top
See Also