org.mini2Dx.tiled

Class TiledMapData

java.lang.Object

org.mini2Dx.tiled.TiledMapData

All Implemented Interfaces:

TiledParserListener

public class TiledMapData
extends java.lang.Object
implements TiledParserListener

Data parsed from a TMX file created with Tiled

Field Summary

Fields

Modifier and Type	Field and Description
protected com.badlogic.gdx.files.FileHandle	fileHandle
protected com.badlogic.gdx.utils.Array<Layer>	layers
protected com.badlogic.gdx.utils.ObjectMap<java.lang.String,TiledObjectGroup>	objectGroups
protected com.badlogic.gdx.utils.IntSet	tilesetGids
protected com.badlogic.gdx.utils.Array<Tileset>	tilesets

Constructor Summary

Constructors

Constructor and Description
TiledMapData(com.badlogic.gdx.files.FileHandle fileHandle)
TiledMapData(TiledParser tiledParser, com.badlogic.gdx.files.FileHandle fileHandle)

Method Summary

Modifier and Type	Method and Description
boolean	containsAnimatedTiles() Returns if this map contains animated tiles
boolean	containsProperty(java.lang.String propertyName) Returns if the map contains the specified property
void	dispose() Releases any resources used by this TiledMap including tilesets
void	dispose(boolean disposeTilesets) Releases any resources used by this TiledMap
com.badlogic.gdx.utils.Array<Tile>	getAnimatedTiles()
com.badlogic.gdx.graphics.Color	getBackgroundColor() Returns the background Color of the map
com.badlogic.gdx.utils.Array<com.badlogic.gdx.assets.AssetDescriptor>	getDependencies()
com.badlogic.gdx.files.FileHandle	getFileHandle() Returns the FileHandle for this data
GroupLayer	getGroupLayer(int index) Returns the GroupLayer at the given index
GroupLayer	getGroupLayer(java.lang.String name) Returns the GroupLayer with the given name
int	getHeight() Returns the height of the map in tiles
int	getLayerIndex(java.lang.String name) Returns the index of the TileLayer or TiledObjectGroup with the given name
int	getLayerIndexIgnoreCase(java.lang.String name) Returns the index of the TileLayer or TiledObjectGroup with the given name ignoring upper/lowercase differences
com.badlogic.gdx.utils.Array<Layer>	getLayers() Returns the Layers of this map
TiledObjectGroup	getObjectGroup(java.lang.String name) Returns the TiledObjectGroup with the given name
java.lang.Iterable<TiledObjectGroup>	getObjectGroups() Returns all the TiledObjectGroups in this map
Orientation	getOrientation() Returns the Orientation of this map
int	getPixelHeight() Return the height of the map in pixels
int	getPixelWidth() Returns the width of the map in pixels
java.lang.String	getProperty(java.lang.String propertyName) Returns the value of a specified property
int	getSideLength() Returns the stagger side length of this map
StaggerAxis	getStaggerAxis() Returns the StaggerAxis of this map
StaggerIndex	getStaggerIndex() Returns the StaggerIndex of this map
Tile	getTile(int tileId) Returns the Tile for the given tile ID
Tile	getTile(int x, int y, int layer) Returns the Tile at the given coordinate on a specific layer
int	getTileHeight() Returns the height of tiles in pixels
TileLayer	getTileLayer(int index) Returns the TileLayer at the given index
TileLayer	getTileLayer(java.lang.String name) Returns the TileLayer with the given name
com.badlogic.gdx.utils.Array<Tileset>	getTilesets() Returns the Tilesets of this map
int	getTileWidth() Returns the width of tiles in pixels
int	getTotalLayers() Returns the total amount of Layer instances
int	getTotalObjectGroups() Returns the total amount of TiledObjectGroup instances
int	getWidth() Returns the width of the map in tiles
boolean	isTilesetTexturesLoaded() Returns if the Tileset images have been loaded
boolean	isTilesetTexturesLoaded(boolean ignoreObjectTemplateTilesets) Returns if the Tileset images have been loaded
void	loadTilesetTextures()
void	loadTilesetTextures(com.badlogic.gdx.assets.AssetManager assetManager)
void	loadTilesetTextures(com.badlogic.gdx.assets.AssetManager assetManager, boolean loadObjectTemplateTilesets)
void	loadTilesetTextures(boolean loadObjectTemplateTilesets)
void	loadTilesetTextures(com.badlogic.gdx.graphics.g2d.TextureAtlas textureAtlas)
void	loadTilesetTextures(com.badlogic.gdx.graphics.g2d.TextureAtlas textureAtlas, boolean loadObjectTemplateTilesets)
void	onBeginParsing(java.lang.String orientation, java.lang.String staggerAxis, java.lang.String staggerIndex, com.badlogic.gdx.graphics.Color backgroundColor, int width, int height, int tileWidth, int tileHeight, int sideLength)
void	onGroupLayerParsed(GroupLayer parsedLayer)
void	onMapPropertyParsed(java.lang.String propertyName, java.lang.String value)
void	onObjectGroupParsed(TiledObjectGroup parsedObjectGroup)
void	onObjectTemplateParsed(TiledObjectTemplate parsedObjectTemplate)
void	onTileLayerParsed(TileLayer parsedLayer)
void	onTilePropertiesParsed(Tile tile)
void	onTilesetParsed(Tileset parsedTileset)
void	setProperty(java.lang.String propertyName, java.lang.String value) Sets the value of a specified property

