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

Public Member Functions

 PathReturnQueue (System.Object pathsClaimedSilentlyBy)
 
void Enqueue (Path path)
 
void ReturnPaths (bool timeSlice)
 Returns all paths in the return stack.
 

Private Attributes

Path pathReturnPop
 A temporary queue for paths which weren't returned due to large processing time.
 
Pathfinding.Util.LockFreeStack pathReturnStack = new Pathfinding.Util.LockFreeStack()
 Holds all paths which are waiting to be flagged as completed.
 
System.Object pathsClaimedSilentlyBy
 Paths are claimed silently by some object to prevent them from being recycled while still in use.
 

Constructor & Destructor Documentation

PathReturnQueue ( System.Object  pathsClaimedSilentlyBy)

Member Function Documentation

void Enqueue ( Path  path)
void ReturnPaths ( bool  timeSlice)

Returns all paths in the return stack.

Paths which have been processed are put in the return stack. This function will pop all items from the stack and return them to e.g the Seeker requesting them.

Parameters
timeSliceDo not return all paths at once if it takes a long time, instead return some and wait until the next call.

Member Data Documentation

Path pathReturnPop
private

A temporary queue for paths which weren't returned due to large processing time.

When some time limit is exceeded in ReturnPaths, paths are put in this queue until the next frame.

Paths contain a member called 'next', so this actually forms a linked list.

See Also
ReturnPaths

Holds all paths which are waiting to be flagged as completed.

See Also
ReturnPaths
System.Object pathsClaimedSilentlyBy
private

Paths are claimed silently by some object to prevent them from being recycled while still in use.

This will be set to the AstarPath object.


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