com.bonzaiengine.light

Class Light

java.lang.Object

com.bonzaiengine.light.Light

All Implemented Interfaces:

ILight, IBoundable, ICullable

public final class Light
extends java.lang.Object
implements ILight

Constructor Summary

Constructors

Constructor and Description
Light()

Method Summary

Modifier and Type	Method and Description
Color3	getAmbient()
Vec3	getAttenuation()
Color3	getColor()
float	getConstantAttenuation()
Color3	getDiffuse()
LightType	getLightType()
float	getLinearAttenuation()
Vec4	getPositionOrDirection()
boolean	getProperty(ILightPropertyReceiver lm, LightProperty p)
float	getQuadracticAttenuation()
ICamera	getRelTo()
Color3	getSpecular()
float	getSpotCutoff()
Vec3	getSpotDirection()
float	getSpotExponent()
IVolume	getVolume(int bvOptions)
boolean	isCulled()
boolean	isEnabled()
boolean	isLightActive() Active property composite of the enable, visibility, culling, ... states.
boolean	isVisible()
static Light	read(ByteInputStream in)
void	set(Light light)
void	setAmbient(Color3 ambient)
void	setConstantAttenuation(float constantAttenuation)
void	setCulled(boolean culled)
void	setDiffuse(Color3 diffuse)
void	setEnabled(boolean enabled)
void	setLinearAttenuation(float linearAttenuation)
void	setPositionOrDirection(Vec4 positionOrDirection)
void	setQuadracticAttenuation(float quadracticAttenuation)
void	setRelTo(ICamera relTo)
void	setSpecular(Color3 specular)
void	setSpotCutoff(float spotCutOff)
void	setSpotDirection(Vec3 spotDirection)
void	setSpotExponent(float spotExponent)
void	updateToView(View view) Update the eye space position/direction with the specified View
void	write(ByteOutputStream out)

Methods inherited from class java.lang.Object

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

Constructor Detail

Light

public Light()

Method Detail

read

public static final Light read(ByteInputStream in)
                        throws java.io.IOException

Throws:

java.io.IOException

write

public final void write(ByteOutputStream out)
                 throws java.io.IOException

Throws:

java.io.IOException

set

public final void set(Light light)

isVisible

public boolean isVisible()

Specified by:

isVisible in interface ICullable

isCulled

public boolean isCulled()

Specified by:

isCulled in interface ICullable

Returns:

the cull value. true if the object is culled (hidden)

setCulled

public void setCulled(boolean culled)

Specified by:

setCulled in interface ICullable

Parameters:

culled - cull state value. true if the object is to be culled (hidden)

isLightActive

public boolean isLightActive()

Description copied from interface: ILight

Active property composite of the enable, visibility, culling, ... states.
This should includes of the enable or visible states (regarding the ) the implementation mays includes

Specified by:

isLightActive in interface ILight

Returns:

true if the ILight is active

getLightType

public LightType getLightType()

Specified by:

getLightType in interface ILight

Returns:

the LightType of this ILight

getVolume

public IVolume getVolume(int bvOptions)

Specified by:

getVolume in interface IBoundable

Parameters:

bvOptions - bounding volume options.

Returns:

bounding volume, cast to BoundingBox or BoundingSphere depending on options.

See Also:

VolumeOptions, Box, Sphere, Cylinder, Capsule

getProperty

public boolean getProperty(ILightPropertyReceiver lm,
                           LightProperty p)

Specified by:

getProperty in interface ILight

Parameters:

lm - the ILightModel to set the property to

p - a LightProperty

Returns:

true if the property value has been successfully set, may return false if not supported by either the light or light model

setRelTo

public void setRelTo(ICamera relTo)

getRelTo

public ICamera getRelTo()

updateToView

public final void updateToView(View view)

Description copied from interface: ILight

Update the eye space position/direction with the specified View

Specified by:

updateToView in interface ILight

isEnabled

public final boolean isEnabled()

setEnabled

public final void setEnabled(boolean enabled)

getSpotCutoff

public final float getSpotCutoff()

setSpotCutoff

public final void setSpotCutoff(float spotCutOff)

Parameters:

spotCutOff - a value in range [0;90] or 180

getSpotExponent

public final float getSpotExponent()

setSpotExponent

public final void setSpotExponent(float spotExponent)

Parameters:

spotExponent - a value in range [0;128]

getAttenuation

public Vec3 getAttenuation()

getConstantAttenuation

public final float getConstantAttenuation()

setConstantAttenuation

public final void setConstantAttenuation(float constantAttenuation)

getLinearAttenuation

public final float getLinearAttenuation()

setLinearAttenuation

public final void setLinearAttenuation(float linearAttenuation)

getQuadracticAttenuation

public final float getQuadracticAttenuation()

setQuadracticAttenuation

public final void setQuadracticAttenuation(float quadracticAttenuation)

getAmbient

public final Color3 getAmbient()

setAmbient

public final void setAmbient(Color3 ambient)

getColor

public Color3 getColor()

getDiffuse

public final Color3 getDiffuse()

setDiffuse

public final void setDiffuse(Color3 diffuse)

getSpecular

public final Color3 getSpecular()

setSpecular

public final void setSpecular(Color3 specular)

getPositionOrDirection

public final Vec4 getPositionOrDirection()

Returns:

the position of a positional light, or the direction of a directional light (w == 0)

setPositionOrDirection

public final void setPositionOrDirection(Vec4 positionOrDirection)

Parameters:

positionOrDirection - the position of a positional light, or the direction of a directional light (w == 0)

getSpotDirection

public final Vec3 getSpotDirection()

setSpotDirection

public final void setSpotDirection(Vec3 spotDirection)