Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 3582

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!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: iSectorIterator 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&nbsp;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&nbsp;Pages</span></a></li>
  </ul>
</div>
<div class="tabs">
  <ul>
    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul>
</div>
<h1>iSectorIterator Struct Reference<br>
<small>
[<a class="el" href="group__engine3d.html">Crystal Space 3D Engine</a>]</small>
</h1><!-- doxytag: class="iSectorIterator" --><!-- doxytag: inherits="iBase" -->An iterator to iterate over sectors.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="sector_8h-source.html">iengine/sector.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for iSectorIterator:</div>
<div class="dynsection">
<p><center><img src="structiSectorIterator__inherit__graph.png" border="0" usemap="#iSectorIterator__inherit__map" alt="Inheritance graph"></center>
<map name="iSectorIterator__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="35,7,91,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="structiSectorIterator-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 const <a class="el" href="classcsVector3.html">csVector3</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiSectorIterator.html#c82c413ac665012991dd854ad62bd4cc">GetLastPosition</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get last position that was used from Fetch.  <a href="#c82c413ac665012991dd854ad62bd4cc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiSectorIterator.html#f042abfd68549f92ab2b13023d57229b">HasNext</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return true if there are more elements.  <a href="#f042abfd68549f92ab2b13023d57229b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiSector.html">iSector</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiSectorIterator.html#f359edbe26a248c2ff0e893e7944bedd">Next</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get sector from iterator. Return 0 at end.  <a href="#f359edbe26a248c2ff0e893e7944bedd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiSectorIterator.html#a28f8db66e0e404e3722daaef5294b1e">Reset</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Restart iterator.  <a href="#a28f8db66e0e404e3722daaef5294b1e"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An iterator to iterate over sectors. 
<p>
Some functions in <a class="el" href="namespaceCS.html" title="Main namespace for CrystalSpace.">CS</a> return this.<p>
Main creators of instances implementing this interface:<ul>
<li><a class="el" href="structiEngine.html#f5d136e5d7e2ddd7345a36eaa66c919a" title="This routine returns an iterator to iterate over all nearby sectors.">iEngine::GetNearbySectors()</a> </li></ul>

<p>Definition at line <a class="el" href="sector_8h-source.html#l00528">528</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="c82c413ac665012991dd854ad62bd4cc"></a><!-- doxytag: member="iSectorIterator::GetLastPosition" ref="c82c413ac665012991dd854ad62bd4cc" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const <a class="el" href="classcsVector3.html">csVector3</a>&amp; iSectorIterator::GetLastPosition           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get last position that was used from Fetch. 
<p>
This can be different from 'pos' because of space warping. 
</div>
</div><p>
<a class="anchor" name="f042abfd68549f92ab2b13023d57229b"></a><!-- doxytag: member="iSectorIterator::HasNext" ref="f042abfd68549f92ab2b13023d57229b" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool iSectorIterator::HasNext           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<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="f359edbe26a248c2ff0e893e7944bedd"></a><!-- doxytag: member="iSectorIterator::Next" ref="f359edbe26a248c2ff0e893e7944bedd" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="structiSector.html">iSector</a>* iSectorIterator::Next           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get sector from iterator. Return 0 at end. 
<p>

</div>
</div><p>
<a class="anchor" name="a28f8db66e0e404e3722daaef5294b1e"></a><!-- doxytag: member="iSectorIterator::Reset" ref="a28f8db66e0e404e3722daaef5294b1e" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iSectorIterator::Reset           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</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="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>