HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::Iterator< ZYXOrder > Class Template Reference

Iterator over the Coord domain covered by a CoordBBox. More...

#include <Coord.h>

Public Member Functions

 Iterator (const CoordBBox &b)
 C-tor from a bounding box. More...
 
Iteratoroperator++ ()
 Increment the iterator to point to the next coordinate. More...
 
 operator bool () const
 Return true if the iterator still points to a valid coordinate. More...
 
const Coordoperator* () const
 Return a const reference to the coordinate currently pointed to. More...
 
bool operator== (const Iterator &other) const
 Return true if this iterator and the given iterator point to the same coordinate. More...
 
bool operator!= (const Iterator &other) const
 Return true if this iterator and the given iterator point to different coordinates. More...
 

Friends

class CoordBBox
 

Detailed Description

template<bool ZYXOrder>
class openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::Iterator< ZYXOrder >

Iterator over the Coord domain covered by a CoordBBox.

Note
If ZYXOrder is true, z is the fastest-moving coordinate, otherwise the traversal is in XYZ order (i.e., x is fastest-moving).

Definition at line 274 of file Coord.h.

Constructor & Destructor Documentation

template<bool ZYXOrder>
openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::Iterator< ZYXOrder >::Iterator ( const CoordBBox b)
inline

C-tor from a bounding box.

Definition at line 278 of file Coord.h.

Member Function Documentation

template<bool ZYXOrder>
openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::Iterator< ZYXOrder >::operator bool ( ) const
inline

Return true if the iterator still points to a valid coordinate.

Definition at line 284 of file Coord.h.

template<bool ZYXOrder>
bool openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::Iterator< ZYXOrder >::operator!= ( const Iterator< ZYXOrder > &  other) const
inline

Return true if this iterator and the given iterator point to different coordinates.

Definition at line 293 of file Coord.h.

template<bool ZYXOrder>
const Coord& openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::Iterator< ZYXOrder >::operator* ( void  ) const
inline

Return a const reference to the coordinate currently pointed to.

Definition at line 286 of file Coord.h.

template<bool ZYXOrder>
Iterator& openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::Iterator< ZYXOrder >::operator++ ( )
inline

Increment the iterator to point to the next coordinate.

Iteration stops one past the maximum coordinate along the axis determined by the template parameter.

Definition at line 282 of file Coord.h.

template<bool ZYXOrder>
bool openvdb::OPENVDB_VERSION_NAME::math::CoordBBox::Iterator< ZYXOrder >::operator== ( const Iterator< ZYXOrder > &  other) const
inline

Return true if this iterator and the given iterator point to the same coordinate.

Definition at line 288 of file Coord.h.

Friends And Related Function Documentation

template<bool ZYXOrder>
friend class CoordBBox
friend

Definition at line 303 of file Coord.h.


The documentation for this class was generated from the following file: