gfx::GFX::Light Class Reference

Opaque struct to define a light source. More...

#include <gfx_opengl.hh>

List of all members.

Public Types

enum  eLightId {
  eLightId_0 = GL_LIGHT0, eLightId_1 = GL_LIGHT1, eLightId_2 = GL_LIGHT2, eLightId_3 = GL_LIGHT3,
  eLightId_4 = GL_LIGHT4, eLightId_6 = GL_LIGHT6, eLightId_7 = GL_LIGHT7
}

Public Member Functions

 Light (const eLightId lightId=eLightId_0)
void SetAmbient (const RGBA color)
void SetDiffuse (const RGBA color)
void SetSpecular (const RGBA color)
void SetPosition (const WorldVertex &position, const fp w)
pair< WorldVertex, fpGetPosition (void) const

Private Attributes

eLightId mId
bool mSetAmbient
TinyArray< 4, GLfloat > mAmbient
bool mSetDiffuse
TinyArray< 4, GLfloat > mDiffuse
bool mSetSpecular
TinyArray< 4, GLfloat > mSpecular
bool mSetPosition
TinyArray< 4, GLfloat > mPosition

Friends

class GFX


Detailed Description

Opaque struct to define a light source.

Client defines it via accessors, then passes it to GFX::SetLight(Light).


Member Enumeration Documentation

enum gfx::GFX::Light::eLightId

Light source ID. Consider using higher-level eng::defs::eLightId instead.

Enumerator:
eLightId_0 
eLightId_1 
eLightId_2 
eLightId_3 
eLightId_4 
eLightId_6 
eLightId_7 


Constructor & Destructor Documentation

gfx::GFX::Light::Light ( const eLightId  id = eLightId_0  ) 

Light class methods.


Member Function Documentation

void gfx::GFX::Light::SetAmbient ( const RGBA  color  ) 

void gfx::GFX::Light::SetDiffuse ( const RGBA  color  ) 

void gfx::GFX::Light::SetSpecular ( const RGBA  color  ) 

void gfx::GFX::Light::SetPosition ( const WorldVertex position,
const fp  w 
)

pair< WorldVertex, fp > gfx::GFX::Light::GetPosition ( void   )  const


Friends And Related Function Documentation

friend class GFX [friend]


Member Data Documentation

eLightId gfx::GFX::Light::mId [private]

bool gfx::GFX::Light::mSetAmbient [private]

TinyArray<4,GLfloat> gfx::GFX::Light::mAmbient [private]

bool gfx::GFX::Light::mSetDiffuse [private]

TinyArray<4,GLfloat> gfx::GFX::Light::mDiffuse [private]

bool gfx::GFX::Light::mSetSpecular [private]

TinyArray<4,GLfloat> gfx::GFX::Light::mSpecular [private]

bool gfx::GFX::Light::mSetPosition [private]

TinyArray<4,GLfloat> gfx::GFX::Light::mPosition [private]


The documentation for this class was generated from the following files: Palomino 3D Engine documents generated by doxygen 1.5.3 on Fri Nov 23 11:26:27 2007