Point Cloud Library (PCL)
1.14.0dev

Octree iterator class More...
#include <pcl/octree/octree_iterator.h>
Public Member Functions  
OctreeFixedDepthIterator ()  
Empty constructor. More...  
OctreeFixedDepthIterator (OctreeT *octree_arg, uindex_t fixed_depth_arg=0)  
Constructor. More...  
OctreeFixedDepthIterator (OctreeT *octree_arg, uindex_t fixed_depth_arg, IteratorState *current_state, const std::deque< IteratorState > &fifo=std::deque< IteratorState >())  
Constructor. More...  
OctreeFixedDepthIterator (const OctreeFixedDepthIterator &other)  
Copy Constructor. More...  
OctreeFixedDepthIterator &  operator= (const OctreeFixedDepthIterator &src) 
Copy assignment. More...  
void  reset (uindex_t fixed_depth_arg) 
Reset the iterator to the first node at the depth given as parameter. More...  
void  reset () 
Reset the iterator to the first node at the current depth. More...  
Public Member Functions inherited from pcl::octree::OctreeBreadthFirstIterator< OctreeT >  
OctreeBreadthFirstIterator (uindex_t max_depth_arg=0)  
Empty constructor. More...  
OctreeBreadthFirstIterator (OctreeT *octree_arg, uindex_t max_depth_arg=0)  
Constructor. More...  
OctreeBreadthFirstIterator (OctreeT *octree_arg, uindex_t max_depth_arg, IteratorState *current_state, const std::deque< IteratorState > &fifo=std::deque< IteratorState >())  
Constructor. More...  
OctreeBreadthFirstIterator (const OctreeBreadthFirstIterator &other)  
Copy Constructor. More...  
OctreeBreadthFirstIterator &  operator= (const OctreeBreadthFirstIterator &src) 
Copy operator. More...  
void  reset () 
Reset the iterator to the root node of the octree. More...  
OctreeBreadthFirstIterator &  operator++ () 
Preincrement operator. More...  
OctreeBreadthFirstIterator  operator++ (int) 
postincrement operator. More...  
Public Member Functions inherited from pcl::octree::OctreeIteratorBase< OctreeT >  
OctreeIteratorBase ()  
Empty constructor. More...  
OctreeIteratorBase (uindex_t max_depth_arg)  
Constructor. More...  
OctreeIteratorBase (OctreeT *octree_arg)  
Constructor. More...  
OctreeIteratorBase (OctreeT *octree_arg, uindex_t max_depth_arg)  
Constructor. More...  
OctreeIteratorBase (OctreeT *octree_arg, uindex_t max_depth_arg, IteratorState *current_state)  
Constructor. More...  
virtual  ~OctreeIteratorBase ()=default 
Empty deconstructor. More...  
bool  operator== (const OctreeIteratorBase &other) const 
Equal comparison operator. More...  
bool  operator!= (const OctreeIteratorBase &other) const 
Inequal comparison operator. More...  
void  reset () 
Reset iterator. More...  
const OctreeKey &  getCurrentOctreeKey () const 
Get octree key for the current iterator octree node. More...  
uindex_t  getCurrentOctreeDepth () const 
Get the current depth level of octree. More...  
OctreeNode *  getCurrentOctreeNode () const 
Get the current octree node. More...  
bool  isBranchNode () const 
check if current node is a branch node More...  
bool  isLeafNode () const 
check if current node is a branch node More...  
virtual OctreeNode *  operator* () const 
*operator. More...  
char  getNodeConfiguration () const 
Get bit pattern of children configuration of current node. More...  
const LeafContainer &  getLeafContainer () const 
Method for retrieving a single leaf container from the octree leaf node. More...  
LeafContainer &  getLeafContainer () 
Method for retrieving a single leaf container from the octree leaf node. More...  
const BranchContainer &  getBranchContainer () const 
Method for retrieving the container from an octree branch node. More...  
BranchContainer &  getBranchContainer () 
Method for retrieving the container from an octree branch node. More...  
virtual unsigned long  getNodeID () const 
get a integer identifier for current node (note: identifier depends on tree depth). More...  
Protected Attributes  
uindex_t  fixed_depth_ 
Given level of the node to be iterated. More...  
Protected Attributes inherited from pcl::octree::OctreeBreadthFirstIterator< OctreeT >  
std::deque< IteratorState >  FIFO_ 
FIFO list. More...  
Protected Attributes inherited from pcl::octree::OctreeIteratorBase< OctreeT >  
OctreeT *  octree_ 
Reference to octree class. More...  
IteratorState *  current_state_ 
Pointer to current iterator state. More...  
uindex_t  max_octree_depth_ 
Maximum octree depth. More...  
Additional Inherited Members  
Public Types inherited from pcl::octree::OctreeBreadthFirstIterator< OctreeT >  
using  BranchNode = typename OctreeIteratorBase< OctreeT >::BranchNode 
using  LeafNode = typename OctreeIteratorBase< OctreeT >::LeafNode 
Public Types inherited from pcl::octree::OctreeIteratorBase< OctreeT >  
using  iterator_category = std::forward_iterator_tag 
using  value_type = const OctreeNode 
using  difference_type = void 
using  pointer = const OctreeNode * 
using  reference = const OctreeNode & 
using  LeafNode = typename OctreeT::LeafNode 
using  BranchNode = typename OctreeT::BranchNode 
using  LeafContainer = typename OctreeT::LeafContainer 
using  BranchContainer = typename OctreeT::BranchContainer 
Octree iterator class
Definition at line 585 of file octree_iterator.h.
pcl::octree::OctreeFixedDepthIterator< OctreeT >::OctreeFixedDepthIterator 
Empty constructor.
Definition at line 260 of file octree_iterator.hpp.

