TiledMap (mini2Dx)

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

All Implemented Interfaces:

TiledParserListener
```
public class TiledMap
extends java.lang.Object
implements TiledParserListener
```
An implementation of a parsed map from Tiled. Note that this implementation will cache renderings of the TileLayers to improve render speeds

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.List<Layer>`	`layers`
`protected java.util.Map<java.lang.String,TiledObjectGroup>`	`objectGroups`
`protected java.util.List<Tileset>`	`tilesets`

Constructor Summary

Constructors
Constructor and Description
`TiledMap()` Constructs an empty map
`TiledMap(com.badlogic.gdx.files.FileHandle fileHandle)` Constructs a map from a TMX file
`TiledMap(com.badlogic.gdx.files.FileHandle fileHandle, boolean loadTilesets, boolean cacheLayers)` Constructs a map from a TMX file
`TiledMap(TiledParser parser, com.badlogic.gdx.files.FileHandle fileHandle, boolean loadTilesets, boolean cacheLayers)` Constructs a map from a TMX file

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`containsProperty(java.lang.String propertyName)` Returns if the map contains the specified property
`void`	`dispose()` Releases any resources used by this TiledMap
`void`	`draw(Graphics g, int x, int y)` Draws the entire map at the specified coordinates
`void`	`draw(Graphics g, int x, int y, int layer)` Draws a layer of the map at the specified coordinates
`void`	`draw(Graphics g, int x, int y, int startTileX, int startTileY, int widthInTiles, int heightInTiles)` Draws a section of the map at the specified coordinates
`void`	`draw(Graphics g, int x, int y, int startTileX, int startTileY, int widthInTiles, int heightInTiles, int layer)` Draws a section of a specified layer of the map at the specified coordinates
`com.badlogic.gdx.graphics.Color`	`getBackgroundColor()` Returns the background `Color` of the map
`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
`java.util.List<Layer>`	`getLayers()` Returns the `Layer`s of this map
`TiledObjectGroup`	`getObjectGroup(java.lang.String name)` Returns the `TiledObjectGroup` with the given name
`java.util.Collection<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
`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
`java.util.List<Tileset>`	`getTilesets()` Returns the `Tileset`s of this map
`int`	`getTileWidth()` Returns the width of tiles in pixels
`int`	`getTotalObjectGroups()` Returns the total amount of `TiledObjectGroup` instances
`int`	`getTotalTilesetsLoaded()` Returns the total amount of `Tileset`s loaded
`int`	`getWidth()` Returns the width of the map in tiles
`boolean`	`isTilesetsLoaded()` Returns if the `Tileset` images have been loaded
`void`	`loadTileset(int tilesetIndex)` Loads a specific `Tileset`
`void`	`loadTilesets()` Loads all `Tileset`s for this map if they are not already loaded
`void`	`onBeginParsing(java.lang.String orientation, com.badlogic.gdx.graphics.Color backgroundColor, int width, int height, int tileWidth, int tileHeight)`
`protected void`	`onLayerRendered(Graphics g, TileLayer layer, int startTileX, int startTileY, int widthInTiles, int heightInTiles)` Developers can override this method to implement sprite rendering
`void`	`onMapPropertyParsed(java.lang.String propertyName, java.lang.String value)`
`void`	`onObjectGroupParsed(TiledObjectGroup parsedObjectGroup)`
`void`	`onTileLayerParsed(TileLayer parsedLayer)`
`void`	`onTilePropertiesParsed(Tile tile)`
`void`	`onTilesetParsed(Tileset parsedTileset)`
`protected boolean`	`preLayerRendered(Graphics g, TileLayer layer, int startTileX, int startTileY, int widthInTiles, int heightInTiles)` Developers can override this method which is called before a layer is rendered To prevent the layer from rendering, return false from this method.
`void`	`setProperty(java.lang.String propertyName, java.lang.String value)` Sets the value of a specified property
`void`	`setTiledObjectGroupRenderer(TiledObjectGroupRenderer tiledObjectGroupRenderer)` Sets the `TiledObjectGroupRenderer` implementation to use for rendering
`void`	`setTileLayerRenderer(TileLayerRenderer tileLayerRenderer)` Sets the `TileLayerRenderer` implementation to use for rendering

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - tilesets
```
protected java.util.List<Tileset> tilesets
```
  - layers
