[This is preliminary documentation and is subject to change.]
Assembly: cai-nav (in cai-nav.dll) Version: 0.4.0.0 (0.4.0.0)
|C#||Visual Basic||Visual C++|
The reference of the polygon to start the search at.
The vertices of the convex polygon. [Length: vertCount]
The filter to apply to the query.
The references of the polygons touched by the search polygon. [(polyRef) * resultCount] (Optional)
The references of the parent polygons for each result. Zero if a result polygon has no parent. [(parentRef) * resultCount] (Optional)
The search cost from the centroid point to the polygon. [(cost) * resultCount] (Optional)
The number of polygons found.
Return ValueThe NavStatus flags for the query.
The order of the result is from least to highest cost.
At least one result buffer must be provided.
The primary use case for this method is for performing Dijkstra searches. Candidate polygons are found by searching the graph beginning at the start polygon.
The same intersection test restrictions that apply to the circle version of this method apply to this method.
The 3D centroid of the polygon is used as the start position for cost calculations.
Intersection tests occur in 2D. All polygons are projected onto the xz-plane, so the y-values of the vertices do not effect intersection tests.
If the buffers are is too small to hold the entire result, they will be filled to capacity.