UnsafeNativeMethods.Plane.Dot Method

Language:

Computes the dot product of a plane and a vector.

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 Dot( _
    ByVal pPlane As Plane, _
    ByVal pV As Vector4 _
) As Single

C# public static float Dot(
    Plane pPlane,
    Vector4 pV
);

C++ public:
static float Dot(
    Plane pPlane,
    Vector4 pV
);

JScript public static function Dot(
    pPlane : Plane,
    pV : Vector4
) : float;

Visual Basic	Public Shared Function Dot( _ ByVal pPlane As Plane, _ ByVal pV As Vector4 _ ) As Single
C#	public static float Dot( Plane pPlane, Vector4 pV );
C++	public: static float Dot( Plane pPlane, Vector4 pV );
JScript	public static function Dot( pPlane : Plane, pV : Vector4 ) : float;

Parameters

pPlane Microsoft.DirectX.Plane
Source Plane structure.

pV Microsoft.DirectX.Vector4
Source Vector4 structure.

Return Value

System.Single
A Single value that is the dot product of the plane and the vector.

Remarks

Given a plane (a, b, c, d) and a 4-D vector (x, y, z, w), this method's return value is a*x + b*y + c*z + d*w. The Dot method is useful for determining the plane's relationship with a homogeneous coordinate. For example, it can determine whether a coordinate is on a particular plane, or on which side of a particular plane a coordinate lies.

Given a plane (a, b, c, d) and a 3-D vector (x, y, z), this method's return value is a*x + b*y + c*z + d*1. The Dot method is useful for determining the plane's relationship with a coordinate in 3-D space.

pPlane	Microsoft.DirectX.Plane Source Plane structure.
pV	Microsoft.DirectX.Vector4 Source Vector4 structure.