```
protected java.util.List<Layer> layers
```
  - objectGroups
```
protected java.util.Map<java.lang.String,TiledObjectGroup> objectGroups
```
- Constructor Detail
  - TiledMap
```
public TiledMap()
```
    Constructs an empty map
  - TiledMap
```
public TiledMap(com.badlogic.gdx.files.FileHandle fileHandle)
         throws TiledException
```
    Constructs a map from a TMX file
    
    Parameters:
    
    fileHandle - A FileHandle to a .tmx file
    
    Throws:
    
    TiledException - Thrown if there were issues with the loaded map
  - TiledMap
```
public TiledMap(com.badlogic.gdx.files.FileHandle fileHandle,
                boolean loadTilesets,
                boolean cacheLayers)
         throws TiledException
```
    Constructs a map from a TMX file
    
    Parameters:
    
    fileHandle - A FileHandle to a .tmx file
    
    loadTilesets - True if the tileset images should be loaded and the map pre-rendered
    
    Throws:
    
    TiledException - Thrown if there were issues with the loaded map
  - TiledMap
```
public TiledMap(TiledParser parser,
                com.badlogic.gdx.files.FileHandle fileHandle,
                boolean loadTilesets,
                boolean cacheLayers)
         throws TiledException
```
    Constructs a map from a TMX file
    
    Parameters:
    
    parser - An existing TiledParser instance
    
    fileHandle - A FileHandle to a .tmx file
    
    loadTilesets - True if the tileset images should be loaded and the map pre-rendered
    
    Throws:
    
    TiledException - Thrown if there were issues with the loaded map
- Method Detail
  - isTilesetsLoaded
```
public boolean isTilesetsLoaded()
```
    Returns if the Tileset images have been loaded
    
    Returns:
    
    True if they have been loaded
  - getTotalTilesetsLoaded
```
public int getTotalTilesetsLoaded()
```
    Returns the total amount of Tilesets loaded
    
    Returns:
    
    0 if none are loaded
  - loadTileset
```
public void loadTileset(int tilesetIndex)
```
    Loads a specific Tileset
    
    Parameters:
    
    tilesetIndex -
  - loadTilesets
```
public void loadTilesets()
```
    Loads all Tilesets for this map if they are not already loaded
  - draw
```
public void draw(Graphics g,
                 int x,
                 int y)
```
    Draws the entire map at the specified coordinates
    
    Parameters:
    
    g - The Graphics context available for rendering
    
    x - The x coordinate to render at
    
    y - The y coordinate to render at
  - draw
```
public void draw(Graphics g,
                 int x,
                 int y,
                 int layer)
```
    Draws a layer of the map at the specified coordinates
    
    Parameters:
    
    g - The Graphics context available for rendering
    
    x - The x coordinate to render at
    
    y - The y coordinate to render at
    
    layer - The layer index to render
  - draw
```
public void draw(Graphics g,
                 int x,
                 int y,
                 int startTileX,
                 int startTileY,
                 int widthInTiles,
                 int heightInTiles)
```
    Draws a section of the map at the specified coordinates
    
    Parameters:
    
    g - The Graphics context available for rendering
    
    x - The x coordinate to render at
    
    y - The y coordinate to render at
    
    startTileX - The x tile coordinate in the map to start from
    
    startTileY - The y tile coordinate in the map to start from
    
    widthInTiles - The amount of tiles across the x axis to render
    
    heightInTiles - The amount of tiles across the y axis to render
  - draw
```
public void draw(Graphics g,
                 int x,
                 int y,
                 int startTileX,
                 int startTileY,
                 int widthInTiles,
                 int heightInTiles,
                 int layer)
```
    Draws a section of a specified layer of the map at the specified coordinates
    
    Parameters:
    
    g - The Graphics context available for rendering
    
    x - The x coordinate to render at
    
    y - The y coordinate to render at
    
    startTileX - The x tile coordinate in the map to start from
    
    startTileY - The y tile coordinate in the map to start from
    
    widthInTiles - The amount of tiles across the x axis to render
    
    heightInTiles - The amount of tiles across the y axis to render
    
    layer - The layer index to render
  - preLayerRendered
