octomap::OcTreeBase< NODE >::iterator_base Class Reference

Base class for OcTree iterators. More...

Inheritance diagram for octomap::OcTreeBase< NODE >::iterator_base:

Collaboration diagram for octomap::OcTreeBase< NODE >::iterator_base:

Data Structures
struct	StackElement
	Element on the internal recursion stack of the iterator. More...
Public Member Functions
point3d	getCoordinate () const
	return the center coordinate of the current node
unsigned	getDepth () const
	return depth of the current node
OcTreeKey	getIndexKey () const
const OcTreeKey &	getKey () const
double	getSize () const
double	getX () const
double	getY () const
double	getZ () const
	iterator_base ()
	Default ctor, only used for the end-iterator.
	iterator_base (OcTreeBase< NodeType > const *tree, unsigned char depth=0)
	Constructor of the iterator.
	iterator_base (const iterator_base &other)
	Copy constructor of the iterator.
bool	operator!= (const iterator_base &other) const
	Comparison between interators. First compares the tree, then stack size and top element of stack.
const NodeType &	operator* () const
	Return the current node in the octree which the iterator is referring to.
NodeType &	operator* ()
	Return the current node in the octree which the iterator is referring to.
NodeType const *	operator-> () const
	Ptr operator will return the current node in the octree which the iterator is referring to.
NodeType *	operator-> ()
	Ptr operator will return the current node in the octree which the iterator is referring to.
iterator_base &	operator= (const iterator_base &other)
bool	operator== (const iterator_base &other) const
	Comparison between interators. First compares the tree, then stack size and top element of stack.
Protected Member Functions
void	singleIncrement ()
	One step of depth-first tree traversal.
Protected Attributes
unsigned char	maxDepth
	Maximum depth for depth-limited queries.
std::stack< StackElement, std::vector< StackElement > >	stack
	Internal recursion stack. Apparently a stack of vector works fastest here.
OcTreeBase< NodeType > const *	tree
	Octree this iterator is working on.

---

Detailed Description

template<class NODE>
class octomap::OcTreeBase< NODE >::iterator_base

Base class for OcTree iterators.

So far, all iterator's are const with respect to the tree

---

Constructor & Destructor Documentation

template<class NODE>

octomap::OcTreeBase< NODE >::iterator_base::iterator_base

(

)

[inline]

Default ctor, only used for the end-iterator.

template<class NODE>

octomap::OcTreeBase< NODE >::iterator_base::iterator_base	(	OcTreeBase< NodeType > const *	tree,
		unsigned char	depth = 0
	)		[inline]

Constructor of the iterator.

Parameters:

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

References octomap::OcTreeBase< NODE >::iterator_base::StackElement::depth, octomap::OcTreeBase< NODE >::getTreeDepth(), octomap::OcTreeBase< NODE >::itsRoot, octomap::OcTreeBase< NODE >::iterator_base::StackElement::key, octomap::OcTreeBase< NODE >::iterator_base::maxDepth, octomap::OcTreeBase< NODE >::iterator_base::StackElement::node, octomap::OcTreeBase< NODE >::iterator_base::stack, and octomap::OcTreeBase< NODE >::tree_max_val.

template<class NODE>

octomap::OcTreeBase< NODE >::iterator_base::iterator_base

(

const iterator_base &

other

)

[inline]

Copy constructor of the iterator.

---

Member Function Documentation

template<class NODE>

point3d octomap::OcTreeBase< NODE >::iterator_base::getCoordinate

(

)

const [inline]

return the center coordinate of the current node

References octomap::OcTreeBase< NODE >::genCoords(), octomap::OcTreeBase< NODE >::iterator_base::stack, and octomap::OcTreeBase< NODE >::iterator_base::tree.

template<class NODE>

unsigned octomap::OcTreeBase< NODE >::iterator_base::getDepth

(

)

const [inline]

return depth of the current node

References octomap::OcTreeBase< NODE >::iterator_base::stack.

template<class NODE>

OcTreeKey octomap::OcTreeBase< NODE >::iterator_base::getIndexKey

(

)

const [inline]

Returns:

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

References octomap::OcTreeBase< NODE >::iterator_base::stack.

