Package de.gurkenlabs.litiengine.environment.tilemap

Interface ILayer

All Superinterfaces:

ICustomPropertyProvider

All Known Subinterfaces:

IGroupLayer, IImageLayer, IMapObjectLayer, ITileLayer

All Known Implementing Classes:

GroupLayer, ImageLayer, Layer, MapObjectLayer, TileLayer

public interface ILayer
extends ICustomPropertyProvider

Method Summary

Modifier and Type	Method	Description
int	getHeight()
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()
boolean	isVisible()	Checks if is visible.
void	setHeight(int newWidth)
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 newWidth)

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

Method Details

getId

int getId()

getName

String getName()

Gets the name.

Returns:

the name

setName

void setName(String name)

getOpacity

float getOpacity()

Gets the opacity.

Returns:

the opacity

setOpacity

void setOpacity(float opacity)

getOffset

Point2D getOffset()

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

Returns:

a Point2D representing the offset

getOffsetX

double getOffsetX()

Gets the horizontal offset of the layer.

Returns:

the x offset

getOffsetY

double getOffsetY()

Gets the vertical offset of the layer.

Returns:

the y offset

getHorizontalParallaxFactor

double getHorizontalParallaxFactor()

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

Returns:

The horizontal parallax scrolling factor.

getVerticalParallaxFactor

double getVerticalParallaxFactor()

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

Returns:

The vertical parallax scrolling factor.

getTintColor

Color getTintColor()

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

Returns:

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

setTintColor

void setTintColor(Color tintcolor)

Sets the tint color of this layer.

Parameters:

tintcolor - The tint color of this layer.

getSizeInTiles

Dimension getSizeInTiles()

Gets the size in tiles.

Returns:

the size in tiles

getMap

IMap getMap()

isVisible

boolean isVisible()

Checks if is visible.

Returns:

true, if is visible

setVisible

void setVisible(boolean visible)

getRenderType

RenderType getRenderType()

setRenderType

void setRenderType(RenderType renderType)

getWidth

int getWidth()

setWidth

void setWidth(int newWidth)

getHeight

int getHeight()

setHeight

void setHeight(int newWidth)