Methods inherited from class java.lang.Object

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

Field Detail

fileHandle

protected final com.badlogic.gdx.files.FileHandle fileHandle

tilesets

protected final com.badlogic.gdx.utils.Array<Tileset> tilesets

tilesetGids

protected final com.badlogic.gdx.utils.IntSet tilesetGids

layers

protected final com.badlogic.gdx.utils.Array<Layer> layers

objectGroups

protected final com.badlogic.gdx.utils.ObjectMap<java.lang.String,TiledObjectGroup> objectGroups

Constructor Detail

TiledMapData

public TiledMapData(com.badlogic.gdx.files.FileHandle fileHandle)

Parameters:

fileHandle -

Throws:

TiledException

TiledMapData

public TiledMapData(TiledParser tiledParser,
                    com.badlogic.gdx.files.FileHandle fileHandle)

Parameters:

tiledParser -

fileHandle -

Throws:

TiledException

Method Detail

getDependencies

public com.badlogic.gdx.utils.Array<com.badlogic.gdx.assets.AssetDescriptor> getDependencies()

loadTilesetTextures

public void loadTilesetTextures()

loadTilesetTextures

public void loadTilesetTextures(com.badlogic.gdx.assets.AssetManager assetManager)

loadTilesetTextures

public void loadTilesetTextures(com.badlogic.gdx.graphics.g2d.TextureAtlas textureAtlas)

loadTilesetTextures

public void loadTilesetTextures(boolean loadObjectTemplateTilesets)

loadTilesetTextures

public void loadTilesetTextures(com.badlogic.gdx.assets.AssetManager assetManager,
                                boolean loadObjectTemplateTilesets)

loadTilesetTextures

public void loadTilesetTextures(com.badlogic.gdx.graphics.g2d.TextureAtlas textureAtlas,
                                boolean loadObjectTemplateTilesets)

onBeginParsing

public void onBeginParsing(java.lang.String orientation,
                           java.lang.String staggerAxis,
                           java.lang.String staggerIndex,
                           com.badlogic.gdx.graphics.Color backgroundColor,
                           int width,
                           int height,
                           int tileWidth,
                           int tileHeight,
                           int sideLength)

Specified by:

onBeginParsing in interface TiledParserListener

containsProperty

public boolean containsProperty(java.lang.String propertyName)

Returns if the map contains the specified property

Parameters:

propertyName - The property name to search for

Returns:

True if the map contains the property

getProperty

public java.lang.String getProperty(java.lang.String propertyName)

Returns the value of a specified property

Parameters:

propertyName - The property name to search for

Returns:

Null if there is no such property

setProperty

public void setProperty(java.lang.String propertyName,
                        java.lang.String value)

Sets the value of a specified property

Parameters:

propertyName - The property name to set the value for

value - The value of the property to set

onMapPropertyParsed

public void onMapPropertyParsed(java.lang.String propertyName,
                                java.lang.String value)

Specified by:

onMapPropertyParsed in interface TiledParserListener

onTilePropertiesParsed

public void onTilePropertiesParsed(Tile tile)

Specified by:

onTilePropertiesParsed in interface TiledParserListener

onTilesetParsed

public void onTilesetParsed(Tileset parsedTileset)

Specified by:

onTilesetParsed in interface TiledParserListener

onTileLayerParsed

public void onTileLayerParsed(TileLayer parsedLayer)

Specified by:

onTileLayerParsed in interface TiledParserListener

onObjectGroupParsed

public void onObjectGroupParsed(TiledObjectGroup parsedObjectGroup)

Specified by:

onObjectGroupParsed in interface TiledParserListener

onGroupLayerParsed

public void onGroupLayerParsed(GroupLayer parsedLayer)

Specified by:

onGroupLayerParsed in interface TiledParserListener

onObjectTemplateParsed

public void onObjectTemplateParsed(TiledObjectTemplate parsedObjectTemplate)

Specified by:

onObjectTemplateParsed in interface TiledParserListener

getTileLayer

public TileLayer getTileLayer(java.lang.String name)

Returns the TileLayer with the given name

Parameters:

