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

Defines area traversal cost and flag restrictions for navigation querys.

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

Members

               
 All Members  Constructors   Fields   Properties   Methods  
 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

 MemberDescription
NavmeshQueryFilter()()()()
Constructor for a filter with the maximum number of areas. (MaxArea + 1)
NavmeshQueryFilter(Int32)
Constructor.
AreaCount
The number of in use areas.
Clone()()()()
Creates a new filter with the same state as the current filter.
DefaultAreaCost
The default area cost.
DefaultExcludeFlags
The default exclude flags.
DefaultIncludeFlags
The default include flags.
ExcludeFlags
The flags for polygons that should be excluded from the query. [Default: DefaultExcludeFlags]
Finalize()()()()
Destructor
(Overrides Object..::..Finalize()()()().)
IncludeFlags
The flags for polygons that should be included in the query. [Default: DefaultIncludeFlags]
IsDisposed
True if the object has been disposed and should no longer be used.
(Overrides ManagedObject..::..IsDisposed.)
Item[([( Int32])])
The traversal cost for each area, indexed by area. [Default: DefaultAreaCost]
RequestDisposal()()()()
Request all unmanaged resources controlled by the object be immediately freed and the object marked as disposed.
(Overrides ManagedObject..::..RequestDisposal()()()().)

Remarks

The way filtering works, a navigation mesh polygon must have at least one flag set to ever be considered by a query. So setting the include flags to 0 will always result in all polygons being excluded.

The array form is used to access area cost. E.g. myFilter[5] = 2.5f

Warning: Behavior is undefined if an area index is out of range. The error may result in a runtime error, or it may operate as if there is no problem whatsoever. E.g. Setting and getting myFilter[myFilter.AreaCount] may get and set the value normally. Do not write code that depends on this behavior since it may change in future releases.

Behavior is undefined if used after disposal.

Inheritance Hierarchy

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

See Also