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

Gets all polygons whose AABB's overlap the search box.

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 GetPolys(
	Vector3 searchPoint,
	Vector3 extents,
	NavmeshQueryFilter filter,
	uint[] resultPolyRefs,
	out int resultCount
)
Public Function GetPolys ( _
	searchPoint As Vector3, _
	extents As Vector3, _
	filter As NavmeshQueryFilter, _
	resultPolyRefs As UInteger(), _
	<OutAttribute> ByRef resultCount As Integer _
) As NavStatus
public:
NavStatus GetPolys(
	Vector3 searchPoint, 
	Vector3 extents, 
	NavmeshQueryFilter^ filter, 
	array<unsigned int>^ resultPolyRefs, 
	[OutAttribute] int% resultCount
)

Parameters

searchPoint
Vector3
The center of the query box.
extents
Vector3
The search distance along each axis.
filter
NavmeshQueryFilter
The filter to apply to the query.
resultPolyRefs
array<UInt32>[]()[][]
The references of the polygons that overlap the query box. [(polyRef) * resultCount] (Out)
resultCount
Int32%
The number of polygons found.

Return Value

The NavStatus flags for the query.

Remarks

This is a fast, but inaccurate query since only AABB's are checked. A strict polygon-box overlap check is not performed.

If no polygons are found, the method will return success with a result count of zero.

If the result buffer is too small to hold the entire result then the buffer will be filled to capacity. The method of choosing which polygons from the full result are included in the partial result is undefined.

See Also