org.xguzm.pathfinding.grid

Class NavigationGrid<T extends NavigationGridGraphNode>

java.lang.Object

org.xguzm.pathfinding.grid.NavigationGrid<T>

Type Parameters:

T - only classes extending GridCell can be used within this graph

All Implemented Interfaces:

NavigationGridGraph<T>, NavigationGraph<T>

public class NavigationGrid<T extends NavigationGridGraphNode>
extends java.lang.Object
implements NavigationGridGraph<T>

A NavigationGraph which is represented as a grid or a table. The nodes are accessible through (x, y) coordinates.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	height
protected T[][]	nodes The nodes contained in the grid.
protected int	width

Constructor Summary

Constructors

Constructor and Description
NavigationGrid() Creates an grid with no nodes.
NavigationGrid(T[][] nodes)

Method Summary

Modifier and Type	Method and Description
boolean	contains(int x, int y) Determine wether the given x,y pair is within the bounds of this grid
T	getCell(int x, int y)
int	getHeight()
float	getMovementCost(T node1, T node2, PathFinderOptions opt) Determines the movement cost for moving from node1 to node2, with the given options
java.util.List<T>	getNeighbors(T cell)
java.util.List<T>	getNeighbors(T node, PathFinderOptions opt) Get the neighbors of the given node.
T[][]	getNodes()
int	getWidth()
boolean	isWalkable(int x, int y) Determine whether the node at the given position is walkable.
boolean	isWalkable(T node)
boolean	lineOfSight(NavigationNode from, NavigationNode to)
void	setCell(int x, int y, T cell)
void	setHeight(int height)
void	setNodes(T[][] nodes)
void	setWalkable(int x, int y, boolean walkable) Set whether the node on the given position is walkable.
void	setWidth(int width)

Methods inherited from class java.lang.Object

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

Field Detail

width

protected int width

height

protected int height

nodes

protected T extends NavigationGridGraphNode[][] nodes

The nodes contained in the grid. They are stored as Grid[x][y]

Constructor Detail

NavigationGrid

public NavigationGrid()

Creates an grid with no nodes. If this constructor is used, make sure to call setNodes(NavigationGridGraphNode[][]) before trying to make use of the grid cells.

NavigationGrid

public NavigationGrid(T[][] nodes)

Method Detail

getCell

public T getCell(int x,
                 int y)

Specified by:

getCell in interface NavigationGridGraph<T extends NavigationGridGraphNode>

setCell

public void setCell(int x,
                    int y,
                    T cell)

Specified by:

setCell in interface NavigationGridGraph<T extends NavigationGridGraphNode>

isWalkable

public boolean isWalkable(int x,
                          int y)

Determine whether the node at the given position is walkable.

Specified by:

isWalkable in interface NavigationGridGraph<T extends NavigationGridGraphNode>

Parameters:

x - - The x / column coordinate of the node.

y - - The y / row coordinate of the node.

Returns:

true if the node at [x,y] is walkable, false if it is not walkable (or if [x,y] is not within the grid's limit)

contains

public boolean contains(int x,
                        int y)

Determine wether the given x,y pair is within the bounds of this grid

Specified by:

contains in interface NavigationGridGraph<T extends NavigationGridGraphNode>

Parameters:

x - - The x / column coordinate of the node.

y - - The y / row coordinate of the node.

Returns:

true if the (x,y) is within the boundaries of this grid

setWalkable

public void setWalkable(int x,
                        int y,
                        boolean walkable)

Set whether the node on the given position is walkable.

Specified by:

setWalkable in interface NavigationGridGraph<T extends NavigationGridGraphNode>

Parameters:

x - - The x / column coordinate of the node.

y - - The y / row coordinate of the node.

walkable - - Whether the position is walkable.

Throws:

java.lang.IndexOutOfBoundsException - if the coordinate is not inside the grid.

getNeighbors

public java.util.List<T> getNeighbors(T cell)

Specified by:

getNeighbors in interface NavigationGraph<T extends NavigationGridGraphNode>

Parameters:

cell - the node to find the neighbors for

Returns:

a list with all the adjacent nodes for the passed node, using the default options

getNeighbors

public java.util.List<T> getNeighbors(T node,
                                      PathFinderOptions opt)

Get the neighbors of the given node.

     offsets      diagonalOffsets:
  +---+---+---+    +---+---+---+
  |   | 0 |   |    | 4 |   | 5 |
  +---+---+---+    +---+---+---+
  | 3 |   | 1 |    |   |   |   |
  +---+---+---+    +---+---+---+
  |   | 2 |   |    | 6 |   | 7 |
  +---+---+---+    +---+---+---+
 

Specified by:

getNeighbors in interface NavigationGraph<T extends NavigationGridGraphNode>

Parameters:

node -

opt -

Returns:

a list containing the adjacent nodes for the passed node, using the passed options

getMovementCost

public float getMovementCost(T node1,
                             T node2,
                             PathFinderOptions opt)

Description copied from interface: NavigationGraph

Determines the movement cost for moving from node1 to node2, with the given options

Specified by:

getMovementCost in interface NavigationGraph<T extends NavigationGridGraphNode>

isWalkable

public boolean isWalkable(T node)

Specified by:

isWalkable in interface NavigationGraph<T extends NavigationGridGraphNode>

getNodes

public T[][] getNodes()

Specified by:

getNodes in interface NavigationGridGraph<T extends NavigationGridGraphNode>

setNodes

public void setNodes(T[][] nodes)

Specified by:

setNodes in interface NavigationGridGraph<T extends NavigationGridGraphNode>

getWidth

public int getWidth()

Specified by:

getWidth in interface NavigationGridGraph<T extends NavigationGridGraphNode>

setWidth

public void setWidth(int width)

Specified by:

setWidth in interface NavigationGridGraph<T extends NavigationGridGraphNode>

getHeight

public int getHeight()

Specified by:

getHeight in interface NavigationGridGraph<T extends NavigationGridGraphNode>

setHeight

public void setHeight(int height)

Specified by:

setHeight in interface NavigationGridGraph<T extends NavigationGridGraphNode>

lineOfSight

public boolean lineOfSight(NavigationNode from,
                           NavigationNode to)

Specified by:

lineOfSight in interface NavigationGraph<T extends NavigationGridGraphNode>