```
protected boolean preLayerRendered(Graphics g,
                                   TileLayer layer,
                                   int startTileX,
                                   int startTileY,
                                   int widthInTiles,
                                   int heightInTiles)
```
    Developers can override this method which is called before a layer is rendered To prevent the layer from rendering, return false from this method.
    
    Parameters:
    
    g - The Graphics context used for rendering
    
    layer - The TileLayer which was just rendered
    
    startTileX - The x coordinate in tiles where rendering started
    
    startTileY - The y coordinate in tiles where rendering started
    
    widthInTiles - The amount of tiles that were rendered along the X axis
    
    heightInTiles - The amount of tiles that were rendered along the Y axis
    
    Returns:
    
    True if the layer should be rendered
  - onLayerRendered
```
protected void onLayerRendered(Graphics g,
                               TileLayer layer,
                               int startTileX,
                               int startTileY,
                               int widthInTiles,
                               int heightInTiles)
```
    Developers can override this method to implement sprite rendering
    
    Parameters:
    
    g - The Graphics context used for rendering
    
    layer - The TileLayer which was just rendered
    
    startTileX - The x coordinate in tiles where rendering started
    
    startTileY - The y coordinate in tiles where rendering started
    
    widthInTiles - The amount of tiles that were rendered along the X axis
    
    heightInTiles - The amount of tiles that were rendered along the Y axis
  - 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
  - onBeginParsing
```
public void onBeginParsing(java.lang.String orientation,
                           com.badlogic.gdx.graphics.Color backgroundColor,
                           int width,
                           int height,
                           int tileWidth,
                           int tileHeight)
```
    Specified by:
    
    onBeginParsing in interface TiledParserListener
  - 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
  - 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
  - getObjectGroups
```
public java.util.Collection<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
  - 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
  - dispose
```
public void dispose()
```
    Releases any resources used by this TiledMap
  - getOrientation
```
public Orientation getOrientation()
```
    Returns the Orientation of this map
    
    Returns:
  - 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 java.util.List<Tileset> getTilesets()
```
    Returns the Tilesets of this map
    
    Returns:
    
    An empty list if none have been loaded
  - getLayers
```
public java.util.List<Layer> getLayers()
```
    Returns the Layers of this map
    
    Returns:
  - getTotalObjectGroups
```
public int getTotalObjectGroups()
```
    Returns the total amount of TiledObjectGroup instances
    
    Returns:
  - getBackgroundColor
```
public com.badlogic.gdx.graphics.Color getBackgroundColor()
```
    Returns the background Color of the map
    
    Returns:
    
    null by default
  - setTileLayerRenderer
```
public void setTileLayerRenderer(TileLayerRenderer tileLayerRenderer)
```
    Sets the TileLayerRenderer implementation to use for rendering
    
    Parameters:
    
    tileLayerRenderer - The TileLayerRenderer to use
  - setTiledObjectGroupRenderer
```
public void setTiledObjectGroupRenderer(TiledObjectGroupRenderer tiledObjectGroupRenderer)
```
    Sets the TiledObjectGroupRenderer implementation to use for rendering
    
    Parameters:
    
    tiledObjectGroupRenderer - The TiledObjectGroupRenderer to use

Class TiledMap

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

tilesets

layers

objectGroups

Constructor Detail

TiledMap

TiledMap

TiledMap

TiledMap

Method Detail

isTilesetsLoaded

getTotalTilesetsLoaded

loadTileset

loadTilesets

draw

draw

draw

draw

preLayerRendered

onLayerRendered

containsProperty

getProperty

setProperty

onBeginParsing

onMapPropertyParsed

onTilePropertiesParsed

onTilesetParsed

onTileLayerParsed

onObjectGroupParsed

getTileLayer

getTileLayer

getObjectGroup

getObjectGroups

getLayerIndex

getTile

getTile

dispose

getOrientation

getWidth

getHeight

getTileWidth

getTileHeight

getPixelWidth

getPixelHeight

getTilesets

getLayers

getTotalObjectGroups

getBackgroundColor

setTileLayerRenderer

setTiledObjectGroupRenderer