de.gurkenlabs.litiengine.environment.tilemap.xml

Class TmxMap

java.lang.Object

de.gurkenlabs.litiengine.environment.tilemap.xml.CustomPropertyProvider

de.gurkenlabs.litiengine.environment.tilemap.xml.TmxMap

All Implemented Interfaces:

ICustomPropertyProvider, ILayerList, IMap, java.lang.Comparable<TmxMap>

public final class TmxMap
extends CustomPropertyProvider
implements IMap, java.lang.Comparable<TmxMap>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FILE_EXTENSION

Constructor Summary

Constructors

Constructor and Description
TmxMap()

Method Summary

Modifier and Type	Method and Description
void	addLayer(ILayer layer) Adds an ILayer to the Layer list.
void	addLayer(int index, ILayer layer) Adds an ILayer to the Layer list at the given index.
int	compareTo(TmxMap o)
boolean	equals(java.lang.Object anObject)
void	finish(java.net.URL location)
java.awt.Color	getBackgroundColor()
java.awt.geom.Rectangle2D	getBounds()
protected int	getChunkOffsetX()
protected int	getChunkOffsetY()
java.util.List<Tileset>	getExternalTilesets()
java.util.List<IGroupLayer>	getGroupLayers() Gets the IGroupLayers contained in a Layer list.
int	getHeight()
int	getHexSideLength() Gets the straight edges' length for hexagonal maps.
java.util.List<IImageLayer>	getImageLayers() Gets the IImageLayers contained in a Layer list.
java.util.List<IMapObjectLayer>	getMapObjectLayers() Gets all MapObjectLayers in the Layer list.
java.lang.String	getName()
int	getNextLayerId()
int	getNextObjectId() Gets the next object id.
IMapOrientation	getOrientation() Gets the orientation.
java.net.URL	getPath()
java.util.List<ILayer>	getRenderLayers() Gets all render layers in the Layer list.
RenderOrder	getRenderOrder() Gets the renderorder.
java.awt.Dimension	getSizeInPixels() Gets the size in pixels.
java.awt.Dimension	getSizeInTiles() Gets the sizein tiles.
StaggerAxis	getStaggerAxis() Gets the staggering axis
StaggerIndex	getStaggerIndex() Gets the tile size.
java.lang.String	getTiledVersion()
int	getTileHeight() Gets the vertical tile size.
java.util.List<ITileLayer>	getTileLayers() Gets the ITileLayers contained in a Layer list.
ITilesetEntry	getTilesetEntry(int gid)
java.util.List<ITileset>	getTilesets() Gets the tilesets.
java.awt.Dimension	getTileSize() Gets the tile size.
int	getTileWidth() Gets the horizontal tile size.
double	getVersion() Gets the version.
int	getWidth()
int	hashCode()
boolean	isInfinite()
void	removeLayer(ILayer layer) Removes an ILayer from the Layer list.
void	removeLayer(int index) Removes a layer from the Layer list.
void	setHeight(int height)
void	setHexSideLength(int hexSideLength)
void	setName(java.lang.String name) Sets the name.
void	setOrientation(IMapOrientation orientation)
void	setPath(java.net.URL path)
void	setRenderOrder(RenderOrder renderorder)
void	setStaggerAxis(StaggerAxis staggerAxis)
void	setStaggerIndex(StaggerIndex staggerIndex)
void	setTiledVersion(java.lang.String tiledversion)
void	setTileHeight(int tileheight)
void	setTileWidth(int tilewidth)
void	setVersion(double version)
void	setWidth(int width)

Methods inherited from class de.gurkenlabs.litiengine.environment.tilemap.xml.CustomPropertyProvider

getBoolValue, getBoolValue, getByteValue, getByteValue, getColorValue, getColorValue, getDoubleValue, getDoubleValue, getEnumValue, getEnumValue, getFileValue, getFileValue, getFloatValue, getFloatValue, getIntValue, getIntValue, getLongValue, getProperties, getProperty, getShortValue, getShortValue, getStringValue, getStringValue, getTypeOfProperty, hasCustomProperty, removeProperty, setProperties, setTypeOfProperty, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.gurkenlabs.litiengine.environment.tilemap.ILayerList

