Microsoft DirectX 9.0 SDK Update (October 2004)

UnsafeNativeMethods.Quaternion.Exp Method

Language:

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

Calculates the exponential.

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 Exp( _
    ByVal pOut As Quaternion, _
    ByVal pQuat As Quaternion _
) As Quaternion
C# public static Quaternion Exp(
    Quaternion pOut,
    Quaternion pQuat
);
Managed C++ public: static Quaternion Exp(
    Quaternion pOut,
    Quaternion pQuat
);
JScript .NET public static function Exp(
    pOut : Quaternion,
    pQuat : Quaternion
) : Quaternion;

Parameters

pOut Microsoft.DirectX.Quaternion. The Quaternion structure that is the exponential of the pQuat parameter.
pQuat Microsoft.DirectX.Quaternion. Source Quaternion structure.

Return Value

Microsoft.DirectX.Quaternion . The Quaternion structure that is the exponential of the pQuat parameter.

Remarks

The Exp method converts a pure quaternion to a unit quaternion. The method expects a pure quaternion, where w is ignored in the calculation (w == 0). In the following example, v represents the vector portion of a quaternion.

Given a pure quaternion defined by:
q = (0, theta * v); 

This method calculates the exponential result.
exp(Q) = (cos(theta), sin(theta) * v)

The return value for this method is the same value returned in the pOut parameter. Resultantly, the Exp 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