Point Cloud Library (PCL)  1.3.1
Public Member Functions
pcl::octree::OctreeNodeIterator Class Reference

Octree iterator class More...

#include <pcl/octree/octree_iterator.h>

List of all members.

Public Member Functions

 OctreeNodeIterator (const OctreeT &octree_arg)
 Constructor.
virtual ~OctreeNodeIterator ()
 Empty deconstructor.
void reset ()
 reset the iterator to the root node of the octree
const OctreeKey & getCurrentOctreeKey () const
 get octree key for the current iterator octree node
unsigned int getCurrentOctreeDepth () const
 get current depth level of octree
const OctreeNodegetCurrentOctreeNode () const
 get current octree node
const OctreeNodeoperator* () const
 *operator.
bool operator== (const OctreeNodeIterator &right_arg) const
 equality operator.
bool operator!= (const OctreeNodeIterator &right_arg) const
 inequality operator.
void skipChildVoxels ()
 Skip all child voxels of current node and return to parent node.
OctreeNodeIteratoroperator++ ()
 preincrement operator.
OctreeNodeIterator operator++ (int)
 postincrement operator.

Detailed Description

Octree iterator class

Note:
This class implements a forward iterator for traversing octrees.
Author:
Julius Kammerl (julius@kammerl.de)

Constructor & Destructor Documentation

pcl::octree::OctreeNodeIterator::OctreeNodeIterator ( const OctreeT &  octree_arg) [explicit]

Constructor.

Parameters:
octree_arg,:Octree to be iterated. Initially the iterator is set to its root node.

Definition at line 56 of file octree_iterator.hpp.

pcl::octree::OctreeNodeIterator::~OctreeNodeIterator ( ) [virtual]

Empty deconstructor.

Definition at line 70 of file octree_iterator.hpp.


Member Function Documentation

unsigned int pcl::octree::OctreeNodeIterator::getCurrentOctreeDepth ( ) const [inline]

get current depth level of octree

Returns:
depth level

Definition at line 101 of file octree_iterator.h.

const OctreeKey& pcl::octree::OctreeNodeIterator::getCurrentOctreeKey ( ) const [inline]

get octree key for the current iterator octree node

Returns:
octree key of current node

Definition at line 91 of file octree_iterator.h.

const OctreeNode* pcl::octree::OctreeNodeIterator::getCurrentOctreeNode ( ) const [inline]

get current octree node

Returns:
pointer to current octree node

Definition at line 110 of file octree_iterator.h.

bool pcl::octree::OctreeNodeIterator::operator!= ( const OctreeNodeIterator right_arg) const [inline]

inequality operator.

Returns:
return true if two OctreeNodeIterator are not equal. False otherwise.

Definition at line 139 of file octree_iterator.h.

const OctreeNode* pcl::octree::OctreeNodeIterator::operator* ( ) const [inline]

*operator.

Returns:
pointer to the current octree node

Reimplemented in pcl::octree::OctreeLeafNodeIterator.

Definition at line 119 of file octree_iterator.h.

OctreeNodeIterator< DataT, LeafT, OctreeT > & pcl::octree::OctreeNodeIterator::operator++ ( )

preincrement operator.

Note:
recursively step to next octree node

Reimplemented in pcl::octree::OctreeLeafNodeIterator.

Definition at line 132 of file octree_iterator.hpp.

OctreeNodeIterator pcl::octree::OctreeNodeIterator::operator++ ( int  ) [inline]

postincrement operator.

Note:
recursively step to next octree node

Reimplemented in pcl::octree::OctreeLeafNodeIterator.

Definition at line 159 of file octree_iterator.h.

bool pcl::octree::OctreeNodeIterator::operator== ( const OctreeNodeIterator right_arg) const [inline]

equality operator.

Returns:
return true if two OctreeNodeIterator are equal. False otherwise.

Definition at line 129 of file octree_iterator.h.

void pcl::octree::OctreeNodeIterator::reset ( ) [inline]

reset the iterator to the root node of the octree

Definition at line 78 of file octree_iterator.hpp.

void pcl::octree::OctreeNodeIterator::skipChildVoxels ( )

Skip all child voxels of current node and return to parent node.

Definition at line 95 of file octree_iterator.hpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines