GeometryHelper.GetClosestPoint Method (Plane, Vector3F, Vector3F)

GeometryHelperGetClosestPoint Method (Plane, Vector3F, Vector3F)

Gets the point on a plane surface that is closest to a given point.

Namespace: DigitalRune.Geometry
Assembly: DigitalRune.Geometry (in DigitalRune.Geometry.dll) Version: 1.18.0.0 (1.18.2.14427)

Syntax

C++

Copy

public static bool GetClosestPoint(
	Plane plane,
	Vector3F point,
	out Vector3F pointOnPlane
)

Public Shared Function GetClosestPoint ( 
	plane As Plane,
	point As Vector3F,
	<OutAttribute> ByRef pointOnPlane As Vector3F
) As Boolean

public:
static bool GetClosestPoint(
	Plane plane, 
	Vector3F point, 
	[OutAttribute] Vector3F% pointOnPlane
)

static member GetClosestPoint : 
        plane : Plane * 
        point : Vector3F * 
        pointOnPlane : Vector3F byref -> bool

Parameters

plane: Type: DigitalRune.Geometry.ShapesPlane
The plane.
point: Type: DigitalRune.Mathematics.AlgebraVector3F
The point position.
pointOnPlane: Type: DigitalRune.Mathematics.AlgebraVector3F
The point on the surface of the plane that is closest to point.

Return Value

Type: Boolean
if the point lies in the plane (pointOnPlane and point are numerically identical); otherwise if the point is either above or below the plane.

Reference

GeometryHelper Class

GetClosestPoint Overload

DigitalRune.Geometry Namespace