template<class NODE>

const OcTreeKey& octomap::OcTreeBase< NODE >::iterator_base::getKey

(

)

const [inline]

Returns:

the OcTreeKey of the current node

References octomap::OcTreeBase< NODE >::iterator_base::stack.

template<class NODE>

double octomap::OcTreeBase< NODE >::iterator_base::getSize

(

)

const [inline]

Returns:

the side if the volume occupied by the current node

References octomap::OcTreeBase< NODE >::getNodeSize(), octomap::OcTreeBase< NODE >::iterator_base::stack, and octomap::OcTreeBase< NODE >::iterator_base::tree.

template<class NODE>

double octomap::OcTreeBase< NODE >::iterator_base::getX

(

)

const [inline]

Returns:

single coordinate of the current node

References octomap::OcTreeBase< NODE >::genCoordFromKey(), octomap::OcTreeBase< NODE >::iterator_base::stack, and octomap::OcTreeBase< NODE >::iterator_base::tree.

template<class NODE>

double octomap::OcTreeBase< NODE >::iterator_base::getY

(

)

const [inline]

Returns:

single coordinate of the current node

References octomap::OcTreeBase< NODE >::genCoordFromKey(), octomap::OcTreeBase< NODE >::iterator_base::stack, and octomap::OcTreeBase< NODE >::iterator_base::tree.

template<class NODE>

double octomap::OcTreeBase< NODE >::iterator_base::getZ

(

)

const [inline]

Returns:

single coordinate of the current node

References octomap::OcTreeBase< NODE >::genCoordFromKey(), octomap::OcTreeBase< NODE >::iterator_base::stack, and octomap::OcTreeBase< NODE >::iterator_base::tree.

template<class NODE>

bool octomap::OcTreeBase< NODE >::iterator_base::operator!=

(

const iterator_base &

other

)

const [inline]

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

References octomap::OcTreeBase< NODE >::iterator_base::stack, and octomap::OcTreeBase< NODE >::iterator_base::tree.

template<class NODE>

const NodeType& octomap::OcTreeBase< NODE >::iterator_base::operator*

(

)

const [inline]

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

References octomap::OcTreeBase< NODE >::iterator_base::stack.

template<class NODE>

NodeType& octomap::OcTreeBase< NODE >::iterator_base::operator*

(

)

[inline]

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

References octomap::OcTreeBase< NODE >::iterator_base::stack.

template<class NODE>

NodeType const* octomap::OcTreeBase< NODE >::iterator_base::operator->

(

)

const [inline]

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

References octomap::OcTreeBase< NODE >::iterator_base::stack.

template<class NODE>

NodeType* octomap::OcTreeBase< NODE >::iterator_base::operator->

(

)

[inline]

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

References octomap::OcTreeBase< NODE >::iterator_base::stack.

template<class NODE>

iterator_base& octomap::OcTreeBase< NODE >::iterator_base::operator=

(

const iterator_base &

other

)

[inline]

References octomap::OcTreeBase< NODE >::iterator_base::maxDepth, octomap::OcTreeBase< NODE >::iterator_base::stack, and octomap::OcTreeBase< NODE >::iterator_base::tree.

template<class NODE>

bool octomap::OcTreeBase< NODE >::iterator_base::operator==

(

const iterator_base &

other

)

const [inline]

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

References octomap::OcTreeBase< NODE >::iterator_base::stack, and octomap::OcTreeBase< NODE >::iterator_base::tree.

template<class NODE>

void octomap::OcTreeBase< NODE >::iterator_base::singleIncrement

(

)

[inline, protected]

One step of depth-first tree traversal.

How this is used depends on the actual iterator.

Reimplemented in octomap::OcTreeBase< NODE >::leaf_bbx_iterator.

References octomap::computeChildKey(), octomap::OcTreeBase< NODE >::iterator_base::StackElement::depth, octomap::OcTreeBase< NODE >::iterator_base::StackElement::key, octomap::OcTreeBase< NODE >::iterator_base::maxDepth, octomap::OcTreeBase< NODE >::iterator_base::StackElement::node, octomap::OcTreeBase< NODE >::iterator_base::stack, octomap::OcTreeBase< NODE >::iterator_base::tree, and octomap::OcTreeBase< NODE >::tree_max_val.

