octomap::OcTreeKey Class Reference

OcTreeKey is a container class for internal key addressing. More...

Data Structures
struct	KeyHash
	Provides a hash function on Keys. More...
Public Member Functions
	OcTreeKey ()
	OcTreeKey (unsigned short int a, unsigned short int b, unsigned short int c)
	OcTreeKey (const OcTreeKey &other)
bool	operator!= (const OcTreeKey &other) const
OcTreeKey &	operator= (const OcTreeKey &other)
bool	operator== (const OcTreeKey &other) const
unsigned short int &	operator[] (unsigned int i)
const unsigned short int &	operator[] (unsigned int i) const
Data Fields
unsigned short int	k [3]

---

Detailed Description

OcTreeKey is a container class for internal key addressing.

The keys count the number of cells (voxels) from the origin as discrete address of a voxel.

See also:

OcTreeBaseImpl::coordToKey() and OcTreeBaseImpl::keyToCoord() for conversions.

---

Constructor & Destructor Documentation

octomap::OcTreeKey::OcTreeKey

(

)

[inline]

octomap::OcTreeKey::OcTreeKey	(	unsigned short int	a,
		unsigned short int	b,
		unsigned short int	c
	)		[inline]

References k.

octomap::OcTreeKey::OcTreeKey

(

const OcTreeKey &

other

)

[inline]

References k.

---

Member Function Documentation

bool octomap::OcTreeKey::operator!=

(

const OcTreeKey &

other

)

const [inline]

References k.

OcTreeKey& octomap::OcTreeKey::operator=

(

const OcTreeKey &

other

)

[inline]

References k.

bool octomap::OcTreeKey::operator==

(

const OcTreeKey &

other

)

const [inline]

References k.

unsigned short int& octomap::OcTreeKey::operator[]

(

unsigned int

i

)

[inline]

References k.

const unsigned short int& octomap::OcTreeKey::operator[]

(

unsigned int

i

)

const [inline]

References k.

---

Field Documentation

unsigned short int octomap::OcTreeKey::k[3]

Referenced by octomap::OcTreeLUT::changeKey(), octomap::computeChildIdx(), octomap::OcTreeLUT::genNeighborKey(), octomap::OcTreeLUT::genPos(), main(), OcTreeKey(), operator!=(), octomap::OcTreeKey::KeyHash::operator()(), operator=(), operator==(), and operator[]().

---

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

• include/octomap/OcTreeKey.h