Package de.gurkenlabs.litiengine.entities

Class LightSource

java.lang.Object

de.gurkenlabs.litiengine.entities.Entity

de.gurkenlabs.litiengine.entities.LightSource

All Implemented Interfaces:

EntityRenderedListener, EntityRenderListener, IEntity, IRenderable, Tweenable, EventListener

public class LightSource
extends Entity
implements IRenderable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	LightSource.Type

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_INTENSITY
static final String	TOGGLE_MESSAGE

Fields inherited from class de.gurkenlabs.litiengine.entities.Entity

ANY_MESSAGE

Constructor Summary

Constructors

Constructor	Description
LightSource(int intensity, Color lightColor, LightSource.Type shapeType, boolean activated)	Instantiates a new LightSource entity.

Method Summary

Modifier and Type	Method	Description
void	activate()
void	deactivate()
Color	getColor()
double	getFocusOffsetX()
double	getFocusOffsetY()
int	getIntensity()
Shape	getLightShape()
LightSource.Type	getLightShapeType()
int	getRadius()
boolean	isActive()
void	render(Graphics2D graphic)	Renders the visual contents of this instance onto the provided graphics context.
String	sendMessage(Object sender, String message)
void	setColor(Color color)
void	setFocusOffsetX(double focusOffsetX)
void	setFocusOffsetY(double focusOffsetY)
void	setHeight(double height)
void	setIntensity(int intensity)
void	setLightShapeType(LightSource.Type shapeType)
void	setLocation(Point2D location)	Sets the map location.
void	setSize(double width, double height)
void	setWidth(double width)
void	setX(double x)
void	setY(double y)
void	toggle()

Methods inherited from class de.gurkenlabs.litiengine.entities.Entity

actions, addController, addEntityRenderListener, addListener, addTag, addTransformListener, animations, attachControllers, behavior, canRender, detachControllers, getAngle, getBoundingBox, getCenter, getController, getControllers, getEnvironment, getHeight, getLocation, getMapId, getName, getProperties, getRenderType, getTags, getTweenValues, getWidth, getX, getY, hasTag, isLoaded, isVisible, loaded, onMessage, onMessage, onRendered, perform, register, removed, removeListener, removeListener, removeListener, removeListener, removeListener, removeTag, rendered, rendering, renderWithLayer, setAngle, setController, setLocation, setMapId, setName, setRenderType, setRenderWithLayer, setTweenValues, setVisible, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

TOGGLE_MESSAGE

public static final String TOGGLE_MESSAGE

See Also:

• Constant Field Values

DEFAULT_INTENSITY

public static final int DEFAULT_INTENSITY

See Also:

• Constant Field Values

Constructor Details

LightSource

public LightSource(int intensity,
 Color lightColor,
 LightSource.Type shapeType,
 boolean activated)

Instantiates a new LightSource entity.

Parameters:

intensity - The intensity of this instance.

lightColor - The color of this instance.

shapeType - The shape type of this instance.

activated - A flag indicating whether this light is activated by default.

Method Details

activate

public void activate()

deactivate

public void deactivate()

getColor

public Color getColor()

getFocusOffsetX

public double getFocusOffsetX()

getFocusOffsetY

public double getFocusOffsetY()

getIntensity

public int getIntensity()

getLightShape

public Shape getLightShape()

getLightShapeType

public LightSource.Type getLightShapeType()

getRadius

public int getRadius()

isActive

public boolean isActive()

setFocusOffsetX

public void setFocusOffsetX(double focusOffsetX)

setFocusOffsetY

public void setFocusOffsetY(double focusOffsetY)

setColor

public void setColor(Color color)

setIntensity

public void setIntensity(int intensity)

setLightShapeType

public void setLightShapeType(LightSource.Type shapeType)

setX

public void setX(double x)

Specified by:

setX in interface IEntity

Overrides:

setX in class Entity

setY

public void setY(double y)

Specified by:

setY in interface IEntity

Overrides:

setY in class Entity

setWidth

public void setWidth(double width)

Specified by:

setWidth in interface IEntity

Overrides:

setWidth in class Entity

setHeight

public void setHeight(double height)

Specified by:

setHeight in interface IEntity

Overrides:

setHeight in class Entity

setLocation

public void setLocation(Point2D location)

Description copied from class: Entity

Sets the map location.

Specified by:

setLocation in interface IEntity

Overrides:

setLocation in class Entity

Parameters:

location - the new map location

setSize

public void setSize(double width,
 double height)

Specified by:

setSize in interface IEntity

Overrides:

setSize in class Entity

toggle

public void toggle()

sendMessage

public String sendMessage(Object sender,
 String message)

Specified by:

sendMessage in interface IEntity

Overrides:

sendMessage in class Entity

render

public void render(Graphics2D graphic)

Description copied from interface: IRenderable

Renders the visual contents of this instance onto the provided graphics context.

If an Entity implements this interface, this method will be called right after the entity was rendered from the environment. Allowing for a custom rendering mechanism.

This interface can be implemented in general by anything that should be rendered to the game's screen.

Specified by:

render in interface IRenderable

Parameters:

graphic - The current graphics object onto which this instance will render its visual contents.

See Also:

• RenderEngine.renderEntity(Graphics2D, de.gurkenlabs.litiengine.entities.IEntity)