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

Class BufferedSprite

java.lang.Object

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

All Implemented Interfaces:

Sprite

public class BufferedSprite
extends Object
implements Sprite

A Sprite that initially divides the provided image into sub-images. First creation is slower and consumes more memory than the unbuffered Sprite, but calls to get/drawTile are much faster.

Author:

Marvin Bruns

Constructor Summary

Constructors

Constructor and Description
BufferedSprite(BufferedImage image, int width, int height) Creates a new BufferedSprite.

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

Methods inherited from class java.lang.Object

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

Constructor Detail

BufferedSprite

public BufferedSprite(BufferedImage image,
                      int width,
                      int height)

Creates a new BufferedSprite. The given BufferedImage is copied.

Method Detail

drawTile

public 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).

Specified by:

drawTile in interface Sprite

Parameters:

g - Graphics 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

public BufferedImage getTile(int x,
                             int y)

Get a tile of this sprite. Creates a copy of the underlying tile. Otherwise the original tile would be transformed. User drawTile(Graphics2D, int, int, int, int) for faster action.

Specified by:

getTile in interface Sprite

Parameters:

x - X-Coordinate of the tile

y - Y-Coordinate of the tile

Returns:

A BufferedImage containing the tile

getTileCount

public int getTileCount()

Description copied from interface: Sprite

Get the number of tiles in this sprite.

Specified by:

getTileCount in interface Sprite

getRows

public int getRows()

Description copied from interface: Sprite

Get the number of rows.

Specified by:

getRows in interface Sprite

getColumns

public int getColumns()

Description copied from interface: Sprite

Get the number of columns.

Specified by:

getColumns in interface Sprite

getTileWidth

public int getTileWidth()

Description copied from interface: Sprite

Get the width of one tile

Specified by:

getTileWidth in interface Sprite

getTileHeight

public int getTileHeight()

Description copied from interface: Sprite

Get the height of one tile

Specified by:

getTileHeight in interface Sprite

getSubSprite

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

Description copied from interface: Sprite

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

Specified by:

getSubSprite in interface 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