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

Class WeakSprite

java.lang.Object

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

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

All Implemented Interfaces:

Image, Sprite

public class WeakSprite
extends DefaultSprite

This implementation of Sprite caches tiles with WeakReference in order to find a balance between time and memory

Author:

Marvin Bruns

Constructor Summary

Constructors

Constructor and Description
WeakSprite(BufferedImage image, int width, int height) Create a new sprite.

Method Summary

Modifier and Type	Method and Description
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.

Methods inherited from class com.github.brunothg.game.engine.image.sprite.DefaultSprite

draw, drawTile, getColumns, getRows, getSize, getTileCount, getTileHeight, getTileWidth

Methods inherited from class java.lang.Object

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

Constructor Detail

WeakSprite

public WeakSprite(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. Calls to getTile(int, int) will be buffered. So changes maybe ignored or delayed. Calls to DefaultSprite.drawTile(Graphics2D, int, int, int, int) won't be buffered.

Parameters:

image - The image that contains the sub-images

width - Width of one sub-image

height - Height of one sub-image

Method Detail

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

Overrides:

getTile in class DefaultSprite

Parameters:

x - X-Coordinate of the tile

y - Y-Coordinate of the tile

Returns:

A BufferedImage containing the tile

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

Overrides:

getSubSprite in class DefaultSprite

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