CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

iIsoLight Struct Reference

A light for the isometric engine. More...

#include <iso.h>

Inheritance diagram for iIsoLight:

iBase List of all members.

Public Methods

virtual void SetGrid (iIsoGrid *grid)=0
 set the grid for this light, first set the light dynamic if you want

virtual iIsoGridGetGrid () const=0
 get the grid for this light

virtual csFlagsFlags ()=0
 get the light flags (for get and set) (CSISO_LIGHT above)

virtual void SetAttenuation (int attn)=0
 set attentuation type of light (CSISO_ATTN_... see above)

virtual int GetAttenuation () const=0
 get attentuation type of light

virtual void SetPosition (const csVector3 &pos)=0
 set the position of the light

virtual const csVector3GetPosition () const=0
 get the position of the light

virtual void SetColor (const csColor &col)=0
 set the color of the light

virtual const csColorGetColor () const=0
 get the color of the light

virtual void SetRadius (float radius)=0
 set the radius of the light

virtual float GetRadius () const=0
 get the radius of the light

virtual void ShineGrid ()=0
 shine the light, add light to all visible areas of the grid

virtual void ShineSprite (iIsoSprite *sprite)=0
 shine the light on a sprite, adding to all the vertex colors

virtual iLightGetFakeLight ()=0
 return an iLight interface that mostly works. For internal use.

virtual float GetVis (int gridx, int gridy) const=0
 how much does the light shine on a particular grid square?


Detailed Description

A light for the isometric engine.

Definition at line 503 of file iso.h.


Member Function Documentation

virtual csFlags& iIsoLight::Flags   [pure virtual]
 

get the light flags (for get and set) (CSISO_LIGHT above)

virtual int iIsoLight::GetAttenuation   [pure virtual]
 

get attentuation type of light

virtual const csColor& iIsoLight::GetColor   [pure virtual]
 

get the color of the light

virtual iLight* iIsoLight::GetFakeLight   [pure virtual]
 

return an iLight interface that mostly works. For internal use.

virtual iIsoGrid* iIsoLight::GetGrid   [pure virtual]
 

get the grid for this light

virtual const csVector3& iIsoLight::GetPosition   [pure virtual]
 

get the position of the light

virtual float iIsoLight::GetRadius   [pure virtual]
 

get the radius of the light

virtual float iIsoLight::GetVis int    gridx,
int    gridy
const [pure virtual]
 

how much does the light shine on a particular grid square?

virtual void iIsoLight::SetAttenuation int    attn [pure virtual]
 

set attentuation type of light (CSISO_ATTN_... see above)

virtual void iIsoLight::SetColor const csColor   col [pure virtual]
 

set the color of the light

virtual void iIsoLight::SetGrid iIsoGrid   grid [pure virtual]
 

set the grid for this light, first set the light dynamic if you want

virtual void iIsoLight::SetPosition const csVector3   pos [pure virtual]
 

set the position of the light

virtual void iIsoLight::SetRadius float    radius [pure virtual]
 

set the radius of the light

virtual void iIsoLight::ShineGrid   [pure virtual]
 

shine the light, add light to all visible areas of the grid

virtual void iIsoLight::ShineSprite iIsoSprite   sprite [pure virtual]
 

shine the light on a sprite, adding to all the vertex colors


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.18