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

Public Attributes

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.

Definition at line 70 of file OcTreeKey.h.

Constructor & Destructor Documentation

◆ OcTreeKey() [1/3]

octomap::OcTreeKey::OcTreeKey ( )
inline

Definition at line 73 of file OcTreeKey.h.

◆ OcTreeKey() [2/3]

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

Definition at line 74 of file OcTreeKey.h.

◆ OcTreeKey() [3/3]

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

Definition at line 80 of file OcTreeKey.h.

Member Function Documentation

◆ operator!=()

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

Definition at line 90 of file OcTreeKey.h.

◆ operator=()

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

Definition at line 94 of file OcTreeKey.h.

◆ operator==()

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

Definition at line 86 of file OcTreeKey.h.

◆ operator[]() [1/2]

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

Definition at line 99 of file OcTreeKey.h.

◆ operator[]() [2/2]

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

Definition at line 103 of file OcTreeKey.h.

Member Data Documentation

◆ k

key_type octomap::OcTreeKey::k[3]

Definition at line 107 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 Fri Jun 7 2019 21:17:32