octomap  1.9.7
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 (const OcTreeKey &other)
 
 OcTreeKey (key_type a, key_type b, key_type c)
 
bool operator!= (const OcTreeKey &other) const
 
OcTreeKeyoperator= (const OcTreeKey &other)
 
bool operator== (const OcTreeKey &other) const
 
key_typeoperator[] (unsigned int i)
 
const key_typeoperator[] (unsigned int i) const
 

Data Fields

key_type 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

◆ OcTreeKey() [1/3]

octomap::OcTreeKey::OcTreeKey ( )
inline

◆ OcTreeKey() [2/3]

octomap::OcTreeKey::OcTreeKey ( key_type  a,
key_type  b,
key_type  c 
)
inline

References k.

◆ OcTreeKey() [3/3]

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

References k.

Member Function Documentation

◆ operator!=()

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

References k.

◆ operator=()

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

References k.

◆ operator==()

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

References k.

◆ operator[]() [1/2]

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

References k.

◆ operator[]() [2/2]

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

References k.

Field Documentation

◆ k


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