A* Pathfinding Project  3.7.3
The A* Pathfinding Project for Unity 3D
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Events Macros Groups Pages
FloodPathTracer Class Reference

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

Detailed Description

Traces a path created with the Pathfinding.FloodPath.

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

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

 FloodPathTracer ()
 Default constructor.
 
override void CalculateStep (long targetTick)
 Calculates the path until completed or until the time has passed targetTick.
 
override void Initialize ()
 Initializes the path.
 
override void Reset ()
 Reset all values to their default values.
 
void Trace (GraphNode from)
 Traces the calculated path from the start node to the end.
 
- Public Member Functions inherited from ABPath
override void Cleanup ()
 Always called after the path has been calculated.
 
override string DebugString (PathLog logMode)
 Returns a debug string for this path.
 
override uint GetConnectionSpecialCost (GraphNode a, GraphNode b, uint currentCost)
 May be called by graph nodes to get a special cost for some connections.
 
Vector3 GetMovementVector (Vector3 point)
 Returns in which direction to move from a point on the path.
 
override void Prepare ()
 Prepares the path.
 
void ResetCosts (Path p)
 Resets End Node Costs.
 
 ABPath ()
 Default constructor.
 
- Public Member Functions inherited from Path
void AdvanceState (PathState s)
 Threadsafe increment of the state.
 
uint CalculateHScore (GraphNode node)
 
bool CanTraverse (GraphNode node)
 Returns if the node can be traversed.
 
void Claim (System.Object o)
 Claim this path.
 
void Error ()
 Aborts the path because of an error.
 
void ForceLogError (string msg)
 Logs an error and calls Error().
 
Int3 GetHTarget ()
 
PathState GetState ()
 Returns the state of the path in the pathfinding pipeline.
 
uint GetTagPenalty (int tag)
 Returns penalty for the given tag.
 
float GetTotalLength ()
 Total Length of the path.
 
uint GetTraversalCost (GraphNode node)
 
bool IsDone ()
 Returns if this path is done calculating.
 
void Log (string msg)
 Appends a message to the errorLog.
 
void LogError (string msg)
 Appends msg to errorLog and logs msg to the console.
 
virtual void OnEnterPool ()
 Called when the path enters the pool.
 
void PrepareBase (PathHandler pathHandler)
 Prepares low level path variables for calculation.
 
void Release (System.Object o)
 Releases a path claim.
 
void ReleaseSilent (System.Object o)
 Releases the path silently.
 
virtual void ReturnPath ()
 Calls callback to return the calculated path.
 
IEnumerator WaitForPath ()
 Waits until this path has been calculated and returned.
 

Static Public Member Functions

static FloodPathTracer Construct (Vector3 start, FloodPath flood, OnPathDelegate callback=null)
 
- Static Public Member Functions inherited from ABPath
static ABPath Construct (Vector3 start, Vector3 end, OnPathDelegate callback=null)
 Construct a path with a start and end point.
 

Protected Member Functions

override void Recycle ()
 Internal method to recycle the path.
 
void Setup (Vector3 start, FloodPath flood, OnPathDelegate callback)
 
- Protected Member Functions inherited from ABPath
virtual void CompletePathIfStartIsValidTarget ()
 Checks if the start node is the target and complete the path if that is the case.
 
void UpdateStartEnd (Vector3 start, Vector3 end)
 Sets the start and end points.
 
void Setup (Vector3 start, Vector3 end, OnPathDelegate callbackDelegate)
 
- Protected Member Functions inherited from Path
bool HasExceededTime (int searchedNodes, long targetTime)
 
virtual void Trace (PathNode from)
 Traces the calculated path from the end node to the start.
 

Protected Attributes

FloodPath flood
 Reference to the FloodPath which searched the path originally.
 
- Protected Attributes inherited from ABPath
int[] endNodeCosts
 Saved original costs for the end node.
 
PathNode partialBestTarget
 Current best target for the partial path.
 
- Protected Attributes inherited from Path
PathNode currentR
 The node currently being processed.
 
bool hasBeenReset
 True if the Reset function has been called.
 
Int3 hTarget
 Target to use for H score calculations.
 
GraphNode hTargetNode
 Target to use for H score calculation.
 
int[] internalTagPenalties
 The tag penalties that are actually used.
 
