de.gurkenlabs.litiengine.environment.tilemap.xml

Class MapObject

java.lang.Object

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

de.gurkenlabs.litiengine.environment.tilemap.xml.MapObject

All Implemented Interfaces:

ICustomPropertyProvider, IMapObject, Resource, java.lang.Comparable<Resource>

Direct Known Subclasses:

Blueprint

public class MapObject
extends CustomPropertyProvider
implements IMapObject

The Class MapObject.

Constructor Summary

Constructors

Constructor and Description
MapObject()
MapObject(MapObject mapObjectToBeCopied) Copy Constructor for copying instances of MapObjects.
MapObject(MapObject mapObjectToBeCopied, boolean keepID) Copy Constructor for copying instances of MapObjects.
MapObject(MapObject mapObjectToBeCopied, int id)
MapObject(java.lang.String type)

Method Summary

Modifier and Type	Method and Description
java.awt.geom.Rectangle2D	getBoundingBox() Gets the hit box.
static java.awt.geom.Rectangle2D	getBounds(IMapObject... objects)
static java.awt.geom.Rectangle2D	getBounds(java.lang.Iterable<IMapObject> objects)
java.awt.geom.Ellipse2D	getEllipse()
int	getGridId() Gets the grid id.
float	getHeight()
int	getId() Gets the id.
IMapObjectLayer	getLayer()
java.awt.geom.Point2D	getLocation() Gets the location.
java.lang.String	getName() Gets the name.
IPolyShape	getPolygon()
IPolyShape	getPolyline()
IMapObjectText	getText()
ITilesetEntry	getTile()
java.lang.String	getType() Gets the type.
float	getWidth()
float	getX()
float	getY()
boolean	isEllipse()
boolean	isPoint()
boolean	isPolygon()
boolean	isPolyline()
void	setGridId(int gid)
void	setHeight(float height)
void	setId(int id)
protected void	setLayer(MapObjectLayer layer)
void	setLocation(float x, float y)
void	setLocation(java.awt.geom.Point2D location)
void	setName(java.lang.String name)
void	setPolyline(PolyShape polyline)
void	setType(java.lang.String type)
void	setWidth(float width)
void	setX(float x)
void	setY(float y)
java.lang.String	toString()

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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

Methods inherited from interface de.gurkenlabs.litiengine.resources.Resource

compareTo

Constructor Detail

MapObject

public MapObject()

MapObject

public MapObject(java.lang.String type)

MapObject

public MapObject(MapObject mapObjectToBeCopied)

Copy Constructor for copying instances of MapObjects. This variant of the constructor will assign an entirely new ID to the newly created MapObject.

Parameters:

mapObjectToBeCopied - the MapObject we want to copy

MapObject

public MapObject(MapObject mapObjectToBeCopied,
                 boolean keepID)

Copy Constructor for copying instances of MapObjects. This variant of the constructor lets you decide if the copy instance will get the same ID as the old MapObject or get a new ID.

Parameters:

mapObjectToBeCopied - the MapObject we want to copy

keepID - decide if the new instance will adopt the old MapObject's ID or get a new, unique one.

MapObject

public MapObject(MapObject mapObjectToBeCopied,
                 int id)

Method Detail

getBounds

public static java.awt.geom.Rectangle2D getBounds(IMapObject... objects)

getBounds

public static java.awt.geom.Rectangle2D getBounds(java.lang.Iterable<IMapObject> objects)

getGridId

public int getGridId()

Description copied from interface: IMapObject

Gets the grid id.

Specified by:

getGridId in interface IMapObject

Returns:

the grid id

getTile

public ITilesetEntry getTile()

Specified by:

getTile in interface IMapObject

getBoundingBox

public java.awt.geom.Rectangle2D getBoundingBox()

Description copied from interface: IMapObject

Gets the hit box.

Specified by:

getBoundingBox in interface IMapObject

Returns:

the hit box

getId

public int getId()

Description copied from interface: IMapObject

Gets the id.

Specified by:

getId in interface IMapObject

Returns:

the id

getLocation

public java.awt.geom.Point2D getLocation()

Description copied from interface: IMapObject

Gets the location.

Specified by:

getLocation in interface IMapObject

Returns:

the location

getName

public java.lang.String getName()

Description copied from interface: Resource

Gets the name.

Specified by:

getName in interface Resource

Returns:

the name

getType

public java.lang.String getType()

Gets the type.

Specified by:

getType in interface IMapObject

Returns:

the type

getPolyline

public IPolyShape getPolyline()

Specified by:

getPolyline in interface IMapObject

getPolygon

public IPolyShape getPolygon()

Specified by:

getPolygon in interface IMapObject

getEllipse

public java.awt.geom.Ellipse2D getEllipse()

Specified by:

getEllipse in interface IMapObject

getText

public IMapObjectText getText()

Specified by:

getText in interface IMapObject

setGridId

public void setGridId(int gid)

Specified by:

setGridId in interface IMapObject

setHeight

public void setHeight(float height)

Specified by:

setHeight in interface IMapObject

setId

public void setId(int id)

Specified by:

setId in interface IMapObject

setName

public void setName(java.lang.String name)

Specified by:

setName in interface Resource

setType

public void setType(java.lang.String type)

Specified by:

setType in interface IMapObject

setWidth

public void setWidth(float width)

Specified by:

setWidth in interface IMapObject

setX

public void setX(float x)

Specified by:

setX in interface IMapObject

setY

public void setY(float y)

Specified by:

setY in interface IMapObject

setLocation

public void setLocation(java.awt.geom.Point2D location)

Specified by:

setLocation in interface IMapObject

setLocation

public void setLocation(float x,
                        float y)

Specified by:

setLocation in interface IMapObject

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getX

public float getX()

Specified by:

getX in interface IMapObject

getY

public float getY()

Specified by:

getY in interface IMapObject

setPolyline

public void setPolyline(PolyShape polyline)

getWidth

public float getWidth()

Specified by:

getWidth in interface IMapObject

getHeight

public float getHeight()

Specified by:

getHeight in interface IMapObject

getLayer

public IMapObjectLayer getLayer()

Specified by:

getLayer in interface IMapObject

isPolyline

public boolean isPolyline()

Specified by:

isPolyline in interface IMapObject

isPolygon

public boolean isPolygon()

Specified by:

isPolygon in interface IMapObject

isPoint

public boolean isPoint()

Specified by:

isPoint in interface IMapObject

isEllipse

public boolean isEllipse()

Specified by:

isEllipse in interface IMapObject

setLayer

protected void setLayer(MapObjectLayer layer)