From 0ea5fc66924303d1bf73ba283a383e2aadee02f2 Mon Sep 17 00:00:00 2001 From: neodarz Date: Sat, 11 Aug 2018 20:21:34 +0200 Subject: Initial commit --- .../nel/structNL3D_1_1CAdvance1Iterator.html | 600 +++++++++++++++++++++ 1 file changed, 600 insertions(+) create mode 100644 docs/doxygen/nel/structNL3D_1_1CAdvance1Iterator.html (limited to 'docs/doxygen/nel/structNL3D_1_1CAdvance1Iterator.html') diff --git a/docs/doxygen/nel/structNL3D_1_1CAdvance1Iterator.html b/docs/doxygen/nel/structNL3D_1_1CAdvance1Iterator.html new file mode 100644 index 00000000..777d8a3a --- /dev/null +++ b/docs/doxygen/nel/structNL3D_1_1CAdvance1Iterator.html @@ -0,0 +1,600 @@ + + + + nevrax.org : docs + + + + + + + + + + + + + + +
# Home   # nevrax.com   
+ + + + +
Nevrax
+ + + + + + + + + + +
+ + +
+ Nevrax.org
+ + + + + + + +
#News
#Mailing-list
#Documentation
#CVS
#Bugs
#License
+
+ + + 		+ + +
+Docs + +
+  + + + + + +
Documentation 
+ +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages   Search  
+

NL3D::CAdvance1Iterator Struct Template Reference

Class that manage iterator progression with a step of 1 We assume that T::value_type gives the operator * return type T is the type of the iterator. +More... +

+#include <ps_iterator.h> +

+List of all members. + + + + + + + + + + + + + + + + + +

Public Methods

 CAdvance1Iterator ()
 CAdvance1Iterator (T it, uint32 index=0)
 create this iterator from the start of a container, and a given position (expressed in fixed point). More...

const PT & get () const
void advance ()
void advance (uint numSteps)
CAdvance1Iterator & operator++ ()
CAdvance1Iterator operator++ (int)
const PT & operator * () const
bool operator== (const CAdvance1Iterator &other) const
 const T &operator->() const { return It; } return the step in a 16:16 format. More...

bool operator!= (const CAdvance1Iterator &other) const
CAdvance1Iterator operator+ (sint quantity)
CAdvance1Iterator & operator+= (sint quantity)

Public Attributes

T It
+

Detailed Description

+

template<typename T, typename PT>
+ struct NL3D::CAdvance1Iterator< T, PT >

+ +Class that manage iterator progression with a step of 1 We assume that T::value_type gives the operator * return type T is the type of the iterator. +

+NOTE: this iterator is not intended to serves with STL algo, it doesn't support all the needed features, ++ and * operator are provided as syntaxic sugars.. This iterator is READ-ONLY TP is the type pointed by T +

+ +

+Definition at line 52 of file ps_iterator.h.

Constructor & Destructor Documentation

+

+ + + + +
+ + + + + + + + + + + + +
+template<typename T, typename PT>
NL3D::CAdvance1Iterator< T, PT >::CAdvance1Iterator (   )  [inline]
+
+ + + + + +
+   + + +

+ +

+Definition at line 56 of file ps_iterator.h. +

+Referenced by operator!=, operator+, operator++, operator+=, and operator==.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + +
+template<typename T, typename PT>
NL3D::CAdvance1Iterator< T, PT >::CAdvance1Iterator ( T   it,
uint32   index = 0
)  [inline]
+
+ + + + + +
+   + + +

+create this iterator from the start of a container, and a given position (expressed in fixed point). +

+ +

+Definition at line 58 of file ps_iterator.h. +

+References index, and It.

+

Member Function Documentation

+

+ + + + +
+ + + + + + + + + + + + + +
+template<typename T, typename PT>
void NL3D::CAdvance1Iterator< T, PT >::advance ( uint   numSteps )  [inline]
+
+ + + + + +
+   + + +

