<!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: csVertexListWalker< Tbase, Tcomplex > Class Template 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>csVertexListWalker< Tbase, Tcomplex > Class Template Reference</h1><!-- doxytag: class="csVertexListWalker" -->Helper class to make it easier to iterate over elements from renderbuffers, with automatic conversion to <em>Tbase</em>.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="vertexlistwalker_8h-source.html">csgfx/vertexlistwalker.h</a>></code>
<p>
<p>
<a href="classcsVertexListWalker-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsVertexListWalker.html#8bdddd21800fdeab268bce050656c267">csVertexListWalker</a> (<a class="el" href="structiRenderBuffer.html">iRenderBuffer</a> *buffer, size_t desiredComponents=0, const Tbase *defaultComponents=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct new walker. <a href="#8bdddd21800fdeab268bce050656c267"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsVertexListWalker.html#1d120e497d5937e5238ba8296e2cdbbb">ResetState</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start from the beginning. <a href="#1d120e497d5937e5238ba8296e2cdbbb"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="828af5a6ba8eb51b8f7a8a65584666fd"></a><!-- doxytag: member="csVertexListWalker::operator *" ref="828af5a6ba8eb51b8f7a8a65584666fd" args="() const " -->
const Tcomplex & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsVertexListWalker.html#828af5a6ba8eb51b8f7a8a65584666fd">operator *</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsVertexListWalker.html#01b038d7bdaa4f127a8e02cd0eae9ad6">operator Tbase const *</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get current element. <a href="#01b038d7bdaa4f127a8e02cd0eae9ad6"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsVertexListWalker.html">csVertexListWalker</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsVertexListWalker.html#cf29ddde83a5e8fd0f8350c8963b958c">operator++</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set current element to the next. <a href="#cf29ddde83a5e8fd0f8350c8963b958c"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<typename Tbase, typename Tcomplex = Tbase><br>
class csVertexListWalker< Tbase, Tcomplex ></h3>
Helper class to make it easier to iterate over elements from renderbuffers, with automatic conversion to <em>Tbase</em>.
<p>
Elements can also be queried as <em>Tcomplex</em>, which must consist of multiple <em>Tbase</em>. <dl class="remark" compact><dt><b>Remarks:</b></dt><dd>The element actually returned (converted or not) is stored in an array internal to the class. That has the consequence that for a queried element, you will only get what you expect as long as <a class="el" href="classcsVertexListWalker.html#cf29ddde83a5e8fd0f8350c8963b958c" title="Set current element to the next.">operator++()</a> is not called. If you need to retain an element, you have to copy it! This also means you cannot really manipulate the buffer this way... </dd></dl>
<p>Definition at line <a class="el" href="vertexlistwalker_8h-source.html#l00042">42</a> of file <a class="el" href="vertexlistwalker_8h-source.html">vertexlistwalker.h</a>.</p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="8bdddd21800fdeab268bce050656c267"></a><!-- doxytag: member="csVertexListWalker::csVertexListWalker" ref="8bdddd21800fdeab268bce050656c267" args="(iRenderBuffer *buffer, size_t desiredComponents=0, const Tbase *defaultComponents=0)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Tbase, typename Tcomplex = Tbase> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcsVertexListWalker.html">csVertexListWalker</a>< Tbase, Tcomplex >::<a class="el" href="classcsVertexListWalker.html">csVertexListWalker</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiRenderBuffer.html">iRenderBuffer</a> * </td>
<td class="paramname"> <em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>desiredComponents</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Tbase * </td>
<td class="paramname"> <em>defaultComponents</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Construct new walker.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>buffer</em> </td><td>The render buffer to walk over. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>desiredComponents</em> </td><td>Number of components to fetch from the buffer. Those can differ from the real number; the components are filled up with default values, if necessary. If 0, the component count as set in the buffer will be returned. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>defaultComponents</em> </td><td>The default values for components, if more are requested than available. If 0, the values {0,0,0,1} are used. </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="vertexlistwalker_8h-source.html#l00055">55</a> of file <a class="el" href="vertexlistwalker_8h-source.html">vertexlistwalker.h</a>.</p>
<p>References <a class="el" href="cssysdef_8h.html#c380bd47888ecfe73e7b7a40b6f827a1">CS_ASSERT</a>, <a class="el" href="structiRenderBuffer.html#39e622dc64c4acc4a3ed2df051e10598">iRenderBuffer::GetComponentCount()</a>, <a class="el" href="structiRenderBuffer.html#23e7848455338c7636d6a97e5a09c7c8">iRenderBuffer::GetComponentType()</a>, and <a class="el" href="structiRenderBuffer.html#2c43d2f649e4725a8e86abfa5dfbfffe">iRenderBuffer::GetElementCount()</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="01b038d7bdaa4f127a8e02cd0eae9ad6"></a><!-- doxytag: member="csVertexListWalker::operator Tbase const *" ref="01b038d7bdaa4f127a8e02cd0eae9ad6" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Tbase, typename Tcomplex = Tbase> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcsVertexListWalker.html">csVertexListWalker</a>< Tbase, Tcomplex >::operator Tbase const * </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get current element.
<p>
<p>Definition at line <a class="el" href="vertexlistwalker_8h-source.html#l00070">70</a> of file <a class="el" href="vertexlistwalker_8h-source.html">vertexlistwalker.h</a>.</p>
<p>References <a class="el" href="cssysdef_8h.html#c380bd47888ecfe73e7b7a40b6f827a1">CS_ASSERT</a>.</p>
</div>
</div><p>
<a class="anchor" name="cf29ddde83a5e8fd0f8350c8963b958c"></a><!-- doxytag: member="csVertexListWalker::operator++" ref="cf29ddde83a5e8fd0f8350c8963b958c" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Tbase, typename Tcomplex = Tbase> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcsVertexListWalker.html">csVertexListWalker</a>& <a class="el" href="classcsVertexListWalker.html">csVertexListWalker</a>< Tbase, Tcomplex >::operator++ </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set current element to the next.
<p>
<p>Definition at line <a class="el" href="vertexlistwalker_8h-source.html#l00086">86</a> of file <a class="el" href="vertexlistwalker_8h-source.html">vertexlistwalker.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="1d120e497d5937e5238ba8296e2cdbbb"></a><!-- doxytag: member="csVertexListWalker::ResetState" ref="1d120e497d5937e5238ba8296e2cdbbb" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename Tbase, typename Tcomplex = Tbase> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classcsVertexListWalker.html">csVertexListWalker</a>< Tbase, Tcomplex >::ResetState </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Start from the beginning.
<p>
<p>Definition at line <a class="el" href="vertexlistwalker_8h-source.html#l00095">95</a> of file <a class="el" href="vertexlistwalker_8h-source.html">vertexlistwalker.h</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csgfx/<a class="el" href="vertexlistwalker_8h-source.html">vertexlistwalker.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
>
1180
