A* Pathfinding Project  3.0.9
The A* Pathfinding Project for Unity
FloodPathTracer Class Reference

Traces a path created with the Pathfinding::FloodPath. More...

+ Inheritance diagram for FloodPathTracer:
+ Collaboration diagram for FloodPathTracer:

List of all members.

Public Member Functions

 FloodPathTracer (Vector3 start, FloodPath flood, OnPathDelegate callbackDelegate)  
override void Prepare ()  Prepares the path.
override void Initialize ()  Initializes the path.
override float CalculateStep (float remainingFrameTime)  Calculates the path until completed or until the function duration has exceeded remainingFrameTime.
override void Trace (Node from)  Traces the calculated path from the end node to the start.

Protected Variables

FloodPath flood  Reference to the FloodPath which searched the path originally.

Detailed Description

Traces a path created with the Pathfinding::FloodPath.

See Pathfinding::FloodPath for examples on how to use this path type

floodPathExample.png
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

Member Function Documentation

override float CalculateStep ( float  remainingFrameTime) [virtual]

Calculates the path until completed or until the function duration has exceeded remainingFrameTime.

Usually a check is only done every 500 nodes if the time has exceeded remainingFrameTime.

Reimplemented from Path.

override void Initialize ( ) [virtual]

Initializes the path.

Sets up the open list and adds the first node to it

Reimplemented from Path.

override void Prepare ( ) [virtual]

Prepares the path.

Searches for start and end nodes and does some simple checking if a path is at all possible

Reimplemented from Path.

override void Trace ( Node  from) [virtual]

Traces the calculated path from the end node to the start.

This will build an array (path) of the nodes this path will pass through and also set the vectorPath array to the path arrays positions. This function will not revert the path as the original implementation does, so the path will go from from to the parent root node (usually the start node)

Reimplemented from Path.


Member Data Documentation

FloodPath flood [protected]

Reference to the FloodPath which searched the path originally.


The documentation for this class was generated from the following file:
 All Classes Functions Variables Enumerations Properties