Iterator over the complete tree (inner nodes and leafs). More...

Inheritance diagram for tree_iterator:

Collaboration diagram for tree_iterator:

Public Member Functions
point3d	getCoordinate () const
	return the center coordinate of the current node More...

unsigned	getDepth () const
	return depth of the current node More...

OcTreeKey	getIndexKey () const

const OcTreeKey &	getKey () const

double	getSize () const

double	getX () const

double	getY () const

double	getZ () const

bool	isLeaf () const

bool	operator!= (const iterator_base &other) const
	Comparison between iterators. First compares the tree, then stack size and top element of stack. More...

NodeType &	operator* ()
	Return the current node in the octree which the iterator is referring to. More...

const NodeType &	operator* () const
	Return the current node in the octree which the iterator is referring to. More...

tree_iterator &	operator++ ()
	Prefix increment operator to advance the iterator. More...

tree_iterator	operator++ (int)
	postfix increment operator of iterator (it++) More...

NodeType *	operator-> ()
	Ptr operator will return the current node in the octree which the iterator is referring to. More...

NodeType const *	operator-> () const
	Ptr operator will return the current node in the octree which the iterator is referring to. More...

bool	operator== (const iterator_base &other) const
	Comparison between iterators. First compares the tree, then stack size and top element of stack. More...

	tree_iterator ()

	tree_iterator (OcTreeBaseImpl< NodeType, INTERFACE > const *ptree, uint8_t depth=0)
	Constructor of the iterator. More...

Protected Member Functions
void	singleIncrement ()
	One step of depth-first tree traversal. How this is used depends on the actual iterator. More...

Protected Attributes
uint8_t	maxDepth
	Maximum depth for depth-limited queries. More...

std::stack< StackElement, std::vector< StackElement > >	stack
	Internal recursion stack. Apparently a stack of vector works fastest here. More...

OcTreeBaseImpl< NodeType, INTERFACE > const *	tree
	Octree this iterator is working on. More...

Detailed Description

Iterator over the complete tree (inner nodes and leafs).

See below for example usage. Note that the non-trivial call to tree->end_tree() should be done only once for efficiency!

for(OcTreeTYPE::tree_iterator it = tree->begin_tree(),
       end=tree->end_tree(); it!= end; ++it)
{
  //manipulate node, e.g.:
  std::cout << "Node center: " << it.getCoordinate() << std::endl;
  std::cout << "Node size: " << it.getSize() << std::endl;
  std::cout << "Node value: " << it->getValue() << std::endl;
}

Constructor & Destructor Documentation

◆ tree_iterator() [1/2]

tree_iterator::tree_iterator ( )

inline

◆ tree_iterator() [2/2]

tree_iterator::tree_iterator	(	OcTreeBaseImpl< NodeType, INTERFACE > const *	ptree,
		uint8_t	depth = `0`
	)

inline

Constructor of the iterator.

Parameters

ptree	OcTreeBaseImpl on which the iterator is used on
depth	Maximum depth to traverse the tree. 0 (default): unlimited

Member Function Documentation

◆ getCoordinate()

point3d iterator_base::getCoordinate ( ) const

inlineinherited

return the center coordinate of the current node

References iterator_base::stack, and iterator_base::tree.

◆ getDepth()

unsigned iterator_base::getDepth ( ) const

inlineinherited

return depth of the current node

References iterator_base::stack.

◆ getIndexKey()

OcTreeKey iterator_base::getIndexKey ( ) const

inlineinherited

Returns: the OcTreeKey of the current node, for nodes with depth != maxDepth

References octomap::computeIndexKey(), iterator_base::stack, and iterator_base::tree.

◆ getKey()

const OcTreeKey& iterator_base::getKey ( ) const

inlineinherited

Returns: the OcTreeKey of the current node

References iterator_base::stack.

◆ getSize()

double iterator_base::getSize ( ) const

inlineinherited

Returns: the side of the volume occupied by the current node

References iterator_base::stack, and iterator_base::tree.

◆ getX()

double iterator_base::getX ( ) const

inlineinherited

Returns: single coordinate of the current node

References iterator_base::stack, and iterator_base::tree.

◆ getY()

