org.scilab.forge.scirenderer.lightning
Interface LightManager

All Known Implementing Classes:

JoGLLightManager

public interface LightManager

Light manager interface.

Author:

Pierre Lando

Field Summary

static boolean

DEFAULT_LIGHTNING_STATUS The default lightning status.

Method Summary

Light	getLight(int i) Return the i-th light.
int	getLightNumber() Return the number of available light.
boolean	isLightningEnable() Return the lightning status.
void	setLightningEnable(boolean isLightningEnable) Set the lightning status.

Field Detail

DEFAULT_LIGHTNING_STATUS

static final boolean DEFAULT_LIGHTNING_STATUS

The default lightning status.

See Also:

Constant Field Values

Method Detail

getLightNumber

int getLightNumber()

Return the number of available light.

Returns:

the number of available light.

getLight

Light getLight(int i)

Return the i-th light. null is returned if i is not a valid index.

Parameters:

i - the given index.

Returns:

the i-th light.

setLightningEnable

void setLightningEnable(boolean isLightningEnable)

Set the lightning status. Lighting is initially disabled. When it is enabled, light sources that are enabled contribute to the lighting calculation.

Parameters:

isLightningEnable - the new lightning status.

isLightningEnable

boolean isLightningEnable()

Return the lightning status.

Returns:

the lightning status.