scene::Light Class Reference

This is the Light class. More...

#include <Light.h>

Inheritance diagram for scene::Light:

Inheritance graph
[legend]
Collaboration diagram for scene::Light:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 Light ()
virtual ~Light ()
void setDirection (const math::Vector3f &direction)
void setAmbient (const ColorRGBA &ambient)
void setDiffuse (const ColorRGBA &diffuse)
void setSpecular (const ColorRGBA &specular)
void setSpotParams (float32 exponent, float32 cutOff)
void setLightType (E_LIGHT_TYPE eType)
const math::Vector3fgetDirection ()
const ColorRGBAgetAmbient ()
const ColorRGBAgetDiffuse ()
const ColorRGBAgetSpecular ()
E_LIGHT_TYPE getLightType ()
void getSpotParams (float32 &exponent, float32 &cutOff)
void setEnable (bool value)
bool isEnabled ()
void setLightNumber (uint32 number)
uint32 getLightNumber ()
const char * toString ()


Detailed Description

This is the Light class.

Constructor & Destructor Documentation

scene::Light::Light (  ) 

Constructor

virtual scene::Light::~Light (  )  [inline, virtual]

Destructor


Member Function Documentation

void scene::Light::setDirection ( const math::Vector3f direction  ) 

Set the light direction

Parameters:
direction The direction value

void scene::Light::setAmbient ( const ColorRGBA ambient  ) 

Set the ambient color

Parameters:
ambient The ambient value

void scene::Light::setDiffuse ( const ColorRGBA diffuse  ) 

Set the diffuse color

Parameters:
diffuse The diffuse value

void scene::Light::setSpecular ( const ColorRGBA specular  ) 

Set the specular color

Parameters:
specular The specular value

void scene::Light::setSpotParams ( float32  exponent,
float32  cutOff 
)

Set the spot parameters

Parameters:
exponent The exponent value
cutOff The cutOff value

void scene::Light::setLightType ( E_LIGHT_TYPE  eType  ) 

Set the light type

Parameters:
eType The light type

const math::Vector3f& scene::Light::getDirection (  ) 

Get the direction

Returns:
The direction

const ColorRGBA& scene::Light::getAmbient (  ) 

Get the ambient color

Returns:
The color

const ColorRGBA& scene::Light::getDiffuse (  ) 

Get the diffuse color

Returns:
The color

const ColorRGBA& scene::Light::getSpecular (  ) 

Get the specular color

Returns:
The color

E_LIGHT_TYPE scene::Light::getLightType (  ) 

Get the light type

Returns:
The light type

void scene::Light::getSpotParams ( float32 &  exponent,
float32 &  cutOff 
)

Get the ambient color

Parameters:
exponent The exponent value
cutOff The cutOff value

void scene::Light::setEnable ( bool  value  ) 

Enable the light

Parameters:
value Set to enable the light

bool scene::Light::isEnabled (  ) 

Verify if the light is enabled

Returns:
True if enabled

void scene::Light::setLightNumber ( uint32  number  ) 

Set the light number

Parameters:
number Set to light number

uint32 scene::Light::getLightNumber (  ) 

Get the light number

Returns:
the light number

const char* scene::Light::toString (  )  [inline, virtual]

See also:
Object::toString()

Reimplemented from scene::Transformation.


The documentation for this class was generated from the following file:

Generated on Mon Mar 3 10:53:10 2008 for Aika by  doxygen 1.5.5