int[] manualTagPenalties
 Tag penalties set by other scripts.
 
float maxFrameTime
 The max number of milliseconds per iteration (frame, in case of non-multithreading)
 

Properties

override bool hasEndPoint [get]
 
- Properties inherited from ABPath
virtual bool hasEndPoint [get]
 Determines if a search for an end node should be done.
 
- Properties inherited from Path
System.DateTime callTime [get, set]
 When the call was made to start the pathfinding for this path.
 
PathCompleteState CompleteState [get, set]
 Current state of the path.
 
bool error [get]
 If the path failed, this is true.
 
string errorLog [get]
 Log messages with info about eventual errors.
 
virtual bool FloodingPath [get]
 True for paths that want to search all nodes and not jump over nodes as optimizations.
 
PathHandler pathHandler [get, set]
 Data for the thread calculating this path.
 
ushort pathID [get, set]
 ID of this path.
 
int[] tagPenalties [get, set]
 Penalties for each tag.
 

Additional Inherited Members

- Public Attributes inherited from ABPath
bool calculatePartial
 Calculate partial path if the target node cannot be reached.
 
GraphNode endHint
 Hints can be set to enable faster Get Nearest Node queries.
 
GraphNode endNode
 End node of the path.
 
Vector3 endPoint
 Exact end point of the path.
 
Vector3 originalEndPoint
 End Point exactly as in the path request.
 
Vector3 originalStartPoint
 Start Point exactly as in the path request.
 
bool recalcStartEndCosts = true
 Defines if start and end nodes will have their connection costs recalculated for this path.
 
GraphNode startHint
 Hints can be set to enable faster Get Nearest Node queries.
 
Int3 startIntPoint
 Start point in integer coordinates.
 
GraphNode startNode
 Start node of the path.
 
Vector3 startPoint
 Exact start point of the path.
 
- Package Attributes inherited from Path
Path next
 Internal linked list implementation.
 
bool recycled
 True if the path is currently recycled (i.e in the path pool).
 

Constructor & Destructor Documentation

Default constructor.

Do not use this. Instead use the static Construct method which can handle path pooling.

Member Function Documentation

override void CalculateStep ( long  targetTick)
virtual

Calculates the path until completed or until the time has passed targetTick.

Usually a check is only done every 500 nodes if the time has passed targetTick. Time/Ticks are got from System.DateTime.UtcNow.Ticks.

Basic outline of what the function does for the standard path (Pathfinding.ABPath).

while the end has not been found and no error has ocurred
check if we have reached the end
if so, exit and return the path
open the current node, i.e loop through its neighbours, mark them as visited and put them on a heap
check if there are still nodes left to process (or have we searched the whole graph)
if there are none, flag error and exit
pop the next node of the heap and set it as current
check if the function has exceeded the time limit
if so, return and wait for the function to get called again

Reimplemented from ABPath.

static FloodPathTracer Construct ( Vector3  start,
FloodPath  flood,
OnPathDelegate  callback = null 
)
static
override void Initialize ( )
virtual

Initializes the path.

Traces the path from the start node.

Reimplemented from ABPath.

override void Recycle ( )
protectedvirtual

Internal method to recycle the path.

Calling this means that the path and any variables on it are not needed anymore and the path can be pooled. All path data will be reset. Implement this in inheriting path types to support recycling of paths.

public override void Recycle () {
//Recycle the Path (<Path> should be replaced by the path type it is implemented in)
PathPool<Path>.Recycle (this);
}
Warning
Do not call this function directly, instead use the Claim and Release functions.
See Also
Pathfinding.PathPool
Reset
Claim
Release

Reimplemented from ABPath.

override void Reset ( )
virtual

Reset all values to their default values.

All inheriting path types must implement this function, resetting ALL their variables to enable recycling of paths. Call this base function in inheriting types with base.Reset ();

Reimplemented from ABPath.

void Setup ( Vector3  start,
FloodPath  flood,
OnPathDelegate  callback 
)
protected
void Trace ( GraphNode  from)

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

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 implementation will use the flood (FloodPath) to trace the path from precalculated data.

Member Data Documentation

FloodPath flood
protected

Reference to the FloodPath which searched the path originally.

Property Documentation

override bool hasEndPoint
getprotected

The documentation for this class was generated from the following file: