Voxomap
A C++11 voxel container.
voxomap::SidedVoxel< T_Voxel > Struct Template Reference

Voxel with side informations Side is present if the corresponding neighbor voxel exist. For example: More...

#include <SidedContainer.hpp>

Inherits T_Voxel.

Public Member Functions

 SidedVoxel ()=default
 Default constructor. More...
 
template<typename T , typename = typename std::enable_if<!std::is_class<T>::value, int>::type>
 SidedVoxel (T arg)
 Constructor with one argument forward to Voxel constructor. More...
 
template<typename T , typename = typename std::enable_if<std::is_class<T>::value, int>::type>
 SidedVoxel (T const &arg)
 Constructor with one argument forward to Voxel constructor. More...
 
template<typename T , typename U , typename... Args>
 SidedVoxel (T &&arg_1, U &&arg_2, Args &&... args)
 Constructor with arguments forward to Voxel constructor. More...
 
 SidedVoxel (SidedVoxel const &other)=default
 Copy constructor. More...
 
 SidedVoxel (SidedVoxel &&other)=default
 Move constructor. More...
 
template<typename... Args>
 SidedVoxel (SideEnum side, Args &&... args)
 Constructor with side information. More...
 
SidedVoxeloperator= (SidedVoxel const &other)=default
 Default assignement operator. More...
 
SidedVoxeloperator= (SidedVoxel &&other)=default
 Default move assignement operator. More...
 
 operator bool () const
 
bool operator== (SidedVoxel const &other) const
 Call the T_Voxel method operator==. More...
 
bool operator!= (SidedVoxel const &other) const
 Call the T_Voxel method operator!=. More...
 
bool operator== (T_Voxel const &other) const
 Call the T_Voxel method operator==. More...
 
bool operator!= (T_Voxel const &other) const
 Call the T_Voxel method operator!=. More...
 
bool operator== (uint8_t s) const
 True if the side of this is equal to s. More...
 
bool operator!= (uint8_t s) const
 True if the side of this is different to s. More...
 
uint8_t operator& (uint8_t s) const
 Returns AND of internal side with s. More...
 
uint8_t operator| (uint8_t s) const
 Returns OR of internal side with s. More...
 
uint8_t operator& (SideEnum s) const
 Returns AND of internal side with s. More...
 
uint8_t operator| (SideEnum s) const
 Returns OR of internal side with s. More...
 
SidedVoxeloperator&= (uint8_t s)
 Apply AND. More...
 
SidedVoxeloperator|= (uint8_t s)
 Apply OR. More...
 
uint8_t getSide () const
 Returns internal side. More...
 

Private Attributes

uint8_t _voxel_side = 0
 

Detailed Description

template<class T_Voxel>
struct voxomap::SidedVoxel< T_Voxel >

Voxel with side informations Side is present if the corresponding neighbor voxel exist. For example:

  • If YPOS is present, a voxel is present at y + 1
  • If XNEG is present, a voxel is present at x - 1
Examples
SidedArea.

Definition at line 43 of file SidedContainer.hpp.

Constructor & Destructor Documentation

◆ SidedVoxel() [1/7]

template<class T_Voxel >
voxomap::SidedVoxel< T_Voxel >::SidedVoxel ( )
default

Default constructor.

◆ SidedVoxel() [2/7]

template<class T_Voxel >
template<typename T , typename = typename std::enable_if<!std::is_class<T>::value, int>::type>
voxomap::SidedVoxel< T_Voxel >::SidedVoxel ( arg)

Constructor with one argument forward to Voxel constructor.

◆ SidedVoxel() [3/7]

template<class T_Voxel >
template<typename T , typename = typename std::enable_if<std::is_class<T>::value, int>::type>
voxomap::SidedVoxel< T_Voxel >::SidedVoxel ( T const &  arg)

Constructor with one argument forward to Voxel constructor.

◆ SidedVoxel() [4/7]

template<class T_Voxel >
template<typename T , typename U , typename... Args>
voxomap::SidedVoxel< T_Voxel >::SidedVoxel ( T &&  arg_1,
U &&  arg_2,
Args &&...  args 
)

Constructor with arguments forward to Voxel constructor.

