Gazebo Sim

API Reference

8.7.0

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

#include <EntityContextMenuPlugin.hh>

Signals

void FollowingTargetChanged ()
 Notify that followingTarget has changed. More...
 

Public Member Functions

 EntityContextMenu ()
 Constructor. More...
 
 EntityContextMenu ()
 Constructor. More...
 
 ~EntityContextMenu () override
 Destructor. More...
 
 ~EntityContextMenu () override
 Destructor. More...
 
Q_INVOKABLE bool FollowingTarget () const
 Get whether it is following target. More...
 
void LoadConfig (const tinyxml2::XMLElement *_pluginElem) override
 
void OnCurrentlyTrackedSub (const msgs::CameraTrack &_msg)
 Callback function to get data from the message. More...
 
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...
 
Q_INVOKABLE void SetFollowingTarget (bool &_followingTarget)
 Set whether followingTarget. 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
 

Protected Member Functions

bool eventFilter (QObject *_obj, QEvent *_event) override
 
- Protected Member Functions inherited from Plugin
void DeleteLater ()
 

Properties

bool followingTarget
 followingTarget More...
 

Additional Inherited Members

- Protected Attributes inherited from Plugin
std::string configStr
 
std::string title
 

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

◆ FollowingTarget()

Q_INVOKABLE bool FollowingTarget ( ) const

Get whether it is following target.

Returns
True if followingTarget

◆ FollowingTargetChanged

void FollowingTargetChanged ( )
signal

Notify that followingTarget has changed.

◆ LoadConfig()

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

Reimplemented from Plugin.

◆ OnCurrentlyTrackedSub()

void OnCurrentlyTrackedSub ( const msgs::CameraTrack &  _msg)

Callback function to get data from the message.

Parameters
[in]_msgCameraTrack message

◆ 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

◆ SetFollowingTarget()

Q_INVOKABLE void SetFollowingTarget ( bool &  _followingTarget)

Set whether followingTarget.

Parameters
[in]_followingTargetTrue if followingTarget

Property Documentation

◆ followingTarget

bool followingTarget
readwrite

followingTarget


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