Microsoft DirectX 9.0 SDK Update (October 2004)

UnsafeNativeMethods.Quaternion.RotationAxis Method

Language:

Note: This documentation is preliminary and is subject to change.

Builds a quaternion that is rotated around an arbitrary axis.

Note: For programming in Microsoft® Visual Basic® .NET or Microsoft® JScript® .NET, use the equivalent method in the Microsoft.DirectX structures.

Definition

Visual Basic .NET Public Shared Function RotationAxis( _
    ByVal pOut As Quaternion, _
    ByVal pAxis As Vector3, _
    ByVal angle As Single _
) As Quaternion
C# public static Quaternion RotationAxis(
    Quaternion pOut,
    Vector3 pAxis,
    float angle
);
Managed C++ public: static Quaternion RotationAxis(
    Quaternion pOut,
    Vector3 pAxis,
    float angle
);
JScript .NET public static function RotationAxis(
    pOut : Quaternion,
    pAxis : Vector3,
    angle : float
) : Quaternion;

Parameters

pOut Microsoft.DirectX.Quaternion. A Quaternion structure that is rotated around the specified axis.
pAxis Microsoft.DirectX.Vector3. A Vector3 structure that identifies the axis about which to rotate the quaternion.
angle System.Single. Angle of rotation, in radians. Angles are measured clockwise when looking along the rotation axis toward the origin.

Return Value

Microsoft.DirectX.Quaternion . A Quaternion structure that is rotated around the specified axis.

Remarks

The return value for this method is the same value returned in the pOut parameter. Resultantly, the RotationAxis method can be used as a parameter for another method.

See Also


© 2004 Microsoft Corporation. All rights reserved. Terms of use.

Feedback? Please provide us with your comments on this topic.
For more help, visit the DirectX Developer Center