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

Octree leaf node iterator class More...

#include <pcl/octree/octree_iterator.h>

Inheritance diagram for pcl::octree::OctreeLeafNodeIterator:
Inheritance graph
[legend]
Collaboration diagram for pcl::octree::OctreeLeafNodeIterator:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 OctreeLeafNodeIterator (const OctreeT &octree_arg)
 Constructor.
virtual ~OctreeLeafNodeIterator ()
 Empty deconstructor.
OctreeLeafNodeIteratoroperator++ ()
 preincrement operator.
OctreeLeafNodeIterator operator++ (int)
 postincrement operator.
const LeafT * operator* () const
 *operator.
virtual void getData (const DataT *&data_arg) const
 Method for retrieving a single DataT element from the octree leaf node.
virtual void getData (std::vector< DataT > &dataVector_arg) const
 Method for retrieving a vector of DataT elements from the octree laef node.
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
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.

Detailed Description

Octree leaf node iterator class

Note:
This class implements a forward iterator for traversing the leaf node an octree data structure.
Author:
Julius Kammerl (julius@kammerl.de)

Constructor & Destructor Documentation

pcl::octree::OctreeLeafNodeIterator::OctreeLeafNodeIterator ( const OctreeT &  octree_arg) [inline, explicit]

Constructor.

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

Definition at line 205 of file octree_iterator.h.

virtual pcl::octree::OctreeLeafNodeIterator::~OctreeLeafNodeIterator ( ) [inline, virtual]

Empty deconstructor.

Definition at line 212 of file octree_iterator.h.


Member Function Documentation

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

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, inherited]

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, inherited]

get current octree node

Returns:
pointer to current octree node

Definition at line 110 of file octree_iterator.h.

virtual void pcl::octree::OctreeLeafNodeIterator::getData ( const DataT *&  data_arg) const [inline, virtual]

Method for retrieving a single DataT element from the octree leaf node.

Parameters:
data_arg,:reference to return pointer of leaf node DataT element.

Definition at line 260 of file octree_iterator.h.

virtual void pcl::octree::OctreeLeafNodeIterator::getData ( std::vector< DataT > &  dataVector_arg) const [inline, virtual]

Method for retrieving a vector of DataT elements from the octree laef node.

Parameters:
dataVector_arg,:reference to DataT vector that is extended with leaf node DataT elements.

Definition at line 276 of file octree_iterator.h.

bool pcl::octree::OctreeNodeIterator::operator!= ( const OctreeNodeIterator< DataT, LeafT, OctreeT > &  right_arg) const [inline, inherited]

inequality operator.

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

Definition at line 139 of file octree_iterator.h.

const LeafT* pcl::octree::OctreeLeafNodeIterator::operator* ( ) const [inline]

*operator.

Returns:
const pointer to the current octree leaf node

Reimplemented from pcl::octree::OctreeNodeIterator< DataT, LeafT, OctreeT >.

Definition at line 245 of file octree_iterator.h.

OctreeLeafNodeIterator& pcl::octree::OctreeLeafNodeIterator::operator++ ( ) [inline]

preincrement operator.

Note:
recursively step to next octree leaf node

Reimplemented from pcl::octree::OctreeNodeIterator< DataT, LeafT, OctreeT >.

Definition at line 220 of file octree_iterator.h.

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

postincrement operator.

Note:
recursively step to next octree leaf node

Reimplemented from pcl::octree::OctreeNodeIterator< DataT, LeafT, OctreeT >.

Definition at line 234 of file octree_iterator.h.

bool pcl::octree::OctreeNodeIterator::operator== ( const OctreeNodeIterator< DataT, LeafT, OctreeT > &  right_arg) const [inline, inherited]

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, inherited]

reset the iterator to the root node of the octree

void pcl::octree::OctreeNodeIterator::skipChildVoxels ( ) [inherited]

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


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