Gazebo Gui

API Reference

8.1.0

Manages grids in a Gazebo Rendering scene. This plugin can be used for: More...

#include <GridConfig.hh>

Public Slots

QStringList NameList () const
 Get the list of grid names.
 
void OnName (const QString &_name)
 Callback when a new name is chosen on the combo box.
 
void OnRefresh ()
 Callback when refresh button is pressed.
 
void OnShow (bool _checked)
 Callback when checkbox is clicked.
 
void SetColor (double _r, double _g, double _b, double _a)
 Callback to update grid color.
 
void SetNameList (const QStringList &_nameList)
 Set the list of names.
 
void SetPose (double _x, double _y, double _z, double _roll, double _pitch, double _yaw)
 Callback to update grid pose.
 
void UpdateCellLength (double _length)
 Callback to update cell length.
 
void UpdateHCellCount (int _cellCount)
 Callback to update horizontal cell count.
 
void UpdateVCellCount (int _cellCount)
 Callback to update vertical cell count.
 

Signals

void NameListChanged ()
 Notify that name list has changed.
 
void newParams (int _hCellCount, int _vCellCount, double _cellLength, QVector3D _pos, QVector3D _rot, QColor _color)
 Notify QML that grid values have changed.
 

Public Member Functions

 GridConfig ()
 Constructor.
 
 ~GridConfig () override
 Destructor.
 
void ConnectToGrid ()
 Callback to retrieve existing grid.
 
void CreateGrids ()
 Create grids defined at startup.
 
void LoadConfig (const tinyxml2::XMLElement *) override
 Load the plugin with a configuration file. Override this on custom plugins to handle custom configurations.
 
void RefreshList ()
 Refresh list of grids. This is called in the rendering thread.
 
void UpdateGrid ()
 Update grid.
 
- Public Member Functions inherited from Plugin
 Plugin ()
 Constructor.
 
virtual ~Plugin ()
 Destructor.
 
QQuickItem * CardItem () const
 Get the card item which contains this plugin. The item is generated the first time this function is run.
 
virtual std::string ConfigStr ()
 Get the configuration XML as a string.
 
QQmlContext * Context () const
 Get the QML context where the plugin was created.
 
bool DeleteLaterRequested () const
 Get the value of the the delete_later element from the configuration file, which defaults to false.
 
void Load (const tinyxml2::XMLElement *_pluginElem)
 Load the plugin with a configuration file. This loads the default parameters and then calls LoadConfig(), which should be overridden to load custom parameters.
 
QQuickItem * PluginItem () const
 Get the plugin item.
 
void PostParentChanges ()
 Apply changes which should come after the plugin already has a parent.
 
virtual std::string Title () const
 Get title.
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual ~QObject ()
 
bool blockSignals (bool block)
 
QObjectchild (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArraydynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObjectparent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThreadthread () const
 

Protected Member Functions

bool eventFilter (QObject *_obj, QEvent *_event) override
 
- Protected Member Functions inherited from Plugin
void DeleteLater ()
 Wait until the plugin has a parent, then close and delete the parent.
 
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObjectsender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 

Properties

QStringList nameList
 Name list.
 
- Properties inherited from QObject
 objectName
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Protected Attributes inherited from Plugin
std::string configStr
 XML configuration.
 
std::string title = ""
 Title to be displayed on top of plugin.
 

Detailed Description

Manages grids in a Gazebo Rendering scene. This plugin can be used for:

  • Introspecting grids
  • Editing grids

Configuration

  • <insert> : One grid will be inserted at startup for each <insert> tag.
    • <horizontal_cell_count> : Number of cells in the horizontal direction, defaults to 20.
    • <vertical_cell_count> : Number of cells in the vertical direction, defaults to 0;
    • <cell_length> : Length of each cell, defaults to 1.
    • <pose> : Grid pose, defaults to the origin.
    • <color> : Grid color, defaults to (0.7, 0.7, 0.7, 1.0)

Constructor & Destructor Documentation

◆ GridConfig()

Constructor.

◆ ~GridConfig()

~GridConfig ( )
override

Destructor.

Member Function Documentation

◆ ConnectToGrid()

void ConnectToGrid ( )

Callback to retrieve existing grid.

◆ CreateGrids()

void CreateGrids ( )

Create grids defined at startup.

◆ eventFilter()

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

Reimplemented from QObject.

◆ LoadConfig()

void LoadConfig ( const tinyxml2::XMLElement * _pluginElem)
overridevirtual

Load the plugin with a configuration file. Override this on custom plugins to handle custom configurations.

Called when a plugin is first created. This function should not be blocking.

See also
Load
Parameters
[in]_pluginElemElement containing configuration

Reimplemented from Plugin.

◆ NameList

QStringList NameList ( ) const
slot

Get the list of grid names.

Returns
List of grids.

◆ NameListChanged

void NameListChanged ( )
signal

Notify that name list has changed.

◆ newParams

void newParams ( int _hCellCount,
int _vCellCount,
double _cellLength,
QVector3D _pos,
QVector3D _rot,
QColor _color )
signal

Notify QML that grid values have changed.

Parameters
[in]_hCellCountHorizontal cell count
[in]_vCellCountVertical cell count
[in]_cellLengthCell length
[in]_posXYZ Position
[in]_rotRPY orientation
[in]_colorGrid color

◆ OnName

void OnName ( const QString & _name)
slot

Callback when a new name is chosen on the combo box.

Parameters
[in]_nameGrid name

◆ OnRefresh

void OnRefresh ( )
slot

Callback when refresh button is pressed.

◆ OnShow

void OnShow ( bool _checked)
slot

Callback when checkbox is clicked.

Parameters
[in]_checkedindicates show or hide grid

◆ RefreshList()

void RefreshList ( )

Refresh list of grids. This is called in the rendering thread.

◆ 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

◆ SetNameList

void SetNameList ( const QStringList & _nameList)
slot

Set the list of names.

Parameters
[in]_nameListList of names

◆ 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

Property Documentation

◆ nameList

QStringList nameList
readwrite

Name list.


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