name - The name to search for

Returns:

Null if there is no such TileLayer

getTileLayer

public TileLayer getTileLayer(int index)

Returns the TileLayer at the given index

Parameters:

index - The index of the layer

Returns:

Null if the index is out of bounds

getObjectGroup

public TiledObjectGroup getObjectGroup(java.lang.String name)

Returns the TiledObjectGroup with the given name

Parameters:

name - The name to search for

Returns:

Null if there is no such TiledObjectGroup

getGroupLayer

public GroupLayer getGroupLayer(java.lang.String name)

Returns the GroupLayer with the given name

Parameters:

name - The name of the layer

Returns:

Null if the layer does not exist

getGroupLayer

public GroupLayer getGroupLayer(int index)

Returns the GroupLayer at the given index

Parameters:

index - The index of the layer

Returns:

Null if the index is out of bounds

getObjectGroups

public java.lang.Iterable<TiledObjectGroup> getObjectGroups()

Returns all the TiledObjectGroups in this map

Returns:

Null if there are no TiledObjectGroups

getLayerIndex

public int getLayerIndex(java.lang.String name)

Returns the index of the TileLayer or TiledObjectGroup with the given name

Parameters:

name - The name to search for

Returns:

-1 if there is no such TileLayer or TiledObjectGroup

getLayerIndexIgnoreCase

public int getLayerIndexIgnoreCase(java.lang.String name)

Returns the index of the TileLayer or TiledObjectGroup with the given name ignoring upper/lowercase differences

Parameters:

name - The name to search for

Returns:

-1 if there is no such TileLayer or TiledObjectGroup

getTile

public Tile getTile(int tileId)

Returns the Tile for the given tile ID

Parameters:

tileId - The tile ID to search for

Returns:

Null if there is no Tile with the given ID

getTile

public Tile getTile(int x,
                    int y,
                    int layer)

Returns the Tile at the given coordinate on a specific layer

Parameters:

x - The x coordinate (in tiles)

y - The y coordinate (in tiles)

layer - The layer index

Returns:

Null if there is no Tile

getOrientation

public Orientation getOrientation()

Returns the Orientation of this map

Returns:

getStaggerAxis

public StaggerAxis getStaggerAxis()

Returns the StaggerAxis of this map

Returns:

Null if there is no value

getStaggerIndex

public StaggerIndex getStaggerIndex()

Returns the StaggerIndex of this map

Returns:

Null if there is no value

getSideLength

public int getSideLength()

Returns the stagger side length of this map

Returns:

-1 if there is no value

getWidth

public int getWidth()

Returns the width of the map in tiles

Returns:

getHeight

public int getHeight()

Returns the height of the map in tiles

Returns:

getTileWidth

public int getTileWidth()

Returns the width of tiles in pixels

Returns:

getTileHeight

public int getTileHeight()

Returns the height of tiles in pixels

Returns:

getPixelWidth

public int getPixelWidth()

Returns the width of the map in pixels

Returns:

getPixelHeight

public int getPixelHeight()

Return the height of the map in pixels

Returns:

getTilesets

public com.badlogic.gdx.utils.Array<Tileset> getTilesets()

Returns the Tilesets of this map

Returns:

An empty list if none have been loaded

getLayers

public com.badlogic.gdx.utils.Array<Layer> getLayers()

Returns the Layers of this map

Returns:

getAnimatedTiles

public com.badlogic.gdx.utils.Array<Tile> getAnimatedTiles()

getTotalObjectGroups

public int getTotalObjectGroups()

Returns the total amount of TiledObjectGroup instances

Returns:

getTotalLayers

public int getTotalLayers()

Returns the total amount of Layer instances

Returns:

getBackgroundColor

public com.badlogic.gdx.graphics.Color getBackgroundColor()

Returns the background Color of the map

Returns:

null by default

containsAnimatedTiles

public boolean containsAnimatedTiles()

Returns if this map contains animated tiles

Returns:

True if there are animated tiles

isTilesetTexturesLoaded

public boolean isTilesetTexturesLoaded()

Returns if the Tileset images have been loaded

Returns:

True if they have been loaded

isTilesetTexturesLoaded

public boolean isTilesetTexturesLoaded(boolean ignoreObjectTemplateTilesets)

Returns if the Tileset images have been loaded

Parameters:

ignoreObjectTemplateTilesets - True if tilesets referenced by object templates should be ignored

Returns:

True if they have been loaded

getFileHandle

public com.badlogic.gdx.files.FileHandle getFileHandle()

Returns the FileHandle for this data

Returns:

dispose

public void dispose()

Releases any resources used by this TiledMap including tilesets

dispose

public void dispose(boolean disposeTilesets)

Releases any resources used by this TiledMap

Parameters:

disposeTilesets - True if tilesets should also be disposed