org.mini2Dx.tiled.tileset

Class TilesetSource

java.lang.Object

org.mini2Dx.tiled.tileset.TilesetSource

All Implemented Interfaces:

org.mini2Dx.gdx.utils.Disposable

Direct Known Subclasses:

ImageTilesetSource, TsxTilesetSource

public abstract class TilesetSource
extends java.lang.Object
implements org.mini2Dx.gdx.utils.Disposable

Base class for tileset sources

Constructor Summary

Constructors

Constructor and Description
TilesetSource()

Method Summary

Modifier and Type	Method and Description
boolean	contains(int tileId, int firstGid, int lastGid) Returns true if a tileset contains the tile with the given id
abstract boolean	containsProperty(java.lang.String propertyName) Returns if the tileset contains the specified property
abstract void	drawTile(Graphics g, int tileId, int firstGid, int renderX, int renderY) Draws a tile to the Graphics context
abstract void	drawTileset(Graphics g, int renderX, int renderY) Draws the whole tileset to the Graphics context
boolean	equals(java.lang.Object obj)
abstract org.mini2Dx.gdx.utils.Array<AssetDescriptor>	getDependencies(FileHandle tmxPath) Returns the dependencies of this source
abstract int	getHeight() Returns the height of this tileset in pixels
abstract int	getHeightInTiles() Returns the height of this source in tiles
abstract java.lang.String	getInternalUuid() Returns a UUID generated by mini2Dx
abstract int	getMargin() Returns the margin at the borders of the tileset
abstract org.mini2Dx.gdx.utils.ObjectMap<java.lang.String,java.lang.String>	getProperties() Returns the properties ObjectMap of this Tileset
abstract java.lang.String	getProperty(java.lang.String propertyName) Returns the value of a specified property
abstract int	getSpacing() Returns the internal spacing between each tile
abstract Tile	getTile(int tileId, int firstGid) Returns the Tile for a given tile id
abstract Tile	getTileByPosition(int x, int y) Returns the Tile for a given x/y coordinate with the tileset source
abstract int	getTileHeight() Returns the height of each tile in pixels
int	getTileId(int x, int y, int firstGid) Returns the tile ID for a given tile within a tileset
abstract Sprite	getTileImage(int tileId) Returns the Sprite for a given tile
Sprite	getTileImage(int tileId, int firstGid) Returns the Sprite for a given tile
abstract int	getTileWidth() Returns the width of each tile in pixels
int	getTileX(int tileId, int firstGid) Returns the x coordinate of a tile within a tileset
int	getTileY(int tileId, int firstGid) Returns the y coordinate of a tile within a tileset
abstract int	getWidth() Returns the width of this tileset in pixels
abstract int	getWidthInTiles() Returns the width of this source in tiles
abstract boolean	isTextureLoaded() Returns if the tileset texture image is loaded
abstract void	loadTexture(AssetManager assetManager, FileHandle tmxPath) Loads the tileset's texture image
abstract void	loadTexture(FileHandle tmxPath) Loads the tileset's texture image
abstract void	loadTexture(TextureAtlas textureAtlas) Loads the texture from a TextureAtlas
abstract 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, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.mini2Dx.gdx.utils.Disposable

dispose

Constructor Detail

TilesetSource

public TilesetSource()

Method Detail

getTileId

public int getTileId(int x,
                     int y,
                     int firstGid)

Returns the tile ID for a given tile within a tileset

Parameters:

x - The x coordinate of the tile on a tileset

y - The y coordinate of the tile on a tileset

firstGid - The first gid of the tileset

Returns:

The tile ID

getTileX

public int getTileX(int tileId,
                    int firstGid)

Returns the x coordinate of a tile within a tileset

Parameters:

tileId - The tile id to get the x coordinate for

firstGid - The first gid of the tileset

Returns:

getTileY

public int getTileY(int tileId,
                    int firstGid)

Returns the y coordinate of a tile within a tileset

Parameters:

tileId - The tile id to get the y coordinate for

firstGid - The first gid of the tileset

Returns:

contains

public boolean contains(int tileId,
                        int firstGid,
                        int lastGid)

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

Parameters:

tileId - The tile id to search for

firstGid - The first gid of the tileset

lastGid - The last gid of the tileset

Returns:

False if the tileset does not contain the tile

getDependencies

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

Returns the dependencies of this source

Parameters:

tmxPath - The path of the TMX file

Returns:

null if there are no dependencies

loadTexture

public abstract void loadTexture(FileHandle tmxPath)

Loads the tileset's texture image

Parameters:

tmxPath - The path of the TMX file

loadTexture

public abstract void loadTexture(AssetManager assetManager,
                                 FileHandle tmxPath)

Loads the tileset's texture image

Parameters:

assetManager - The AssetManager to use

tmxPath - The path of the TMX file

loadTexture

public abstract void loadTexture(TextureAtlas textureAtlas)

Loads the texture from a TextureAtlas

Parameters:

textureAtlas - The TextureAtlas to use

isTextureLoaded

public abstract boolean isTextureLoaded()

Returns if the tileset texture image is loaded

Returns:

True if loaded

getTileImage

public abstract Sprite getTileImage(int tileId)

Returns the Sprite for a given tile

Parameters:

tileId - The tile id to retrieve

Returns:

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

getTileImage

public Sprite getTileImage(int tileId,
                           int firstGid)

Returns the Sprite for a given tile

Parameters:

tileId - The tile id to retrieve

firstGid - The first gid of the tileset

Returns:

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

drawTile

public abstract void drawTile(Graphics g,
                              int tileId,
                              int firstGid,
                              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

firstGid - The first gid of the parent tileset

renderX - The X coordinate to render at

renderY - The Y coordinate to render at

drawTileset

public abstract 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 abstract Tile getTile(int tileId,
                             int firstGid)

Returns the Tile for a given tile id

Parameters:

tileId - The tile id to look up

firstGid - The first gid for the tileset

Returns:

The Tile

getTileByPosition

public abstract Tile getTileByPosition(int x,
                                       int y)

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

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

getWidth

public abstract int getWidth()

Returns the width of this tileset in pixels

Returns:

getHeight

public abstract int getHeight()

Returns the height of this tileset in pixels

Returns:

getTileWidth

public abstract int getTileWidth()

Returns the width of each tile in pixels

Returns:

getTileHeight

public abstract int getTileHeight()

Returns the height of each tile in pixels

Returns:

getWidthInTiles

public abstract int getWidthInTiles()

Returns the width of this source in tiles

Returns:

getHeightInTiles

public abstract int getHeightInTiles()

Returns the height of this source in tiles

Returns:

getSpacing

public abstract int getSpacing()

Returns the internal spacing between each tile

Returns:

The spacing in pixels

getMargin

public abstract int getMargin()

Returns the margin at the borders of the tileset

Returns:

The margin in pixels

containsProperty

public abstract 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 abstract 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 abstract 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 abstract org.mini2Dx.gdx.utils.ObjectMap<java.lang.String,java.lang.String> getProperties()

Returns the properties ObjectMap of this Tileset

Returns:

Null if there are no properties

getInternalUuid

public abstract java.lang.String getInternalUuid()

Returns a UUID generated by mini2Dx

Returns:

A non-null String representing this source

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object