org.mini2Dx.libgdx.graphics

Class LibgdxSpriteCache

java.lang.Object

org.mini2Dx.libgdx.graphics.LibgdxSpriteCache

All Implemented Interfaces:

SpriteCache

public class LibgdxSpriteCache
extends java.lang.Object
implements SpriteCache

Constructor Summary

Constructors

Constructor and Description
LibgdxSpriteCache()

Method Summary

Modifier and Type	Method and Description
int	add(Sprite sprite) Adds a Sprite to the cache.
int	add(Texture texture, float x, float y) Adds a Texture to the cache
int	add(Texture texture, float x, float y, int srcX, int srcY, int srcWidth, int srcHeight) Adds a region of a Texture to the cache
int	add(Texture texture, float x, float y, int srcX, int srcY, int srcWidth, int srcHeight, boolean flipX, boolean flipY) Adds a region of a Texture to the cache
int	add(Texture texture, float x, float y, int srcX, int srcY, int srcWidth, int srcHeight, float scaleX, float scaleY, boolean flipX, boolean flipY) Adds a transformed region of a Texture to the cache
int	add(Texture texture, float x, float y, int srcX, int srcY, int srcWidth, int srcHeight, float scaleX, float scaleY, float originX, float originY, float rotation, boolean flipX, boolean flipY) Adds a transformed region of a Texture to the cache
int	add(TextureRegion region, float x, float y) Adds a TextureRegion to the cache
int	add(TextureRegion region, float x, float y, float scaleX, float scaleY) Adds a scaled TextureRegion to the cache
int	add(TextureRegion region, float x, float y, float scaleX, float scaleY, float originX, float originY, float rotation) Adds a scaled TextureRegion to the cache
int	add(TextureRegion region, float x, float y, float scaleX, float scaleY, float originX, float originY, float rotation, boolean flipX, boolean flipY) Adds a scaled TextureRegion to the cache
void	beginCache() Starts the definition of a new cache
void	beginCache(int cacheID) Starts the redefinition of an existing cache
void	clear() Invalidates all the caches and resets the SpriteCache.
void	dispose() Releases all the resources held by this SpriteCache.
void	draw(Graphics g, int cacheID) Draws all the images defined in a SpriteCache to the screen.
void	draw(Graphics g, int cacheID, int offset, int length) Draws a subset of the images defined in a SpriteCache to the screen.
int	endCache() Ends the definition of the current cache
Color	getColor() Indicates the Color currently used to tint images when they are added to the SpriteCache
Shader	getCustomShader() Indicates the custom Shader used to draw images to the cache
boolean	isDrawing() Indicates if SpriteCache.beginCache() has been called
void	setColor(Color tint) Sets the Color used to tint images when they are added to the SpriteCache
void	setColor(float r, float g, float b, float a) Sets the Color used to tint images when they are added to the SpriteCache
void	setCustomShader(Shader shader) Sets the custom Shader used to draw images to the cache

Methods inherited from class java.lang.Object

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

Constructor Detail

LibgdxSpriteCache

public LibgdxSpriteCache()

Method Detail

add

public int add(Sprite sprite)

Description copied from interface: SpriteCache

Adds a Sprite to the cache.

Specified by:

add in interface SpriteCache

Parameters:

sprite - The Sprite to be added.

Returns:

The index of the added sprite

add

public int add(Texture texture,
               float x,
               float y)

Description copied from interface: SpriteCache

Adds a Texture to the cache

Specified by:

add in interface SpriteCache

Parameters:

texture - The texture to be added

x - x position of the texture

y - y position of the texture

Returns:

The index of the added texture

add

public int add(Texture texture,
               float x,
               float y,
               int srcX,
               int srcY,
               int srcWidth,
               int srcHeight)

Description copied from interface: SpriteCache

Adds a region of a Texture to the cache

Specified by:

add in interface SpriteCache

Parameters:

texture - the texture to be added

x - x position of the texture

y - y position of the texture

srcX - x point in the texture

srcY - y point in the texture

