CrystalSpace

Public API Reference

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

csLightList Class Reference

List of lights for a sector. More...

#include <light.h>

Inheritance diagram for csLightList:

iLightList iBase csSectorLightList List of all members.

Public Methods

 csLightList ()
 constructor. More...

virtual void PrepareItem (iLight *)
 Override PrepareItem. More...

virtual void FreeItem (iLight *)
 Override FreeItem. More...

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

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

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

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

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

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

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

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

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


Detailed Description

List of lights for a sector.

This class implements iLightList.

Definition at line 600 of file csengine/light.h.


Constructor & Destructor Documentation

csLightList::csLightList  
 

constructor.


Member Function Documentation

virtual int csLightList::Add iLight   obj [virtual]
 

Add a light.

Implements iLightList.

virtual int csLightList::Find iLight   obj const [virtual]
 

Find a light and return its index.

Implements iLightList.

virtual iLight* csLightList::FindByID const char *    id const [virtual]
 

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

Implements iLightList.

virtual iLight* csLightList::FindByName const char *    Name const [virtual]
 

Find a light by name.

Implements iLightList.

virtual void csLightList::FreeItem iLight   [inline, virtual]
 

Override FreeItem.

Reimplemented in csSectorLightList.

Definition at line 615 of file csengine/light.h.

virtual iLight* csLightList::Get int    n const [inline, virtual]
 

Return a light by index.

Implements iLightList.

Definition at line 618 of file csengine/light.h.

References csRefArray::Get.

virtual int csLightList::GetCount   const [inline, virtual]
 

Return the number of lights in this list.

Implements iLightList.

Definition at line 617 of file csengine/light.h.

References csRefArray::Length.

virtual void csLightList::PrepareItem iLight   [inline, virtual]
 

Override PrepareItem.

Reimplemented in csSectorLightList.

Definition at line 613 of file csengine/light.h.

virtual bool csLightList::Remove int    n [virtual]
 

Remove the nth light.

Implements iLightList.

virtual bool csLightList::Remove iLight   obj [virtual]
 

Remove a light.

Implements iLightList.

virtual void csLightList::RemoveAll   [virtual]
 

Remove all lights.

Implements iLightList.


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