Gazebo Gazebo

API Reference

6.16.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 an Ignition transport thread, so any interaction with Qt should be done through signals and slots. More...
 

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 gz::sim::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 an Ignition 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 Plot3D, Scene3D, AlignTool, GzSceneManager, VisualizeContacts, CopyPaste, VideoRecorder, VisualizationCapabilities, VisualizeLidar, EntityTree, PlaybackScrubber, and Plotting.


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