<html>
<head>
<title> TemplateOgre::VectorIterator class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link type="text/css" rel="stylesheet" href="style.css">
</head>
<body>
<!-- Generated by Doxygen 1.2.16 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
<hr><h1>Ogre::VectorIterator< T > Class Template Reference</h1>Wraps iteration over a vector.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="OgreIteratorWrappers_8h-source.html">OgreIteratorWrappers.h</a>></code>
<p>
<a href="classOgre_1_1VectorIterator-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classOgre_1_1VectorIterator.html#Ogre_1_1VectorIteratora0">VectorIterator</a> (typename T::iterator start, typename T::const_iterator end)</td></tr>
<tr><td> </td><td><font size=-1><em>Constructor.</em> <a href="#Ogre_1_1VectorIteratora0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1VectorIterator.html#Ogre_1_1VectorIteratora1">hasMoreElements</a> (void) const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns true if there are more items in the collection.</em> <a href="#Ogre_1_1VectorIteratora1"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>T::value_type </td><td valign=bottom><a class="el" href="classOgre_1_1VectorIterator.html#Ogre_1_1VectorIteratora2">getNext</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>Returns the next element in the collection, and advances to the next.</em> <a href="#Ogre_1_1VectorIteratora2"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>T::value_type </td><td valign=bottom><a class="el" href="classOgre_1_1VectorIterator.html#Ogre_1_1VectorIteratora3">peekNext</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>Returns the next element in the collection, without advancing to the next.</em> <a href="#Ogre_1_1VectorIteratora3"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>T::pointer </td><td valign=bottom><a class="el" href="classOgre_1_1VectorIterator.html#Ogre_1_1VectorIteratora4">peekNextPtr</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>Returns a pointer to the next element in the collection, without advancing to the next afterwards.</em> <a href="#Ogre_1_1VectorIteratora4"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classOgre_1_1VectorIterator.html#Ogre_1_1VectorIteratora5">moveNext</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>Moves the iterator on one element.</em> <a href="#Ogre_1_1VectorIteratora5"></a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Private Methods</h2></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classOgre_1_1VectorIterator.html#Ogre_1_1VectorIteratorc0">VectorIterator</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Private constructor since only the parameterised constructor should be used.</em> <a href="#Ogre_1_1VectorIteratorc0"></a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top>T::iterator </td><td valign=bottom><a class="el" href="classOgre_1_1VectorIterator.html#Ogre_1_1VectorIteratoro0">mCurrent</a></td></tr>
<tr><td nowrap align=right valign=top>T::const_iterator </td><td valign=bottom><a class="el" href="classOgre_1_1VectorIterator.html#Ogre_1_1VectorIteratoro1">mEnd</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<class T><br>
class Ogre::VectorIterator< T ></h3>
Wraps iteration over a vector.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
This class is here just to allow clients to iterate over an internal vector of a class without having to have access to the vector itself (typically to iterate you need both the iterator and the end() iterator to test for the end condition, which is messy). No updates are allowed through this interface, it is purely for iterating and reading.
<p>
Note that like STL iterators, these iterators are only valid whilst no updates are made to the underlying collection. You should not attempt to use this iterator if a change is made to the collection. In fact, treat this iterator as a transient object, do NOT store it and try to use it repeatedly. </dl>
<p>
<p>
Definition at line <a class="el" href="OgreIteratorWrappers_8h-source.html#l00047">47</a> of file <a class="el" href="OgreIteratorWrappers_8h-source.html">OgreIteratorWrappers.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a name="Ogre_1_1VectorIteratorc0" doxytag="Ogre::VectorIterator::VectorIterator"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template<class T> </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> Ogre::VectorIterator< T >::VectorIterator </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [private]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Private constructor since only the parameterised constructor should be used.
<p>
<p>
Definition at line <a class="el" href="OgreIteratorWrappers_8h-source.html#l00053">53</a> of file <a class="el" href="OgreIteratorWrappers_8h-source.html">OgreIteratorWrappers.h</a>. </td>
</tr>
</table>
<a name="Ogre_1_1VectorIteratora0" doxytag="Ogre::VectorIterator::VectorIterator"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template<class T> </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> Ogre::VectorIterator< T >::VectorIterator </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">typename T::iterator </td>
<td class="mdname" nowrap> <em>start</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>typename T::const_iterator </td>
<td class="mdname" nowrap> <em>end</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Constructor.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
Provide a start and end iterator to initialise. </dl>
<p>
Definition at line <a class="el" href="OgreIteratorWrappers_8h-source.html#l00059">59</a> of file <a class="el" href="OgreIteratorWrappers_8h-source.html">OgreIteratorWrappers.h</a>.
<p>
References <a class="el" href="OgreIteratorWrappers_8h-source.html#l00050">Ogre::VectorIterator< T >::mCurrent</a>, and <a class="el" href="OgreIteratorWrappers_8h-source.html#l00051">Ogre::VectorIterator< T >::mEnd</a>. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="Ogre_1_1VectorIteratora2" doxytag="Ogre::VectorIterator::getNext"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template<class T> </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> T::value_type Ogre::VectorIterator< T >::getNext </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns the next element in the collection, and advances to the next.
<p>
<p>
Definition at line <a class="el" href="OgreIteratorWrappers_8h-source.html#l00071">71</a> of file <a class="el" href="OgreIteratorWrappers_8h-source.html">OgreIteratorWrappers.h</a>.
<p>
References <a class="el" href="OgreIteratorWrappers_8h-source.html#l00050">Ogre::VectorIterator< T >::mCurrent</a>. </td>
</tr>
</table>
<a name="Ogre_1_1VectorIteratora1" doxytag="Ogre::VectorIterator::hasMoreElements"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template<class T> </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> bool Ogre::VectorIterator< T >::hasMoreElements </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns true if there are more items in the collection.
<p>
<p>
Definition at line <a class="el" href="OgreIteratorWrappers_8h-source.html#l00065">65</a> of file <a class="el" href="OgreIteratorWrappers_8h-source.html">OgreIteratorWrappers.h</a>.
<p>
References <a class="el" href="OgreIteratorWrappers_8h-source.html#l00050">Ogre::VectorIterator< T >::mCurrent</a>, and <a class="el" href="OgreIteratorWrappers_8h-source.html#l00051">Ogre::VectorIterator< T >::mEnd</a>. </td>
</tr>
</table>
<a name="Ogre_1_1VectorIteratora5" doxytag="Ogre::VectorIterator::moveNext"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template<class T> </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> void Ogre::VectorIterator< T >::moveNext </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Moves the iterator on one element.
<p>
<p>
Definition at line <a class="el" href="OgreIteratorWrappers_8h-source.html#l00086">86</a> of file <a class="el" href="OgreIteratorWrappers_8h-source.html">OgreIteratorWrappers.h</a>.
<p>
References <a class="el" href="OgreIteratorWrappers_8h-source.html#l00050">Ogre::VectorIterator< T >::mCurrent</a>. </td>
</tr>
</table>
<a name="Ogre_1_1VectorIteratora3" doxytag="Ogre::VectorIterator::peekNext"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template<class T> </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> T::value_type Ogre::VectorIterator< T >::peekNext </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns the next element in the collection, without advancing to the next.
<p>
<p>
Definition at line <a class="el" href="OgreIteratorWrappers_8h-source.html#l00076">76</a> of file <a class="el" href="OgreIteratorWrappers_8h-source.html">OgreIteratorWrappers.h</a>.
<p>
References <a class="el" href="OgreIteratorWrappers_8h-source.html#l00050">Ogre::VectorIterator< T >::mCurrent</a>. </td>
</tr>
</table>
<a name="Ogre_1_1VectorIteratora4" doxytag="Ogre::VectorIterator::peekNextPtr"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template<class T> </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> T::pointer Ogre::VectorIterator< T >::peekNextPtr </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns a pointer to the next element in the collection, without advancing to the next afterwards.
<p>
<p>
Definition at line <a class="el" href="OgreIteratorWrappers_8h-source.html#l00081">81</a> of file <a class="el" href="OgreIteratorWrappers_8h-source.html">OgreIteratorWrappers.h</a>. </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="Ogre_1_1VectorIteratoro0" doxytag="Ogre::VectorIterator::mCurrent"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template<class T> </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> T::iterator Ogre::VectorIterator< T >::mCurrent<code> [private]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreIteratorWrappers_8h-source.html#l00050">50</a> of file <a class="el" href="OgreIteratorWrappers_8h-source.html">OgreIteratorWrappers.h</a>.
<p>
Referenced by <a class="el" href="OgreIteratorWrappers_8h-source.html#l00071">Ogre::VectorIterator< T >::getNext</a>(), <a class="el" href="OgreIteratorWrappers_8h-source.html#l00065">Ogre::VectorIterator< T >::hasMoreElements</a>(), <a class="el" href="OgreIteratorWrappers_8h-source.html#l00086">Ogre::VectorIterator< T >::moveNext</a>(), <a class="el" href="OgreIteratorWrappers_8h-source.html#l00076">Ogre::VectorIterator< T >::peekNext</a>(), and <a class="el" href="OgreIteratorWrappers_8h-source.html#l00059">Ogre::VectorIterator< T >::VectorIterator</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1VectorIteratoro1" doxytag="Ogre::VectorIterator::mEnd"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" colspan="4">
template<class T> </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> T::const_iterator Ogre::VectorIterator< T >::mEnd<code> [private]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreIteratorWrappers_8h-source.html#l00051">51</a> of file <a class="el" href="OgreIteratorWrappers_8h-source.html">OgreIteratorWrappers.h</a>.
<p>
Referenced by <a class="el" href="OgreIteratorWrappers_8h-source.html#l00065">Ogre::VectorIterator< T >::hasMoreElements</a>(), and <a class="el" href="OgreIteratorWrappers_8h-source.html#l00059">Ogre::VectorIterator< T >::VectorIterator</a>(). </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="OgreIteratorWrappers_8h-source.html">OgreIteratorWrappers.h</a></ul>
<p>
Copyright © 2002-2003 by The OGRE Team<br />
Last modified Wed Jan 21 00:21:13 2004
</p>
</body>
</html>
