Function directx_math::XMPlaneDotCoord [−][src]
pub fn XMPlaneDotCoord(P: FXMVECTOR, V: FXMVECTOR) -> XMVECTOR
Calculates the dot product between an input plane and a 3D vector.
Parameters
P
XMVECTOR describing the plane coefficients (A
, B
, C
, D
) for the plane equation Ax+By+Cz+D=0
.
V
3D vector to use in the dot product. The w
component of V
is always treated as if is 1.0
.
Return value
Returns the dot product between P
and V
replicated into each of the four components of the returned
XMVECTOR.
Remarks
This function can be useful in finding the signed distance from a point to a plane. The following pseudocode demonstrates the operation of the function.
XMVECTOR vectorOut;
vectorOut.x = P.x * V.x + P.y * V.y + P.z * V.z + P.w * 1.0f;
vectorOut.y = P.x * V.x + P.y * V.y + P.z * V.z + P.w * 1.0f;
vectorOut.z = P.x * V.x + P.y * V.y + P.z * V.z + P.w * 1.0f;
vectorOut.w = P.x * V.x + P.y * V.y + P.z * V.z + P.w * 1.0f;
return vectorOut;
Reference
https://docs.microsoft.com/en-us/windows/win32/api/directxmath/nf-directxmath-XMPlaneDotCoord