TiledMapData (mini2Dx)

java.lang.Object
- org.mini2Dx.tiled.TiledMapData

All Implemented Interfaces:

TiledLayerParserListener, 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 FileHandle`	`fileHandle`
`protected org.mini2Dx.gdx.utils.Array<Layer>`	`layers`
`static long`	`MAX_TILESET_LOAD_TIMESLICE_MILLIS`
`protected org.mini2Dx.gdx.utils.ObjectMap<java.lang.String,TiledObjectGroup>`	`objectGroups`
`protected org.mini2Dx.gdx.utils.IntSet`	`tilesetGids`
`protected org.mini2Dx.gdx.utils.Array<Tileset>`	`tilesets`

Constructor Summary

Constructors
Constructor and Description

TiledMapData(FileHandle fileHandle)

TiledMapData(TiledParser tiledParser, FileHandle fileHandle)

Constructors
Constructor and Description
`TiledMapData(FileHandle fileHandle)`
`TiledMapData(TiledParser tiledParser, FileHandle fileHandle)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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
`org.mini2Dx.gdx.utils.Array<Tile>`	`getAnimatedTiles()`
`Color`	`getBackgroundColor()` Returns the background `Color` of the map
`org.mini2Dx.gdx.utils.Array<AssetDescriptor>`	`getDependencies()`
`FileHandle`	`getFileHandle()` Returns the `FileHandle` for this data
`static GroupLayer`	`getGroupLayer(org.mini2Dx.gdx.utils.Array<Layer> layers, java.lang.String name, boolean recursive)` Returns the `GroupLayer` with the given name
`GroupLayer`	`getGroupLayer(int index)` Returns the `GroupLayer` at the given index
`GroupLayer`	`getGroupLayer(java.lang.String name)` Returns the `GroupLayer` with the given name
`GroupLayer`	`getGroupLayer(java.lang.String name, boolean recursive)` 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
`org.mini2Dx.gdx.utils.Array<Layer>`	`getLayers()` Returns the `Layer`s of this map
`static TiledObjectGroup`	`getObjectGroup(org.mini2Dx.gdx.utils.Array<Layer> layers, org.mini2Dx.gdx.utils.ObjectMap<java.lang.String,TiledObjectGroup> objectGroups, java.lang.String name, boolean recursive)` Returns the `TiledObjectGroup` with the given name
`TiledObjectGroup`	`getObjectGroup(java.lang.String name)` Returns the `TiledObjectGroup` with the given name
`TiledObjectGroup`	`getObjectGroup(java.lang.String name, boolean recursive)` Returns the `TiledObjectGroup` with the given name
`java.lang.Iterable<TiledObjectGroup>`	`getObjectGroups()` Returns all the `TiledObjectGroup`s 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
`static TileLayer`	`getTileLayer(org.mini2Dx.gdx.utils.Array<Layer> layers, java.lang.String name, boolean recursive)` Returns the `TileLayer` with the given name
`TileLayer`	`getTileLayer(int index)` Returns the `TileLayer` at the given index
`TileLayer`	`getTileLayer(java.lang.String name)` Returns the `TileLayer` with the given name
`TileLayer`	`getTileLayer(java.lang.String name, boolean recursive)` Returns the `TileLayer` with the given name
`org.mini2Dx.gdx.utils.Array<Tileset>`	`getTilesets()` Returns the `Tileset`s 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
`boolean`	`loadTilesetTextures()` Loads all `Tileset` textures for this map if they are not already loaded Note: Depending on the texture sizes, this may need to be called over several frames
`boolean`	`loadTilesetTextures(AssetManager assetManager)` Loads all `Tileset` textures for this map if they are not already loaded Note: Depending on the texture sizes, this may need to be called over several frames
`boolean`	`loadTilesetTextures(AssetManager assetManager, boolean loadObjectTemplateTilesets)` Loads all `Tileset` textures for this map if they are not already loaded Note: Depending on the texture sizes, this may need to be called over several frames
`boolean`	`loadTilesetTextures(boolean loadObjectTemplateTilesets)` Loads all `Tileset` textures for this map if they are not already loaded Note: Depending on the texture sizes, this may need to be called over several frames
`boolean`	`loadTilesetTextures(TextureAtlas textureAtlas)` Loads all `Tileset` textures for this map if they are not already loaded Note: Depending on the texture sizes, this may need to be called over several frames
`boolean`	`loadTilesetTextures(TextureAtlas textureAtlas, boolean loadObjectTemplateTilesets)` Loads all `Tileset` textures for this map if they are not already loaded Note: Depending on the texture sizes, this may need to be called over several frames
`void`	`onBeginParsing(java.lang.String orientation, java.lang.String staggerAxis, java.lang.String staggerIndex, 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
  - MAX_TILESET_LOAD_TIMESLICE_MILLIS
```
public static long MAX_TILESET_LOAD_TIMESLICE_MILLIS
```
  - fileHandle
```
protected final FileHandle fileHandle
```
  - tilesets
```
protected final org.mini2Dx.gdx.utils.Array<Tileset> tilesets
```
  - tilesetGids
```
protected final org.mini2Dx.gdx.utils.IntSet tilesetGids
```
  - layers
```
protected final org.mini2Dx.gdx.utils.Array<Layer> layers
```
  - objectGroups
```
protected final org.mini2Dx.gdx.utils.ObjectMap<java.lang.String,TiledObjectGroup> objectGroups
```
- Constructor Detail
  - TiledMapData
```
public TiledMapData(FileHandle fileHandle)
```
    Parameters:
    
    fileHandle -
    
    Throws:
    
    TiledException
  - TiledMapData
```
public TiledMapData(TiledParser tiledParser,
                    FileHandle fileHandle)
