Quaternion Structure |
An efficient mathematical representation for three dimensional rotations.
Inheritance HierarchyNamespace: CFX.Structures.Geometry
Assembly: CFX (in CFX.dll) Version: 2.0.0+5bb1f71a933ed371a0f5f2d5e7db34c89b75f3ea
SyntaxThe Quaternion type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Quaternion(Vector3, Double) | Constructs a quaternion with X, Y, Z from Vector3 and rotation component from a scalar. |
| Quaternion(Double, Double, Double, Double) | Constructs a quaternion with X, Y, Z and W from four values. |
Properties
Methods| Name | Description | |
|---|---|---|
 | Add(Quaternion, Quaternion) | Creates a new Quaternion that contains the sum of two quaternions. |
| Add(Quaternion, Quaternion, Quaternion) | Creates a new Quaternion that contains the sum of two quaternions. |
| Concatenate(Quaternion, Quaternion) | Creates a new Quaternion that contains concatenation between two quaternion. |
| Concatenate(Quaternion, Quaternion, Quaternion) | Creates a new Quaternion that contains concatenation between two quaternion. |
| Conjugate | Transforms this quaternion into its conjugated version. |
| Conjugate(Quaternion) | Creates a new Quaternion that contains conjugated version of the specified quaternion. |
| Conjugate(Quaternion, Quaternion) | Creates a new Quaternion that contains conjugated version of the specified quaternion. |
| CreateFromAxisAngle(Vector3, Double) | Creates a new Quaternion from the specified axis and angle. |
| CreateFromAxisAngle(Vector3, Double, Quaternion) | Creates a new Quaternion from the specified axis and angle. |
| CreateFromRotationMatrix(Matrix44) | Creates a new Quaternion from the specified Matrix44. |
| CreateFromRotationMatrix(Matrix44, Quaternion) | Creates a new Quaternion from the specified Matrix44. |
| CreateFromYawPitchRoll(Double, Double, Double) | Creates a new Quaternion from the specified yaw, pitch and roll angles. |
| CreateFromYawPitchRoll(Double, Double, Double, Quaternion) | Creates a new Quaternion from the specified yaw, pitch and roll angles. |
| Divide(Quaternion, Quaternion) | Divides a Quaternion by the other Quaternion. |
| Divide(Quaternion, Quaternion, Quaternion) | Divides a Quaternion by the other Quaternion. |
| Dot(Quaternion, Quaternion) | Returns a dot product of two quaternions. |
| Dot(Quaternion, Quaternion, Double) | Returns a dot product of two quaternions. |
| Equals(Object) |
Compares whether current instance is equal to specified Object.
(Overrides ValueTypeEquals(Object)) |
| Equals(Quaternion) | Compares whether current instance is equal to specified Quaternion. |
| GetHashCode |
Gets the hash code of this Quaternion.
(Overrides ValueTypeGetHashCode) |
| Inverse(Quaternion) | Returns the inverse quaternion which represents the opposite rotation. |
| Inverse(Quaternion, Quaternion) | Returns the inverse quaternion which represents the opposite rotation. |
| Length | Returns the magnitude of the quaternion components. |
| LengthSquared | Returns the squared magnitude of the quaternion components. |
| Lerp(Quaternion, Quaternion, Double) | Performs a linear blend between two quaternions. |
| Lerp(Quaternion, Quaternion, Double, Quaternion) | Performs a linear blend between two quaternions. |
| Multiply(Quaternion, Quaternion) | Creates a new Quaternion that contains a multiplication of two quaternions. |
| Multiply(Quaternion, Double) | Creates a new Quaternion that contains a multiplication of Quaternion and a scalar. |
| Multiply(Quaternion, Quaternion, Quaternion) | Creates a new Quaternion that contains a multiplication of two quaternions. |
| Multiply(Quaternion, Double, Quaternion) | Creates a new Quaternion that contains a multiplication of Quaternion and a scalar. |
| Negate(Quaternion) | Flips the sign of the all the quaternion components. |
| Negate(Quaternion, Quaternion) | Flips the sign of the all the quaternion components. |
| Normalize | Scales the quaternion magnitude to unit length. |
| Normalize(Quaternion) | Scales the quaternion magnitude to unit length. |
| Normalize(Quaternion, Quaternion) | Scales the quaternion magnitude to unit length. |
| Slerp(Quaternion, Quaternion, Double) | Performs a spherical linear blend between two quaternions. |
| Slerp(Quaternion, Quaternion, Double, Quaternion) | Performs a spherical linear blend between two quaternions. |
| Subtract(Quaternion, Quaternion) | Creates a new Quaternion that contains subtraction of one Quaternion from another. |
| Subtract(Quaternion, Quaternion, Quaternion) | Creates a new Quaternion that contains subtraction of one Quaternion from another. |
| ToString |
Returns a String representation of this Quaternion in the format:
{X:[X] Y:[Y] Z:[Z] W:[W]}
(Overrides ValueTypeToString) |
Operators| Name | Description | |
|---|---|---|
 | Addition(Quaternion, Quaternion) | Adds two quaternions. |
| Division(Quaternion, Quaternion) | Divides a Quaternion by the other Quaternion. |
| Equality(Quaternion, Quaternion) | Compares whether two Quaternion instances are equal. |
| Inequality(Quaternion, Quaternion) | Compares whether two Quaternion instances are not equal. |
| Multiply(Quaternion, Quaternion) | Multiplies two quaternions. |
| Multiply(Quaternion, Double) | Multiplies the components of quaternion by a scalar. |
| Subtraction(Quaternion, Quaternion) | Subtracts a Quaternion from a Quaternion. |
| UnaryNegation(Quaternion) | Flips the sign of the all the quaternion components. |
Fields| Name | Description | |
|---|---|---|
 | W | The rotation component of this Quaternion. |
| X | The x coordinate of this Quaternion. |
| Y | The y coordinate of this Quaternion. |
| Z | The z coordinate of this Quaternion. |
See Also