jade.path.AStar Class Reference

Inheritance diagram for jade.path.AStar:

Public Member Functions
List< Coordinate >	calcPath (World world, Coordinate start, Coordinate end)
Public Member Functions inherited from jade.path.PathFinder
final List< Coordinate >	getPartialPath (World world, Coordinate start, Coordinate end)
final List< Coordinate >	getPartialPath (World world, int posX, int posY, int endX, int endY)
final List< Coordinate >	getPath (World world, Coordinate start, Coordinate end)
final List< Coordinate >	getPath (World world, int posX, int posY, int endX, int endY)

Detailed Description

A

PathFinder 

which uses the A* path finding algorithm to quickly calculate optimal paths. The implementation uses Cartesian distance as both traversal cost and heuristic estimates. If a path exists it is guaranteed to be found, and an optimal path will always be returned. If no path exists, a partial path from the accessible location closest to the goal will be returned.

Member Function Documentation

List<Coordinate> jade.path.AStar.calcPath ( World  world, Coordinate  start, Coordinate  end  )

virtual

Calculates and returns the partial path from the given start to end on the provided

World 

. Since the path is incomplete, it may or may not terminate at the provided end. Null should never be returned from this method. If a path cannot be found, a partial path, or at least an empty path should be returned.

Parameters

world	the world on which the path is calculated
start	the start of the calculated path
end	the intended end of the calculated path

Returns

a path from start to end on world

Implements jade.path.PathFinder.

---

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

• jade/path/AStar.java