org.mini2Dx.tiled

Class Tileset

java.lang.Object

org.mini2Dx.tiled.Tileset

All Implemented Interfaces:

com.badlogic.gdx.utils.Disposable

public class Tileset
extends java.lang.Object
implements com.badlogic.gdx.utils.Disposable

A tileset loaded with a TiledMap

Constructor Summary

Constructors

Constructor and Description
Tileset(int firstGid, TilesetSource tilesetSource)

Method Summary

Modifier and Type	Method and Description
boolean	contains(int tileId) Returns true if this tileset contains the tile with the given id
boolean	containsProperty(java.lang.String propertyName) Returns if the tileset contains the specified property
void	dispose()
void	drawTile(Graphics g, int tileId, int renderX, int renderY) Draws a tile to the Graphics context
void	drawTileset(Graphics g, int renderX, int renderY) Draws the whole tileset to the Graphics context
com.badlogic.gdx.utils.Array<com.badlogic.gdx.assets.AssetDescriptor>	getDependencies(com.badlogic.gdx.files.FileHandle tmxPath) Returns the AssetManager dependencies for this tileset
int	getFirstGid() Returns the first GID.
int	getHeight() Returns the height of this tileset in pixels
int	getHeightInTiles() Returns the height of this tileset in tiles
int	getMargin() Returns the margin at the borders of the tileset
com.badlogic.gdx.utils.ObjectMap<java.lang.String,java.lang.String>	getProperties() Returns the properties ObjectMap of this Tileset
java.lang.String	getProperty(java.lang.String propertyName) Returns the value of a specified property
int	getSpacing() Returns the internal spacing between each tile
Tile	getTile(int tileId) Returns the Tile for a given tile id
Tile	getTile(int x, int y) Returns the Tile for a given tile coordinate on the tileset
int	getTileHeight() Returns the height of each tile in pixels
int	getTileId(int x, int y) Returns the tile ID for a given tile within this tileset
int	getTileWidth() Returns the width of each tile in pixels
int	getTileX(int tileId) Returns the x coordinate of a tile within this tileset
int	getTileY(int tileId) Returns the y coordinate of a tile within this tileset
int	getWidth() Returns the width of this tileset in pixels
int	getWidthInTiles() Returns the width of this tileset in tiles
boolean	isTextureLoaded() Returns if the tileset image has been loaded
void	loadTexture(com.badlogic.gdx.assets.AssetManager assetManager, com.badlogic.gdx.files.FileHandle tmxPath) Loads the tileset image
void	loadTexture(com.badlogic.gdx.files.FileHandle tmxPath) Loads the tileset image
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

Constructor Detail

Tileset

public Tileset(int firstGid,
               TilesetSource tilesetSource)

Method Detail

containsProperty

public boolean containsProperty(java.lang.String propertyName)

Returns if the tileset contains the specified property

Parameters:

propertyName - The property name to search for

Returns:

True if the tileset 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

getProperties

public com.badlogic.gdx.utils.ObjectMap<java.lang.String,java.lang.String> getProperties()

Returns the properties ObjectMap of this Tileset

Returns:

Null if there are no properties

drawTile

public void drawTile(Graphics g,
                     int tileId,
                     int renderX,
                     int renderY)

Draws a tile to the Graphics context

Parameters:

g - The Graphics context available for rendering

tileId - The tile id to render

renderX - The X coordinate to render at

renderY - The Y coordinate to render at

drawTileset

public void drawTileset(Graphics g,
                        int renderX,
                        int renderY)

Draws the whole tileset to the Graphics context

Parameters:

g - The Graphics context available for rendering

renderX - The X coordinate to render at

renderY - The Y coordinate to render at

getTile

public Tile getTile(int tileId)

Returns the Tile for a given tile id

Parameters:

tileId - The tile id to look up

Returns:

The Tile

getTile

public Tile getTile(int x,
                    int y)

Returns the Tile for a given tile coordinate on the tileset

Parameters:

x - The x coordinate in tiles

y - The y coordinate in tiles

Returns:

The Tile

getDependencies

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

Returns the AssetManager dependencies for this tileset

Parameters:

tmxPath - The path of the TMX file

Returns:

null if there are no dependencies

isTextureLoaded

public boolean isTextureLoaded()

Returns if the tileset image has been loaded

Returns:

True if loaded

loadTexture

public void loadTexture(com.badlogic.gdx.files.FileHandle tmxPath)

Loads the tileset image

Parameters:

tmxPath - The path of the TMX file for the TiledMap that has loaded this tileset

loadTexture

public void loadTexture(com.badlogic.gdx.assets.AssetManager assetManager,
                        com.badlogic.gdx.files.FileHandle tmxPath)

Loads the tileset image

Parameters:

assetManager - The AssetManager to use

tmxPath - The path of the TMX file for the TiledMap that has loaded this tileset

dispose

public void dispose()

Specified by:

dispose in interface com.badlogic.gdx.utils.Disposable

contains

public boolean contains(int tileId)

Returns true if this tileset contains the tile with the given id

Parameters:

tileId - The tile id to search for

Returns:

False if the tileset does not contain the tile

getTileId

public int getTileId(int x,
                     int y)

Returns the tile ID for a given tile within this tileset

Parameters:

x - The x coordinate of the tile on the tileset

y - The y coordinate of the tile on the tileset

Returns:

The tile ID

getTileX

public int getTileX(int tileId)

Returns the x coordinate of a tile within this tileset

Parameters:

tileId - The tile id to get the x coordinate for

Returns:

getTileY

public int getTileY(int tileId)

Returns the y coordinate of a tile within this tileset

Parameters:

tileId - The tile id to get the y coordinate for

Returns:

getWidthInTiles

public int getWidthInTiles()

Returns the width of this tileset in tiles

Returns:

getHeightInTiles

public int getHeightInTiles()

Returns the height of this tileset in tiles

Returns:

getWidth

public int getWidth()

Returns the width of this tileset in pixels

Returns:

getHeight

public int getHeight()

Returns the height of this tileset in pixels

Returns:

getTileWidth

public int getTileWidth()

Returns the width of each tile in pixels

Returns:

getTileHeight

public int getTileHeight()

Returns the height of each tile in pixels

Returns:

getSpacing

public int getSpacing()

Returns the internal spacing between each tile

Returns:

The spacing in pixels

getMargin

public int getMargin()

Returns the margin at the borders of the tileset

Returns:

The margin in pixels

getFirstGid

public int getFirstGid()

Returns the first GID. See: TMX Map Format

Returns: