com.badlogic.gdx.ai.pfa

Interface PathFinder<N>

Type Parameters:

N - Type of node

All Known Implementing Classes:

HierarchicalPathFinder, IndexedAStarPathFinder

public interface PathFinder<N>

A PathFinder that can find a path from one node in an arbitrary graph to a goal node based on information provided by that graph.

A fully implemented path finder can perform both interruptible and non-interruptible searches. If a specific path finder is not able to perform one of the two type of search then the corresponding method should throw an UnsupportedOperationException.

Method Summary

Modifier and Type	Method and Description
boolean	search(PathFinderRequest<N> request, long timeToRun) Performs an interruptible search, trying to find a path made up of nodes from the start node to the goal node attempting to honor costs provided by the graph.
boolean	searchConnectionPath(N startNode, N endNode, Heuristic<N> heuristic, GraphPath<Connection<N>> outPath) Performs a non-interruptible search, trying to find a path made up of connections from the start node to the goal node attempting to honor costs provided by the graph.
boolean	searchNodePath(N startNode, N endNode, Heuristic<N> heuristic, GraphPath<N> outPath) Performs a non-interruptible search, trying to find a path made up of nodes from the start node to the goal node attempting to honor costs provided by the graph.

Method Detail

searchConnectionPath

boolean searchConnectionPath(N startNode,
                             N endNode,
                             Heuristic<N> heuristic,
                             GraphPath<Connection<N>> outPath)

Performs a non-interruptible search, trying to find a path made up of connections from the start node to the goal node attempting to honor costs provided by the graph.

Parameters:

startNode - the start node

endNode - the end node

heuristic - the heuristic function

outPath - the output path that will only be filled if a path is found, otherwise it won't get touched.

Returns:

true if a path was found; false otherwise.

searchNodePath

boolean searchNodePath(N startNode,
                       N endNode,
                       Heuristic<N> heuristic,
                       GraphPath<N> outPath)

Performs a non-interruptible search, trying to find a path made up of nodes from the start node to the goal node attempting to honor costs provided by the graph.

Parameters:

startNode - the start node

endNode - the end node

heuristic - the heuristic function

outPath - the output path that will only be filled if a path is found, otherwise it won't get touched.

Returns:

true if a path was found; false otherwise.

search

boolean search(PathFinderRequest<N> request,
               long timeToRun)

Performs an interruptible search, trying to find a path made up of nodes from the start node to the goal node attempting to honor costs provided by the graph.

Parameters:

request - the pathfinding request

timeToRun - the time in nanoseconds that can be used to advance the search

Returns:

true if the search has finished; false otherwise.