Quaternion Structure (Microsoft.DirectX)
Describes a quaternion.
Definition
Visual Basic Public Structure Quaternion C# public struct Quaternion C++ public value class Quaternion sealed JScript In JScript, you can use structures, but you cannot define your own.
Members Table
The following table lists the members exposed by the object.
Fields
Field Description W Retrieves or sets the w component of the quaternion. X Retrieves or sets the x component of the quaternion. Y Retrieves or sets the y component of the quaternion. Z Retrieves or sets the z component of the quaternion. Methods
Method Description Add
Adds two quaternions. Returns a quaternion in barycentric coordinates. Returns the conjugate of a quaternion. Returns the dot product of two quaternions. Equals Returns a value that indicates whether the current instance is equal to a specified object. Exp Calculates the exponential. GetHashCode Returns the hash code for the current instance. Invert Conjugates and re-normalizes a quaternion. Length Returns the length of a quaternion. LengthSq Returns the square of a quaternion's length. Ln Calculates the natural logarithm. Multiply Multiplies two quaternions. Normalize Returns the normal of a quaternion. Adds two quaternions. Compares the current instance of a class to another instance to determine whether they are the same. Compares the current instance of a class to another instance to determine whether they are different. Determines the product of two quaternions. Subtracts two quaternions. Quaternion Initializes a new instance of the Quaternion class. RotateAxis Rotates a quaternion around an arbitrary axis. RotateMatrix Builds a quaternion from a rotation matrix. RotateYawPitchRoll Builds a quaternion with the given yaw, pitch, and roll. Builds a quaternion that is rotated around an arbitrary axis. Builds a quaternion from a rotation matrix. Builds a quaternion with the given yaw, pitch, and roll. Interpolates between two quaternions, using spherical linear interpolation. Interpolates between quaternions, using spherical quadrangle interpolation. Sets up control points for spherical quadrangle interpolation. Subtracts two quaternion instances. Computes a quaternion's axis and angle of rotation. ToString Obtains a string representation of the current instance. Properties
Property Description Retrieves the identity quaternion. Retrieves an empty quaternion.
Remarks
Quaternions add a fourth element to the [ x, y, z] values that define a vector, resulting in arbitrary 4-D vectors. However, the following example illustrates how each element of a unit quaternion relates to an axis-angle rotation, where q represents a unit quaternion (x, y, z, w), axis is normalized, and theta is the desired counterclockwise (CCW) rotation around the axis.
q.x = sin(theta/2) * axis.x q.y = sin(theta/2) * axis.y q.z = sin(theta/2) * axis.z q.w = cos(theta/2)
Structure Information
Namespace Microsoft.DirectX Assembly Microsoft.DirectX (microsoft.directx.dll) Strong Name Microsoft.DirectX, Version=1.0.900.0, Culture=neutral, PublicKeyToken=d3231b57b74a1492
See Also