org.mini2Dx.core.graphics

Class TextureAtlas

java.lang.Object

org.mini2Dx.core.graphics.TextureAtlas

All Implemented Interfaces:

org.mini2Dx.gdx.utils.Disposable

public class TextureAtlas
extends java.lang.Object
implements org.mini2Dx.gdx.utils.Disposable

Constructor Summary

Constructors

Constructor and Description
TextureAtlas(FileHandle packFile, FileHandle imagesDir)
TextureAtlas(TextureAtlasConfig config)

Method Summary

Modifier and Type	Method and Description
void	dispose()
TextureAtlasRegion	findRegion(java.lang.String name) Returns the first region found with the specified name.
TextureAtlasRegion	findRegion(java.lang.String name, int index) Returns the first region found with the specified name and index.
org.mini2Dx.gdx.utils.Array<TextureAtlasRegion>	findRegions(java.lang.String name) Returns all regions with the specified name, ordered by smallest to largest index.
org.mini2Dx.gdx.utils.Array<TextureAtlasRegion>	getRegions() Returns all regions in the atlas.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextureAtlas

public TextureAtlas(FileHandle packFile,
                    FileHandle imagesDir)

TextureAtlas

public TextureAtlas(TextureAtlasConfig config)

Method Detail

getRegions

public org.mini2Dx.gdx.utils.Array<TextureAtlasRegion> getRegions()

Returns all regions in the atlas.

findRegion

public TextureAtlasRegion findRegion(java.lang.String name)

Returns the first region found with the specified name. This method uses string comparison to find the region, so the result should be cached rather than calling this method multiple times.

Returns:

The region, or null.

findRegion

public TextureAtlasRegion findRegion(java.lang.String name,
                                     int index)

Returns the first region found with the specified name and index. This method uses string comparison to find the region, so the result should be cached rather than calling this method multiple times.

Returns:

The region, or null.

findRegions

public org.mini2Dx.gdx.utils.Array<TextureAtlasRegion> findRegions(java.lang.String name)

Returns all regions with the specified name, ordered by smallest to largest index. This method uses string comparison to find the regions, so the result should be cached rather than calling this method multiple times.

dispose

public void dispose()

Specified by:

dispose in interface org.mini2Dx.gdx.utils.Disposable