Ignition Gazebo

API Reference

6.0.0~pre1

This plugin is in charge of showing the entity context menu when the right button is clicked on a visual. More...

#include <EntityContextMenuPlugin.hh>

Public Member Functions

 EntityContextMenu ()
 Constructor. More...
 
 EntityContextMenu ()
 Constructor. More...
 
 ~EntityContextMenu () override
 Destructor. More...
 
 ~EntityContextMenu () override
 Destructor. More...
 
void LoadConfig (const tinyxml2::XMLElement *_pluginElem) override
 
Q_INVOKABLE void OnRemove (const QString &_data, const QString &_type)
 Callback when a context menu item is invoked. More...
 
Q_INVOKABLE void OnRequest (const QString &_request, const QString &_data)
 Callback when a context menu item is invoked. More...
 

Protected Member Functions

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

Detailed Description

This plugin is in charge of showing the entity context menu when the right button is clicked on a visual.

A context menu providing actions that can be invoked on an entity.

Constructor & Destructor Documentation

◆ EntityContextMenu() [1/2]

Constructor.

◆ ~EntityContextMenu() [1/2]

~EntityContextMenu ( )
override

Destructor.

◆ EntityContextMenu() [2/2]

Constructor.

◆ ~EntityContextMenu() [2/2]

~EntityContextMenu ( )
override

Destructor.

Member Function Documentation

◆ eventFilter()

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

◆ LoadConfig()

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

◆ OnRemove()

Q_INVOKABLE void OnRemove ( const QString &  _data,
const QString &  _type 
)

Callback when a context menu item is invoked.

Parameters
[in]_dataRequest data
[in]_typeEntity type

◆ OnRequest()

Q_INVOKABLE void OnRequest ( const QString &  _request,
const QString &  _data 
)

Callback when a context menu item is invoked.

Parameters
[in]_requestRequest type
[in]_dataRequest data

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