Gazebo Gazebo

API Reference

3.15.1

#include <GridConfig.hh>

Public Slots

void OnShow (bool _checked)
 Callback when checkbox is clicked. More...
 
void SetColor (double _r, double _g, double _b, double _a)
 Callback to update grid color. More...
 
void SetPose (double _x, double _y, double _z, double _roll, double _pitch, double _yaw)
 Callback to update grid pose. More...
 
void UpdateCellLength (double _length)
 Callback to update cell length. More...
 
void UpdateHCellCount (int _cellCount)
 Callback to update horizontal cell count. More...
 
void UpdateVCellCount (int _cellCount)
 Callback to update vertical cell count. More...
 

Public Member Functions

 GridConfig ()
 Constructor. More...
 
 ~GridConfig () override
 Destructor. More...
 
void LoadConfig (const tinyxml2::XMLElement *) override
 
void LoadGrid ()
 Callback to retrieve existing grid or create a new one. More...
 
void UpdateGrid ()
 Update grid. More...
 

Protected Member Functions

bool eventFilter (QObject *_obj, QEvent *_event) override
 

Constructor & Destructor Documentation

◆ GridConfig()

Constructor.

◆ ~GridConfig()

~GridConfig ( )
override

Destructor.

Member Function Documentation

◆ eventFilter()

bool eventFilter ( QObject *  _obj,
QEvent *  _event 
)
overrideprotected

◆ LoadConfig()

void LoadConfig ( const tinyxml2::XMLElement *  )
override

◆ LoadGrid()

void LoadGrid ( )

Callback to retrieve existing grid or create a new one.

Parameters
[in]_sceneScene to look for grid.

◆ OnShow

void OnShow ( bool  _checked)
slot

Callback when checkbox is clicked.

Parameters
[in]_checkedindicates show or hide grid

◆ SetColor

void SetColor ( double  _r,
double  _g,
double  _b,
double  _a 
)
slot

Callback to update grid color.

Parameters
[in]_r,_g,_b,_aRGB color model with fourth alpha channel

◆ SetPose

void SetPose ( double  _x,
double  _y,
double  _z,
double  _roll,
double  _pitch,
double  _yaw 
)
slot

Callback to update grid pose.

Parameters
[in]_x,_y,_zcartesion coordinates
[in]_roll,_pitch,_yawprincipal coordinates

◆ UpdateCellLength

void UpdateCellLength ( double  _length)
slot

Callback to update cell length.

Parameters
[in]_lengthnew cell length

◆ UpdateGrid()

void UpdateGrid ( )

Update grid.

◆ UpdateHCellCount

void UpdateHCellCount ( int  _cellCount)
slot

Callback to update horizontal cell count.

Parameters
[in]_cellCountnew horizontal cell count

◆ UpdateVCellCount

void UpdateVCellCount ( int  _cellCount)
slot

Callback to update vertical cell count.

Parameters
[in]_cellCountnew vertical cell count

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