Point Cloud Library (PCL)  1.7.0
List of all members | Public Member Functions
pcl::octree::OctreeLeafNodeIterator< OctreeT > Class Template Reference

Octree leaf node iterator class. More...

#include <pcl/octree/octree_iterator.h>

+ Inheritance diagram for pcl::octree::OctreeLeafNodeIterator< OctreeT >:

Public Member Functions

 OctreeLeafNodeIterator (unsigned int max_depth_arg=0)
 Empty constructor.
 OctreeLeafNodeIterator (OctreeT *octree_arg, unsigned int max_depth_arg=0)
 Constructor.
virtual ~OctreeLeafNodeIterator ()
 Empty deconstructor.
void reset ()
 Reset the iterator to the root node of the octree.
OctreeLeafNodeIterator & operator++ ()
 Preincrement operator.
OctreeLeafNodeIterator operator++ (int)
 postincrement operator.
OctreeNode * operator* () const
 *operator.
- Public Member Functions inherited from pcl::octree::OctreeDepthFirstIterator< OctreeT >
 OctreeDepthFirstIterator (unsigned int max_depth_arg=0)
 Empty constructor.
 OctreeDepthFirstIterator (OctreeT *octree_arg, unsigned int max_depth_arg=0)
 Constructor.
virtual ~OctreeDepthFirstIterator ()
 Empty deconstructor.
OctreeDepthFirstIterator & operator= (const OctreeDepthFirstIterator &src)
 Copy operator.
void skipChildVoxels ()
 Skip all child voxels of current node and return to parent node.
- Public Member Functions inherited from pcl::octree::OctreeIteratorBase< OctreeT >
 OctreeIteratorBase (unsigned int max_depth_arg=0)
 Empty constructor.
 OctreeIteratorBase (OctreeT *octree_arg, unsigned int max_depth_arg=0)
 Constructor.
 OctreeIteratorBase (const OctreeIteratorBase &src, unsigned int max_depth_arg=0)
 Copy constructor.
OctreeIteratorBase & operator= (const OctreeIteratorBase &src)
 Copy operator.
virtual ~OctreeIteratorBase ()
 Empty deconstructor.
bool operator== (const OctreeIteratorBase &other) const
 Equal comparison operator.
bool operator!= (const OctreeIteratorBase &other) const
 Inequal comparison operator.
const OctreeKey & getCurrentOctreeKey () const
 Get octree key for the current iterator octree node.
unsigned int getCurrentOctreeDepth () const
 Get the current depth level of octree.
OctreeNode * getCurrentOctreeNode () const
 Get the current octree node.
bool isBranchNode () const
 check if current node is a branch node
bool isLeafNode () const
 check if current node is a branch node
char getNodeConfiguration () const
 Get bit pattern of children configuration of current node.
const LeafContainer & getLeafContainer () const
 Method for retrieving a single leaf container from the octree leaf node.
LeafContainer & getLeafContainer ()
 Method for retrieving a single leaf container from the octree leaf node.
const BranchContainer & getBranchContainer () const
 Method for retrieving the container from an octree branch node.
BranchContainer & getBranchContainer ()
 Method for retrieving the container from an octree branch node.
virtual unsigned long getNodeID () const
 get a integer identifier for current node (note: identifier depends on tree depth).

Additional Inherited Members

- Public Types inherited from pcl::octree::OctreeDepthFirstIterator< OctreeT >
typedef OctreeIteratorBase
< OctreeT >::LeafNode 
LeafNode
typedef OctreeIteratorBase
< OctreeT >::BranchNode 
BranchNode
- Protected Attributes inherited from pcl::octree::OctreeDepthFirstIterator< OctreeT >
std::vector< IteratorState > stack_
 Stack structure.

Detailed Description

template<typename OctreeT>
class pcl::octree::OctreeLeafNodeIterator< OctreeT >

Octree leaf node iterator class.

Note
This class implements a forward iterator for traversing the leaf nodes of an octree data structure.
Author
Julius Kammerl (juliu.nosp@m.s@ka.nosp@m.mmerl.nosp@m..de)

Definition at line 536 of file octree_iterator.h.

Constructor & Destructor Documentation

template<typename OctreeT >
pcl::octree::OctreeLeafNodeIterator< OctreeT >::OctreeLeafNodeIterator ( unsigned int  max_depth_arg = 0)
inlineexplicit

Empty constructor.

Parameters
[in]max_depth_argDepth limitation during traversal

Definition at line 546 of file octree_iterator.h.

References pcl::octree::OctreeLeafNodeIterator< OctreeT >::reset().

template<typename OctreeT >
pcl::octree::OctreeLeafNodeIterator< OctreeT >::OctreeLeafNodeIterator ( OctreeT *  octree_arg,
unsigned int  max_depth_arg = 0 
)
inlineexplicit

Constructor.

Parameters
[in]octree_argOctree to be iterated. Initially the iterator is set to its root node.
[in]max_depth_argDepth limitation during traversal

Definition at line 557 of file octree_iterator.h.

References pcl::octree::OctreeLeafNodeIterator< OctreeT >::reset().

template<typename OctreeT >
virtual pcl::octree::OctreeLeafNodeIterator< OctreeT >::~OctreeLeafNodeIterator ( )
inlinevirtual

Empty deconstructor.

Definition at line 565 of file octree_iterator.h.

Member Function Documentation

template<typename OctreeT >
OctreeNode* pcl::octree::OctreeLeafNodeIterator< OctreeT >::operator* ( ) const
inline
template<typename OctreeT >
OctreeLeafNodeIterator& pcl::octree::OctreeLeafNodeIterator< OctreeT >::operator++ ( )
inline
template<typename OctreeT >
OctreeLeafNodeIterator pcl::octree::OctreeLeafNodeIterator< OctreeT >::operator++ ( int  )
inline

postincrement operator.

Note
step to next octree node

Reimplemented from pcl::octree::OctreeDepthFirstIterator< OctreeT >.

Definition at line 596 of file octree_iterator.h.

template<typename OctreeT >
void pcl::octree::OctreeLeafNodeIterator< OctreeT >::reset ( )
inlinevirtual

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