de.gurkenlabs.litiengine.environment.tilemap.xml

Class Map

java.lang.Object

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

de.gurkenlabs.litiengine.environment.tilemap.xml.Map

All Implemented Interfaces:

ICustomPropertyProvider, IMap, java.io.Serializable, java.lang.Comparable<Map>

public final class Map
extends CustomPropertyProvider
implements IMap, java.io.Serializable, java.lang.Comparable<Map>

See Also:

Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
Map()

Method Summary

Modifier and Type	Method and Description
void	addMapObjectLayer(IMapObjectLayer layer)
void	addMapObjectLayer(int index, IMapObjectLayer layer)
int	compareTo(Map o)
java.awt.Color	getBackgroundColor()
java.awt.geom.Rectangle2D	getBounds()
protected int	getChunkOffsetX()
protected int	getChunkOffsetY()
java.util.List<Tileset>	getExternalTilesets()
int	getHeight()
int	getHexSideLength() Gets the straight edges' length for hexagonal maps.
java.util.List<IImageLayer>	getImageLayers() Gets the image layers.
IMapObject	getMapObject(int mapId)
IMapObjectLayer	getMapObjectLayer(IMapObject mapObject)
java.util.List<IMapObjectLayer>	getMapObjectLayers() Gets the shape layers.
java.util.Collection<IMapObject>	getMapObjects()
java.util.Collection<IMapObject>	getMapObjects(java.lang.String... types)
java.lang.String	getName()
int	getNextObjectId() Gets the next object id.
MapOrientation	getOrientation() Gets the orientation.
java.lang.String	getPath()
protected java.util.List<ImageLayer>	getRawImageLayers()
protected java.util.List<MapObjectLayer>	getRawMapObjectLayers()
java.util.List<TileLayer>	getRawTileLayers()
java.util.List<Tileset>	getRawTilesets()
java.util.List<ILayer>	getRenderLayers()
java.lang.String	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 tile layers.
java.util.List<ITileset>	getTilesets() Gets the tilesets.
java.awt.Shape	getTileShape(int tileX, int tileY) Gets the shape of the tile [X|Y] at its absolute location.
java.awt.Dimension	getTileSize() Gets the tile size.
int	getTileWidth() Gets the horizontal tile size.
double	getVersion() Gets the version.
int	getWidth()
boolean	isInfinite()
void	removeMapObject(int mapId)
void	removeMapObjectLayer(IMapObjectLayer layer)
void	removeMapObjectLayer(int index)
void	setHeight(int height)
void	setHexSideLength(int hexSideLength)
void	setName(java.lang.String name) Sets the name.
void	setOrientation(java.lang.String orientation)
void	setPath(java.lang.String path)
void	setRenderorder(java.lang.String renderorder)
void	setStaggerAxis(java.lang.String staggerAxis)
void	setStaggerIndex(java.lang.String staggerIndex)
void	setTiledVersion(java.lang.String tiledversion)
void	setTileHeight(int tileheight)
void	setTileWidth(int tilewidth)
void	setVersion(double version)
void	setWidth(int width)
void	updateTileTerrain()

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

getBoolValue, getBoolValue, getByteValue, getByteValue, getColorValue, getColorValue, getDoubleValue, getDoubleValue, getEnumValue, getEnumValue, getFloatValue, getFloatValue, getIntValue, getIntValue, getLongValue, getLongValue, getProperties, getShortValue, getShortValue, getStringValue, getStringValue, hasCustomProperty, setProperties, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue

Methods inherited from class java.lang.Object

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

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

getBoolValue, getBoolValue, getByteValue, getByteValue, getColorValue, getColorValue, getDoubleValue, getDoubleValue, getEnumValue, getEnumValue, getFloatValue, getFloatValue, getIntValue, getIntValue, getLongValue, getLongValue, getProperties, getShortValue, getShortValue, getStringValue, getStringValue, hasCustomProperty, setProperties, 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

