XMPlaneDotNormal

Calculates the dot product between the normal vector of a plane and a 3D vector.

Syntax

XMVECTOR XMPlaneDotNormal(
         XMVECTOR P,
         XMVECTOR V
)  

Parameters

P
Type: XMVECTOR 

XMVECTOR describing the plane coefficients (A, B, C, D) for the plane equation

XMVECTOR vectorOut;

vectorOut.x = P.x * V.x + P.y * V.y + P.z * V.z;
vectorOut.y = P.x * V.x + P.y * V.y + P.z * V.z;
vectorOut.z = P.x * V.x + P.y * V.y + P.z * V.z;
vectorOut.w = P.x * V.x + P.y * V.y + P.z * V.z;

return vectorOut;  

.

V
Type: XMVECTOR 

3D vector to use in the dot product. The w component of V is always treated as if is 0.0f.

Return value

Type: XMVECTOR 

Returns the dot product between the normal vector of the plane and V replicated into each of the four components of the returned XMVECTOR.

Remarks

This function is useful for calculating the angle between the normal vector of the plane, and another normal vector. The following pseudocode demonstrates the operation of the function.
Ax+By+Cz+D=0

Requirements

Header: Declared in directxmath.h.