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

Provides core pathfinding functionality for navigation meshes.

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 sealed class NavmeshQuery : ManagedObject
Public NotInheritable Class NavmeshQuery _
	Inherits ManagedObject
public ref class NavmeshQuery sealed : public ManagedObject

Members

         
 All Members  Properties   Methods  
 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

 MemberDescription
Create(Navmesh, Int32, NavmeshQuery%)
Creates a new navigation mesh query based on the provided navigation mesh.
Finalize()()()()
Destructor
(Overrides Object..::..Finalize()()()().)
FinalizeSlicedFindPath(array<UInt32>[]()[][], Int32%)
Finalizes and returns the results of the sliced path query.
FindDistanceToWall(NavmeshPoint, Single, NavmeshQueryFilter, Single%, Vector3%, Vector3%)
Returns the distance from the specified position to the nearest polygon wall.
FindPath(NavmeshPoint, NavmeshPoint, NavmeshQueryFilter, array<UInt32>[]()[][], Int32%)
Finds the polygon path from the start to the end polygon.
FindPath(NavmeshPoint%, NavmeshPoint%, Vector3, NavmeshQueryFilter, array<UInt32>[]()[][], Int32%)
Finds the polygon path from the start to the end polygon.
FindPolys(UInt32, array<Vector3>[]()[][], NavmeshQueryFilter, array<UInt32>[]()[][], array<UInt32>[]()[][], array<Single>[]()[][], Int32%)
Finds the navigation polygons within the graph that touch the specified convex polygon.
FindPolys(NavmeshPoint, Single, NavmeshQueryFilter, array<UInt32>[]()[][], array<UInt32>[]()[][], array<Single>[]()[][], Int32%)
Finds the polygons within the graph that touch the specified circle.
GetNearestPoint(UInt32, Vector3, Vector3%)
Finds the closest point on the specified polygon.
GetNearestPoint(Vector3, Vector3, NavmeshQueryFilter, NavmeshPoint%)
Finds the nearest point on the surface of the navigation mesh.
GetNearestPointF(UInt32, Vector3, Vector3%)
Returns a point on the boundary closest to the source point if the source point is outside the polygon's xz-column.
GetPolyHeight(NavmeshPoint, Single%)
Gets the height of the polygon at the provided point using the detail mesh. (Most accurate.)
GetPolys(Vector3, Vector3, NavmeshQueryFilter, array<UInt32>[]()[][], Int32%)
Gets all polygons whose AABB's overlap the search box.
GetPolySegments(UInt32, NavmeshQueryFilter, array<Vector3>[]()[][], Int32%)
Returns the wall segments for the specified polygon.
GetPolySegments(UInt32, NavmeshQueryFilter, array<Vector3>[]()[][], array<UInt32>[]()[][], Int32%)
Returns the segments for the specified polygon, optionally excluding portals.
GetPolysLocal(NavmeshPoint, Single, NavmeshQueryFilter, array<UInt32>[]()[][], array<UInt32>[]()[][], Int32%)
Finds the non-overlapping navigation polygons in the local neighborhood around the specified point.
GetRandomPoint(NavmeshQueryFilter, NavmeshPoint%)
Returns a random point on the navigation mesh.
GetRandomPoint(NavmeshPoint, Single, NavmeshQueryFilter, NavmeshPoint%)
Returns a random point within reach of the specified location.
GetStraightPath(Vector3, Vector3, array<UInt32>[]()[][], Int32, Int32, array<Vector3>[]()[][], array<WaypointFlag>[]()[][], array<UInt32>[]()[][], Int32%)
Returns the staight path from the start to the end point within the polygon corridor.
InitSlicedFindPath(NavmeshPoint, NavmeshPoint, NavmeshQueryFilter)
Initializes a sliced path find query.
IsDisposed
True if the object has been disposed and should no longer be used.
(Overrides ManagedObject..::..IsDisposed.)
IsInClosedList(UInt32)
Returns true if the polygon refernce is in the current closed list.
IsRestricted
If true, certain methods are disabled.
IsValidPolyRef(UInt32, NavmeshQueryFilter)
Returns true if the polygon reference is valid and passes the filter restrictions.
MoveAlongSurface(NavmeshPoint, Vector3, NavmeshQueryFilter, Vector3%, array<UInt32>[]()[][], Int32%)
Moves from the start to the end point constrained to the navigation mesh.
Raycast(NavmeshPoint, Vector3, NavmeshQueryFilter, Single%, Vector3%, array<UInt32>[]()[][], Int32%)
Casts a 'walkability' ray along the surface of the navigation mesh from the start point toward the end point.
RequestDisposal()()()()
Marks the object as disposed and immediately frees all unmanaged resources for locally owned objects.
(Overrides ManagedObject..::..RequestDisposal()()()().)
UpdateSlicedFindPath(Int32, Int32%)
Continues a sliced path find query.

Remarks

In the context of this class: A wall is a polygon segment that is considered impassable. A portal is a passable segment between polygons.

If a buffer is too small to hold the entire result, the return status will include the BufferTooSmall flag. (For methods that support undersized buffers.)

Behavior is undefined if used after disposal.

Inheritance Hierarchy

System..::..Object
  org.critterai.interop..::..ManagedObject
    org.critterai.nav..::..NavmeshQuery

See Also