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

Class InvertedSprite

java.lang.Object

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

All Implemented Interfaces:

Sprite

public class InvertedSprite
extends Object
implements Sprite

Sprite that uses another sprite and inverts the coordinates. Now the first frame is the last etc.
Mirroring is also supported.

Author:

Marvin Bruns

Constructor Summary

Constructors

Constructor and Description
InvertedSprite(DefaultSprite sprite, boolean X, boolean Y, boolean mirror)
InvertedSprite(DefaultSprite sprite, boolean invertX, boolean invertY, boolean mirrorX, boolean mirrorY)

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
boolean	isInvertX() Check if X-Coordinates are inverted
boolean	isInvertY() Check if Y-Coordinates are inverted
boolean	isMirrorX() Check if tiles are mirrored left-right
boolean	isMirrorY() Check if tiles are mirrored top-bottom

Methods inherited from class java.lang.Object

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

Constructor Detail

InvertedSprite

public InvertedSprite(DefaultSprite sprite,
                      boolean X,
                      boolean Y,
                      boolean mirror)

Parameters:

sprite - DefaultSprite used for this sprite

X - if true X-Axis is inverted

Y - if true Y-Axis is inverted

mirror - if true the X, Y parameters are used for mirroring. Otherwise coordinates will be inverted.

InvertedSprite

public InvertedSprite(DefaultSprite sprite,
                      boolean invertX,
                      boolean invertY,
                      boolean mirrorX,
                      boolean mirrorY)

Parameters:

sprite - DefaultSprite used for this sprite

invertX - if true X-Axis is inverted

invertY - if true Y-Axis is inverted

mirrorX - if true the tiles will be mirrored in X direction (left-right)

mirrorY - if true the tiles will be mirrored in Y direction (top-bottom)

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

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

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

isInvertX

public boolean isInvertX()

Check if X-Coordinates are inverted

isInvertY

public boolean isInvertY()

Check if Y-Coordinates are inverted

isMirrorX

public boolean isMirrorX()

Check if tiles are mirrored left-right

isMirrorY

public boolean isMirrorY()

Check if tiles are mirrored top-bottom

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