explicit 
Constructor.
[in]  octree_arg  Octree to be iterated. Initially the iterator is set to its root node. 
[in]  fixed_depth_arg  Depth level during traversal 
Definition at line 266 of file octree_iterator.hpp.
References pcl::octree::OctreeFixedDepthIterator< OctreeT >::reset().

inline 
Constructor.
[in]  octree_arg  Octree to be iterated. Initially the iterator is set to its root node. 
[in]  fixed_depth_arg  Depth level during traversal 
[in]  current_state  A pointer to the current iterator state 
[in]  fifo  Internal container of octree node to go through 
Definition at line 611 of file octree_iterator.h.

inline 
Copy Constructor.
[in]  other  Another OctreeFixedDepthIterator to copy from 
Definition at line 624 of file octree_iterator.h.
References pcl::octree::OctreeFixedDepthIterator< OctreeT >::fixed_depth_.

inline 
Copy assignment.
[in]  src  the iterator to copy into this 
Definition at line 635 of file octree_iterator.h.
References pcl::octree::OctreeFixedDepthIterator< OctreeT >::fixed_depth_, and pcl::octree::OctreeBreadthFirstIterator< OctreeT >::operator=().

inline 
Reset the iterator to the first node at the current depth.
Definition at line 652 of file octree_iterator.h.
References pcl::octree::OctreeFixedDepthIterator< OctreeT >::fixed_depth_.
Referenced by pcl::octree::OctreeFixedDepthIterator< OctreeT >::OctreeFixedDepthIterator().
void pcl::octree::OctreeFixedDepthIterator< OctreeT >::reset  (  uindex_t  fixed_depth_arg  ) 
Reset the iterator to the first node at the depth given as parameter.
[in]  fixed_depth_arg  Depth level during traversal 
Definition at line 277 of file octree_iterator.hpp.
References pcl::octree::OctreeBreadthFirstIterator< OctreeT >::operator++(), and pcl::octree::OctreeBreadthFirstIterator< OctreeT >::reset().

protected 
Given level of the node to be iterated.
Definition at line 661 of file octree_iterator.h.
Referenced by pcl::octree::OctreeFixedDepthIterator< OctreeT >::OctreeFixedDepthIterator(), pcl::octree::OctreeFixedDepthIterator< OctreeT >::operator=(), and pcl::octree::OctreeFixedDepthIterator< OctreeT >::reset().