org.cell2d.space.map

Class ArrayTileGrid

java.lang.Object

org.cell2d.space.map.TileGrid

org.cell2d.space.map.ArrayTileGrid

All Implemented Interfaces:

Drawable

public class ArrayTileGrid
extends TileGrid

An ArrayTileGrid is a type of TileGrid that stores its tile data in a rectangular two-dimensional array. An ArrayTileGrid's memory usage, and the time needed to iterate through the set of its tile locations, are both proportional to the number of its columns multiplied by the number of its rows.

Constructor Summary

Constructors

Constructor and Description
ArrayTileGrid(int numColumns, int numRows, int tileWidth, int tileHeight) Constructs an ArrayTileGrid with all of its grid cells unoccupied by tiles, and with none of its tiles set to be flipped or rotated.
ArrayTileGrid(int leftmostColumn, int rightmostColumn, int topmostRow, int bottommostRow, int tileWidth, int tileHeight) Constructs an ArrayTileGrid with all of its grid cells unoccupied by tiles, and with none of its tiles set to be flipped or rotated.

Method Summary

Modifier and Type	Method and Description
java.util.List<java.awt.Rectangle>	cover() Returns a list of non-overlapping rectangles that collectively overlap or "cover" all and only the grid cells in this TileGrid that are occupied by tiles.
int	getBottommostRow() Returns the index of this TileGrid's bottommost row.
int	getLeftmostColumn() Returns the index of this TileGrid's leftmost column.
int	getRightmostColumn() Returns the index of this TileGrid's rightmost column.
Drawable	getTile(int column, int row) Returns the tile at the specified location in this TileGrid, or null if there is none.
double	getTileAngle(int column, int row) Returns the angle by which the tile at the specified location in this TileGrid is rotated, or 0 if the location is outside the bounds of this TileGrid.
java.util.Set<java.awt.Point>	getTileLocations() Returns an unmodifiable Set view of the locations in this TileGrid that are occupied by tiles.
boolean	getTileXFlip(int column, int row) Returns whether the tile at the specified location in this TileGrid is flipped horizontally, or false if the location is outside the bounds of this TileGrid.
boolean	getTileYFlip(int column, int row) Returns whether the tile at the specified location in this TileGrid is flipped vertically, or false if the location is outside the bounds of this TileGrid.
int	getTopmostRow() Returns the index of this TileGrid's topmost row.
boolean	setTile(int column, int row, Drawable tile) Sets the tile at the specified location in this TileGrid to the specified Drawable.
boolean	setTileAngle(int column, int row, double angle) Sets to the specified value the angle by which the tile at the specified location in this TileGrid is rotated.
boolean	setTileXFlip(int column, int row, boolean xFlip) Sets whether the tile at the specified location in this TileGrid is flipped horizontally.
boolean	setTileYFlip(int column, int row, boolean yFlip) Sets whether the tile at the specified location in this TileGrid is flipped vertically.

Methods inherited from class org.cell2d.space.map.TileGrid

coverObjects, coverPoints, draw, draw, draw, draw, draw, draw, getTileHeight, getTileWidth

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cell2d.Drawable

getRenderableRegion

Constructor Detail

ArrayTileGrid

public ArrayTileGrid(int numColumns,
                     int numRows,
                     int tileWidth,
                     int tileHeight)

Constructs an ArrayTileGrid with all of its grid cells unoccupied by tiles, and with none of its tiles set to be flipped or rotated.

Parameters:

numColumns - The number of this ArrayTileGrid's columns. Column indices will range from 0 to numColumns - 1.

numRows - The number of this ArrayTileGrid's rows. Row indices will range from 0 to numRows - 1.

tileWidth - The width in pixels of each of this ArrayTileGrid's tiles

tileHeight - The height in pixels of each of this ArrayTileGrid's tiles

ArrayTileGrid

public ArrayTileGrid(int leftmostColumn,
                     int rightmostColumn,
                     int topmostRow,
                     int bottommostRow,
                     int tileWidth,
                     int tileHeight)

Constructs an ArrayTileGrid with all of its grid cells unoccupied by tiles, and with none of its tiles set to be flipped or rotated.

Parameters:

leftmostColumn - The index of this ArrayTileGrid's leftmost column

rightmostColumn - The index of this ArrayTileGrid's rightmost column

topmostRow - The index of this ArrayTileGrid's topmost row

bottommostRow - The index of this ArrayTileGrid's bottommost row

tileWidth - The width in pixels of each of this ArrayTileGrid's tiles

tileHeight - The height in pixels of each of this ArrayTileGrid's tiles

Method Detail

getLeftmostColumn

public final int getLeftmostColumn()

Description copied from class: TileGrid

Returns the index of this TileGrid's leftmost column.

Specified by:

getLeftmostColumn in class TileGrid

Returns:

The index of this TileGrid's leftmost column

getRightmostColumn

public final int getRightmostColumn()

Description copied from class: TileGrid

Returns the index of this TileGrid's rightmost column.

Specified by:

getRightmostColumn in class TileGrid

Returns:

The index of this TileGrid's rightmost column

getTopmostRow

public final int getTopmostRow()

Description copied from class: TileGrid

Returns the index of this TileGrid's topmost row.

