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: 24.2.419.0 (24.2.419.0)
SyntaxThe AngleAxisRotation type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | AngleAxisRotation(Double) |
Initializes a set of AngleAxisRotation coordinates from the first 4 consecutive elements in the provided array.
|
| AngleAxisRotation(ElementaryRotation) |
Initializes a set of AngleAxisRotation coordinates from the provided ElementaryRotation.
|
| AngleAxisRotation(EulerSequence) |
Initializes a set of AngleAxisRotation coordinates from the provided EulerSequence.
|
| AngleAxisRotation(Matrix3By3) |
Initializes a set of AngleAxisRotation coordinates from the provided Matrix3By3.
|
| AngleAxisRotation(UnitQuaternion) |
Initializes a set of AngleAxisRotation coordinates from the provided UnitQuaternion.
|
| AngleAxisRotation(YawPitchRoll) |
Initializes a set of AngleAxisRotation coordinates from the provided YawPitchRoll.
|
| AngleAxisRotation(Double, UnitCartesian) |
Initializes a set of AngleAxisRotation coordinates from the provided values.
|
| AngleAxisRotation(Double, Int32) |
Initializes a set of AngleAxisRotation coordinates from the provided array.
|
Properties| Name | Description | |
|---|---|---|
 | Angle |
Gets the angle coordinate.
|
| Axis |
Gets the unit vector representation the axis of rotation.
|
| Item |
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.
|
| Length |
Gets the number of elements.
|
 | Zero |
Gets the set of AngleAxisRotation coordinates representing the zero vector.
|
Methods| Name | Description | |
|---|---|---|
| Equals(AngleAxisRotation) |
Indicates whether another instance of this type is exactly equal to this instance.
|
| Equals(Object) |
Indicates whether another object is exactly equal to this instance.
(Overrides ValueTypeEquals(Object).) |
| EqualsEpsilon |
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.
|
| GetHashCode |
Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
(Overrides ValueTypeGetHashCode.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Invert |
Returns the inverse of this angle-axis rotation.
|
| Multiply |
Multiplies this instance by a scalar, yielding a new AngleAxisRotation.
|
| ToString |
Returns the value of this set of AngleAxisRotation coordinates in the form "angle, axis"
(Overrides ValueTypeToString.) |
Operators| Name | Description | |
|---|---|---|
 | Equality |
Returns if the two instances are exactly equal.
|
| Inequality |
Returns if the two instances are not exactly equal.
|
| Multiply(AngleAxisRotation, Double) |
Multiplies a specified AngleAxisRotation by a scalar, yielding a new AngleAxisRotation.
|
| Multiply(Double, AngleAxisRotation) |
Multiplies a scalar by a specified AngleAxisRotation, yielding a new AngleAxisRotation.
|
See Also