org.mini2Dx.tiled.tileset

Class TsxTilesetSource

java.lang.Object

org.mini2Dx.tiled.tileset.TilesetSource

org.mini2Dx.tiled.tileset.TsxTilesetSource

All Implemented Interfaces:

GameDataSerializable, org.mini2Dx.gdx.utils.Disposable

public class TsxTilesetSource
extends TilesetSource

A TilesetSource loaded from a TSX file. Allows for sharing data across multiple TiledMap instances.

Field Summary

Fields

Modifier and Type	Field and Description
static int	TILESET_TYPE

Constructor Summary

Constructors

Constructor and Description
TsxTilesetSource(FileHandle tmxPath, java.lang.String tsxPath)

Method Summary

Modifier and Type	Method and Description
boolean	containsProperty(java.lang.String propertyName) Returns if the tileset contains the specified property
void	dispose()
void	drawTile(Graphics g, int tileId, int firstGid, int renderX, int renderY, float alpha) Draws a tile to the Graphics context
void	drawTileset(Graphics g, int renderX, int renderY, float alpha) Draws the whole tileset to the Graphics context
boolean	equals(java.lang.Object o)
static TsxTilesetSource	fromInputStream(TiledMapData tiledMapData, java.io.DataInputStream inputStream)
org.mini2Dx.gdx.utils.Array<Tile>	getAnimatedTiles() Returns all animated tiles in this tileset source
org.mini2Dx.gdx.utils.Array<AssetDescriptor>	getDependencies(FileHandle tmxPath) Returns the dependencies of this source
int	getHeight() Returns the height of this tileset in pixels
int	getHeightInTiles() Returns the height of this source in tiles
java.lang.String	getInternalUuid() Returns a UUID generated by mini2Dx
int	getMargin() Returns the margin at the borders of the tileset
org.mini2Dx.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, int firstGid) Returns the Tile for a given tile id
Tile	getTileByPosition(int x, int y) Returns the Tile for a given x/y coordinate with the tileset source
int	getTileHeight() Returns the height of each tile in pixels
Sprite	getTileImage(int tileId) Returns the Sprite for a given tile
ImageTilesetSource	getTileset()
int	getTilesetSourceType() Returns a int representation of the source type.
int	getTileWidth() Returns the width of each tile in pixels
java.lang.String	getTsxPath()
int	getWidth() Returns the width of this tileset in pixels
int	getWidthInTiles() Returns the width of this source in tiles
int	hashCode()
boolean	isTextureLoaded() Returns if the tileset texture image is loaded
void	loadTexture(AssetManager assetManager, FileHandle tmxPath) Loads the tileset's texture image
void	loadTexture(FileHandle tmxPath) Loads the tileset's texture image
void	loadTexture(TextureAtlas textureAtlas) Loads the texture from a TextureAtlas
void	readData(java.io.DataInputStream inputStream) Deserializes this object from a DataInputStream
void	registerAnimatedTile(Tile tile) Registers an animated tile in this tileset source
void	setProperty(java.lang.String propertyName, java.lang.String value) Sets the value of a specified property
void	setTsxPath(java.lang.String tsxPath)
static void	updateAllAnimatedTiles(float delta) Updates animated tiles across all tilesets even if they are unreferenced by a TiledMap
void	updateAnimatedTiles(float delta) Updates all animated tiles
void	writeData(java.io.DataOutputStream outputStream) Serializes this object to a DataOutputStream

Methods inherited from class org.mini2Dx.tiled.tileset.TilesetSource

contains, getTileId, getTileImage, getTileX, getTileY

Methods inherited from class java.lang.Object

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

Field Detail

TILESET_TYPE

public static final int TILESET_TYPE

See Also:

Constant Field Values

Constructor Detail

TsxTilesetSource

public TsxTilesetSource(FileHandle tmxPath,
                        java.lang.String tsxPath)

Method Detail

