delphyne_gui
OriginDisplay Class Reference

Detailed Description

Implements a plugin to display the Inertial Frame axes 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 gets the scene name from the plugin configuration and tries to get a pointer to it. If the scene is not available, then it starts a timer and tries periodically to retrieve the scene. 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/origin_display.hh>

Inheritance diagram for OriginDisplay:
[legend]

Signals

void IsVisibleChanged ()
 

Public Member Functions

 OriginDisplay ()=default
 
void LoadConfig (const tinyxml2::XMLElement *_pluginElem) override
 Loads the plugin configuration and tries to load the axes in the scene. More...
 
Q_INVOKABLE bool IsVisible () const
 isVisible accessors. More...
 
Q_INVOKABLE void SetIsVisible (bool _isVisible)
 

Protected Member Functions

void timerEvent (QTimerEvent *_event) override
 Timer event callback which handles the logic to get the scene. More...
 
bool eventFilter (QObject *_obj, QEvent *_event) override
 Filters ignition::gui::events::Render events to update the visualization of the axis if needed. More...
 

Properties

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

Constructor & Destructor Documentation

◆ OriginDisplay()

OriginDisplay ( )
default

Member Function Documentation

◆ eventFilter()

bool eventFilter ( QObject *  _obj,
QEvent *  _event 
)
overrideprotected

Filters ignition::gui::events::Render events to update the visualization of the axis if needed.

To make this method be called by Qt Event System, install the event filter in target object.

See also
QObject::installEventFilter() method.

◆ IsVisible()

Q_INVOKABLE bool IsVisible ( ) const

isVisible accessors.

◆ IsVisibleChanged

void IsVisibleChanged ( )
signal

◆ LoadConfig()

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

Loads the plugin configuration and tries to load the axes in the scene.

When the scene is not available, a timer is started to try every kTimerPeriodInMs ms to load the axes. It only works with ogre rendering engine.

◆ SetIsVisible()

void SetIsVisible ( bool  _isVisible)

◆ timerEvent()

void timerEvent ( QTimerEvent *  _event)
overrideprotected

Timer event callback which handles the logic to get the scene.

Property Documentation

◆ isVisible

bool isVisible {true}
readwrite

Holds the visibility status of the axes.


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