com.github.brunothg.game.engine.image.sprite

Interface Sprite

All Known Implementing Classes:

BufferedSprite, ColoredSprite, DefaultSprite, DerivedSprite, InvertedSprite, WeakSprite

public interface Sprite

A sprite is an image that contains an array of smaller images (tiles). This images can be accessed like a normal Java array (and animated). But that this works, it is necessary that all tiles have the same size. Overlaying a grid of the dimensions of one frame marks all tiles. Even the space (if any exists) between the tiles has to be equal everywhere in the sprite, even at the edges of the sprite or tiles will be missed.

Author:

Marvin Bruns

Method Summary

Modifier and Type	Method and Description
void	drawTile(Graphics2D g, int x, int y, int width, int height) Draws a tile of this sprite.
int	getColumns() Get the number of columns.
int	getRows() Get the number of rows.
Sprite	getSubSprite(int x, int y, int width, int height) Get sub-sprite with given dimension.
BufferedImage	getTile(int x, int y) Get a tile of this sprite.
int	getTileCount() Get the number of tiles in this sprite.
int	getTileHeight() Get the height of one tile
int	getTileWidth() Get the width of one tile

Method Detail

drawTile

void drawTile(Graphics2D g,
              int x,
              int y,
              int width,
              int height)

Draws a tile of this sprite. The tile is drawn with Bounds(0, 0, width, height). Consider creating a clipped Graphics2D object.

Parameters:

g - Graphics2D object to draw on

x - X-Coordinate of the tile

y - Y-Coordinate of the tile

width - The width of the Graphics object to draw on

height - The height of the Graphics object to draw on

getTile

BufferedImage getTile(int x,
                      int y)

Get a tile of this sprite. Be careful with this method. Creates a copy of the underlying tile.
Use drawTile(Graphics2D, int, int, int, int) for faster action and less memory usage.

Parameters:

x - X-Coordinate of the tile

y - Y-Coordinate of the tile

Returns:

A BufferedImage containing the tile

getTileCount

int getTileCount()

Get the number of tiles in this sprite.

getRows

int getRows()

Get the number of rows.

getColumns

int getColumns()

Get the number of columns.

getTileWidth

int getTileWidth()

Get the width of one tile

getTileHeight

int getTileHeight()

Get the height of one tile

getSubSprite

Sprite getSubSprite(int x,
                    int y,
                    int width,
                    int height)

Get sub-sprite with given dimension. The returned DerivedSprite is linked with this sprite.

Parameters:

x - X-Coordinate of first tile

y - Y-Coordinate of first tile

width - Width of the sub-sprite

height - Height of the sub-sprite

Returns:

The sub-sprite in form of a DerivedSprite