io.anuke.ucore.graphics

Class Atlas

java.lang.Object

com.badlogic.gdx.graphics.g2d.TextureAtlas

io.anuke.ucore.graphics.Atlas

All Implemented Interfaces:

com.badlogic.gdx.utils.Disposable

public class Atlas
extends com.badlogic.gdx.graphics.g2d.TextureAtlas

Utility class that improves on TextureAtlas - faster texture lookups with an ObjectMap and automatic error textures.

Nested Class Summary

Nested classes/interfaces inherited from class com.badlogic.gdx.graphics.g2d.TextureAtlas

com.badlogic.gdx.graphics.g2d.TextureAtlas.AtlasRegion, com.badlogic.gdx.graphics.g2d.TextureAtlas.AtlasSprite, com.badlogic.gdx.graphics.g2d.TextureAtlas.TextureAtlasData

Constructor Summary

Constructors

Constructor and Description
Atlas(com.badlogic.gdx.files.FileHandle file)

Method Summary

Modifier and Type	Method and Description
com.badlogic.gdx.graphics.g2d.TextureAtlas.AtlasRegion	addRegion(java.lang.String name, com.badlogic.gdx.graphics.Texture texture, int x, int y, int width, int height)
void	dispose()
com.badlogic.gdx.graphics.g2d.TextureAtlas.AtlasRegion	findRegion(java.lang.String name) Note that this returns the 'error' region if this region is not found.
com.badlogic.gdx.graphics.Pixmap	getPixmapOf(java.lang.String name)
com.badlogic.gdx.graphics.Pixmap	getPixmapOf(com.badlogic.gdx.graphics.g2d.TextureRegion region) Used for getting the pixmap of a certain region.
boolean	hasRegion(java.lang.String s)
float	regionHeight(java.lang.String name)
float	regionWidth(java.lang.String name)
void	setErrorRegion(com.badlogic.gdx.graphics.g2d.TextureAtlas.AtlasRegion region) Sets the error region to the specified region.

Methods inherited from class com.badlogic.gdx.graphics.g2d.TextureAtlas

addRegion, createPatch, createSprite, createSprite, createSprites, createSprites, findRegion, findRegions, getRegions, getTextures

Methods inherited from class java.lang.Object

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

Constructor Detail

Atlas

public Atlas(com.badlogic.gdx.files.FileHandle file)

Method Detail

getPixmapOf

public com.badlogic.gdx.graphics.Pixmap getPixmapOf(java.lang.String name)

getPixmapOf

public com.badlogic.gdx.graphics.Pixmap getPixmapOf(com.badlogic.gdx.graphics.g2d.TextureRegion region)

Used for getting the pixmap of a certain region. Note that it is internally stored and disposed when needed.

Parameters:

region - the region to use.

Returns:

the pixmap of the region.

addRegion

public com.badlogic.gdx.graphics.g2d.TextureAtlas.AtlasRegion addRegion(java.lang.String name,
                                                                        com.badlogic.gdx.graphics.Texture texture,
                                                                        int x,
                                                                        int y,
                                                                        int width,
                                                                        int height)

Overrides:

addRegion in class com.badlogic.gdx.graphics.g2d.TextureAtlas

setErrorRegion

public void setErrorRegion(com.badlogic.gdx.graphics.g2d.TextureAtlas.AtlasRegion region)

Sets the error region to the specified region.

findRegion

public com.badlogic.gdx.graphics.g2d.TextureAtlas.AtlasRegion findRegion(java.lang.String name)

Note that this returns the 'error' region if this region is not found.

Overrides:

findRegion in class com.badlogic.gdx.graphics.g2d.TextureAtlas

regionHeight

public float regionHeight(java.lang.String name)

regionWidth

public float regionWidth(java.lang.String name)

hasRegion

public boolean hasRegion(java.lang.String s)

Returns:

whether or not the specified region is found.

dispose

public void dispose()

Specified by:

dispose in interface com.badlogic.gdx.utils.Disposable

Overrides:

dispose in class com.badlogic.gdx.graphics.g2d.TextureAtlas