octomap::ColorOcTreeNode Class Reference

#include <ColorOcTree.h>

Inheritance diagram for octomap::ColorOcTreeNode:

List of all members.

Classes
class	Color
Public Member Functions
	ColorOcTreeNode ()
	ColorOcTreeNode (const ColorOcTreeNode &rhs)
bool	createChild (unsigned int i)
	initialize i-th child, allocate children array if needed
void	expandNode ()
ColorOcTreeNode::Color	getAverageChildColor () const
ColorOcTreeNode *	getChild (unsigned int i)
const ColorOcTreeNode *	getChild (unsigned int i) const
Color	getColor () const
Color &	getColor ()
bool	isColorSet () const
bool	operator== (const ColorOcTreeNode &rhs) const
bool	pruneNode ()
std::istream &	readValue (std::istream &s)
void	setColor (Color c)
void	setColor (unsigned char r, unsigned char g, unsigned char b)
void	updateColorChildren ()
std::ostream &	writeValue (std::ostream &s) const
Protected Attributes
Color	color

---

Detailed Description

Definition at line 45 of file ColorOcTree.h.

---

Constructor & Destructor Documentation

octomap::ColorOcTreeNode::ColorOcTreeNode

(

)

[inline]

Definition at line 63 of file ColorOcTree.h.

octomap::ColorOcTreeNode::ColorOcTreeNode

(

const ColorOcTreeNode &

rhs

)

[inline]

Definition at line 65 of file ColorOcTree.h.

---

Member Function Documentation

bool octomap::ColorOcTreeNode::createChild

(

unsigned int

i

)

[inline]

initialize i-th child, allocate children array if needed

Reimplemented from octomap::OcTreeNode.

Definition at line 79 of file ColorOcTree.h.

void octomap::ColorOcTreeNode::expandNode

(

)

Expands a node (reverse of pruning): All children are created and their occupancy probability is set to the node's value.

You need to verify that this is indeed a pruned node (i.e. not a leaf at the lowest level)

Reimplemented from octomap::OcTreeDataNode< float >.

Definition at line 123 of file ColorOcTree.cpp.

ColorOcTreeNode::Color octomap::ColorOcTreeNode::getAverageChildColor

(

)

const

Definition at line 78 of file ColorOcTree.cpp.

ColorOcTreeNode* octomap::ColorOcTreeNode::getChild

(

unsigned int

i

)

[inline]

Returns:

a pointer to the i-th child of the node. The child needs to exist.

Reimplemented from octomap::OcTreeNode.

Definition at line 72 of file ColorOcTree.h.

const ColorOcTreeNode* octomap::ColorOcTreeNode::getChild

(

unsigned int

i

)

const [inline]

Returns:

a const pointer to the i-th child of the node. The child needs to exist.

Reimplemented from octomap::OcTreeNode.

Definition at line 75 of file ColorOcTree.h.

Color octomap::ColorOcTreeNode::getColor

(

)

const [inline]

Definition at line 88 of file ColorOcTree.h.

Color& octomap::ColorOcTreeNode::getColor

(

)

[inline]

Definition at line 94 of file ColorOcTree.h.

bool octomap::ColorOcTreeNode::isColorSet

(

)

const [inline]

Definition at line 97 of file ColorOcTree.h.

bool octomap::ColorOcTreeNode::operator==

(

const ColorOcTreeNode &

rhs

)

const [inline]

Definition at line 67 of file ColorOcTree.h.

bool octomap::ColorOcTreeNode::pruneNode

(

)

Prunes a node when it is collapsible

Returns:

true if pruning was successful

Reimplemented from octomap::OcTreeDataNode< float >.

Definition at line 107 of file ColorOcTree.cpp.

std::istream & octomap::ColorOcTreeNode::readValue

(

std::istream &

s

)

Read node from binary stream (incl. float value), recursively continue with all children.

Parameters:

s

Returns:

Reimplemented from octomap::OcTreeDataNode< float >.

Definition at line 60 of file ColorOcTree.cpp.

void octomap::ColorOcTreeNode::setColor

(

Color

c

)

[inline]

Definition at line 89 of file ColorOcTree.h.

void octomap::ColorOcTreeNode::setColor	(	unsigned char	r,
		unsigned char	g,
		unsigned char	b
	)		[inline]

Definition at line 90 of file ColorOcTree.h.

void octomap::ColorOcTreeNode::updateColorChildren

(

)

Definition at line 101 of file ColorOcTree.cpp.

std::ostream & octomap::ColorOcTreeNode::writeValue

(

std::ostream &

s

)

const

Write node to binary stream (incl float value), recursively continue with all children. This preserves the complete state of the node.

Parameters:

s

Returns:

Reimplemented from octomap::OcTreeDataNode< float >.

Definition at line 40 of file ColorOcTree.cpp.

---

Member Data Documentation

Color octomap::ColorOcTreeNode::color [protected]

Definition at line 111 of file ColorOcTree.h.

---

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

• ColorOcTree.h
• ColorOcTree.cpp