de.esw.eengine.renderable
Class Layer

java.lang.Object
  de.esw.eengine.renderable.AbstractRenderable
      de.esw.eengine.renderable.Layer

All Implemented Interfaces:

IActivatable, IRenderable, IScriptable<Layer>, IUpdateable

public class Layer
extends AbstractRenderable
implements IActivatable, IRenderable, IUpdateable, IScriptable<Layer>

Since:

1.0

Version:

$Id: Layer.java 209 2005-07-23 00:39:50Z markusw $

Author:

markusw

Constructor Summary

Layer(java.lang.String name, Image backgroundImage)

Layer(java.lang.String name, java.lang.Integer width, java.lang.Integer height)

Layer(java.lang.String name, java.lang.Integer width, java.lang.Integer height, Image backgroundImage)

Method Summary

void	addRenderable(IRenderable renderable)
void	addScript(IScript<Layer> script)
int	getHeight()
IRenderable	getRenderableByName(java.lang.String name)
IScript<Layer>	getScriptByName(java.lang.String name)
java.util.HashMap<java.lang.String,IScript<Layer>>	getScripts()
int	getWidth()
boolean	isActive()
void	removeRenderable(IRenderable renderable)
void	removeScript(IScript<Layer> script)
void	render(IRenderDevice renderDevice) Renders this entity to the current IRenderDevice
void	render(IRenderDevice renderDevice, int x, int y)
void	setActive(boolean active)
void	toggle() Switches activation state
void	update(float delta)

Methods inherited from class de.esw.eengine.renderable.AbstractRenderable

blend, getAlpha, getName, setAlpha, setName

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.esw.eengine.core.IRenderable

blend, getAlpha, getName, setAlpha, setName

Constructor Detail

Layer

public Layer(java.lang.String name,
             java.lang.Integer width,
             java.lang.Integer height)

Parameters:

name - Name of this Layer

width - Width of this layer

height - Height of this layer

Layer

public Layer(java.lang.String name,
             Image backgroundImage)

Parameters:

name - Name of this Layer

backgroundImage - Image to render as background

Layer

public Layer(java.lang.String name,
             java.lang.Integer width,
             java.lang.Integer height,
             Image backgroundImage)

Parameters:

name - Name of this Layer

width - Width of this layer

height - Height of this layer

backgroundImage - Image to render as background

Method Detail

render

public void render(IRenderDevice renderDevice)

Description copied from interface: IRenderable

Renders this entity to the current IRenderDevice

Specified by:

render in interface IRenderable

Parameters:

renderDevice - IRenderDevice to render onto

See Also:

IRenderable.render(de.esw.eengine.core.IRenderDevice)

render

public void render(IRenderDevice renderDevice,
                   int x,
                   int y)

Parameters:

renderDevice - IRenderDevice to render onto

x - X coordinate in world space to render from

y - Y coordinate in world space to render from

update

public void update(float delta)

Specified by:

update in interface IUpdateable

Parameters:

delta - Time in millis since last update

See Also:

IUpdateable.update(float)

addScript

public void addScript(IScript<Layer> script)

Specified by:

addScript in interface IScriptable<Layer>

Parameters:

script - IScript to add

See Also:

IScriptable.addScript(de.esw.eengine.core.IScript)

removeScript

public void removeScript(IScript<Layer> script)

Specified by:

removeScript in interface IScriptable<Layer>

Parameters:

script - IScript to remove

See Also:

IScriptable.removeScript(de.esw.eengine.core.IScript)

getScripts

public java.util.HashMap<java.lang.String,IScript<Layer>> getScripts()

Specified by:

getScripts in interface IScriptable<Layer>

Returns:

List of all IScripts

See Also:

IScriptable.getScripts()

getScriptByName

public IScript<Layer> getScriptByName(java.lang.String name)

Specified by:

getScriptByName in interface IScriptable<Layer>

Parameters:

name - Name of the script to return

Returns:

IScript with the given name

See Also:

IScriptable.getScriptByName(java.lang.String)

setActive

public void setActive(boolean active)

Specified by:

setActive in interface IActivatable

Parameters:

active - True if IActivatable should be active, false otherwise

See Also:

IActivatable.setActive(boolean)

isActive

public boolean isActive()

Specified by:

isActive in interface IActivatable

Returns:

True if IActivatable is active, false otherwise

See Also:

IActivatable.isActive()

toggle

public void toggle()

Description copied from interface: IActivatable

Switches activation state

Specified by:

toggle in interface IActivatable

See Also:

IActivatable.toggle()

addRenderable

public void addRenderable(IRenderable renderable)

Parameters:

renderable - IRenderable to add

removeRenderable

public void removeRenderable(IRenderable renderable)

Parameters:

renderable - IRenderable to remove

getRenderableByName

public IRenderable getRenderableByName(java.lang.String name)

Parameters:

name - Name of the IRenderable

Returns:

IRenderable matching the given name

getHeight

public final int getHeight()

Returns:

Returns the height.

getWidth

public final int getWidth()

Returns:

Returns the width.