de.gurkenlabs.litiengine.graphics

Class Spritesheet

java.lang.Object

de.gurkenlabs.litiengine.graphics.Spritesheet

public final class Spritesheet
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object object)
static java.util.Collection<Spritesheet>	find(java.util.function.Predicate<Spritesheet> pred)
static Spritesheet	find(java.lang.String path) Finds Spritesheets that were previously loaded by any load method or by the sprites.info file.
int	getColumns() Gets the sprites per row.
static int[]	getCustomKeyFrameDurations(Spritesheet sprite)
static int[]	getCustomKeyFrameDurations(java.lang.String name)
java.awt.image.BufferedImage	getImage()
ImageFormat	getImageFormat()
java.lang.String	getName() The unique name of this spritesheet.
java.awt.image.BufferedImage	getPreview(int dimension)
int	getRows()
java.awt.image.BufferedImage	getSprite(int index)
java.awt.image.BufferedImage	getSprite(int index, int margin, int spacing)
int	getSpriteHeight() Gets the sprite height.
static java.util.Collection<Spritesheet>	getSpritesheets()
int	getSpriteWidth() Gets the sprite width.
int	getTotalNumberOfSprites() Gets the total sprites.
int	hashCode()
boolean	isLoaded()
static Spritesheet	load(java.awt.image.BufferedImage image, java.lang.String path, int spriteWidth, int spriteHeight)
static Spritesheet	load(ITileset tileset)
static Spritesheet	load(SpritesheetInfo info)
static java.util.List<Spritesheet>	load(java.lang.String spriteInfoFile) The sprite info file must be located under the GameInfo#getSpritesDirectory() directory.
static Spritesheet	load(java.lang.String path, int spriteWidth, int spriteHeight)
static Spritesheet	remove(java.lang.String path)
void	setSpriteHeight(int spriteHeight)
void	setSpriteWidth(int spriteWidth)
static void	update(SpritesheetInfo info)

Methods inherited from class java.lang.Object

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

Method Detail

getSpritesheets

public static java.util.Collection<Spritesheet> getSpritesheets()

find

public static Spritesheet find(java.lang.String path)

Finds Spritesheets that were previously loaded by any load method or by the sprites.info file.

Parameters:

path - The path of the spritesheet.

Returns:

The Spritesheet assotiated with the path or null if not loaded yet

find

public static java.util.Collection<Spritesheet> find(java.util.function.Predicate<Spritesheet> pred)

getCustomKeyFrameDurations

public static int[] getCustomKeyFrameDurations(java.lang.String name)

getCustomKeyFrameDurations

public static int[] getCustomKeyFrameDurations(Spritesheet sprite)

load

public static Spritesheet load(java.awt.image.BufferedImage image,
                               java.lang.String path,
                               int spriteWidth,
                               int spriteHeight)

load

public static Spritesheet load(ITileset tileset)

load

public static Spritesheet load(SpritesheetInfo info)

load

public static java.util.List<Spritesheet> load(java.lang.String spriteInfoFile)

The sprite info file must be located under the GameInfo#getSpritesDirectory() directory.

Parameters:

spriteInfoFile - The path to the sprite info file.

Returns:

A list of spritesheets that were loaded from the info file.

load

public static Spritesheet load(java.lang.String path,
                               int spriteWidth,
                               int spriteHeight)

remove

public static Spritesheet remove(java.lang.String path)

update

public static void update(SpritesheetInfo info)

getColumns

public int getColumns()

Gets the sprites per row.

Returns:

the sprites per row

getPreview

public java.awt.image.BufferedImage getPreview(int dimension)

getImage

public java.awt.image.BufferedImage getImage()

getImageFormat

public ImageFormat getImageFormat()

getName

public java.lang.String getName()

The unique name of this spritesheet. A spritesheet can always be identified by this name within a game project.

Returns:

The name of the spritesheet.

getRows

public int getRows()

getSprite

public java.awt.image.BufferedImage getSprite(int index)

getSprite

public java.awt.image.BufferedImage getSprite(int index,
                                              int margin,
                                              int spacing)

getSpriteHeight

public int getSpriteHeight()

Gets the sprite height.

Returns:

the sprite height

getSpriteWidth

public int getSpriteWidth()

Gets the sprite width.

Returns:

the sprite width

getTotalNumberOfSprites

public int getTotalNumberOfSprites()

Gets the total sprites.

Returns:

the total sprites

isLoaded

public boolean isLoaded()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

setSpriteHeight

public void setSpriteHeight(int spriteHeight)

setSpriteWidth

public void setSpriteWidth(int spriteWidth)