Google

Main Page   Class Hierarchy   Compound List   File List   Compound Members  

iLight Struct Reference

The iLight interface is the SCF interface for the csLight class. More...

#include <light.h>

Inheritance diagram for iLight:

iBase List of all members.

Public Methods

virtual csLightGetPrivateObject ()=0
 Get private pointer to light object. UGLY.

virtual unsigned long GetLightID ()=0
 Get the id of this light.

virtual iObjectQueryObject ()=0
 Get the iObject for this light.

virtual const csVector3GetCenter ()=0
 Get the position of this light.

virtual void SetCenter (const csVector3 &pos)=0
 Set the position of this light.

virtual iSectorGetSector ()=0
 Get the sector for this light.

virtual void SetSector (iSector *sector)=0
 Set the sector for this light.

virtual float GetRadius ()=0
 Get the radius.

virtual float GetSquaredRadius ()=0
 Get the squared radius.

virtual float GetInverseRadius ()=0
 Get the inverse radius.

virtual void SetRadius (float r)=0
 Set the radius.

virtual const csColorGetColor ()=0
 Get the color of this light.

virtual void SetColor (const csColor &col)=0
 Set the color of this light.

virtual int GetAttenuation ()=0
 Return current attenuation mode.

virtual void SetAttenuation (int a)=0
 Set attenuation mode. More...

virtual iCrossHaloCreateCrossHalo (float intensity, float cross)=0
 Create a cross halo for this light.

virtual iNovaHaloCreateNovaHalo (int seed, int num_spokes, float roundness)=0
 Create a nova halo for this light.

virtual iFlareHaloCreateFlareHalo ()=0
 Create a flare halo for this light.

virtual float GetBrightnessAtDistance (float d)=0
 Get the brightness of a light at a given distance.


Detailed Description

The iLight interface is the SCF interface for the csLight class.


Member Function Documentation

void iLight::SetAttenuation ( int a ) [pure virtual]
 

Set attenuation mode.

The following values are possible (CS_ATTN_LINEAR is default CS_ATTN_LINEAR):

  • CS_ATTN_NONE: light * 1
  • CS_ATTN_LINEAR: light * (radius - distance) / radius
  • CS_ATTN_INVERSE: light * (radius / distance)
  • CS_ATTN_REALISTIC: light * (radius^2 / distance^2)


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.5 written by Dimitri van Heesch, ©1997-2000