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

Class Layer

java.lang.Object

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

de.gurkenlabs.litiengine.environment.tilemap.xml.Layer

All Implemented Interfaces:

ICustomPropertyProvider, ILayer

Direct Known Subclasses:

GroupLayer, ImageLayer, MapObjectLayer, TileLayer

public abstract class Layer
extends CustomPropertyProvider
implements ILayer

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Layer()
protected	Layer(Layer layerToBeCopied)	Copy Constructor for copying instances of Layers.

Method Summary

Modifier and Type	Method	Description
protected void	afterUnmarshal(jakarta.xml.bind.Unmarshaller u, Object parent)
int	getHeight()	Gets the height.
double	getHorizontalParallaxFactor()	Gets the horizontal parallax scrolling factor of the layer.
int	getId()
IMap	getMap()
String	getName()	Gets the name.
Point2D	getOffset()	Gets both the X and the Y offset of the layer.
double	getOffsetX()	Gets the horizontal offset of the layer.
double	getOffsetY()	Gets the vertical offset of the layer.
float	getOpacity()	Gets the opacity.
RenderType	getRenderType()
Dimension	getSizeInTiles()	Gets the size in tiles.
Color	getTintColor()	Gets a tint color that affects the way contents of this layer are rendered.
double	getVerticalParallaxFactor()	Gets the vertical parallax scrolling factor of the layer.
int	getWidth()	Gets the width.
boolean	isVisible()	Checks if is visible.
void	setHeight(int height)
protected void	setMap(TmxMap map)
void	setName(String name)
void	setOpacity(float opacity)
void	setRenderType(RenderType renderType)
void	setTintColor(Color tintColor)	Sets the tint color of this layer.
void	setVisible(boolean visible)
void	setWidth(int width)

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

getBoolValue, getBoolValue, getByteValue, getByteValue, getCharValue, getCharValue, getColorValue, getColorValue, getCommaSeparatedStringValues, getDoubleValue, getDoubleValue, getEnumValue, getEnumValue, getFileValue, getFileValue, getFloatValue, getFloatValue, getIntValue, getIntValue, getLongValue, getLongValue, getMapObjectId, getProperties, getProperty, getShortValue, getShortValue, getStringValue, getStringValue, hasCustomProperty, removeProperty, setProperties, setValue, setValue, 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, toString, wait, wait, wait

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

getBoolValue, getBoolValue, getByteValue, getByteValue, getCharValue, getCharValue, getColorValue, getColorValue, getCommaSeparatedStringValues, getDoubleValue, getDoubleValue, getEnumValue, getEnumValue, getFileValue, getFileValue, getFloatValue, getFloatValue, getIntValue, getIntValue, getLongValue, getLongValue, getMapObjectId, getProperties, getProperty, getShortValue, getShortValue, getStringValue, getStringValue, hasCustomProperty, removeProperty, setProperties, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue

Constructor Details

Layer

protected Layer()

Layer

protected Layer(Layer layerToBeCopied)

Copy Constructor for copying instances of Layers.

Parameters:

layerToBeCopied - the layer we want to copy

Method Details

getHeight

public int getHeight()

Gets the height.

Specified by:

getHeight in interface ILayer

Returns:

the height

getId

public int getId()

Specified by:

getId in interface ILayer

getName

public String getName()

Description copied from interface: ILayer

Gets the name.

Specified by:

getName in interface ILayer

Returns:

the name

getOpacity

public float getOpacity()

Description copied from interface: ILayer

Gets the opacity.

Specified by:

getOpacity in interface ILayer

Returns:

the opacity

getOffset

public Point2D getOffset()

Description copied from interface: ILayer

Gets both the X and the Y offset of the layer.

Specified by:

getOffset in interface ILayer

Returns:

a Point2D representing the offset

getOffsetX

public double getOffsetX()

Description copied from interface: ILayer

Gets the horizontal offset of the layer.

Specified by:

getOffsetX in interface ILayer

Returns:

the x offset

getOffsetY

public double getOffsetY()

Description copied from interface: ILayer

Gets the vertical offset of the layer.

Specified by:

getOffsetY in interface ILayer

Returns:

the y offset

getHorizontalParallaxFactor

public double getHorizontalParallaxFactor()

Description copied from interface: ILayer

Gets the horizontal parallax scrolling factor of the layer. Defaults to 1.0.

Specified by:

getHorizontalParallaxFactor in interface ILayer

Returns:

The horizontal parallax scrolling factor.

getVerticalParallaxFactor

public double getVerticalParallaxFactor()

Description copied from interface: ILayer

Gets the vertical parallax scrolling factor of the layer. Defaults to 1.0.

Specified by:

getVerticalParallaxFactor in interface ILayer

Returns:

The vertical parallax scrolling factor.

getTintColor

public Color getTintColor()

Description copied from interface: ILayer

Gets a tint color that affects the way contents of this layer are rendered.

Specified by:

getTintColor in interface ILayer

Returns:

A color that is used to tint the visible contents of this layer.

setTintColor

public void setTintColor(Color tintColor)

Description copied from interface: ILayer

Sets the tint color of this layer.

Specified by:

setTintColor in interface ILayer

Parameters:

tintColor - The tint color of this layer.

getRenderType

public RenderType getRenderType()

Specified by:

getRenderType in interface ILayer

getSizeInTiles

public Dimension getSizeInTiles()

Description copied from interface: ILayer

Gets the size in tiles.

Specified by:

getSizeInTiles in interface ILayer

Returns:

the size in tiles

getWidth

public int getWidth()

Gets the width.

Specified by:

getWidth in interface ILayer

Returns:

the width

getMap

public IMap getMap()

Specified by:

getMap in interface ILayer

isVisible

public boolean isVisible()

Description copied from interface: ILayer

Checks if is visible.

Specified by:

isVisible in interface ILayer

Returns:

true, if is visible

setName

public void setName(String name)

Specified by:

setName in interface ILayer

setWidth

public void setWidth(int width)

Specified by:

setWidth in interface ILayer

setHeight

public void setHeight(int height)

Specified by:

setHeight in interface ILayer

setOpacity

public void setOpacity(float opacity)

Specified by:

setOpacity in interface ILayer

setRenderType

public void setRenderType(RenderType renderType)

Specified by:

setRenderType in interface ILayer

setVisible

public void setVisible(boolean visible)

Specified by:

setVisible in interface ILayer

setMap

protected void setMap(TmxMap map)

afterUnmarshal

protected void afterUnmarshal(jakarta.xml.bind.Unmarshaller u,
 Object parent)