srcWidth - width of the region to be drawn

srcHeight - height of the region to be drawn

Returns:

The index of the added texture

add

public int add(Texture texture,
               float x,
               float y,
               int srcX,
               int srcY,
               int srcWidth,
               int srcHeight,
               boolean flipX,
               boolean flipY)

Description copied from interface: SpriteCache

Adds a region of a Texture to the cache

Specified by:

add in interface SpriteCache

Parameters:

texture - the texture to be added

x - x position of the texture

y - y position of the texture

srcX - x point in the texture

srcY - y point in the texture

srcWidth - width of the region to be drawn

srcHeight - height of the region to be drawn

flipX - indication of whether the region should be drawn x-flipped

flipY - indication of whether the region should be drawn y-flipped

Returns:

The index of the added texture

add

public int add(Texture texture,
               float x,
               float y,
               int srcX,
               int srcY,
               int srcWidth,
               int srcHeight,
               float scaleX,
               float scaleY,
               boolean flipX,
               boolean flipY)

Description copied from interface: SpriteCache

Adds a transformed region of a Texture to the cache

Specified by:

add in interface SpriteCache

Parameters:

texture - the texture to be added

x - x position of the texture

y - y position of the texture

srcX - x point in the texture

srcY - y point in the texture

srcWidth - width of the region to be drawn

srcHeight - height of the region to be drawn

scaleX - scale of the texture in the x direction

scaleY - scale of the texture in the y direction

flipX - indication of whether the region should be drawn x-flipped

flipY - indication of whether the region should be drawn y-flipped

Returns:

The index of the added texture

add

public int add(Texture texture,
               float x,
               float y,
               int srcX,
               int srcY,
               int srcWidth,
               int srcHeight,
               float scaleX,
               float scaleY,
               float originX,
               float originY,
               float rotation,
               boolean flipX,
               boolean flipY)

Description copied from interface: SpriteCache

Adds a transformed region of a Texture to the cache

Specified by:

add in interface SpriteCache

Parameters:

texture - the texture to be added

x - x position of the texture

y - y position of the texture

srcX - x point in the texture

srcY - y point in the texture

srcWidth - width of the region to be drawn

srcHeight - height of the region to be drawn

scaleX - scale of the texture in the x direction

scaleY - scale of the texture in the y direction

originX - x position of the point around which the texture should be rotated

originY - y position of the point around which the texture should be rotated

rotation - rotation of the texture around the origin point (in degrees)

flipX - indication of whether the region should be drawn x-flipped

flipY - indication of whether the region should be drawn y-flipped

Returns:

The index of the added texture

add

public int add(TextureRegion region,
               float x,
               float y)

Description copied from interface: SpriteCache

Adds a TextureRegion to the cache

Specified by:

add in interface SpriteCache

Parameters:

region - the texture region to be added

x - x position of the texture region

y - y position of the texture region

Returns:

The index of the added texture region

add

public int add(TextureRegion region,
               float x,
               float y,
               float scaleX,
               float scaleY)

Description copied from interface: SpriteCache

Adds a scaled TextureRegion to the cache

Specified by:

add in interface SpriteCache

Parameters:

region - the texture region to be added

x - x position of the texture region

y - y position of the texture region

scaleX - scale of the texture region in the x direction

scaleY - scale of the texture region in the y direction

Returns:

The index of the added texture region

add

public int add(TextureRegion region,
               float x,
               float y,
               float scaleX,
               float scaleY,
               float originX,
               float originY,
               float rotation)

Description copied from interface: SpriteCache

Adds a scaled TextureRegion to the cache

Specified by:

add in interface SpriteCache

Parameters:

region - the texture region to be added

x - x position of the texture region

y - y position of the texture region

scaleX - scale of the texture region in the x direction

scaleY - scale of the texture region in the y direction

originX - x position of the point around which the region should be rotated

originY - y position of the point around which the region should be rotated

rotation - rotation of the texture around the origin point (in degrees)

Returns:

The index of the added texture region

add

