org.cell2d

Class SpriteSheet

java.lang.Object

org.cell2d.SpriteSheet

All Implemented Interfaces:

java.lang.Iterable<Sprite>, Loadable

public class SpriteSheet
extends java.lang.Object
implements java.lang.Iterable<Sprite>, Loadable

A SpriteSheet is a rectangular grid of Sprites. Each Sprite has an x-coordinate in the grid that starts at 0 for the leftmost column and increases to the right, as well as a y-coordinate that starts at 0 for the topmost row and increases below. Like other Loadables, SpriteSheets can be manually loaded and unloaded into and out of memory. Loading may take a moment, but a SpriteSheet's Sprites cannot be loaded and drawn if the SpriteSheet itself is not loaded. Loading a SpriteSheet will also load all of its Sprites, and loading a Sprite that is part of a SpriteSheet will also load that SpriteSheet.

A SpriteSheet has a fixed set of Filters, specified upon its creation, that can have an effect on its Sprites when applied to them with their draw() methods. The SpriteSheet makes this possible by making a copy of its image data with each Filter applied upon being loaded. Thus, the amount of memory that a loaded SpriteSheet occupies is proportional to its number of applicable Filters plus 1.

See Also:

Sprite, Filter

Constructor Summary

Constructors

Constructor and Description
SpriteSheet(SpriteSheet spriteSheet, Filter filter, boolean load) Constructs a SpriteSheet from an existing SpriteSheet with a Filter applied to it.
SpriteSheet(java.lang.String path, int width, int height, int spriteWidth, int spriteHeight, int spacing, int margin, int originX, int originY, boolean load, Filter... filters) Constructs a SpriteSheet from an image file.
SpriteSheet(java.lang.String path, int width, int height, int spriteWidth, int spriteHeight, int spacing, int margin, int originX, int originY, Color transColor, boolean load, Filter... filters) Constructs a SpriteSheet from an image file.
SpriteSheet(java.lang.String path, int width, int height, int spriteWidth, int spriteHeight, int spacing, int margin, int originX, int originY, int transR, int transG, int transB, boolean load, Filter... filters) Constructs a SpriteSheet from an image file.

Method Summary

Modifier and Type	Method and Description
java.util.Set<Filter>	getFilters() Returns an unmodifiable Set view of the Filters that will have an effect on this SpriteSheet's Sprites when applied to them with draw().
int	getHeight() Returns the height in Sprites of this SpriteSheet.
int	getMargin() Returns the horizontal and vertical spacing in pixels between this SpriteSheet's grid of Sprites and the edges of its image.
int	getOriginX() Returns the x-coordinate in pixels on each of this SpriteSheet's Sprites of that Sprite's origin.
int	getOriginY() Returns the y-coordinate in pixels on each of this SpriteSheet's Sprites of that Sprite's origin.
int	getSpacing() Returns the horizontal and vertical spacing in pixels between Sprites in this SpriteSheet.
Sprite	getSprite(int x, int y) Returns this SpriteSheet's Sprite at the specified coordinates.
int	getSpriteHeight() Returns the height in pixels of each of this SpriteSheet's sprites.
int	getSpriteWidth() Returns the width in pixels of each of this SpriteSheet's sprites.
int	getWidth() Returns the width in Sprites of this SpriteSheet.
boolean	isLoaded() Returns whether this Loadable is loaded.
java.util.Iterator<Sprite>	iterator() Returns an Iterator over this SpriteSheet's Sprites.
boolean	load() Loads this SpriteSheet, along with all of its Sprites, if it is not already loaded.
boolean	unload() Unloads this SpriteSheet, along with all of its Sprites, if it is currently loaded.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

SpriteSheet

public SpriteSheet(java.lang.String path,
                   int width,
                   int height,
                   int spriteWidth,
                   int spriteHeight,
                   int spacing,
                   int margin,
                   int originX,
                   int originY,
                   boolean load,
                   Filter... filters)

Constructs a SpriteSheet from an image file.

Parameters:

path - The relative path to the image file

width - The width in Sprites of this SpriteSheet

height - The height in Sprites of this SpriteSheet

spriteWidth - The width in pixels of each Sprite

spriteHeight - The height in pixels of each Sprite

spacing - The horizontal and vertical spacing in pixels between Sprites

margin - The horizontal and vertical spacing in pixels between the grid of Sprites and the edges of the image

originX - The x-coordinate in pixels on each Sprite of that Sprite's origin

originY - The y-coordinate in pixels on each Sprite of that Sprite's origin

load - Whether this SpriteSheet should load upon creation

filters - The Filters that will have an effect on this SpriteSheet's Sprites when applied to them with draw()

SpriteSheet

public SpriteSheet(java.lang.String path,
                   int width,
                   int height,
                   int spriteWidth,
                   int spriteHeight,
                   int spacing,
                   int margin,
                   int originX,
                   int originY,
                   Color transColor,
                   boolean load,
                   Filter... filters)

Constructs a SpriteSheet from an image file.

Parameters:

path - The relative path to the image file

width - The width in Sprites of this SpriteSheet

height - The height in Sprites of this SpriteSheet

spriteWidth - The width in pixels of each Sprite

spriteHeight - The height in pixels of each Sprite

spacing - The horizontal and vertical spacing in pixels between Sprites

margin - The horizontal and vertical spacing in pixels between the grid of Sprites and the edges of the image