◆ SidedVoxel() [5/7]

template<class T_Voxel >
voxomap::SidedVoxel< T_Voxel >::SidedVoxel ( SidedVoxel< T_Voxel > const &  other)
default

Copy constructor.

◆ SidedVoxel() [6/7]

template<class T_Voxel >
voxomap::SidedVoxel< T_Voxel >::SidedVoxel ( SidedVoxel< T_Voxel > &&  other)
default

Move constructor.

◆ SidedVoxel() [7/7]

template<class T_Voxel >
template<typename... Args>
voxomap::SidedVoxel< T_Voxel >::SidedVoxel ( SideEnum  side,
Args &&...  args 
)

Constructor with side information.

Parameters
sideSide information
argsArguments forward to voxel constructor

Member Function Documentation

◆ operator=() [1/2]

template<class T_Voxel >
SidedVoxel& voxomap::SidedVoxel< T_Voxel >::operator= ( SidedVoxel< T_Voxel > const &  other)
default

Default assignement operator.

◆ operator=() [2/2]

template<class T_Voxel >
SidedVoxel& voxomap::SidedVoxel< T_Voxel >::operator= ( SidedVoxel< T_Voxel > &&  other)
default

Default move assignement operator.

◆ operator bool()

template<class T_Voxel >
voxomap::SidedVoxel< T_Voxel >::operator bool ( ) const

◆ operator==() [1/3]

template<class T_Voxel >
bool voxomap::SidedVoxel< T_Voxel >::operator== ( SidedVoxel< T_Voxel > const &  other) const

Call the T_Voxel method operator==.

◆ operator!=() [1/3]

template<class T_Voxel >
bool voxomap::SidedVoxel< T_Voxel >::operator!= ( SidedVoxel< T_Voxel > const &  other) const

Call the T_Voxel method operator!=.

◆ operator==() [2/3]

template<class T_Voxel >
bool voxomap::SidedVoxel< T_Voxel >::operator== ( T_Voxel const &  other) const

Call the T_Voxel method operator==.

◆ operator!=() [2/3]

template<class T_Voxel >
bool voxomap::SidedVoxel< T_Voxel >::operator!= ( T_Voxel const &  other) const

Call the T_Voxel method operator!=.

◆ operator==() [3/3]

template<class T_Voxel >
bool voxomap::SidedVoxel< T_Voxel >::operator== ( uint8_t  s) const

True if the side of this is equal to s.

◆ operator!=() [3/3]

template<class T_Voxel >
bool voxomap::SidedVoxel< T_Voxel >::operator!= ( uint8_t  s) const

True if the side of this is different to s.

◆ operator&() [1/2]

template<class T_Voxel >
uint8_t voxomap::SidedVoxel< T_Voxel >::operator& ( uint8_t  s) const

Returns AND of internal side with s.

◆ operator|() [1/2]

template<class T_Voxel >
uint8_t voxomap::SidedVoxel< T_Voxel >::operator| ( uint8_t  s) const

Returns OR of internal side with s.

◆ operator&() [2/2]

template<class T_Voxel >
uint8_t voxomap::SidedVoxel< T_Voxel >::operator& ( SideEnum  s) const

Returns AND of internal side with s.

◆ operator|() [2/2]

template<class T_Voxel >
uint8_t voxomap::SidedVoxel< T_Voxel >::operator| ( SideEnum  s) const

Returns OR of internal side with s.

◆ operator&=()

template<class T_Voxel >
SidedVoxel& voxomap::SidedVoxel< T_Voxel >::operator&= ( uint8_t  s)

Apply AND.

Returns
Reference to this

◆ operator|=()

template<class T_Voxel >
SidedVoxel& voxomap::SidedVoxel< T_Voxel >::operator|= ( uint8_t  s)

Apply OR.

Returns
Reference to this

◆ getSide()

template<class T_Voxel >
uint8_t voxomap::SidedVoxel< T_Voxel >::getSide ( ) const

Returns internal side.

Member Data Documentation

◆ _voxel_side

template<class T_Voxel >
uint8_t voxomap::SidedVoxel< T_Voxel >::_voxel_side = 0
private

Definition at line 146 of file SidedContainer.hpp.


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