org.mini2Dx.tiled

Class TiledMap

java.lang.Object

org.mini2Dx.tiled.TiledMap

public class TiledMap
extends java.lang.Object

A Tiled map instance

Constructor Summary

Constructors

Constructor and Description
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(TiledMapData tiledMapData, boolean loadTilesetTextures, boolean cacheLayers)
TiledMap(TiledParser parser, com.badlogic.gdx.files.FileHandle fileHandle, boolean loadTilesetTextures, boolean cacheLayers) Constructs a map from a TMX file

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
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
int	getLayerIndexIgnoreCase(java.lang.String name) Returns the index of the TileLayer or TiledObjectGroup with the given name ignoring upper/lowercase differences
java.util.List<Layer>	getLayers() Returns the Layers of this map
TiledObjectGroup	getObjectGroup(java.lang.String name) Returns the TiledObjectGroup with the given name
java.util.Collection<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
java.util.List<Tileset>	getTilesets() Returns the Tilesets of this map
int	getTileWidth() Returns the width of tiles in pixels
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
void	loadTilesetTextures() Loads all Tileset textures for this map if they are not already loaded
void	loadTilesetTextures(com.badlogic.gdx.assets.AssetManager assetManager) Loads all Tileset textures for this map if they are not already loaded
protected void	onLayerRendered(Graphics g, TileLayer layer, int startTileX, int startTileY, int widthInTiles, int heightInTiles) Developers can override this method to implement sprite rendering
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
void	update(float delta) Updates map elements such as animated tiles

Methods inherited from class java.lang.Object

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

Constructor Detail

TiledMap

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

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)

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 loadTilesetTextures,
                boolean cacheLayers)

Constructs a map from a TMX file

Parameters:

parser - An existing TiledParser instance

fileHandle - A FileHandle to a .tmx file

loadTilesetTextures - True if the tileset images should be loaded

Throws:

TiledException - Thrown if there were issues with the loaded map

TiledMap

public TiledMap(TiledMapData tiledMapData,
                boolean loadTilesetTextures,
                boolean cacheLayers)

Method Detail

isTilesetTexturesLoaded

public boolean isTilesetTexturesLoaded()

Returns if the Tileset images have been loaded

Returns:

True if they have been loaded

loadTilesetTextures

public void loadTilesetTextures()

Loads all Tileset textures for this map if they are not already loaded

loadTilesetTextures

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

Loads all Tileset textures for this map if they are not already loaded

Parameters:

assetManager - The AssetManager to use

update

public void update(float delta)

Updates map elements such as animated tiles

Parameters:

delta - The time since the last frame (in seconds)

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

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

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

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

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 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

containsAnimatedTiles

public boolean containsAnimatedTiles()

Returns if this map contains animated tiles

Returns:

True if there are animated tiles