<!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: iLightList 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>iLightList Struct Reference<br>
<small>
[<a class="el" href="group__engine3d__light.html">Lighting</a>]</small>
</h1><!-- doxytag: class="iLightList" --><!-- doxytag: inherits="iBase" -->This structure represents a list of lights.
<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 iLightList:</div>
<div class="dynsection">
<p><center><img src="structiLightList__inherit__graph.png" border="0" usemap="#iLightList__inherit__map" alt="Inheritance graph"></center>
<map name="iLightList__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="16,7,72,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiLightList-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 int </td><td class="memItemRight" valign="bottom"><a class="el" href="structiLightList.html#fd33dee443a911ad6925c89a98504a4d">Add</a> (<a class="el" href="structiLight.html">iLight</a> *obj)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a light. <a href="#fd33dee443a911ad6925c89a98504a4d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="structiLightList.html#f746f2affffdfe64bef7a524437eee49">Find</a> (<a class="el" href="structiLight.html">iLight</a> *obj) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find a light and return its index. <a href="#f746f2affffdfe64bef7a524437eee49"></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="structiLightList.html#baa54383803df4d10fbffe6bde01e083">FindByID</a> (const char *id) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find a light by its ID value (16-byte MD5). <a href="#baa54383803df4d10fbffe6bde01e083"></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="structiLightList.html#2aa7a4ce6e8875562f58006014eb1028">FindByName</a> (const char *Name) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find a light by name. <a href="#2aa7a4ce6e8875562f58006014eb1028"></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="structiLightList.html#e41513babb272603006e792ef2179298">Get</a> (int n) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a light by index. <a href="#e41513babb272603006e792ef2179298"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="structiLightList.html#dcbf6adf171370abd54b1988d93a10b2">GetCount</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of lights in this list. <a href="#dcbf6adf171370abd54b1988d93a10b2"></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="structiLightList.html#d95fa0a7515d7a3808ee8b2f00159515">Remove</a> (int n)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove the nth light. <a href="#d95fa0a7515d7a3808ee8b2f00159515"></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="structiLightList.html#dce9caadeb8f791d8a80838d5ce751ad">Remove</a> (<a class="el" href="structiLight.html">iLight</a> *obj)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove a light. <a href="#dce9caadeb8f791d8a80838d5ce751ad"></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="structiLightList.html#d85cc15ab4bea27f2e000eac0f43cef1">RemoveAll</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove all lights. <a href="#d85cc15ab4bea27f2e000eac0f43cef1"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This structure represents a list of lights.
<p>
Main ways to get pointers to this interface:<ul>
<li><a class="el" href="structiSector.html#e36d55cdd6b57528a6e94744a242107b" title="Get the list of static and pseudo-dynamic lights in this sector.">iSector::GetLights()</a></li></ul>
<p>
Main users of this interface:<ul>
<li><a class="el" href="structiEngine.html" title="This interface is the main interface to the 3D engine.">iEngine</a> </li></ul>
<p>Definition at line <a class="el" href="light_8h-source.html#l00427">427</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="fd33dee443a911ad6925c89a98504a4d"></a><!-- doxytag: member="iLightList::Add" ref="fd33dee443a911ad6925c89a98504a4d" args="(iLight *obj)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int iLightList::Add </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiLight.html">iLight</a> * </td>
<td class="paramname"> <em>obj</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add a light.
<p>
</div>
</div><p>
<a class="anchor" name="f746f2affffdfe64bef7a524437eee49"></a><!-- doxytag: member="iLightList::Find" ref="f746f2affffdfe64bef7a524437eee49" args="(iLight *obj) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int iLightList::Find </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiLight.html">iLight</a> * </td>
<td class="paramname"> <em>obj</em> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Find a light and return its index.
<p>
</div>
</div><p>
<a class="anchor" name="baa54383803df4d10fbffe6bde01e083"></a><!-- doxytag: member="iLightList::FindByID" ref="baa54383803df4d10fbffe6bde01e083" args="(const char *id) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiLight.html">iLight</a>* iLightList::FindByID </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>id</em> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Find a light by its ID value (16-byte MD5).
<p>
</div>
</div><p>
<a class="anchor" name="2aa7a4ce6e8875562f58006014eb1028"></a><!-- doxytag: member="iLightList::FindByName" ref="2aa7a4ce6e8875562f58006014eb1028" args="(const char *Name) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiLight.html">iLight</a>* iLightList::FindByName </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>Name</em> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Find a light by name.
<p>
</div>
</div><p>
<a class="anchor" name="e41513babb272603006e792ef2179298"></a><!-- doxytag: member="iLightList::Get" ref="e41513babb272603006e792ef2179298" args="(int n) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiLight.html">iLight</a>* iLightList::Get </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>n</em> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return a light by index.
<p>
</div>
</div><p>
<a class="anchor" name="dcbf6adf171370abd54b1988d93a10b2"></a><!-- doxytag: member="iLightList::GetCount" ref="dcbf6adf171370abd54b1988d93a10b2" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int iLightList::GetCount </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the number of lights in this list.
<p>
</div>
</div><p>
<a class="anchor" name="d95fa0a7515d7a3808ee8b2f00159515"></a><!-- doxytag: member="iLightList::Remove" ref="d95fa0a7515d7a3808ee8b2f00159515" args="(int n)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iLightList::Remove </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>n</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove the nth light.
<p>
</div>
</div><p>
<a class="anchor" name="dce9caadeb8f791d8a80838d5ce751ad"></a><!-- doxytag: member="iLightList::Remove" ref="dce9caadeb8f791d8a80838d5ce751ad" args="(iLight *obj)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iLightList::Remove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiLight.html">iLight</a> * </td>
<td class="paramname"> <em>obj</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove a light.
<p>
</div>
</div><p>
<a class="anchor" name="d85cc15ab4bea27f2e000eac0f43cef1"></a><!-- doxytag: member="iLightList::RemoveAll" ref="d85cc15ab4bea27f2e000eac0f43cef1" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iLightList::RemoveAll </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove all lights.
<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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
3180
