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

Class DefaultSprite

java.lang.Object

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

All Implemented Interfaces:

Image, Sprite

Direct Known Subclasses:

WeakSprite

public class DefaultSprite
extends Object
implements Sprite, Image

Class for handling sprite images.

Author:

Marvin Bruns

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultSprite() When using this constructor you'll have to override all methods.
	DefaultSprite(BufferedImage image, int width, int height) Create a new sprite.

Method Summary

Modifier and Type	Method and Description
void	draw(Graphics2D g, int width, int height) Draws the image on a given Graphics2D object
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.
Size	getSize() Get the original size of the image
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

DefaultSprite

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

Create a new sprite. The given BufferedImage will be used as is. So consider passing a copy of your original image.

Parameters:

image - The image that contains the sub-images

width - Width of one sub-image

height - Height of one sub-image

DefaultSprite

protected DefaultSprite()

When using this constructor you'll have to override all methods.

Method Detail

drawTile

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

Description copied from interface: Sprite

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

Specified by:

drawTile in interface Sprite

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

draw

public void draw(Graphics2D g,
                 int width,
                 int height)

Description copied from interface: Image

Draws the image on a given Graphics2D object

Specified by:

draw in interface Image

Parameters:

g - The graphics object to draw the image on

width - The width to use for drawing

height - The height to use for drawing

getTile

public BufferedImage getTile(int x,
                             int y)

Description copied from interface: Sprite

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

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

getSize

public Size getSize()

Description copied from interface: Image

Get the original size of the image

Specified by:

getSize in interface Image

Returns:

The original size of the image

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