Point Cloud Library (PCL)  1.14.1-dev
List of all members | Public Types | Public Member Functions | Protected Attributes
pcl::octree::OctreeBreadthFirstIterator< OctreeT > Class Template Reference

Octree iterator class More...

#include <pcl/octree/octree_iterator.h>

+ Inheritance diagram for pcl::octree::OctreeBreadthFirstIterator< OctreeT >:
+ Collaboration diagram for pcl::octree::OctreeBreadthFirstIterator< OctreeT >:

Public Types

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
 

Public Member Functions

 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...
 
OctreeBreadthFirstIteratoroperator= (const OctreeBreadthFirstIterator &src)
 Copy operator. More...
 
void reset ()
 Reset the iterator to the root node of the octree. More...
 
OctreeBreadthFirstIteratoroperator++ ()
 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 OctreeKeygetCurrentOctreeKey () const
 Get octree key for the current iterator octree node. More...
 
uindex_t getCurrentOctreeDepth () const
 Get the current depth level of octree. More...
 
OctreeNodegetCurrentOctreeNode () 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 OctreeNodeoperator* () const
 *operator. More...
 
char getNodeConfiguration () const
 Get bit pattern of children configuration of current node. More...
 
const LeafContainergetLeafContainer () const
 Method for retrieving a single leaf container from the octree leaf node. More...
 
LeafContainergetLeafContainer ()
 Method for retrieving a single leaf container from the octree leaf node. More...
 
const BranchContainergetBranchContainer () const
 Method for retrieving the container from an octree branch node. More...
 
BranchContainergetBranchContainer ()
 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

std::deque< IteratorStateFIFO_
 FIFO list. More...
 
- Protected Attributes inherited from pcl::octree::OctreeIteratorBase< OctreeT >
OctreeT * octree_
 Reference to octree class. More...
 
IteratorStatecurrent_state_
 Pointer to current iterator state. More...
 
uindex_t max_octree_depth_
 Maximum octree depth. More...
 

Detailed Description

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

Octree iterator class

Note
This class implements a forward iterator for traversing octrees in a breadth-first manner.
Author
Julius Kammerl (juliu.nosp@m.s@ka.nosp@m.mmerl.nosp@m..de)

Definition at line 486 of file octree_iterator.h.

Member Typedef Documentation

◆ BranchNode

template<typename OctreeT >
using pcl::octree::OctreeBreadthFirstIterator< OctreeT >::BranchNode = typename OctreeIteratorBase<OctreeT>::BranchNode

Definition at line 489 of file octree_iterator.h.

◆ LeafNode

template<typename OctreeT >
using pcl::octree::OctreeBreadthFirstIterator< OctreeT >::LeafNode = typename OctreeIteratorBase<OctreeT>::LeafNode

Definition at line 490 of file octree_iterator.h.

Constructor & Destructor Documentation

◆ OctreeBreadthFirstIterator() [1/4]

template<typename OctreeT >
pcl::octree::OctreeBreadthFirstIterator< OctreeT >::OctreeBreadthFirstIterator ( uindex_t  max_depth_arg = 0)
explicit

Empty constructor.

Parameters
[in]max_depth_argDepth limitation during traversal

Definition at line 166 of file octree_iterator.hpp.

References pcl::octree::OctreeIteratorBase< OctreeT >::reset(), and pcl::octree::OctreeBreadthFirstIterator< OctreeT >::reset().

◆ OctreeBreadthFirstIterator() [2/4]

template<typename OctreeT >
pcl::octree::OctreeBreadthFirstIterator< OctreeT >::OctreeBreadthFirstIterator ( OctreeT *  octree_arg,
uindex_t  max_depth_arg = 0 
)
explicit

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 177 of file octree_iterator.hpp.

References pcl::octree::OctreeIteratorBase< OctreeT >::reset(), and pcl::octree::OctreeBreadthFirstIterator< OctreeT >::reset().

◆ OctreeBreadthFirstIterator() [3/4]

template<typename OctreeT >
pcl::octree::OctreeBreadthFirstIterator< OctreeT >::OctreeBreadthFirstIterator ( OctreeT *  octree_arg,
uindex_t  max_depth_arg,
IteratorState current_state,
const std::deque< IteratorState > &  fifo = std::deque<IteratorState>() 
)
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
[in]current_stateA pointer to the current iterator state
Warning
For advanced users only.

Definition at line 512 of file octree_iterator.h.

◆ OctreeBreadthFirstIterator() [4/4]

template<typename OctreeT >
pcl::octree::OctreeBreadthFirstIterator< OctreeT >::OctreeBreadthFirstIterator ( const OctreeBreadthFirstIterator< OctreeT > &  other)
inline

Copy Constructor.

Parameters
[in]otherAnother OctreeBreadthFirstIterator to copy from

Definition at line 523 of file octree_iterator.h.

References pcl::octree::OctreeIteratorBase< OctreeT >::current_state_, and pcl::octree::OctreeBreadthFirstIterator< OctreeT >::FIFO_.

Member Function Documentation

◆ operator++() [1/2]

template<typename OctreeT >
OctreeBreadthFirstIterator< OctreeT > & pcl::octree::OctreeBreadthFirstIterator< OctreeT >::operator++
virtual

◆ operator++() [2/2]

template<typename OctreeT >
OctreeBreadthFirstIterator pcl::octree::OctreeBreadthFirstIterator< OctreeT >::operator++ ( int  )
inline

postincrement operator.

Note
step to next octree node

Definition at line 565 of file octree_iterator.h.

◆ operator=()

template<typename OctreeT >
OctreeBreadthFirstIterator& pcl::octree::OctreeBreadthFirstIterator< OctreeT >::operator= ( const OctreeBreadthFirstIterator< OctreeT > &  src)
inline

◆ reset()

template<typename OctreeT >
void pcl::octree::OctreeBreadthFirstIterator< OctreeT >::reset

Member Data Documentation

◆ FIFO_

template<typename OctreeT >
std::deque<IteratorState> pcl::octree::OctreeBreadthFirstIterator< OctreeT >::FIFO_
protected

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