WorldControl Class Reference

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.
void	OnPlay ()
	Callback in Qt thread when play button is clicked.
void	OnReset ()
	Callback in Qt thread when reset button is clicked.
void	OnStep ()
	Callback in Qt thread when step button is clicked.
void	OnStepCount (const unsigned int _steps)
	Callback in Qt thread when step count is changed.
void	ProcessMsg ()
	Callback in main thread when diagnostics come in.

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

Public Member Functions
	WorldControl ()
	Constructor.
	~WorldControl () override
	Destructor.
void	LoadConfig (const tinyxml2::XMLElement *_pluginElem) override

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 present, 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()

WorldControl

(

)

Constructor.

~WorldControl()

~WorldControl ( )

override

Destructor.

Member Function Documentation

LoadConfig()

void LoadConfig ( const tinyxml2::XMLElement *  _pluginElem )

override

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.

OnReset

void OnReset ( )

slot

Callback in Qt thread when reset 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]

_steps

New 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.

reset

void reset ( )

signal

Notify that it's now reset.

---

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

• WorldControl.hh