Handles thread specific path data. More...

Detailed Description

Handles thread specific path data.

Public Member Functions
	PathHandler (int threadID, int totalThreadCount)

void	ClearPathIDs ()
	Set all nodes' pathIDs to 0. More...

void	DestroyNode (GraphNode node)
	Internal method to clean up node data. More...

PathNode	GetPathNode (int nodeIndex)

PathNode	GetPathNode (GraphNode node)
	Returns the PathNode corresponding to the specified node. More...

void	InitializeForPath (Path p)

void	InitializeNode (GraphNode node)
	Internal method to initialize node data. More...

Public Attributes
readonly System.Text.StringBuilder	DebugStringBuilder = new System.Text.StringBuilder()
	StringBuilder that paths can use to build debug strings. More...

readonly BinaryHeap	heap = new BinaryHeap(128)
	Binary heap to keep track of nodes on the "Open list". More...

PathNode []	nodes = new PathNode[0]
	Array of all PathNodes. More...

readonly int	threadID

readonly int	totalThreadCount

Properties
ushort	PathID `[get]`
	ID for the path currently being calculated or last path that was calculated. More...

Private Attributes
ushort	pathID
	Current PathID. More...

Constructor & Destructor Documentation

◆ PathHandler()

PathHandler	(	int	threadID,
		int	totalThreadCount
	)

Member Function Documentation

◆ ClearPathIDs()

void ClearPathIDs ( )

Set all nodes' pathIDs to 0.

See also: Pathfinding.PathNode.pathID

◆ DestroyNode()

void DestroyNode ( GraphNode node )

Internal method to clean up node data.

◆ GetPathNode() [1/2]

PathNode GetPathNode ( int nodeIndex )

◆ GetPathNode() [2/2]

PathNode GetPathNode ( GraphNode node )

Returns the PathNode corresponding to the specified node.

The PathNode is specific to this PathHandler since multiple PathHandlers are used at the same time if multithreading is enabled.

◆ InitializeForPath()

void InitializeForPath ( Path p )

◆ InitializeNode()

void InitializeNode ( GraphNode node )

Internal method to initialize node data.

Member Data Documentation

◆ DebugStringBuilder

readonly System.Text.StringBuilder DebugStringBuilder = new System.Text.StringBuilder()

StringBuilder that paths can use to build debug strings.

Better for performance and memory usage to use a single StringBuilder instead of each path creating its own

◆ heap

readonly BinaryHeap heap = new BinaryHeap(128)

Binary heap to keep track of nodes on the "Open list".

See also: https://en.wikipedia.org/wiki/A*_search_algorithm

◆ nodes

PathNode [] nodes = new PathNode[0]

Array of all PathNodes.

◆ pathID

ushort pathID

private

Current PathID.

See also: PathID

◆ threadID

readonly int threadID

◆ totalThreadCount

readonly int totalThreadCount

Property Documentation

◆ PathID

ushort PathID

get

ID for the path currently being calculated or last path that was calculated.

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

/Users/arong/Unity/a-pathfinding-project/Assets/AstarPathfindingProject/Core/PathHandler.cs