Package de.gurkenlabs.litiengine.environment.tilemap.xml

Class MapImage

java.lang.Object

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

de.gurkenlabs.litiengine.environment.tilemap.xml.MapImage

All Implemented Interfaces:

ICustomPropertyProvider, IMapImage

public class MapImage
extends CustomPropertyProvider
implements IMapImage

Constructor Summary

Constructors

Constructor	Description
MapImage()	Instantiates a new MapImage instance.
MapImage(MapImage original)	Instantiates a new MapImage instance by copying the specified original.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object anObject)	Tests for equality between two map images.
URL	getAbsoluteSourcePath()
Dimension	getDimension()	Gets the dimension.
int	getHeight()	Gets the height.
String	getSource()	Gets the source.
Color	getTransparentColor()	Gets the transparent color.
int	getWidth()	Gets the width.
int	hashCode()	Computes a hash code for this map image.
void	setAbsoluteSourcePath(URL absolutePath)
void	setHeight(int height)
void	setSource(String source)
void	setTransparentColor(Color color)
void	setWidth(int width)
String	toString()

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

getBoolValue, getBoolValue, getByteValue, getByteValue, getColorValue, getColorValue, getCommaSeparatedStringValues, 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, wait, wait, wait

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

getBoolValue, getBoolValue, getByteValue, getByteValue, getColorValue, getColorValue, getCommaSeparatedStringValues, 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

Constructor Details

MapImage

public MapImage()

Instantiates a new MapImage instance.

MapImage

public MapImage(MapImage original)

Instantiates a new MapImage instance by copying the specified original.

Parameters:

original - the original we want to copy

Method Details

getAbsoluteSourcePath

public URL getAbsoluteSourcePath()

Specified by:

getAbsoluteSourcePath in interface IMapImage

getDimension

public Dimension getDimension()

Description copied from interface: IMapImage

Gets the dimension.

Specified by:

getDimension in interface IMapImage

Returns:

the dimension

getWidth

public int getWidth()

Description copied from interface: IMapImage

Gets the width.

Specified by:

getWidth in interface IMapImage

Returns:

the width

getHeight

public int getHeight()

Description copied from interface: IMapImage

Gets the height.

Specified by:

getHeight in interface IMapImage

Returns:

the height

getSource

public String getSource()

Description copied from interface: IMapImage

Gets the source.

Specified by:

getSource in interface IMapImage

Returns:

the source

getTransparentColor

public Color getTransparentColor()

Description copied from interface: IMapImage

Gets the transparent color.

Specified by:

getTransparentColor in interface IMapImage

Returns:

the transparent color

setTransparentColor

public void setTransparentColor(Color color)

Specified by:

setTransparentColor in interface IMapImage

setSource

public void setSource(String source)

Specified by:

setSource in interface IMapImage

setAbsoluteSourcePath

public void setAbsoluteSourcePath(URL absolutePath)

Specified by:

setAbsoluteSourcePath in interface IMapImage

setWidth

public void setWidth(int width)

Specified by:

setWidth in interface IMapImage

setHeight

public void setHeight(int height)

Specified by:

setHeight in interface IMapImage

equals

public boolean equals(Object anObject)

Description copied from interface: IMapImage

Tests for equality between two map images. Two map images are equal if they have the same absolute source path and the same transparent color.

Specified by:

equals in interface IMapImage

Overrides:

equals in class Object

Parameters:

anObject - The map image to test for equality with

Returns:

Whether this map image is equal to the provided map image, or false if anObject is not a map image

hashCode

public int hashCode()

Computes a hash code for this map image. The hash code for a map image is equal to the hash code of its absolute source path xor the hash code of its transparent color.

Overrides:

hashCode in class Object

Returns:

The hash code for this map image

toString

public String toString()

Overrides:

toString in class Object