Map

public Map()

Method Detail

getImageLayers

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

Description copied from interface: IMap

Gets the image layers.

Specified by:

getImageLayers in interface IMap

Returns:

the image layers

getNextObjectId

public int getNextObjectId()

Gets the next object id.

Specified by:

getNextObjectId in interface IMap

Returns:

the next object id

getOrientation

public MapOrientation getOrientation()

Description copied from interface: IMap

Gets the orientation.

Specified by:

getOrientation in interface IMap

Returns:

the orientation

getPath

public java.lang.String getPath()

Specified by:

getPath in interface IMap

getRenderOrder

public java.lang.String 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: IMap

Gets the shape layers.

Specified by:

getMapObjectLayers in interface IMap

Returns:

the shape layers

getMapObjectLayer

public IMapObjectLayer getMapObjectLayer(IMapObject mapObject)

Specified by:

getMapObjectLayer in interface IMap

removeMapObject

public void removeMapObject(int mapId)

Specified by:

removeMapObject in interface IMap

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: IMap

Gets the tile layers.

Specified by:

getTileLayers in interface IMap

Returns:

the tile layers

getTilesets

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

Description copied from interface: IMap

Gets the tilesets.

Specified by:

getTilesets in interface IMap

Returns:

the tilesets

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

getTileShape

public java.awt.Shape getTileShape(int tileX,
                                   int tileY)

Description copied from interface: IMap

Gets the shape of the tile [X|Y] at its absolute location.

Specified by:

getTileShape in interface IMap

Parameters:

tileX - the horizontal grid index of the tile

tileY - the vertical grid index of the tile

Returns:

the tile shape

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

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

getMapObjects

public java.util.Collection<IMapObject> getMapObjects(java.lang.String... types)

Specified by:

getMapObjects in interface IMap

getMapObjects

public java.util.Collection<IMapObject> getMapObjects()

Specified by:

getMapObjects in interface IMap

getMapObject

public IMapObject getMapObject(int mapId)

Specified by:

getMapObject in interface IMap

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.lang.String path)

updateTileTerrain

public void updateTileTerrain()

addMapObjectLayer

public void addMapObjectLayer(IMapObjectLayer layer)

Specified by:

addMapObjectLayer in interface IMap

addMapObjectLayer

public void addMapObjectLayer(int index,
                              IMapObjectLayer layer)

Specified by:

addMapObjectLayer in interface IMap

removeMapObjectLayer

public void removeMapObjectLayer(IMapObjectLayer layer)

Specified by:

removeMapObjectLayer in interface IMap

removeMapObjectLayer

public void removeMapObjectLayer(int index)

Specified by:

removeMapObjectLayer in interface IMap

setHeight

public void setHeight(int height)

setOrientation

public void setOrientation(java.lang.String orientation)

setRenderorder

public void setRenderorder(java.lang.String 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(java.lang.String staggerAxis)

setStaggerIndex

public void setStaggerIndex(java.lang.String staggerIndex)

setVersion

public void setVersion(double version)

setWidth

public void setWidth(int width)

compareTo

public int compareTo(Map o)

Specified by:

compareTo in interface java.lang.Comparable<Map>

getRenderLayers

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

Specified by:

getRenderLayers in interface IMap

getExternalTilesets

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

getRawTilesets

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

getBackgroundColor

public java.awt.Color getBackgroundColor()

Specified by:

getBackgroundColor in interface IMap

getRawTileLayers

public java.util.List<TileLayer> getRawTileLayers()

isInfinite

public boolean isInfinite()

Specified by:

isInfinite in interface IMap

getRawImageLayers

protected java.util.List<ImageLayer> getRawImageLayers()

getRawMapObjectLayers

protected java.util.List<MapObjectLayer> getRawMapObjectLayers()

getChunkOffsetX

protected int getChunkOffsetX()

getChunkOffsetY

protected int getChunkOffsetY()