UnsafeNativeMethods.Quaternion.RotationAxis Method

Language:

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 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
);

C++ public:
static Quaternion RotationAxis(
    Quaternion pOut,
    Vector3 pAxis,
    float angle
);

JScript public static function RotationAxis(
    pOut : Quaternion,
    pAxis : Vector3,
    angle : float
) : Quaternion;

Visual Basic	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 );
C++	public: static Quaternion RotationAxis( Quaternion pOut, Vector3 pAxis, float angle );
JScript	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. This allows you to use the RotationAxis method as a parameter for another method.

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.