double iterator_base::getY ( ) const

inlineinherited

Returns: single coordinate of the current node

References iterator_base::stack, and iterator_base::tree.

◆ getZ()

double iterator_base::getZ ( ) const

inlineinherited

Returns: single coordinate of the current node

References iterator_base::stack, and iterator_base::tree.

◆ isLeaf()

bool tree_iterator::isLeaf ( ) const

inline

Returns: whether the current node is a leaf, i.e. has no children or is at max level

References iterator_base::tree.

◆ operator!=()

bool iterator_base::operator!= ( const iterator_base & other ) const

inlineinherited

Comparison between iterators. First compares the tree, then stack size and top element of stack.

References iterator_base::stack, and iterator_base::tree.

◆ operator*() [1/2]

NodeType& iterator_base::operator* ( )

inlineinherited

Return the current node in the octree which the iterator is referring to.

References iterator_base::stack.

◆ operator*() [2/2]

const NodeType& iterator_base::operator* ( ) const

inlineinherited

Return the current node in the octree which the iterator is referring to.

References iterator_base::stack.

◆ operator++() [1/2]

tree_iterator& tree_iterator::operator++ ( )

inline

Prefix increment operator to advance the iterator.

References iterator_base::singleIncrement(), iterator_base::stack, and iterator_base::tree.

◆ operator++() [2/2]

tree_iterator tree_iterator::operator++ ( int )

inline

postfix increment operator of iterator (it++)

◆ operator->() [1/2]

NodeType* iterator_base::operator-> ( )

inlineinherited

Ptr operator will return the current node in the octree which the iterator is referring to.

References iterator_base::stack.

◆ operator->() [2/2]

NodeType const* iterator_base::operator-> ( ) const

inlineinherited

Ptr operator will return the current node in the octree which the iterator is referring to.

References iterator_base::stack.

◆ operator==()

bool iterator_base::operator== ( const iterator_base & other ) const

inlineinherited

Comparison between iterators. First compares the tree, then stack size and top element of stack.

References iterator_base::stack, and iterator_base::tree.

◆ singleIncrement()

void iterator_base::singleIncrement ( )

inlineprotectedinherited

One step of depth-first tree traversal. How this is used depends on the actual iterator.

References octomap::computeChildKey(), iterator_base::StackElement::depth, iterator_base::StackElement::key, iterator_base::maxDepth, iterator_base::StackElement::node, iterator_base::stack, and iterator_base::tree.

Referenced by operator++(), and leaf_iterator::operator++().

Field Documentation

◆ maxDepth

uint8_t iterator_base::maxDepth

protectedinherited

Maximum depth for depth-limited queries.

Referenced by iterator_base::iterator_base(), leaf_bbx_iterator::leaf_bbx_iterator(), iterator_base::operator=(), and iterator_base::singleIncrement().

◆ stack

std::stack<StackElement,std::vector<StackElement> > iterator_base::stack

protectedinherited

◆ tree

OcTreeBaseImpl<NodeType,INTERFACE> const* iterator_base::tree

protectedinherited

Octree this iterator is working on.

Referenced by iterator_base::getCoordinate(), iterator_base::getIndexKey(), iterator_base::getSize(), iterator_base::getX(), iterator_base::getY(), iterator_base::getZ(), isLeaf(), iterator_base::iterator_base(), leaf_bbx_iterator::leaf_bbx_iterator(), iterator_base::operator!=(), operator++(), leaf_iterator::operator++(), leaf_bbx_iterator::operator++(), iterator_base::operator=(), iterator_base::operator==(), iterator_base::singleIncrement(), and leaf_bbx_iterator::singleIncrement().

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

include/octomap/OcTreeIterator.hxx

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ tree_iterator() [1/2]

◆ tree_iterator() [2/2]

Member Function Documentation

◆ getCoordinate()

◆ getDepth()

◆ getIndexKey()

◆ getKey()

◆ getSize()

◆ getX()

◆ getY()

◆ getZ()

◆ isLeaf()

◆ operator!=()

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator->() [1/2]

◆ operator->() [2/2]

◆ operator==()

◆ singleIncrement()

Field Documentation

◆ maxDepth

◆ stack

◆ tree