Public Member Functions | Protected Attributes | List of all members
lvr2::BaseHandle< IdxT > Class Template Reference

Interface for all kinds of handles. Handles are basically a key to refer to something. More...

#include <BaseHandle.hpp>

Public Member Functions

 BaseHandle (IdxT idx)
 
IdxT idx () const
 
bool operator!= (const BaseHandle &other) const
 
bool operator< (const BaseHandle &other) const
 
bool operator== (const BaseHandle &other) const
 
void setIdx (IdxT idx)
 

Protected Attributes

IdxT m_idx
 

Detailed Description

template<typename IdxT = uint32_t>
class lvr2::BaseHandle< IdxT >

Interface for all kinds of handles. Handles are basically a key to refer to something.

From this class, a few concrete handle types (such as FaceHandle) will be derived.

Internally, the handle is just an index. How those indices are used is determined by the thing creating handles (e.g. the mesh implementation).

Definition at line 54 of file BaseHandle.hpp.

Constructor & Destructor Documentation

◆ BaseHandle()

template<typename IdxT = uint32_t>
lvr2::BaseHandle< IdxT >::BaseHandle ( IdxT  idx)
explicit

Member Function Documentation

◆ idx()

template<typename IdxT = uint32_t>
IdxT lvr2::BaseHandle< IdxT >::idx ( ) const

◆ operator!=()

template<typename IdxT = uint32_t>
bool lvr2::BaseHandle< IdxT >::operator!= ( const BaseHandle< IdxT > &  other) const

◆ operator<()

template<typename IdxT = uint32_t>
bool lvr2::BaseHandle< IdxT >::operator< ( const BaseHandle< IdxT > &  other) const

◆ operator==()

template<typename IdxT = uint32_t>
bool lvr2::BaseHandle< IdxT >::operator== ( const BaseHandle< IdxT > &  other) const

◆ setIdx()

template<typename IdxT = uint32_t>
void lvr2::BaseHandle< IdxT >::setIdx ( IdxT  idx)

Member Data Documentation

◆ m_idx

template<typename IdxT = uint32_t>
IdxT lvr2::BaseHandle< IdxT >::m_idx
protected

Definition at line 67 of file BaseHandle.hpp.


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


lvr2
Author(s): Thomas Wiemann , Sebastian Pütz , Alexander Mock , Lars Kiesow , Lukas Kalbertodt , Tristan Igelbrink , Johan M. von Behren , Dominik Feldschnieders , Alexander Löhr
autogenerated on Mon Feb 28 2022 22:46:11