delphyne_gui
AgentInfoDisplay Class Reference

Detailed Description

Implements a plugin to display the state information for agents in the scene.

ign-gui3 does not have DisplayPlugins, so this plugin implements a slightly different logic to what the original ign-gui0 DisplayPlugin did. It subscribes to events emitted by the MainWindow and checks for ignition::gui::events::Render to make rendering calls. On its first Render event, it gets a pointer to the scene and subscribes to the agent info topic. On subsequent Render events, it checks for new agent info data and creates or updates a text geometry to display this data. Typically, this plugin goes hand in hand with the Scene3D plugin. The plugin UI has a checkbox to toggle visibility. It is paired with isVisible

#include <visualizer/display_plugins/agent_info_display.hh>

Inheritance diagram for AgentInfoDisplay:
[legend]

Signals

void IsVisibleChanged ()
 

Public Member Functions

 AgentInfoDisplay ()=default
 
void LoadConfig (const tinyxml2::XMLElement *_pluginElem) override
 Loads the plugin configuration. More...
 
Q_INVOKABLE bool IsVisible () const
 isVisible accessors. More...
 
Q_INVOKABLE void SetIsVisible (bool _isVisible)
 

Properties

bool isVisible {true}
 Holds the visibility status of the agent info. More...
 

Constructor & Destructor Documentation

◆ AgentInfoDisplay()

AgentInfoDisplay ( )
default

Member Function Documentation

◆ IsVisible()

Q_INVOKABLE bool IsVisible ( ) const

isVisible accessors.

◆ IsVisibleChanged

void IsVisibleChanged ( )
signal

◆ LoadConfig()

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

Loads the plugin configuration.

◆ SetIsVisible()

Q_INVOKABLE void SetIsVisible ( bool  _isVisible)

Property Documentation

◆ isVisible

bool isVisible {true}
readwrite

Holds the visibility status of the agent info.


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