com.almasb.fxgl.ai.pathfinding

Class AStarGrid

java.lang.Object

com.almasb.fxgl.ai.pathfinding.AStarGrid

public class AStarGrid
extends Object

A* grid containing A* nodes.

Author:

Almas Baimagambetov (AlmasB) (almaslvl@gmail.com)

Constructor Summary

Constructors

Constructor and Description
AStarGrid(int width, int height) Constructs A* grid with A* nodes with given width and height.

Method Summary

Modifier and Type	Method and Description
AStarNode[][]	getGrid()
int	getHeight()
AStarNode	getNode(int x, int y) Returns a node at x, y.
List<AStarNode>	getNodes()
NodeState	getNodeState(int x, int y) Returns state of the node at a, y.
List<AStarNode>	getPath(int startX, int startY, int targetX, int targetY) Returns a list of A* nodes from start to target.
AStarNode	getRandomNode()
Optional<AStarNode>	getRandomNode(Predicate<AStarNode> predicate)
int	getWidth()
boolean	isWithin(int x, int y)
void	setNodeState(int x, int y, NodeState state) Set state of the node at x, y.
void	setStateForAllNodes(NodeState state) Convenience method to set state of all nodes to given state.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AStarGrid

public AStarGrid(int width,
                 int height)

Constructs A* grid with A* nodes with given width and height. All nodes are initially NodeState.WALKABLE

Parameters:

width - grid width

height - grid height

Method Detail

getWidth

public final int getWidth()

Returns:

grid width

getHeight

public final int getHeight()

Returns:

grid height

isWithin

public final boolean isWithin(int x,
                              int y)

Parameters:

x - x coord

y - y coord

Returns:

true IFF the point is within the grid

setStateForAllNodes

public final void setStateForAllNodes(NodeState state)

Convenience method to set state of all nodes to given state.

Parameters:

state - node state

setNodeState

public final void setNodeState(int x,
                               int y,
                               NodeState state)

Set state of the node at x, y.

Parameters:

x - the x coordinate

y - the y coordinate

state - the state

getNodeState

public final NodeState getNodeState(int x,
                                    int y)

Returns state of the node at a, y.

Parameters:

x - the x coordinate

y - the y coordinate

Returns:

the state

getPath

public final List<AStarNode> getPath(int startX,
                                     int startY,
                                     int targetX,
                                     int targetY)

Returns a list of A* nodes from start to target. The list will include target. Return an empty list if the path doesn't exist.

Parameters:

startX - start node x

startY - start node y

targetX - target node x

targetY - target node y

Returns:

the path

getNode

public final AStarNode getNode(int x,
                               int y)

Returns a node at x, y. There is no bounds checking.

Parameters:

x - the x coordinate

y - the y coordinate

Returns:

A* node at x, y

getRandomNode

public final AStarNode getRandomNode()

Returns:

a random node from the grid

getRandomNode

public final Optional<AStarNode> getRandomNode(Predicate<AStarNode> predicate)

Parameters:

predicate - filter condition

Returns:

a random node that passes the filter or Optional.empty() if no such node exists

getGrid

public final AStarNode[][] getGrid()

Returns:

underlying grid of nodes

getNodes

public final List<AStarNode> getNodes()

Returns:

all grid nodes