<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>Crystal Space 1.2.1: iLightIterator Struct Reference (Crystal Space 1.2.1 Public API Reference)</title> <link href="tabs.css" rel="stylesheet" type="text/css"> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <table border="0" cellpadding="0" cellspacing="0" width="100%" class="head"> <tr height="59"> <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td> <td class="head"><h2>Public API Reference</h2></td> </tr> <tr height="11"> <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td> </tr> </table> <div class="content"> <!-- Generated by Doxygen 1.5.3 --> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="classes.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="classes.html"><span>Alphabetical List</span></a></li> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <h1>iLightIterator Struct Reference<br> <small> [<a class="el" href="group__engine3d__light.html">Lighting</a>]</small> </h1><!-- doxytag: class="iLightIterator" --><!-- doxytag: inherits="iBase" -->Iterator to iterate over all static lights in the engine. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="light_8h-source.html">iengine/light.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for iLightIterator:</div> <div class="dynsection"> <p><center><img src="structiLightIterator__inherit__graph.png" border="0" usemap="#iLightIterator__inherit__map" alt="Inheritance graph"></center> <map name="iLightIterator__inherit__map"> <area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="29,7,85,33"></map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> <p> <a href="structiLightIterator-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiSector.html">iSector</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiLightIterator.html#c2f7d9118723f2f40f8ccda6dc14b547">GetLastSector</a> ()=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the sector for the last fetched light. <a href="#c2f7d9118723f2f40f8ccda6dc14b547"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiLightIterator.html#ec162179920a2409f45453e850068675">HasNext</a> ()=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return true if there are more elements. <a href="#ec162179920a2409f45453e850068675"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiLight.html">iLight</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiLightIterator.html#21ec8842a268adb480ffc06106b3854a">Next</a> ()=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get light from iterator. Return 0 at end. <a href="#21ec8842a268adb480ffc06106b3854a"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiLightIterator.html#3862094058dc45d7ecebcb3a04d30fa1">Reset</a> ()=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Restart iterator. <a href="#3862094058dc45d7ecebcb3a04d30fa1"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Iterator to iterate over all static lights in the engine. <p> 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.<p> Main creators of instances implementing this interface:<ul> <li><a class="el" href="structiEngine.html#0cb1a95ef972e82d385ea19bcfa7e9fa" title="Create an iterator to iterate over all static lights of the engine.">iEngine::GetLightIterator()</a></li></ul> <p> Main users of this interface:<ul> <li>Application. </li></ul> <p>Definition at line <a class="el" href="light_8h-source.html#l00528">528</a> of file <a class="el" href="light_8h-source.html">light.h</a>.</p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="c2f7d9118723f2f40f8ccda6dc14b547"></a><!-- doxytag: member="iLightIterator::GetLastSector" ref="c2f7d9118723f2f40f8ccda6dc14b547" args="()=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="structiSector.html">iSector</a>* iLightIterator::GetLastSector </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the sector for the last fetched light. <p> </div> </div><p> <a class="anchor" name="ec162179920a2409f45453e850068675"></a><!-- doxytag: member="iLightIterator::HasNext" ref="ec162179920a2409f45453e850068675" args="()=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual bool iLightIterator::HasNext </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Return true if there are more elements. <p> </div> </div><p> <a class="anchor" name="21ec8842a268adb480ffc06106b3854a"></a><!-- doxytag: member="iLightIterator::Next" ref="21ec8842a268adb480ffc06106b3854a" args="()=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="structiLight.html">iLight</a>* iLightIterator::Next </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get light from iterator. Return 0 at end. <p> </div> </div><p> <a class="anchor" name="3862094058dc45d7ecebcb3a04d30fa1"></a><!-- doxytag: member="iLightIterator::Reset" ref="3862094058dc45d7ecebcb3a04d30fa1" args="()=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void iLightIterator::Reset </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Restart iterator. <p> </div> </div><p> <hr>The documentation for this struct was generated from the following file:<ul> <li>iengine/<a class="el" href="light_8h-source.html">light.h</a></ul> <hr size="1"><address><small>Generated for Crystal Space 1.2.1 by <a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 </small></address> </div></body> </html>