Share via

UnsafeNativeMethods.Quaternion.Invert(Quaternion,Quaternion) Method (Microsoft.DirectX)

  • Article

Conjugates and re-normalizes a quaternion.

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

Parameters

pOut Microsoft.DirectX.Quaternion
A Quaternion structure that is the inverse of the quaternion passed into the pQuat parameter.
pQuat Microsoft.DirectX.Quaternion
Source Quaternion structure.

Return Value

Microsoft.DirectX.Quaternion
A Quaternion structure that is the inverse of the quaternion passed into the pQuat parameter.

Remarks

A unit quaternion is defined by the following equation.

q == (cos(theta), sin(theta) * v) where |v| = 1
The natural logarithm of q is ln(q) = (0, theta * v)

The return value for this method is the same value returned in the pOut parameter. This allows you to use the Invert method as a parameter for another method.

See Also