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 List of all members.

Public Methods

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

virtual iLight * Get (int n) const=0
 Return a light by index.

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

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

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

virtual void RemoveAll ()=0
 Remove all lights.

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

virtual iLight * FindByName (const char *Name) const=0
 Find a light by name.

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


Detailed Description

This structure represents a list of lights.

Main ways to get pointers to this interface:

Main users of this interface:

Definition at line 386 of file light.h.


Member Function Documentation

virtual int iLightList::Add (  iLight *    obj )  [pure virtual]
 

Add a light.

virtual int iLightList::Find (  iLight *    obj )  const [pure virtual]
 

Find a light and return its index.

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

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

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

Find a light by name.

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

Return a light by index.

virtual int iLightList::GetCount (    )  [pure virtual]
 

Return the number of lights in this list.

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

Remove the nth light.

virtual bool iLightList::Remove (  iLight *    obj )  [pure virtual]
 

Remove a light.

virtual void iLightList::RemoveAll (    )  [pure virtual]
 

Remove all lights.


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