com.jme3.light

Class Light

java.lang.Object

com.jme3.light.Light

All Implemented Interfaces:

Savable, java.lang.Cloneable

Direct Known Subclasses:

AmbientLight, DirectionalLight, LightProbe, PointLight, SpotLight

public abstract class Light
extends java.lang.Object
implements Savable, java.lang.Cloneable

Abstract class for representing a light source.

All light source types have a color.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Light.Type Describes the light type.

Field Summary

Fields

Modifier and Type	Field and Description
protected ColorRGBA	color
protected boolean	enabled
protected float	lastDistance Used in LightList for caching the distance to the owner spatial.
protected java.lang.String	name The light name.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Light()
protected	Light(ColorRGBA color)

Method Summary

Modifier and Type	Method and Description
Light	clone()
protected abstract void	computeLastDistance(Spatial owner) Used internally to compute the last distance value.
ColorRGBA	getColor() Returns the color of the light.
java.lang.String	getName() Return the light name.
abstract Light.Type	getType() Returns the light type
abstract boolean	intersectsBox(BoundingBox box, TempVars vars) Determines if the light intersects with the given bounding box.
abstract boolean	intersectsFrustum(Camera camera, TempVars vars) Determines if the light intersects with the given camera frustum.
abstract boolean	intersectsSphere(BoundingSphere sphere, TempVars vars) Determines if the light intersects with the given bounding sphere.
boolean	isEnabled() Returns true if this light is enabled.
boolean	isFrustumCheckNeeded()
boolean	isIntersectsFrustum()
void	read(JmeImporter im)
void	setColor(ColorRGBA color) Sets the light color.
void	setEnabled(boolean enabled) Set to false in order to disable a light and have it filtered out from being included in rendering.
void	setFrustumCheckNeeded(boolean frustumCheckNeeded)
void	setIntersectsFrustum(boolean intersectsFrustum)
void	setName(java.lang.String name) This method sets the light name.
void	write(JmeExporter ex)

Methods inherited from class java.lang.Object

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

Field Detail

color

protected ColorRGBA color

lastDistance

protected transient float lastDistance

Used in LightList for caching the distance to the owner spatial. Should be reset after the sorting.

enabled

protected boolean enabled

name

protected java.lang.String name

The light name.

Constructor Detail

Light

protected Light()

Light

protected Light(ColorRGBA color)

Method Detail

getColor

public ColorRGBA getColor()

Returns the color of the light.

Returns:

The color of the light.

setName

public void setName(java.lang.String name)

This method sets the light name.

Parameters:

name - the light name

getName

public java.lang.String getName()

Return the light name.

Returns:

the light name

setColor

public void setColor(ColorRGBA color)

Sets the light color.

Parameters:

color - the light color.

isEnabled

public boolean isEnabled()

Returns true if this light is enabled.

Returns:

true if enabled, otherwise false.

setEnabled

public void setEnabled(boolean enabled)

Set to false in order to disable a light and have it filtered out from being included in rendering.

Parameters:

enabled - true to enable and false to disable the light.

isFrustumCheckNeeded

public boolean isFrustumCheckNeeded()

setFrustumCheckNeeded

public void setFrustumCheckNeeded(boolean frustumCheckNeeded)

isIntersectsFrustum

public boolean isIntersectsFrustum()

setIntersectsFrustum

public void setIntersectsFrustum(boolean intersectsFrustum)

intersectsBox

public abstract boolean intersectsBox(BoundingBox box,
                                      TempVars vars)

Determines if the light intersects with the given bounding box.

For non-local lights, such as directional lights, ambient lights, or point lights without influence radius, this method should always return true.

Parameters:

box - The box to check intersection against.

vars - TempVars in case it is needed.

Returns:

True if the light intersects the box, false otherwise.

intersectsSphere

public abstract boolean intersectsSphere(BoundingSphere sphere,
                                         TempVars vars)

Determines if the light intersects with the given bounding sphere.

For non-local lights, such as directional lights, ambient lights, or point lights without influence radius, this method should always return true.

Parameters:

sphere - The sphere to check intersection against.

vars - TempVars in case it is needed.

Returns:

True if the light intersects the sphere, false otherwise.

intersectsFrustum

public abstract boolean intersectsFrustum(Camera camera,
                                          TempVars vars)

Determines if the light intersects with the given camera frustum. For non-local lights, such as directional lights, ambient lights, or point lights without influence radius, this method should always return true.

Parameters:

camera - The camera frustum to check intersection against.

vars - TempVars in case it is needed.

Returns:

True if the light intersects the frustum, false otherwise.

clone

public Light clone()

Overrides:

clone in class java.lang.Object

write

public void write(JmeExporter ex)
           throws java.io.IOException

Specified by:

write in interface Savable

Throws:

java.io.IOException

read

public void read(JmeImporter im)
          throws java.io.IOException

Specified by:

read in interface Savable

Throws:

java.io.IOException

computeLastDistance

protected abstract void computeLastDistance(Spatial owner)

Used internally to compute the last distance value.

Parameters:

owner - the Spatial whose distance is to be determined

getType

public abstract Light.Type getType()

Returns the light type

Returns:

the light type

See Also:

Light.Type