Specified by:

getTopmostRow in class TileGrid

Returns:

The index of this TileGrid's topmost row

getBottommostRow

public final int getBottommostRow()

Description copied from class: TileGrid

Returns the index of this TileGrid's bottommost row.

Specified by:

getBottommostRow in class TileGrid

Returns:

The index of this TileGrid's bottommost row

getTileLocations

public final java.util.Set<java.awt.Point> getTileLocations()

Description copied from class: TileGrid

Returns an unmodifiable Set view of the locations in this TileGrid that are occupied by tiles. The x-coordinate of each returned point is the column index of one of these locations, and the y-coordinate of that point is the location's row index.

Specified by:

getTileLocations in class TileGrid

Returns:

The locations in this TileGrid that are occupied by tiles

getTile

public final Drawable getTile(int column,
                              int row)

Description copied from class: TileGrid

Returns the tile at the specified location in this TileGrid, or null if there is none.

Specified by:

getTile in class TileGrid

Parameters:

column - The location's column index

row - The location's row index

Returns:

The tile at the specified location

setTile

public final boolean setTile(int column,
                             int row,
                             Drawable tile)

Description copied from class: TileGrid

Sets the tile at the specified location in this TileGrid to the specified Drawable. If the location is outside the bounds of this TileGrid, the operation will fail and this method will do nothing.

Specified by:

setTile in class TileGrid

Parameters:

column - The location's column index

row - The location's row index

tile - The Drawable to set as the tile at the specified location, or null if there should be no tile at that location

Returns:

Whether the operation was successful

getTileXFlip

public final boolean getTileXFlip(int column,
                                  int row)

Description copied from class: TileGrid

Returns whether the tile at the specified location in this TileGrid is flipped horizontally, or false if the location is outside the bounds of this TileGrid.

Specified by:

getTileXFlip in class TileGrid

Parameters:

column - The location's column index

row - The location's row index

Returns:

Whether the tile at the specified location is flipped horizontally

setTileXFlip

public final boolean setTileXFlip(int column,
                                  int row,
                                  boolean xFlip)

Description copied from class: TileGrid

Sets whether the tile at the specified location in this TileGrid is flipped horizontally. If the location is outside the bounds of this TileGrid, the operation will fail and this method will do nothing.

Specified by:

setTileXFlip in class TileGrid

Parameters:

column - The location's column index

row - The location's row index

xFlip - Whether the tile at the specified location should be flipped horizontally

Returns:

Whether the operation was successful

getTileYFlip

public final boolean getTileYFlip(int column,
                                  int row)

Description copied from class: TileGrid

Returns whether the tile at the specified location in this TileGrid is flipped vertically, or false if the location is outside the bounds of this TileGrid.

Specified by:

getTileYFlip in class TileGrid

Parameters:

column - The location's column index

row - The location's row index

Returns:

Whether the tile at the specified location is flipped vertically

setTileYFlip

public final boolean setTileYFlip(int column,
                                  int row,
                                  boolean yFlip)

Description copied from class: TileGrid

Sets whether the tile at the specified location in this TileGrid is flipped vertically. If the location is outside the bounds of this TileGrid, the operation will fail and this method will do nothing.

Specified by:

setTileYFlip in class TileGrid

Parameters:

column - The location's column index

row - The location's row index

yFlip - Whether the tile at the specified location should be flipped vertically

Returns:

Whether the operation was successful

getTileAngle

public final double getTileAngle(int column,
                                 int row)

Description copied from class: TileGrid

Returns the angle by which the tile at the specified location in this TileGrid is rotated, or 0 if the location is outside the bounds of this TileGrid. The returned angle is normalized to be between 0 and 360 degrees.

Specified by:

getTileAngle in class TileGrid

Parameters:

column - The location's column index

row - The location's row index

Returns:

The angle by which the tile at the specified location is rotated

setTileAngle

public final boolean setTileAngle(int column,
                                  int row,
                                  double angle)

Description copied from class: TileGrid

Sets to the specified value the angle by which the tile at the specified location in this TileGrid is rotated. If the value is not a multiple of 90 degrees, or the location is outside the bounds of this TileGrid, the operation will fail and this method will do nothing.

Specified by:

setTileAngle in class TileGrid

Parameters:

column - The location's column index

row - The location's row index

angle - The angle in degrees by which the tile at the specified location should be rotated

Returns:

Whether the operation was successful

cover

public final java.util.List<java.awt.Rectangle> cover()

Description copied from class: TileGrid

Returns a list of non-overlapping rectangles that collectively overlap or "cover" all and only the grid cells in this TileGrid that are occupied by tiles. The coordinate space of the returned rectangles has this TileGrid's column indices as its x-coordinates and this TileGrid's row indices as its y-coordinates. (For instance, if the only tile in this TileGrid is at column index 0 and row index 0, this method will return only the rectangle with top left corner (0, 0) and bottom right corner (1, 1).) Each of the rectangles may be of any width and any height. The number of returned rectangles is not necessarily the smallest possible number that can satisfy the requirements, but it is likely to be close.

Specified by:

cover in class TileGrid

Returns:

A list of non-overlapping rectangles that collectively cover the grid cells in this TileGrid that are occupied by tiles