updateAllAnimatedTiles

public static void updateAllAnimatedTiles(float delta)

Updates animated tiles across all tilesets even if they are unreferenced by a TiledMap

Parameters:

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

fromInputStream

public static TsxTilesetSource fromInputStream(TiledMapData tiledMapData,
                                               java.io.DataInputStream inputStream)
                                        throws java.io.IOException

Throws:

java.io.IOException

writeData

public void writeData(java.io.DataOutputStream outputStream)
               throws java.io.IOException

Description copied from interface: GameDataSerializable

Serializes this object to a DataOutputStream

Parameters:

outputStream - The DataOutputStream to write to

Throws:

java.io.IOException - Thrown if an error occurs during I/O

readData

public void readData(java.io.DataInputStream inputStream)
              throws java.io.IOException

Description copied from interface: GameDataSerializable

Deserializes this object from a DataInputStream

Parameters:

inputStream - The DataInputStream to read from

Throws:

java.io.IOException - Thrown if an error occurs during I/O

getDependencies

public org.mini2Dx.gdx.utils.Array<AssetDescriptor> getDependencies(FileHandle tmxPath)

Description copied from class: TilesetSource

Returns the dependencies of this source

Specified by:

getDependencies in class TilesetSource

Parameters:

tmxPath - The path of the TMX file

Returns:

null if there are no dependencies

loadTexture

public void loadTexture(FileHandle tmxPath)

Description copied from class: TilesetSource

Loads the tileset's texture image

Specified by:

loadTexture in class TilesetSource

Parameters:

tmxPath - The path of the TMX file

loadTexture

public void loadTexture(AssetManager assetManager,
                        FileHandle tmxPath)

Description copied from class: TilesetSource

Loads the tileset's texture image

Specified by:

loadTexture in class TilesetSource

Parameters:

assetManager - The AssetManager to use

tmxPath - The path of the TMX file

loadTexture

public void loadTexture(TextureAtlas textureAtlas)

Description copied from class: TilesetSource

Loads the texture from a TextureAtlas

Specified by:

loadTexture in class TilesetSource

Parameters:

textureAtlas - The TextureAtlas to use

isTextureLoaded

public boolean isTextureLoaded()

Description copied from class: TilesetSource

Returns if the tileset texture image is loaded

Specified by:

isTextureLoaded in class TilesetSource

Returns:

True if loaded

getTileImage

public Sprite getTileImage(int tileId)

Description copied from class: TilesetSource

Returns the Sprite for a given tile

Specified by:

getTileImage in class TilesetSource

Parameters:

tileId - The tile id to retrieve

Returns:

The Sprite or null if that textures haven't been loaded

getWidthInTiles

public int getWidthInTiles()

Description copied from class: TilesetSource

Returns the width of this source in tiles

Specified by:

getWidthInTiles in class TilesetSource

Returns:

getHeightInTiles

public int getHeightInTiles()

Description copied from class: TilesetSource

Returns the height of this source in tiles

Specified by:

getHeightInTiles in class TilesetSource

Returns:

drawTile

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

Description copied from class: TilesetSource

Draws a tile to the Graphics context

Specified by:

drawTile in class TilesetSource

Parameters:

g - The Graphics context available for rendering

tileId - The tile id to render

firstGid - The first gid of the parent tileset

renderX - The X coordinate to render at

renderY - The Y coordinate to render at

alpha - The alpha blend value (1.0 by default)

drawTileset

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

Description copied from class: TilesetSource

Draws the whole tileset to the Graphics context

Specified by:

drawTileset in class TilesetSource

Parameters:

g - The Graphics context available for rendering

renderX - The X coordinate to render at

renderY - The Y coordinate to render at

alpha - The alpha blend value (1.0 by default)

getWidth

public int getWidth()

Description copied from class: TilesetSource

Returns the width of this tileset in pixels

Specified by:

getWidth in class TilesetSource

Returns:

