org.xguzm.pathfinding.grid

Interface NavigationGridGraph<T extends NavigationGridGraphNode>

Type Parameters:

T - only classes implementing NavigationGridGraphNode can be used within this graph

All Superinterfaces:

NavigationGraph<T>

All Known Implementing Classes:

NavigationGrid

public interface NavigationGridGraph<T extends NavigationGridGraphNode>
extends NavigationGraph<T>

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

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()
T[][]	getNodes()
int	getWidth()
boolean	isWalkable(int x, int y) Determine whether the node at the given position is walkable.
void	setCell(int x, int y, T node)
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 interface org.xguzm.pathfinding.NavigationGraph

getMovementCost, getNeighbors, getNeighbors, isWalkable, lineOfSight

Method Detail

getCell

T getCell(int x,
          int y)

setCell

void setCell(int x,
             int y,
             T node)

contains

boolean contains(int x,
                 int y)

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

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

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

Set whether the node on the given position is walkable.

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.

isWalkable

boolean isWalkable(int x,
                   int y)

Determine whether the node at the given position is walkable.

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)

getNodes

T[][] getNodes()

setNodes

void setNodes(T[][] nodes)

getWidth

int getWidth()

setWidth

void setWidth(int width)

getHeight

int getHeight()

setHeight

void setHeight(int height)