org.mini2Dx.tiled

Class Tileset

java.lang.Object

org.mini2Dx.tiled.Tileset

public class Tileset
extends Object

A tileset loaded with a TiledMap

Author:

Thomas Cashman

Constructor Summary

Constructors

Constructor and Description
Tileset()

Method Summary

Methods

Modifier and Type	Method and Description
void	calculateLastGid()
boolean	contains(int tileId) Returns true if this tileset contains the tile with the given id
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
int	getFirstGid() Returns the first GID https://github.com/bjorn/tiled/wiki/TMX-Map-Format
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
String	getName() Returns the name of this tileset
int	getSpacing() Returns the internal spacing between each tile
int	getTileHeight() Returns the height of each tile in pixels
com.badlogic.gdx.graphics.g2d.TextureRegion	getTileImage(int tileId) Returns the TextureRegion for a given tile id
String	getTilesetImagePath() Returns the relative path of the tileset image
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
String	getTransparentColorValue()
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.files.FileHandle tmxDirectory) Loads the tileset image
void	setFirstGid(int firstGid) Sets the first GID https://github.com/bjorn/tiled/wiki/TMX-Map-Format
void	setHeight(int height) Sets the height of this tileset in pixels
void	setMargin(int margin) Sets the margin at the borders of the tileset
void	setName(String name) Sets the name of this tileset
void	setSpacing(int spacing) Sets the internal spacing between each tile
void	setTileHeight(int tileHeight) Sets the height of each tile in pixels
void	setTilesetImagePath(String tilesetImagePath) Sets the relative path of the tileset image
void	setTileWidth(int tileWidth) Sets the width of each tile in pixels
void	setTransparentColorValue(String transparentColorValue)
void	setWidth(int width) Sets the width of this tileset in pixels

Methods inherited from class java.lang.Object

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

Constructor Detail

Tileset

public Tileset()

Method Detail

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

getTileImage

public com.badlogic.gdx.graphics.g2d.TextureRegion getTileImage(int tileId)

Returns the TextureRegion for a given tile id

Parameters:

tileId - The tile id to look up

Returns:

The tile image

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

Loads the tileset image

Parameters:

tmxDirectory - The directory containing the TMX files for the TiledMap that has loaded this tileset

calculateLastGid

public void calculateLastGid()

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

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:

getName

public String getName()

Returns the name of this tileset

Returns:

setName

public void setName(String name)

Sets the name of this tileset

Parameters:

name - The name to set

getWidth

public int getWidth()

Returns the width of this tileset in pixels

Returns:

setWidth

public void setWidth(int width)

Sets the width of this tileset in pixels

Parameters:

width - The width in pixels

getHeight

public int getHeight()

Returns the height of this tileset in pixels

Returns:

setHeight

public void setHeight(int height)

Sets the height of this tileset in pixels

Parameters:

height - The height in pixels

getTileWidth

public int getTileWidth()

Returns the width of each tile in pixels

Returns:

setTileWidth

public void setTileWidth(int tileWidth)

Sets the width of each tile in pixels

Parameters:

tileWidth - The width in pixels

getTileHeight

public int getTileHeight()

Returns the height of each tile in pixels

Returns:

setTileHeight

public void setTileHeight(int tileHeight)

Sets the height of each tile in pixels

Parameters:

tileHeight - The height in pixels

getSpacing

public int getSpacing()

Returns the internal spacing between each tile

Returns:

The spacing in pixels

setSpacing

public void setSpacing(int spacing)

Sets the internal spacing between each tile

Parameters:

spacing - The spacing in pixels

getMargin

public int getMargin()

Returns the margin at the borders of the tileset

Returns:

The margin in pixels

setMargin

public void setMargin(int margin)

Sets the margin at the borders of the tileset

Parameters:

margin - The margin in pixels

getFirstGid

public int getFirstGid()

Returns the first GID https://github.com/bjorn/tiled/wiki/TMX-Map-Format

Returns:

setFirstGid

public void setFirstGid(int firstGid)

Sets the first GID https://github.com/bjorn/tiled/wiki/TMX-Map-Format

Parameters:

firstGid -

getTilesetImagePath

public String getTilesetImagePath()

Returns the relative path of the tileset image

Returns:

setTilesetImagePath

public void setTilesetImagePath(String tilesetImagePath)

Sets the relative path of the tileset image

Parameters:

tilesetImagePath -

getTransparentColorValue

public String getTransparentColorValue()

setTransparentColorValue

public void setTransparentColorValue(String transparentColorValue)