pcl::octree::OctreeLeafNodeIterator< OctreeT > Class Template Reference
[Module octree]

Octree leaf node iterator class. More...

#include <pcl/octree/octree_iterator.h>

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

[legend]

Collaboration diagram for pcl::octree::OctreeLeafNodeIterator< OctreeT >:

[legend]

List of all members.

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.

---

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 (julius@kammerl.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

)

[inline, explicit]

Empty constructor.

Parameters:

[in]

max_depth_arg

Depth 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
	)			[inline, explicit]

Constructor.

Parameters:

[in]	octree_arg	Octree to be iterated. Initially the iterator is set to its root node.
[in]	max_depth_arg	Depth 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

(

)

[inline, virtual]

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]

*operator.

Returns:

pointer to the current octree leaf node

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

Definition at line 607 of file octree_iterator.h.

References pcl::octree::OctreeIteratorBase< OctreeT >::current_state_, pcl::octree::OctreeNode::getNodeType(), pcl::octree::LEAF_NODE, and pcl::octree::IteratorState::node_.

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 >

OctreeLeafNodeIterator& pcl::octree::OctreeLeafNodeIterator< OctreeT >::operator++

(

)

[inline]

Preincrement operator.

Note:

recursively step to next octree leaf node

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

Definition at line 582 of file octree_iterator.h.

References pcl::octree::OctreeIteratorBase< OctreeT >::current_state_, pcl::octree::OctreeNode::getNodeType(), pcl::octree::LEAF_NODE, and pcl::octree::IteratorState::node_.

Referenced by pcl::octree::OctreeLeafNodeIterator< OctreeT >::reset().

template<typename OctreeT >

void pcl::octree::OctreeLeafNodeIterator< OctreeT >::reset

(

)

[inline, virtual]

Reset the iterator to the root node of the octree.

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

Definition at line 572 of file octree_iterator.h.

References pcl::octree::OctreeLeafNodeIterator< OctreeT >::operator++().

Referenced by pcl::octree::OctreeLeafNodeIterator< OctreeT >::OctreeLeafNodeIterator().

---

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

• /builddir/build/BUILD/pcl-pcl-1.7.1/octree/include/pcl/octree/octree_iterator.h