public int add(TextureRegion region,
               float x,
               float y,
               float scaleX,
               float scaleY,
               float originX,
               float originY,
               float rotation,
               boolean flipX,
               boolean flipY)

Description copied from interface: SpriteCache

Adds a scaled TextureRegion to the cache

Specified by:

add in interface SpriteCache

Parameters:

region - the texture region to be added

x - x position of the texture region

y - y position of the texture region

scaleX - scale of the texture region in the x direction

scaleY - scale of the texture region in the y direction

originX - x position of the point around which the region should be rotated

originY - y position of the point around which the region should be rotated

rotation - rotation of the texture around the origin point (in degrees)

flipX - indication of whether the region should be drawn x-flipped

flipY - indication of whether the region should be drawn y-flipped

Returns:

The index of the added texture region

clear

public void clear()

Description copied from interface: SpriteCache

Invalidates all the caches and resets the SpriteCache.

Specified by:

clear in interface SpriteCache

dispose

public void dispose()

Description copied from interface: SpriteCache

Releases all the resources held by this SpriteCache.

Specified by:

dispose in interface SpriteCache

draw

public void draw(Graphics g,
                 int cacheID)

Description copied from interface: SpriteCache

Draws all the images defined in a SpriteCache to the screen.

Specified by:

draw in interface SpriteCache

Parameters:

g - the current Graphics context

cacheID - ID of the SpriteCache containing the images to draw.

draw

public void draw(Graphics g,
                 int cacheID,
                 int offset,
                 int length)

Description copied from interface: SpriteCache

Draws a subset of the images defined in a SpriteCache to the screen.

Specified by:

draw in interface SpriteCache

Parameters:

g - the current Graphics context

cacheID - ID of the SpriteCache containing the images to draw.

offset - The index of the first image to draw

length - The number of the images to draw

beginCache

public void beginCache()

Description copied from interface: SpriteCache

Starts the definition of a new cache

Specified by:

beginCache in interface SpriteCache

beginCache

public void beginCache(int cacheID)

Description copied from interface: SpriteCache

Starts the redefinition of an existing cache

Specified by:

beginCache in interface SpriteCache

Parameters:

cacheID - ID of the cache to be redefined

endCache

public int endCache()

Description copied from interface: SpriteCache

Ends the definition of the current cache

Specified by:

endCache in interface SpriteCache

Returns:

ID of the current cache

getColor

public Color getColor()

Description copied from interface: SpriteCache

Indicates the Color currently used to tint images when they are added to the SpriteCache

Specified by:

getColor in interface SpriteCache

Returns:

the color currently used to tint images when they are added to the SpriteCache

setColor

public void setColor(Color tint)

Description copied from interface: SpriteCache

Sets the Color used to tint images when they are added to the SpriteCache

Specified by:

setColor in interface SpriteCache

Parameters:

tint - the new color to be used to tint images when they are added to the SpriteCache

setColor

public void setColor(float r,
                     float g,
                     float b,
                     float a)

Description copied from interface: SpriteCache

Sets the Color used to tint images when they are added to the SpriteCache

Specified by:

setColor in interface SpriteCache

Parameters:

r - The red value of the new color (0.0-1.0)

g - The green value of the new color (0.0-1.0)

b - The blue value of the new color (0.0-1.0)

a - The alpha value of the new color (0.0-1.0)

getCustomShader

public Shader getCustomShader()

Description copied from interface: SpriteCache

Indicates the custom Shader used to draw images to the cache

Specified by:

getCustomShader in interface SpriteCache

Returns:

the custom Shader used to draw images to the cache

setCustomShader

public void setCustomShader(Shader shader)

Description copied from interface: SpriteCache

Sets the custom Shader used to draw images to the cache

Specified by:

setCustomShader in interface SpriteCache

Parameters:

shader - the new custom Shader used to draw images to the cache

isDrawing

public boolean isDrawing()

Description copied from interface: SpriteCache

Indicates if SpriteCache.beginCache() has been called

Specified by:

isDrawing in interface SpriteCache

Returns:

beginCache has been called