Voxel Class Reference

A voxel storing whether it is occupied or free and the object label it is occupied by. More...

#include <VisionX/libraries/VoxelGrids/LabelOccupancy/VoxelGrid.h>

Public Member Functions

Label getLabel () const
 Get the label. Voxel must be occupied. More...
 
bool isFree () const
 Indicate whether this voxel is free (i.e. it is not occupied). More...
 
bool isOccupied () const
 Indicate whether this voxel is occupied. More...
 
void setFree ()
 Set the voxel to free, i.e. unoccupied. More...
 
void setOccupied (Label label)
 Set the voxel to occupied and set its label. More...
 
 Voxel ()
 Construct an unoccupied voxel. More...
 
 Voxel (Label label)
 Construct an occupied voxel with given label. More...
 

Detailed Description

A voxel storing whether it is occupied or free and the object label it is occupied by.

Definition at line 23 of file VoxelGrid.h.

Constructor & Destructor Documentation

◆ Voxel() [1/2]

Voxel ( )

Construct an unoccupied voxel.

Definition at line 13 of file VoxelGrid.cpp.

+ Here is the call graph for this function:

◆ Voxel() [2/2]

Voxel ( Label  label)

Construct an occupied voxel with given label.

Definition at line 18 of file VoxelGrid.cpp.

+ Here is the call graph for this function:

Member Function Documentation

◆ getLabel()

Label getLabel ( ) const

Get the label. Voxel must be occupied.

Definition at line 33 of file VoxelGrid.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ isFree()

bool isFree ( ) const

Indicate whether this voxel is free (i.e. it is not occupied).

Definition at line 23 of file VoxelGrid.cpp.

+ Here is the call graph for this function:

◆ isOccupied()

bool isOccupied ( ) const

Indicate whether this voxel is occupied.

Definition at line 28 of file VoxelGrid.cpp.

+ Here is the caller graph for this function:

◆ setFree()

void setFree ( )

Set the voxel to free, i.e. unoccupied.

Definition at line 39 of file VoxelGrid.cpp.

+ Here is the caller graph for this function:

◆ setOccupied()

void setOccupied ( Label  label)

Set the voxel to occupied and set its label.

Definition at line 45 of file VoxelGrid.cpp.

+ Here is the caller graph for this function:

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