Sophie

Sophie

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

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: csNodeIterator Class 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>csNodeIterator Class Reference</h1><!-- doxytag: class="csNodeIterator" -->A node iterator.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="cstool_2mapnode_8h-source.html">cstool/mapnode.h</a>&gt;</code>
<p>

<p>
<a href="classcsNodeIterator-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsNodeIterator.html#141ab668fc42bfe4e43ffab657bc63a0">csNodeIterator</a> (<a class="el" href="structiSector.html">iSector</a> *pSector, const char *classname=0)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The constructor.  <a href="#141ab668fc42bfe4e43ffab657bc63a0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsNodeIterator.html#618948a232818e69bf99c05a2acdbd9b">HasNext</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Check if there are other nodes.  <a href="#618948a232818e69bf99c05a2acdbd9b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structiMapNode.html">iMapNode</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsNodeIterator.html#b5c6c4dcac2e20466b072d1497381f83">Next</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Move forward.  <a href="#b5c6c4dcac2e20466b072d1497381f83"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsNodeIterator.html#c74177e23dab4fe665138c1cd8274eeb">Reset</a> (<a class="el" href="structiSector.html">iSector</a> *pSector, const char *classname=0)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reuse the iterator for an other search.  <a href="#c74177e23dab4fe665138c1cd8274eeb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsNodeIterator.html#a728c23033f3bdeb31675608210d6414">~csNodeIterator</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The destructor as usual.  <a href="#a728c23033f3bdeb31675608210d6414"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsNodeIterator.html#735e391e0949f67b8fa54dfe902ab1fa">NextNode</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Step to the next node in the sector, ignoring its classname.  <a href="#735e391e0949f67b8fa54dfe902ab1fa"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsNodeIterator.html#1079d0c06965b7713860bf7c31adf796">SkipWrongClassname</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Skip all nodes with wrong classname.  <a href="#1079d0c06965b7713860bf7c31adf796"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="58ee3885a802a583465d7a9b7d6a4845"></a><!-- doxytag: member="csNodeIterator::Classname" ref="58ee3885a802a583465d7a9b7d6a4845" args="" -->
const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsNodeIterator.html#58ee3885a802a583465d7a9b7d6a4845">Classname</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ffc0fa16362c194b21442c07f0867968"></a><!-- doxytag: member="csNodeIterator::CurrentNode" ref="ffc0fa16362c194b21442c07f0867968" args="" -->
<a class="el" href="classcsRef.html">csRef</a>&lt; <a class="el" href="structiMapNode.html">iMapNode</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsNodeIterator.html#ffc0fa16362c194b21442c07f0867968">CurrentNode</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="590780d545f9ebce6f28df72a6cf53d3"></a><!-- doxytag: member="csNodeIterator::Iterator" ref="590780d545f9ebce6f28df72a6cf53d3" args="" -->
<a class="el" href="classcsRef.html">csRef</a>&lt; <a class="el" href="structiObjectIterator.html">iObjectIterator</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsNodeIterator.html#590780d545f9ebce6f28df72a6cf53d3">Iterator</a></td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A node iterator. 
<p>Definition at line <a class="el" href="cstool_2mapnode_8h-source.html#l00076">76</a> of file <a class="el" href="cstool_2mapnode_8h-source.html">mapnode.h</a>.</p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="141ab668fc42bfe4e43ffab657bc63a0"></a><!-- doxytag: member="csNodeIterator::csNodeIterator" ref="141ab668fc42bfe4e43ffab657bc63a0" args="(iSector *pSector, const char *classname=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">csNodeIterator::csNodeIterator           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiSector.html">iSector</a> *&nbsp;</td>
          <td class="paramname"> <em>pSector</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>classname</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The constructor. 
<p>
Theorectially, we could handle any <a class="el" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a>, but that doesn't make sense for the current implementation, so we restrict it to <a class="el" href="structiSector.html" title="The iSector interface is used to work with &quot;sectors&quot;.">iSector</a> to avoid some pitfalls.<p>
If a classname is given, search is restricted to nodes, in which the key "classname" has the same value as the given classname. the classname string is _not_ duplicated, so the caller is responsible to take care, that the string is available while the Iterator is alive. 
</div>
</div><p>
<a class="anchor" name="a728c23033f3bdeb31675608210d6414"></a><!-- doxytag: member="csNodeIterator::~csNodeIterator" ref="a728c23033f3bdeb31675608210d6414" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">csNodeIterator::~csNodeIterator           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The destructor as usual. 
<p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="618948a232818e69bf99c05a2acdbd9b"></a><!-- doxytag: member="csNodeIterator::HasNext" ref="618948a232818e69bf99c05a2acdbd9b" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool csNodeIterator::HasNext           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Check if there are other nodes. 
<p>

</div>
</div><p>
<a class="anchor" name="b5c6c4dcac2e20466b072d1497381f83"></a><!-- doxytag: member="csNodeIterator::Next" ref="b5c6c4dcac2e20466b072d1497381f83" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structiMapNode.html">iMapNode</a>* csNodeIterator::Next           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Move forward. 
<p>

</div>
</div><p>
<a class="anchor" name="735e391e0949f67b8fa54dfe902ab1fa"></a><!-- doxytag: member="csNodeIterator::NextNode" ref="735e391e0949f67b8fa54dfe902ab1fa" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void csNodeIterator::NextNode           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Step to the next node in the sector, ignoring its classname. 
<p>

</div>
</div><p>
<a class="anchor" name="c74177e23dab4fe665138c1cd8274eeb"></a><!-- doxytag: member="csNodeIterator::Reset" ref="c74177e23dab4fe665138c1cd8274eeb" args="(iSector *pSector, const char *classname=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void csNodeIterator::Reset           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiSector.html">iSector</a> *&nbsp;</td>
          <td class="paramname"> <em>pSector</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>classname</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Reuse the iterator for an other search. 
<p>

</div>
</div><p>
<a class="anchor" name="1079d0c06965b7713860bf7c31adf796"></a><!-- doxytag: member="csNodeIterator::SkipWrongClassname" ref="1079d0c06965b7713860bf7c31adf796" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void csNodeIterator::SkipWrongClassname           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Skip all nodes with wrong classname. 
<p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>cstool/<a class="el" href="cstool_2mapnode_8h-source.html">mapnode.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>