CrystalSpace

Public API Reference

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

iLightList Struct Reference
[Lighting]

This structure represents a list of lights. More...

#include <light.h>

Inheritance diagram for iLightList:

iBase csLightList csSectorLightList List of all members.

Public Methods

virtual int GetCount () const=0
 Return the number of lights in this list. More...

virtual iLightGet (int n) const=0
 Return a light by index. More...

virtual int Add (iLight *obj)=0
 Add a light. More...

virtual bool Remove (iLight *obj)=0
 Remove a light. More...

virtual bool Remove (int n)=0
 Remove the nth light. More...

virtual void RemoveAll ()=0
 Remove all lights. More...

virtual int Find (iLight *obj) const=0
 Find a light and return its index. More...

virtual iLightFindByName (const char *Name) const=0
 Find a light by name. More...

virtual iLightFindByID (const char *id) const=0
 Find a light by its ID value (16-byte MD5). More...


Detailed Description

This structure represents a list of lights.

Definition at line 296 of file iengine/light.h.


Member Function Documentation

virtual int iLightList::Add iLight   obj [pure virtual]
 

Add a light.

Implemented in csLightList.

virtual int iLightList::Find iLight   obj const [pure virtual]
 

Find a light and return its index.

Implemented in csLightList.

virtual iLight* iLightList::FindByID const char *    id const [pure virtual]
 

Find a light by its ID value (16-byte MD5).

Implemented in csLightList.

virtual iLight* iLightList::FindByName const char *    Name const [pure virtual]
 

Find a light by name.

Implemented in csLightList.

virtual iLight* iLightList::Get int    n const [pure virtual]
 

Return a light by index.

Implemented in csLightList.

virtual int iLightList::GetCount   const [pure virtual]
 

Return the number of lights in this list.

Implemented in csLightList.

virtual bool iLightList::Remove int    n [pure virtual]
 

Remove the nth light.

Implemented in csLightList.

virtual bool iLightList::Remove iLight   obj [pure virtual]
 

Remove a light.

Implemented in csLightList.

virtual void iLightList::RemoveAll   [pure virtual]
 

Remove all lights.

Implemented in csLightList.


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