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

The Class MapImage.

Constructor Summary

Constructors

Constructor and Description
MapImage()
MapImage(MapImage original) Copy Constructor for copying instances of MapImage.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object anObject) Tests for equality between two map images.
java.net.URL	getAbsoluteSourcePath()
java.awt.Dimension	getDimension() Gets the dimension.
int	getHeight() Gets the height.
java.lang.String	getSource() Gets the source.
java.awt.Color	getTransparentColor() Gets the transparent color.
int	getWidth() Gets the width.
int	hashCode() Computes a hash code for this map image.
void	setAbsoluteSourcePath(java.net.URL absolutePath)
void	setHeight(int height)
void	setSource(java.lang.String source)
void	setTransparentColor(java.awt.Color color)
void	setWidth(int width)
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, finalize, getClass, 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

Constructor Detail

MapImage

public MapImage()

MapImage

public MapImage(MapImage original)

Copy Constructor for copying instances of MapImage.

Parameters:

original - the original we want to copy

Method Detail

getAbsoluteSourcePath

public java.net.URL getAbsoluteSourcePath()

Specified by:

getAbsoluteSourcePath in interface IMapImage

getDimension

public java.awt.Dimension getDimension()

Description copied from interface: IMapImage

Gets the dimension.

Specified by:

getDimension in interface IMapImage

Returns:

the dimension

getHeight

public int getHeight()

Gets the height.

Returns:

the height

getSource

public java.lang.String getSource()

Description copied from interface: IMapImage

Gets the source.

Specified by:

getSource in interface IMapImage

Returns:

the source

getTransparentColor

public java.awt.Color getTransparentColor()

Description copied from interface: IMapImage

Gets the transparent color.

Specified by:

getTransparentColor in interface IMapImage

Returns:

the transparent color

getWidth

public int getWidth()

Gets the width.

Returns:

the width

setTransparentColor

public void setTransparentColor(java.awt.Color color)

Specified by:

setTransparentColor in interface IMapImage

setSource

public void setSource(java.lang.String source)

Specified by:

setSource in interface IMapImage

setAbsoluteSourcePath

public void setAbsoluteSourcePath(java.net.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(java.lang.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 java.lang.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()

Description copied from interface: IMapImage

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.

Specified by:

hashCode in interface IMapImage

Overrides:

hashCode in class java.lang.Object

Returns:

The hash code for this map image

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object