A* Pathfinding Project  3.8.12
The A* Pathfinding Project for Unity 3D
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Events Macros Groups Pages
Public Member Functions | Private Attributes | List of all members
FloodPathConstraint Class Reference

Restrict suitable nodes by if they have been searched by a FloodPath. More...

Detailed Description

Restrict suitable nodes by if they have been searched by a FloodPath.

Suitable nodes are in addition to the basic contraints, only the nodes which return true on a FloodPath.HasPathTo (node) call.

See Also
Pathfinding.FloodPath
Pathfinding.FloodPathTracer
A* Pro Feature:
This is an A* Pathfinding Project Pro feature only. This function/class/variable might not exist in the Free version of the A* Pathfinding Project or the functionality might be limited
The Pro version can be bought here

Public Member Functions

 FloodPathConstraint (FloodPath path)
 
override bool Suitable (GraphNode node)
 Returns whether or not the node conforms to this NNConstraint's rules.
 
- Public Member Functions inherited from NNConstraint
 NNConstraint ()
 Default constructor.
 
virtual bool SuitableGraph (int graphIndex, NavGraph graph)
 Returns whether or not the graph conforms to this NNConstraint's rules.
 

Private Attributes

readonly FloodPath path
 

Additional Inherited Members

- Public Attributes inherited from NNConstraint
int area = -1
 Area ID to constrain to.
 
bool constrainArea
 Only treat nodes in the area area as suitable.
 
bool constrainDistance = true
 Constrain distance to node.
 
bool constrainTags = true
 Sets if tags should be constrained.
 
bool constrainWalkability = true
 Only treat nodes with the walkable flag set to the same as walkable as suitable.
 
bool distanceXZ
 if available, do an XZ check instead of checking on all axes.
 
int graphMask = -1
 Graphs treated as valid to search on.
 
int tags = -1
 Nodes which have any of these tags set are suitable.
 
bool walkable = true
 What must the walkable flag on a node be for it to be suitable.
 
- Properties inherited from NNConstraint
static NNConstraint Default [get]
 The default NNConstraint.
 
static NNConstraint None [get]
 Returns a constraint which will not filter the results.
 

Constructor & Destructor Documentation

FloodPathConstraint ( FloodPath  path)

Member Function Documentation

override bool Suitable ( GraphNode  node)
virtual

Returns whether or not the node conforms to this NNConstraint's rules.

Reimplemented from NNConstraint.

Member Data Documentation

readonly FloodPath path
private
The documentation for this class was generated from the following file: