CrystalSpace

Public API Reference

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

csLightIt Class Reference

Iterator to iterate over all static lights in the engine. More...

#include <engine.h>

Inheritance diagram for csLightIt:

iLightIterator iBase List of all members.

Public Methods

 csLightIt (csEngine *, iRegion *region=0)
 Construct an iterator and initialize to start. More...

virtual void Reset ()
 Restart iterator. More...

virtual bool HasNext ()
 Return true if there are more elements. More...

virtual iLightNext ()
 Get light from iterator. Return 0 at end. More...

virtual iSectorGetLastSector ()
 Get the sector for the last fetched light. More...


Detailed Description

Iterator to iterate over all static lights in the engine.

This iterator assumes there are no fundamental changes in the engine while it is being used. If changes to the engine happen the results are unpredictable.

Definition at line 85 of file csengine/engine.h.


Constructor & Destructor Documentation

csLightIt::csLightIt csEngine  ,
iRegion   region = 0
 

Construct an iterator and initialize to start.


Member Function Documentation

virtual iSector* csLightIt::GetLastSector   [virtual]
 

Get the sector for the last fetched light.

Implements iLightIterator.

virtual bool csLightIt::HasNext   [virtual]
 

Return true if there are more elements.

Implements iLightIterator.

virtual iLight* csLightIt::Next   [virtual]
 

Get light from iterator. Return 0 at end.

Implements iLightIterator.

virtual void csLightIt::Reset   [virtual]
 

Restart iterator.

Implements iLightIterator.


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