<!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: iSectorList 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>iSectorList Struct Reference<br> <small> [<a class="el" href="group__engine3d.html">Crystal Space 3D Engine</a>]</small> </h1><!-- doxytag: class="iSectorList" --><!-- doxytag: inherits="iBase" -->A list of sectors. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="sector_8h-source.html">iengine/sector.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for iSectorList:</div> <div class="dynsection"> <p><center><img src="structiSectorList__inherit__graph.png" border="0" usemap="#iSectorList__inherit__map" alt="Inheritance graph"></center> <map name="iSectorList__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="21,7,77,33"></map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> <p> <a href="structiSectorList-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="structiSectorList.html#15ecbf45d547f70ad5fb30b6a21b9e02">Add</a> (<a class="el" href="structiSector.html">iSector</a> *obj)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Add a sector. <a href="#15ecbf45d547f70ad5fb30b6a21b9e02"></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="structiSectorList.html#f8e5e46b9a7a42fa970764eb9e749656">Find</a> (<a class="el" href="structiSector.html">iSector</a> *obj) const =0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Find a sector and return its index. <a href="#f8e5e46b9a7a42fa970764eb9e749656"></a><br></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="structiSectorList.html#3a9f8c5dac3eee679819da1439bb8bf8">FindByName</a> (const char *Name) const =0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Find a sector by name. <a href="#3a9f8c5dac3eee679819da1439bb8bf8"></a><br></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="structiSectorList.html#71e586708f0cb83c986c979740751024">Get</a> (int n) const =0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return a sector by index. <a href="#71e586708f0cb83c986c979740751024"></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="structiSectorList.html#c4558f370d5b3c9122540f6f3a898a0f">GetCount</a> () const =0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of sectors in this list. <a href="#c4558f370d5b3c9122540f6f3a898a0f"></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="structiSectorList.html#790d11a65fde73fd59b4a2a323a7dabd">Remove</a> (int n)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Remove the nth sector. <a href="#790d11a65fde73fd59b4a2a323a7dabd"></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="structiSectorList.html#961642881d32fbca97a81e704ea4f239">Remove</a> (<a class="el" href="structiSector.html">iSector</a> *obj)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Remove a sector. <a href="#961642881d32fbca97a81e704ea4f239"></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="structiSectorList.html#5e376750d382c4dd402cdbe75bed2f11">RemoveAll</a> ()=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Remove all sectors. <a href="#5e376750d382c4dd402cdbe75bed2f11"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> A list of sectors. <p> Main ways to get pointers to this interface:<ul> <li><a class="el" href="structiEngine.html#6154fdb7e98d5b4519e02149ceb4a00e" title="Get the list of sectors.">iEngine::GetSectors()</a></li><li><a class="el" href="structiMovable.html#5bb2f5f74320a6d075f0b5eb4089c542" title="Get the list of sectors for this object.">iMovable::GetSectors()</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="sector_8h-source.html#l00492">492</a> of file <a class="el" href="sector_8h-source.html">sector.h</a>.</p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="15ecbf45d547f70ad5fb30b6a21b9e02"></a><!-- doxytag: member="iSectorList::Add" ref="15ecbf45d547f70ad5fb30b6a21b9e02" args="(iSector *obj)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int iSectorList::Add </td> <td>(</td> <td class="paramtype"><a class="el" href="structiSector.html">iSector</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 sector. <p> </div> </div><p> <a class="anchor" name="f8e5e46b9a7a42fa970764eb9e749656"></a><!-- doxytag: member="iSectorList::Find" ref="f8e5e46b9a7a42fa970764eb9e749656" args="(iSector *obj) const =0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int iSectorList::Find </td> <td>(</td> <td class="paramtype"><a class="el" href="structiSector.html">iSector</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 sector and return its index. <p> </div> </div><p> <a class="anchor" name="3a9f8c5dac3eee679819da1439bb8bf8"></a><!-- doxytag: member="iSectorList::FindByName" ref="3a9f8c5dac3eee679819da1439bb8bf8" args="(const char *Name) const =0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="structiSector.html">iSector</a>* iSectorList::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 sector by name. <p> </div> </div><p> <a class="anchor" name="71e586708f0cb83c986c979740751024"></a><!-- doxytag: member="iSectorList::Get" ref="71e586708f0cb83c986c979740751024" args="(int n) const =0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="structiSector.html">iSector</a>* iSectorList::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 sector by index. <p> </div> </div><p> <a class="anchor" name="c4558f370d5b3c9122540f6f3a898a0f"></a><!-- doxytag: member="iSectorList::GetCount" ref="c4558f370d5b3c9122540f6f3a898a0f" args="() const =0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int iSectorList::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 sectors in this list. <p> </div> </div><p> <a class="anchor" name="790d11a65fde73fd59b4a2a323a7dabd"></a><!-- doxytag: member="iSectorList::Remove" ref="790d11a65fde73fd59b4a2a323a7dabd" args="(int n)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual bool iSectorList::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 sector. <p> </div> </div><p> <a class="anchor" name="961642881d32fbca97a81e704ea4f239"></a><!-- doxytag: member="iSectorList::Remove" ref="961642881d32fbca97a81e704ea4f239" args="(iSector *obj)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual bool iSectorList::Remove </td> <td>(</td> <td class="paramtype"><a class="el" href="structiSector.html">iSector</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 sector. <p> </div> </div><p> <a class="anchor" name="5e376750d382c4dd402cdbe75bed2f11"></a><!-- doxytag: member="iSectorList::RemoveAll" ref="5e376750d382c4dd402cdbe75bed2f11" args="()=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void iSectorList::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 sectors. <p> </div> </div><p> <hr>The documentation for this struct was generated from the following file:<ul> <li>iengine/<a class="el" href="sector_8h-source.html">sector.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>