originX - The x-coordinate in pixels on each Sprite of that Sprite's origin

originY - The y-coordinate in pixels on each Sprite of that Sprite's origin

transColor - The transparent color of this SpriteSheet's Sprites, or null if there should be none

load - Whether this SpriteSheet should load upon creation

filters - The Filters that will have an effect on this SpriteSheet's Sprites when applied to them with draw()

SpriteSheet

public SpriteSheet(java.lang.String path,
                   int width,
                   int height,
                   int spriteWidth,
                   int spriteHeight,
                   int spacing,
                   int margin,
                   int originX,
                   int originY,
                   int transR,
                   int transG,
                   int transB,
                   boolean load,
                   Filter... filters)

Constructs a SpriteSheet from an image file.

Parameters:

path - The relative path to the image file

width - The width in Sprites of this SpriteSheet

height - The height in Sprites of this SpriteSheet

spriteWidth - The width in pixels of each Sprite

spriteHeight - The height in pixels of each Sprite

spacing - The horizontal and vertical spacing in pixels between Sprites

margin - The horizontal and vertical spacing in pixels between the grid of Sprites and the edges of the image

originX - The x-coordinate in pixels on each Sprite of that Sprite's origin

originY - The y-coordinate in pixels on each Sprite of that Sprite's origin

transR - The red value (0-255) of this SpriteSheet's Sprites' transparent color

transG - The green value (0-255) of this SpriteSheet's Sprites' transparent color

transB - The blue value (0-255) of this SpriteSheet's Sprites' transparent color

load - Whether this SpriteSheet should load upon creation

filters - The Filters that will have an effect on this SpriteSheet's Sprites when applied to them with draw()

SpriteSheet

public SpriteSheet(SpriteSheet spriteSheet,
                   Filter filter,
                   boolean load)

Constructs a SpriteSheet from an existing SpriteSheet with a Filter applied to it. The new SpriteSheet will have the same set of Filters that are usable with its Sprites' draw() methods as the existing Sprite.

Parameters:

spriteSheet - The SpriteSheet to create this SpriteSheet from

filter - The Filter to apply to the existing SpriteSheet

load - Whether this SpriteSheet should load upon creation

Method Detail

iterator

public final java.util.Iterator<Sprite> iterator()

Returns an Iterator over this SpriteSheet's Sprites. The Iterator does not support the remove operation.

Specified by:

iterator in interface java.lang.Iterable<Sprite>

Returns:

An Iterator over this SpriteSheet's Sprites

isLoaded

public final boolean isLoaded()

Description copied from interface: Loadable

Returns whether this Loadable is loaded.

Specified by:

isLoaded in interface Loadable

Returns:

Whether this Loadable is loaded

load

public final boolean load()

Loads this SpriteSheet, along with all of its Sprites, if it is not already loaded.

Specified by:

load in interface Loadable

Returns:

Whether the loading occurred

unload

public final boolean unload()

Unloads this SpriteSheet, along with all of its Sprites, if it is currently loaded.

Specified by:

unload in interface Loadable

Returns:

Whether the unloading occurred

getFilters

public final java.util.Set<Filter> getFilters()

Returns an unmodifiable Set view of the Filters that will have an effect on this SpriteSheet's Sprites when applied to them with draw().

Returns:

The Set of Filters that will have an effect on this SpriteSheet's Sprites when applied to them with draw()

getWidth

public final int getWidth()

Returns the width in Sprites of this SpriteSheet.

Returns:

The width in Sprites of this SpriteSheet

getHeight

public final int getHeight()

Returns the height in Sprites of this SpriteSheet.

Returns:

The height in Sprites of this SpriteSheet

getSprite

public Sprite getSprite(int x,
                        int y)

Returns this SpriteSheet's Sprite at the specified coordinates.

Parameters:

x - The x-coordinate in Sprites of the Sprite

y - The y-coordinate in Sprites of the Sprite

Returns:

The Sprite at the specified coordinates

Throws:

java.lang.IndexOutOfBoundsException - if the location is out of this SpriteSheet's bounds

getSpriteWidth

public final int getSpriteWidth()

Returns the width in pixels of each of this SpriteSheet's sprites.

Returns:

The width of each of this SpriteSheet's sprites

getSpriteHeight

public final int getSpriteHeight()

Returns the height in pixels of each of this SpriteSheet's sprites.

Returns:

The height of each of this SpriteSheet's sprites

getSpacing

public final int getSpacing()

Returns the horizontal and vertical spacing in pixels between Sprites in this SpriteSheet.

Returns:

The spacing between Sprites in this SpriteSheet

getMargin

public final int getMargin()

Returns the horizontal and vertical spacing in pixels between this SpriteSheet's grid of Sprites and the edges of its image.

Returns:

The spacing between this SpriteSheet's grid of Sprites and the edges of its image

getOriginX

public final int getOriginX()

Returns the x-coordinate in pixels on each of this SpriteSheet's Sprites of that Sprite's origin.

Returns:

The x-coordinate in pixels on each of this SpriteSheet's Sprites of that Sprite's origin

getOriginY

public final int getOriginY()

Returns the y-coordinate in pixels on each of this SpriteSheet's Sprites of that Sprite's origin.

Returns:

The y-coordinate in pixels on each of this SpriteSheet's Sprites of that Sprite's origin