getMapObject, getMapObjectLayer, getMapObjectLayer, getMapObjectLayer, getMapObjects, getMapObjects, getMapObjects, removeMapObject

Methods inherited from interface de.gurkenlabs.litiengine.environment.tilemap.ICustomPropertyProvider

getBoolValue, getBoolValue, getByteValue, getByteValue, getColorValue, getColorValue, getDoubleValue, getDoubleValue, getEnumValue, getEnumValue, getFileValue, getFileValue, getFloatValue, getFloatValue, getIntValue, getIntValue, getLongValue, getLongValue, getProperties, getProperty, getShortValue, getShortValue, getStringValue, getStringValue, getTypeOfProperty, hasCustomProperty, removeProperty, setProperties, setTypeOfProperty, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue

Field Detail

FILE_EXTENSION

public static final java.lang.String FILE_EXTENSION

See Also:

Constant Field Values

Constructor Detail

TmxMap

public TmxMap()

Method Detail

getImageLayers

public java.util.List<IImageLayer> getImageLayers()

Description copied from interface: ILayerList

Gets the IImageLayers contained in a Layer list.

Specified by:

getImageLayers in interface ILayerList

Returns:

a List of all IImageLayers

getNextObjectId

public int getNextObjectId()

Gets the next object id.

Specified by:

getNextObjectId in interface IMap

Returns:

the next object id

getNextLayerId

public int getNextLayerId()

Specified by:

getNextLayerId in interface IMap

getOrientation

public IMapOrientation getOrientation()

Description copied from interface: IMap

Gets the orientation.

Specified by:

getOrientation in interface IMap

Returns:

the orientation

getPath

public java.net.URL getPath()

Specified by:

getPath in interface IMap

getRenderOrder

public RenderOrder getRenderOrder()

Description copied from interface: IMap

Gets the renderorder.

Specified by:

getRenderOrder in interface IMap

Returns:

the renderorder

getMapObjectLayers

public java.util.List<IMapObjectLayer> getMapObjectLayers()

Description copied from interface: ILayerList

Gets all MapObjectLayers in the Layer list.

Specified by:

getMapObjectLayers in interface ILayerList

Returns:

a List of IMapObjectLayers

getSizeInPixels

public java.awt.Dimension getSizeInPixels()

Description copied from interface: IMap

Gets the size in pixels.

Specified by:

getSizeInPixels in interface IMap

Returns:

the size in pixels

getBounds

public java.awt.geom.Rectangle2D getBounds()

Specified by:

getBounds in interface IMap

getSizeInTiles

public java.awt.Dimension getSizeInTiles()

Description copied from interface: IMap

Gets the sizein tiles.

Specified by:

getSizeInTiles in interface IMap

Returns:

the sizein tiles

getTileLayers

public java.util.List<ITileLayer> getTileLayers()

Description copied from interface: ILayerList

Gets the ITileLayers contained in a Layer list.

Specified by:

getTileLayers in interface ILayerList

Returns:

a List of all ITileLayers

getTilesets

public java.util.List<ITileset> getTilesets()

Description copied from interface: IMap

Gets the tilesets.

Specified by:

getTilesets in interface IMap

Returns:

the tilesets

getTilesetEntry

public ITilesetEntry getTilesetEntry(int gid)

Specified by:

getTilesetEntry in interface IMap

getTileSize

public java.awt.Dimension getTileSize()

Description copied from interface: IMap

Gets the tile size.

Specified by:

getTileSize in interface IMap

Returns:

the tile size

getTileWidth

public int getTileWidth()

Description copied from interface: IMap

Gets the horizontal tile size.

Specified by:

getTileWidth in interface IMap

Returns:

the horizontal tile size

getTileHeight

public int getTileHeight()

Description copied from interface: IMap

Gets the vertical tile size.

Specified by:

getTileHeight in interface IMap

Returns:

the vertical tile size

getVersion

public double getVersion()

