UnsafeNativeMethods.Quaternion.Ln Method

Language:

Calculates the natural logarithm.

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 Ln( _
    ByVal pOut As Quaternion, _
    ByVal pQuat As Quaternion _
) As Quaternion

C# public static Quaternion Ln(
    Quaternion pOut,
    Quaternion pQuat
);

C++ public:
static Quaternion Ln(
    Quaternion pOut,
    Quaternion pQuat
);

JScript public static function Ln(
    pOut : Quaternion,
    pQuat : Quaternion
) : Quaternion;

Visual Basic	Public Shared Function Ln( _ ByVal pOut As Quaternion, _ ByVal pQuat As Quaternion _ ) As Quaternion
C#	public static Quaternion Ln( Quaternion pOut, Quaternion pQuat );
C++	public: static Quaternion Ln( Quaternion pOut, Quaternion pQuat );
JScript	public static function Ln( pOut : Quaternion, pQuat : Quaternion ) : Quaternion;

Parameters

pOut Microsoft.DirectX.Quaternion
A Quaternion structure that is the natural logarithm 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 natural logarithm of the quaternion passed into the pQuat parameter.

Remarks

The Ln method works only for unit quaternions.

A unit quaternion is defined by the following example.
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 Ln method as a parameter for another method.

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