```
    Parameters:
    
    tiledParser -
    
    fileHandle -
    
    Throws:
    
    TiledException
- Method Detail
  - getDependencies
```
public org.mini2Dx.gdx.utils.Array<AssetDescriptor> getDependencies()
```
  - loadTilesetTextures
```
public boolean loadTilesetTextures()
```
    Loads all Tileset textures for this map if they are not already loaded
    Note: Depending on the texture sizes, this may need to be called over several frames
    
    Returns:
    
    True if all tilesets + textures have been loaded, otherwise false
  - loadTilesetTextures
```
public boolean loadTilesetTextures(AssetManager assetManager)
```
    Loads all Tileset textures for this map if they are not already loaded
    Note: Depending on the texture sizes, this may need to be called over several frames
    
    Parameters:
    
    assetManager - The AssetManager to use
    
    Returns:
    
    True if all tilesets + textures have been loaded, otherwise false
  - loadTilesetTextures
```
public boolean loadTilesetTextures(TextureAtlas textureAtlas)
```
    Loads all Tileset textures for this map if they are not already loaded
    Note: Depending on the texture sizes, this may need to be called over several frames
    
    Parameters:
    
    textureAtlas - The TextureAtlas to load textures from
    
    Returns:
    
    True if all tilesets + textures have been loaded, otherwise false
  - loadTilesetTextures
```
public boolean loadTilesetTextures(boolean loadObjectTemplateTilesets)
```
    Loads all Tileset textures for this map if they are not already loaded
    Note: Depending on the texture sizes, this may need to be called over several frames
    
    Parameters:
    
    loadObjectTemplateTilesets - True if tilesets used by object templates should be loaded
    
    Returns:
    
    True if all tilesets + textures have been loaded, otherwise false
  - loadTilesetTextures
```
public boolean loadTilesetTextures(AssetManager assetManager,
                                   boolean loadObjectTemplateTilesets)
```
    Loads all Tileset textures for this map if they are not already loaded
    Note: Depending on the texture sizes, this may need to be called over several frames
    
    Parameters:
    
    loadObjectTemplateTilesets - True if tilesets used by object templates should be loaded
    
    assetManager - The AssetManager to use
    
    Returns:
    
    True if all tilesets + textures have been loaded, otherwise false
  - loadTilesetTextures
```
public boolean loadTilesetTextures(TextureAtlas textureAtlas,
                                   boolean loadObjectTemplateTilesets)