Description copied from interface: IMap

Gets the version.

Specified by:

getVersion in interface IMap

Returns:

the version

getTiledVersion

public java.lang.String getTiledVersion()

Specified by:

getTiledVersion in interface IMap

getGroupLayers

public java.util.List<IGroupLayer> getGroupLayers()

Description copied from interface: ILayerList

Gets the IGroupLayers contained in a Layer list.

Specified by:

getGroupLayers in interface ILayerList

Returns:

a List of all IGroupLayers

getName

public java.lang.String getName()

Specified by:

getName in interface IMap

setName

public void setName(java.lang.String name)

Description copied from interface: IMap

Sets the name.

Specified by:

setName in interface IMap

Parameters:

name - the new name

getWidth

public int getWidth()

Specified by:

getWidth in interface IMap

getHeight

public int getHeight()

Specified by:

getHeight in interface IMap

getHexSideLength

public int getHexSideLength()

Description copied from interface: IMap

Gets the straight edges' length for hexagonal maps.

Specified by:

getHexSideLength in interface IMap

Returns:

the hex side length

getStaggerAxis

public StaggerAxis getStaggerAxis()

Description copied from interface: IMap

Gets the staggering axis

Specified by:

getStaggerAxis in interface IMap

Returns:

the tile size

getStaggerIndex

public StaggerIndex getStaggerIndex()

Description copied from interface: IMap

Gets the tile size.

Specified by:

getStaggerIndex in interface IMap

Returns:

the tile size

setPath

public void setPath(java.net.URL path)

finish

public void finish(java.net.URL location)
            throws TmxException

Throws:

TmxException

addLayer

public void addLayer(ILayer layer)

Description copied from interface: ILayerList

Adds an ILayer to the Layer list.

Specified by:

addLayer in interface ILayerList

Parameters:

layer - the layer to be added

addLayer

public void addLayer(int index,
                     ILayer layer)

Description copied from interface: ILayerList

Adds an ILayer to the Layer list at the given index.

Specified by:

addLayer in interface ILayerList

Parameters:

index - the index

layer - the layer to be added

removeLayer

public void removeLayer(ILayer layer)

Description copied from interface: ILayerList

Removes an ILayer from the Layer list.

Specified by:

removeLayer in interface ILayerList

Parameters:

layer - the layer to be removed

removeLayer

public void removeLayer(int index)

Description copied from interface: ILayerList

Removes a layer from the Layer list.

Specified by:

removeLayer in interface ILayerList

Parameters:

index - the index of the layer to be removed

setHeight

public void setHeight(int height)

setOrientation

public void setOrientation(IMapOrientation orientation)

setRenderOrder

public void setRenderOrder(RenderOrder renderorder)

setTiledVersion

public void setTiledVersion(java.lang.String tiledversion)

setTileHeight

public void setTileHeight(int tileheight)

setTileWidth

public void setTileWidth(int tilewidth)

setHexSideLength

public void setHexSideLength(int hexSideLength)

setStaggerAxis

public void setStaggerAxis(StaggerAxis staggerAxis)

setStaggerIndex

public void setStaggerIndex(StaggerIndex staggerIndex)

setVersion

public void setVersion(double version)

setWidth

public void setWidth(int width)

compareTo

public int compareTo(TmxMap o)

Specified by:

compareTo in interface java.lang.Comparable<TmxMap>

equals

public boolean equals(java.lang.Object anObject)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getRenderLayers

public java.util.List<ILayer> getRenderLayers()

Description copied from interface: ILayerList

Gets all render layers in the Layer list.

Specified by:

getRenderLayers in interface ILayerList

Returns:

a List of ILayers

getExternalTilesets

public java.util.List<Tileset> getExternalTilesets()

getBackgroundColor

public java.awt.Color getBackgroundColor()

Specified by:

getBackgroundColor in interface IMap

isInfinite

public boolean isInfinite()

Specified by:

isInfinite in interface IMap

getChunkOffsetX

protected int getChunkOffsetX()

getChunkOffsetY

protected int getChunkOffsetY()