+ +

+Definition at line 64 of file ps_iterator.h. +

+References It.

+

+ + + + +
+ + + + + + + + + + + + +
+template<typename T, typename PT>
void NL3D::CAdvance1Iterator< T, PT >::advance (   )  [inline]
+
+ + + + + +
+   + + +

+ +

+Definition at line 63 of file ps_iterator.h. +

+References It. +

+Referenced by operator++.

+

+ + + + +
+ + + + + + + + + + + + +
+template<typename T, typename PT>
const PT& NL3D::CAdvance1Iterator< T, PT >::get (   )  const [inline]
+
+ + + + + +
+   + + +

+ +

+Definition at line 62 of file ps_iterator.h. +

+References It. +

+Referenced by operator *.

+

+ + + + +
+ + + + + + + + + + + + + +
+template<typename T, typename PT>
const PT& NL3D::CAdvance1Iterator< T, PT >::operator * ( void   )  const [inline]
+
+ + + + + +
+   + + +

+ +

+Definition at line 70 of file ps_iterator.h. +

+References get.

+

+ + + + +
+ + + + + + + + + + + + + +
+template<typename T, typename PT>
bool NL3D::CAdvance1Iterator< T, PT >::operator!= ( const CAdvance1Iterator< T, PT > &   other )  const [inline]
+
+ + + + + +
+   + + +

+ +

+Definition at line 75 of file ps_iterator.h. +

+References CAdvance1Iterator.

+

+ + + + +
+ + + + + + + + + + + + + +
+template<typename T, typename PT>
CAdvance1Iterator NL3D::CAdvance1Iterator< T, PT >::operator+ ( sint   quantity )  [inline]
+
+ + + + + +
+   + + +

+ +

+Definition at line 76 of file ps_iterator.h. +

+References CAdvance1Iterator, and It.

+

+ + + + +
+ + + + + + + + + + + + + +
+template<typename T, typename PT>
CAdvance1Iterator NL3D::CAdvance1Iterator< T, PT >::operator++ ( int   )  [inline]
+
+ + + + + +
+   + + +

+ +

+Definition at line 69 of file ps_iterator.h. +

+References advance, and CAdvance1Iterator.

+

+ + + + +
+ + + + + + + + + + + + +
+template<typename T, typename PT>
CAdvance1Iterator& NL3D::CAdvance1Iterator< T, PT >::operator++ (   )  [inline]
+
+ + + + + +
+   + + +

+ +

+Definition at line 68 of file ps_iterator.h. +

+References advance, and CAdvance1Iterator.

+

+ + + + +
+ + + + + + + + + + + + + +
+template<typename T, typename PT>
CAdvance1Iterator& NL3D::CAdvance1Iterator< T, PT >::operator+= ( sint   quantity )  [inline]
+
+ + + + + +
+   + + +

+ +

+Definition at line 77 of file ps_iterator.h. +

+References CAdvance1Iterator, and It.

+

+ + + + +
+ + + + + + + + + + + + + +
+template<typename T, typename PT>
bool NL3D::CAdvance1Iterator< T, PT >::operator== ( const CAdvance1Iterator< T, PT > &   other )  const [inline]
+
+ + + + + +
+   + + +

+const T &operator->() const { return It; } return the step in a 16:16 format. +

+ +

+Definition at line 74 of file ps_iterator.h. +

+References CAdvance1Iterator, and It.

+

Member Data Documentation

+

+ + + + +
+ + + + + +
+template<typename T, typename PT>
T NL3D::CAdvance1Iterator::It +
+
+ + + + + +
+   + + +

+ +

+Definition at line 54 of file ps_iterator.h. +

+Referenced by advance, CAdvance1Iterator, get, operator+, operator+=, and operator==.

+

The documentation for this struct was generated from the following file: + + + +
                                                                                                                                                                    +
+ + -- cgit v1.2.1