Referenced by octomap::OcTreeBase< NODE >::leaf_iterator::operator++(), and octomap::OcTreeBase< NODE >::tree_iterator::operator++().

---

Field Documentation

template<class NODE>

unsigned char octomap::OcTreeBase< NODE >::iterator_base::maxDepth [protected]

Maximum depth for depth-limited queries.

Referenced by octomap::OcTreeBase< NODE >::tree_iterator::isLeaf(), octomap::OcTreeBase< NODE >::iterator_base::iterator_base(), octomap::OcTreeBase< NODE >::leaf_bbx_iterator::leaf_bbx_iterator(), octomap::OcTreeBase< NODE >::leaf_bbx_iterator::operator++(), octomap::OcTreeBase< NODE >::leaf_iterator::operator++(), octomap::OcTreeBase< NODE >::iterator_base::operator=(), and octomap::OcTreeBase< NODE >::iterator_base::singleIncrement().

template<class NODE>

std::stack<StackElement,std::vector<StackElement> > octomap::OcTreeBase< NODE >::iterator_base::stack [protected]

Internal recursion stack. Apparently a stack of vector works fastest here.

Referenced by octomap::OcTreeBase< NODE >::iterator_base::getCoordinate(), octomap::OcTreeBase< NODE >::iterator_base::getDepth(), octomap::OcTreeBase< NODE >::iterator_base::getIndexKey(), octomap::OcTreeBase< NODE >::iterator_base::getKey(), octomap::OcTreeBase< NODE >::iterator_base::getSize(), octomap::OcTreeBase< NODE >::iterator_base::getX(), octomap::OcTreeBase< NODE >::iterator_base::getY(), octomap::OcTreeBase< NODE >::iterator_base::getZ(), octomap::OcTreeBase< NODE >::tree_iterator::isLeaf(), octomap::OcTreeBase< NODE >::iterator_base::iterator_base(), octomap::OcTreeBase< NODE >::leaf_bbx_iterator::leaf_bbx_iterator(), octomap::OcTreeBase< NODE >::leaf_iterator::leaf_iterator(), octomap::OcTreeBase< NODE >::iterator_base::operator!=(), octomap::OcTreeBase< NODE >::iterator_base::operator*(), octomap::OcTreeBase< NODE >::leaf_bbx_iterator::operator++(), octomap::OcTreeBase< NODE >::leaf_iterator::operator++(), octomap::OcTreeBase< NODE >::tree_iterator::operator++(), octomap::OcTreeBase< NODE >::iterator_base::operator->(), octomap::OcTreeBase< NODE >::iterator_base::operator=(), octomap::OcTreeBase< NODE >::iterator_base::operator==(), octomap::OcTreeBase< NODE >::leaf_bbx_iterator::singleIncrement(), and octomap::OcTreeBase< NODE >::iterator_base::singleIncrement().

template<class NODE>

OcTreeBase<NodeType> const* octomap::OcTreeBase< NODE >::iterator_base::tree [protected]

Octree this iterator is working on.

Referenced by octomap::OcTreeBase< NODE >::iterator_base::getCoordinate(), octomap::OcTreeBase< NODE >::iterator_base::getSize(), octomap::OcTreeBase< NODE >::iterator_base::getX(), octomap::OcTreeBase< NODE >::iterator_base::getY(), octomap::OcTreeBase< NODE >::iterator_base::getZ(), octomap::OcTreeBase< NODE >::iterator_base::operator!=(), octomap::OcTreeBase< NODE >::leaf_bbx_iterator::operator++(), octomap::OcTreeBase< NODE >::leaf_iterator::operator++(), octomap::OcTreeBase< NODE >::tree_iterator::operator++(), octomap::OcTreeBase< NODE >::iterator_base::operator=(), octomap::OcTreeBase< NODE >::iterator_base::operator==(), octomap::OcTreeBase< NODE >::leaf_bbx_iterator::singleIncrement(), and octomap::OcTreeBase< NODE >::iterator_base::singleIncrement().

---

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

• include/octomap/OcTreeBase.h