Classes | Public Member Functions | Public Attributes | List of all members
octomap::OcTreeKey Class Reference

#include <OcTreeKey.h>

Classes

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
 
OcTreeKeyoperator= (const OcTreeKey &other)
 
bool operator== (const OcTreeKey &other) const
 
const unsigned short int & operator[] (unsigned int i) const
 
unsigned short int & operator[] (unsigned int i)
 

Public Attributes

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.

Definition at line 68 of file OcTreeKey.h.

Constructor & Destructor Documentation

octomap::OcTreeKey::OcTreeKey ( )
inline

Definition at line 71 of file OcTreeKey.h.

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

Definition at line 72 of file OcTreeKey.h.

octomap::OcTreeKey::OcTreeKey ( const OcTreeKey other)
inline

Definition at line 74 of file OcTreeKey.h.

Member Function Documentation

bool octomap::OcTreeKey::operator!= ( const OcTreeKey other) const
inline

Definition at line 80 of file OcTreeKey.h.

OcTreeKey& octomap::OcTreeKey::operator= ( const OcTreeKey other)
inline

Definition at line 83 of file OcTreeKey.h.

bool octomap::OcTreeKey::operator== ( const OcTreeKey other) const
inline

Definition at line 77 of file OcTreeKey.h.

const unsigned short int& octomap::OcTreeKey::operator[] ( unsigned int  i) const
inline

Definition at line 87 of file OcTreeKey.h.

unsigned short int& octomap::OcTreeKey::operator[] ( unsigned int  i)
inline

Definition at line 90 of file OcTreeKey.h.

Member Data Documentation

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

Definition at line 94 of file OcTreeKey.h.


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


octomap
Author(s): Kai M. Wurm , Armin Hornung
autogenerated on Mon Jun 10 2019 14:00:13