Gazebo Gui

API Reference

3.12.0

This plugin provides a world control panel which may have a play / pause and step buttons. More...

#include <WorldControl.hh>

Public Slots

void OnPause ()
 Callback in Qt thread when pause button is clicked. More...
 
void OnPlay ()
 Callback in Qt thread when play button is clicked. More...
 
void OnStep ()
 Callback in Qt thread when step button is clicked. More...
 
void OnStepCount (const unsigned int _steps)
 Callback in Qt thread when step count is changed. More...
 
void ProcessMsg ()
 Callback in main thread when diagnostics come in. More...
 

Signals

void paused ()
 Notify that it's now paused. More...
 
void playing ()
 Notify that it's now playing. More...
 

Public Member Functions

 WorldControl ()
 Constructor. More...
 
virtual ~WorldControl ()
 Destructor. More...
 
void LoadConfig (const tinyxml2::XMLElement *_pluginElem)
 Load the plugin with a configuration file. Override this on custom plugins to handle custom configurations. More...
 
- Public Member Functions inherited from Plugin
 Plugin ()
 Constructor. More...
 
virtual ~Plugin ()
 Destructor. More...
 
QQuickItem * CardItem () const
 Get the card item which contains this plugin. The item is generated the first time this function is run. More...
 
virtual std::string ConfigStr ()
 Get the configuration XML as a string. More...
 
QQmlContext * Context () const
 Get the QML context where the plugin was created. More...
 
bool DeleteLaterRequested () const
 Get the value of the the delete_later element from the configuration file, which defaults to false. More...
 
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. More...
 
QQuickItem * PluginItem () const
 Get the plugin item. More...
 
void PostParentChanges ()
 Apply changes which should come after the plugin already has a parent. More...
 
virtual std::string Title () const
 Get title. More...
 
- 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)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
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
 

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)
 
- Protected Member Functions inherited from Plugin
void DeleteLater ()
 Wait until the plugin has a parent, then close and delete the parent. More...
 
- 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)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Protected Attributes inherited from Plugin
std::string configStr
 XML configuration. More...
 
std::string title = ""
 Title to be displayed on top of plugin. More...
 
- Properties inherited from QObject
 objectName
 

Detailed Description

This plugin provides a world control panel which may have a play / pause and step buttons.

Configuration

  • <play_pause> : Set to true to see a play/pause button, false by default.
  • <step> : Set to true to see a step button, false by default.
  • <start_paused> : Set to false to start playing, false by default.
  • <service> : Service for world control, optional. If not presnt, the plugin will attempt to create a topic with the main window's worldName property.
  • <stats_topic> : Topic to receive world statistics, optional. If not present, the plugin will attempt to create a topic with the main window's worldName property.

If no elements are filled for the plugin, both the play/pause and the step buttons will be displayed.

Constructor & Destructor Documentation

◆ WorldControl()

Constructor.

◆ ~WorldControl()

virtual ~WorldControl ( )
virtual

Destructor.

Member Function Documentation

◆ LoadConfig()

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

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.

◆ OnPause

void OnPause ( )
slot

Callback in Qt thread when pause button is clicked.

◆ OnPlay

void OnPlay ( )
slot

Callback in Qt thread when play button is clicked.

◆ OnStep

void OnStep ( )
slot

Callback in Qt thread when step button is clicked.

◆ OnStepCount

void OnStepCount ( const unsigned int  _steps)
slot

Callback in Qt thread when step count is changed.

Parameters
[in]_stepsNew number of steps.

◆ paused

void paused ( )
signal

Notify that it's now paused.

◆ playing

void playing ( )
signal

Notify that it's now playing.

◆ ProcessMsg

void ProcessMsg ( )
slot

Callback in main thread when diagnostics come in.


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