getHeight

public int getHeight()

Description copied from class: TilesetSource

Returns the height of this tileset in pixels

Specified by:

getHeight in class TilesetSource

Returns:

getTileWidth

public int getTileWidth()

Description copied from class: TilesetSource

Returns the width of each tile in pixels

Specified by:

getTileWidth in class TilesetSource

Returns:

getTileHeight

public int getTileHeight()

Description copied from class: TilesetSource

Returns the height of each tile in pixels

Specified by:

getTileHeight in class TilesetSource

Returns:

getSpacing

public int getSpacing()

Description copied from class: TilesetSource

Returns the internal spacing between each tile

Specified by:

getSpacing in class TilesetSource

Returns:

The spacing in pixels

getMargin

public int getMargin()

Description copied from class: TilesetSource

Returns the margin at the borders of the tileset

Specified by:

getMargin in class TilesetSource

Returns:

The margin in pixels

getTileByPosition

public Tile getTileByPosition(int x,
                              int y)

Description copied from class: TilesetSource

Returns the Tile for a given x/y coordinate with the tileset source

Specified by:

getTileByPosition in class TilesetSource

Parameters:

x - The x coordinate of the tile within the tileset (in tiles)

y - The y coordinate of the tile within the tileset (in tiles)

Returns:

The Tile

getTile

public Tile getTile(int tileId,
                    int firstGid)

Description copied from class: TilesetSource

Returns the Tile for a given tile id

Specified by:

getTile in class TilesetSource

Parameters:

tileId - The tile id to look up

firstGid - The first gid for the tileset

Returns:

The Tile

containsProperty

public boolean containsProperty(java.lang.String propertyName)

Description copied from class: TilesetSource

Returns if the tileset contains the specified property

Specified by:

containsProperty in class TilesetSource

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)

Description copied from class: TilesetSource

Returns the value of a specified property

Specified by:

getProperty in class TilesetSource

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)

Description copied from class: TilesetSource

Sets the value of a specified property

Specified by:

setProperty in class TilesetSource

Parameters:

propertyName - The property name to set the value for

value - The value of the property to set

getProperties

public org.mini2Dx.gdx.utils.ObjectMap<java.lang.String,java.lang.String> getProperties()

Description copied from class: TilesetSource

Returns the properties ObjectMap of this Tileset

Specified by:

getProperties in class TilesetSource

Returns:

Null if there are no properties

updateAnimatedTiles

public void updateAnimatedTiles(float delta)

Description copied from class: TilesetSource

Updates all animated tiles

Specified by:

updateAnimatedTiles in class TilesetSource

Parameters:

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

getAnimatedTiles

public org.mini2Dx.gdx.utils.Array<Tile> getAnimatedTiles()

Description copied from class: TilesetSource

Returns all animated tiles in this tileset source

Specified by:

getAnimatedTiles in class TilesetSource

Returns:

An empty Array if no animated tiles

registerAnimatedTile

public void registerAnimatedTile(Tile tile)

Description copied from class: TilesetSource

Registers an animated tile in this tileset source

Specified by:

registerAnimatedTile in class TilesetSource

Parameters:

tile - The animated Tile

getInternalUuid

public java.lang.String getInternalUuid()

Description copied from class: TilesetSource

Returns a UUID generated by mini2Dx

Specified by:

getInternalUuid in class TilesetSource

Returns:

A non-null String representing this source

getTilesetSourceType

public int getTilesetSourceType()

Description copied from class: TilesetSource

Returns a int representation of the source type.

Specified by:

getTilesetSourceType in class TilesetSource

Returns:

ImageTilesetSource.TILESET_TYPE or TILESET_TYPE

getTileset

public ImageTilesetSource getTileset()

getTsxPath

public java.lang.String getTsxPath()

setTsxPath

public void setTsxPath(java.lang.String tsxPath)

dispose

public void dispose()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class TilesetSource

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object