[This is preliminary documentation and is subject to change.]

Finds the closest point on the specified polygon.

Namespace: org.critterai.nav
Assembly: cai-nav (in cai-nav.dll) Version: 0.4.0.0 (0.4.0.0)

Syntax

         
 C#  Visual Basic  Visual C++ 
public NavStatus GetNearestPoint(
	uint polyRef,
	Vector3 sourcePoint,
	out Vector3 resultPoint
)
Public Function GetNearestPoint ( _
	polyRef As UInteger, _
	sourcePoint As Vector3, _
	<OutAttribute> ByRef resultPoint As Vector3 _
) As NavStatus
public:
NavStatus GetNearestPoint(
	unsigned int polyRef, 
	Vector3 sourcePoint, 
	[OutAttribute] Vector3% resultPoint
)

Parameters

polyRef
UInt32
The polygon reference.
sourcePoint
Vector3
The position to search from.
resultPoint
Vector3%
The closest point on the polygon.

Return Value

The NavStatus flags for the query.

Remarks

Uses the height detail to provide the most accurate information.

The source point does not have to be within the bounds of the navigation mesh.

See Also