com.bonzaiengine.gamekit.component

Class OmniLightComponent

java.lang.Object

com.bonzaiengine.gamekit.component.ILightComponent

com.bonzaiengine.gamekit.component.OmniLightComponent

All Implemented Interfaces:

IComponent, ILight, IBoundable, ICullable

public final class OmniLightComponent
extends ILightComponent

Field Summary

Fields

Modifier and Type	Field and Description
Color3	color
float	radius
float	spotCutoff
float	spotExponent

Constructor Summary

Constructors

Constructor and Description
OmniLightComponent()

Method Summary

Modifier and Type	Method and Description
LightType	getLightType()
boolean	getProperty(ILightPropertyReceiver lm, LightProperty p)
IVolume	getVolume(int bvOptions)
boolean	isCulled()
boolean	isLightActive() Active property composite of the enable, visibility, culling, ... states.
boolean	isVisible()
void	setCulled(boolean culled)
java.lang.String	toString()
void	updateToView(View view) Update the eye space position/direction with the specified View

Methods inherited from class com.bonzaiengine.gamekit.component.ILightComponent

getGameObject, init, onActivate, onDeactivate, onDestroy, start

Methods inherited from class java.lang.Object

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

Field Detail

color

public final Color3 color

spotCutoff

public float spotCutoff

spotExponent

public float spotExponent

radius

public float radius

Constructor Detail

OmniLightComponent

public OmniLightComponent()

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getVolume

public IVolume getVolume(int bvOptions)

Parameters:

bvOptions - bounding volume options.

Returns:

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

See Also:

VolumeOptions, Box, Sphere, Cylinder, Capsule

updateToView

public void updateToView(View view)

Description copied from interface: ILight

Update the eye space position/direction with the specified View

isVisible

public boolean isVisible()

isCulled

public boolean isCulled()

Returns:

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

setCulled

public void setCulled(boolean culled)

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

Returns:

true if the ILight is active

getLightType

public LightType getLightType()

Returns:

the LightType of this ILight

getProperty

public boolean getProperty(ILightPropertyReceiver lm,
                           LightProperty p)

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