org.scilab.forge.scirenderer.lightning
Interface Light

All Known Implementing Classes:
JoGLLight

public interface Light

The light interface.

Author:
Pierre Lando

Method Summary
 Color getAmbientColor()
          Return the ambient color of this light;
 Color getDiffuseColor()
          Return the diffuse color of this light;
 int getIndex()
          Return the light index.
 Vector3d getPosition()
          Return the light position.
 Color getSpecularColor()
          Return the specular color of this light;
 float getSpotAngle()
          Return the spot angle.
 Vector3d getSpotDirection()
          Return the spot direction.
 boolean isEnable()
          Return the status of this light.
 void setAmbientColor(Color color)
          Set the ambient color of this light.
 void setDiffuseColor(Color color)
          Set the diffuse color of this light.
 void setEnable(boolean enable)
          Set the status of this light.
 void setPosition(Vector3d position)
          Set the light position.
 void setSpecularColor(Color color)
          Set the specular color of this light.
 void setSpotAngle(float angle)
          Set the spot angle.
 void setSpotDirection(Vector3d spotDirection)
          Set the spot direction.
 

Method Detail

isEnable

boolean isEnable()
Return the status of this light.

Returns:
the status of this light.

setEnable

void setEnable(boolean enable)
Set the status of this light.

Parameters:
enable - the new status of this light.

getAmbientColor

Color getAmbientColor()
Return the ambient color of this light;

Returns:
the ambient color of this light;

setAmbientColor

void setAmbientColor(Color color)
Set the ambient color of this light.

Parameters:
color - the new ambient color of this light.

getDiffuseColor

Color getDiffuseColor()
Return the diffuse color of this light;

Returns:
the diffuse color of this light;

setDiffuseColor

void setDiffuseColor(Color color)
Set the diffuse color of this light.

Parameters:
color - the new diffuse color of this light.

getSpecularColor

Color getSpecularColor()
Return the specular color of this light;

Returns:
the specular color of this light;

setSpecularColor

void setSpecularColor(Color color)
Set the specular color of this light.

Parameters:
color - the new specular color of this light.

getPosition

Vector3d getPosition()
Return the light position.

Returns:
the light position.

setPosition

void setPosition(Vector3d position)
Set the light position.

Parameters:
position - the new position.

getSpotDirection

Vector3d getSpotDirection()
Return the spot direction.

Returns:
the spot direction.

setSpotDirection

void setSpotDirection(Vector3d spotDirection)
Set the spot direction.

Parameters:
spotDirection - the new spot direction.

getSpotAngle

float getSpotAngle()
Return the spot angle.

Returns:
the spot angle.

setSpotAngle

void setSpotAngle(float angle)
Set the spot angle.

Parameters:
angle - the new spot angle.

getIndex

int getIndex()
Return the light index.

Returns:
the light index.