```
    Loads all Tileset textures for this map if they are not already loaded
    Note: Depending on the texture sizes, this may need to be called over several frames
    
    Parameters:
    
    loadObjectTemplateTilesets - True if tilesets used by object templates should be loaded
    
    textureAtlas - The TextureAtlas to load textures from
    
    Returns:
    
    True if all tilesets + textures have been loaded, otherwise false
  - onBeginParsing
```
public void onBeginParsing(java.lang.String orientation,
                           java.lang.String staggerAxis,
                           java.lang.String staggerIndex,
                           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 TiledLayerParserListener
  - onObjectGroupParsed
```
public void onObjectGroupParsed(TiledObjectGroup parsedObjectGroup)
```
    Specified by:
    
    onObjectGroupParsed in interface TiledLayerParserListener
  - onGroupLayerParsed
```
public void onGroupLayerParsed(GroupLayer parsedLayer)
```
    Specified by:
    
    onGroupLayerParsed in interface TiledLayerParserListener
  - 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(java.lang.String name,
                              boolean recursive)
```
    Returns the TileLayer with the given name
    
    Parameters:
    
    name - The name to search for
    
    recursive - False if only the root's immediate child layers should be searched (ignoring descendants)
    
    Returns:
    
    Null if there is no such TileLayer
  - getTileLayer
```
public static TileLayer getTileLayer(org.mini2Dx.gdx.utils.Array<Layer> layers,
                                     java.lang.String name,
                                     boolean recursive)
```
    Returns the TileLayer with the given name
    
    Parameters:
    
    layers - The layers to search through
    
    name - The name to search for
    
    recursive - False if only the immediate layers should be searched (ignoring descendants)
    
    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
  - getObjectGroup
```
public TiledObjectGroup getObjectGroup(java.lang.String name,
                                       boolean recursive)
```
    Returns the TiledObjectGroup with the given name
    
    Parameters:
    
    name - The name to search for
    
    recursive - False if only the immediate layers should be searched (ignoring descendants)
    
    Returns:
    
    Null if there is no such TiledObjectGroup
  - getObjectGroup
```
public static TiledObjectGroup getObjectGroup(org.mini2Dx.gdx.utils.Array<Layer> layers,
                                              org.mini2Dx.gdx.utils.ObjectMap<java.lang.String,TiledObjectGroup> objectGroups,
                                              java.lang.String name,
                                              boolean recursive)
```
    Returns the TiledObjectGroup with the given name
    
    Parameters:
    
    layers - The layers to search through
    
    objectGroups - A map of layer names to object groups
    
    name - The name to search for
    
    recursive - False if only the immediate layers should be searched (ignoring descendants)
    
    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(java.lang.String name,
                                boolean recursive)
```
    Returns the GroupLayer with the given name
    
    Parameters:
    
    name - The name of the layer
    
    recursive - False if only the root's immediate child layers should be searched (ignoring descendants)
    
    Returns:
    
    Null if the layer does not exist
  - getGroupLayer
```
public static GroupLayer getGroupLayer(org.mini2Dx.gdx.utils.Array<Layer> layers,
                                       java.lang.String name,
                                       boolean recursive)
```
    Returns the GroupLayer with the given name
    
    Parameters:
    
    layers - The layers to search through
    
    name - The name of the layer
    
    recursive - False if only the immediate layers should be searched (ignoring descendants)
    
    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 org.mini2Dx.gdx.utils.Array<Tileset> getTilesets()
```
    Returns the Tilesets of this map
    
    Returns:
    
    An empty list if none have been loaded
  - getLayers
```
public org.mini2Dx.gdx.utils.Array<Layer> getLayers()
```
    Returns the Layers of this map
    
    Returns:
  - getAnimatedTiles
```
public org.mini2Dx.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 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 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

Class TiledMapData

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAX_TILESET_LOAD_TIMESLICE_MILLIS

fileHandle

tilesets

tilesetGids

layers

objectGroups

Constructor Detail

TiledMapData

TiledMapData

Method Detail

getDependencies

loadTilesetTextures

loadTilesetTextures

loadTilesetTextures

loadTilesetTextures

loadTilesetTextures

loadTilesetTextures

onBeginParsing

containsProperty

getProperty

setProperty

onMapPropertyParsed

onTilePropertiesParsed

onTilesetParsed

onTileLayerParsed

onObjectGroupParsed

onGroupLayerParsed

onObjectTemplateParsed

getTileLayer

getTileLayer

getTileLayer

getTileLayer

getObjectGroup

getObjectGroup

getObjectGroup

getGroupLayer

getGroupLayer

getGroupLayer

getGroupLayer

getObjectGroups

getLayerIndex

getLayerIndexIgnoreCase

getTile

getTile

getOrientation

getStaggerAxis

getStaggerIndex

getSideLength

getWidth

getHeight

getTileWidth

getTileHeight

getPixelWidth

getPixelHeight

getTilesets

getLayers

getAnimatedTiles

getTotalObjectGroups

getTotalLayers

getBackgroundColor

containsAnimatedTiles

isTilesetTexturesLoaded

isTilesetTexturesLoaded

getFileHandle

dispose

dispose