Gazebo Sim

API Reference

8.7.0
GuiSystem Class Reference

Base class for a GUI System. More...

#include <GuiSystem.hh>

Public Member Functions

virtual void Update (const UpdateInfo &_info, EntityComponentManager &_ecm)
 Update callback called every time the system is stepped. This is called at a Gazebo Transport thread, so any interaction with Qt should be done through signals and slots. More...
 
- Public Member Functions inherited from Plugin
 Plugin ()
 
virtual ~Plugin ()
 
QQuickItem * CardItem () const
 
virtual std::string ConfigStr ()
 
QQmlContext * Context () const
 
bool DeleteLaterRequested () const
 
void Load (const tinyxml2::XMLElement *_pluginElem)
 
QQuickItem * PluginItem () const
 
void PostParentChanges ()
 
virtual std::string Title () const
 

Additional Inherited Members

- Protected Member Functions inherited from Plugin
void DeleteLater ()
 
virtual void LoadConfig (const tinyxml2::XMLElement *_pluginElem)
 
- Protected Attributes inherited from Plugin
std::string configStr
 
std::string title
 

Detailed Description

Base class for a GUI System.

A System operates on Entities that have certain Components. A System will only operate on an Entity if it has all of the required Components.

GUI systems are different from Systems because they don't run in the same process as the physics. Instead, they run in a separate process that is stepped by updates coming through the network

Member Function Documentation

◆ Update()

virtual void Update ( const UpdateInfo _info,
EntityComponentManager _ecm 
)
inlinevirtual

Update callback called every time the system is stepped. This is called at a Gazebo Transport thread, so any interaction with Qt should be done through signals and slots.

Parameters
[in]_infoCurrent simulation information, such as time.
[in]_ecmMutable reference to the ECM, so the system can read and write entities and their components.

Reimplemented in VisualizeContacts, VisualizationCapabilities, VideoRecorder, GzSceneManager, Plotting, Plot3D, MouseDrag, CopyPaste, ApplyForceTorque, AlignTool, VisualizeLidar, EnvironmentVisualization, EnvironmentLoader, PlaybackScrubber, and EntityTree.


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