EntityContextMenu Class Reference

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.

Public Member Functions
	EntityContextMenu ()
	Constructor.
	EntityContextMenu ()
	Constructor.
	~EntityContextMenu () override
	Destructor.
	~EntityContextMenu () override
	Destructor.
Q_INVOKABLE bool	FollowingTarget () const
	Get whether it is following target.
void	LoadConfig (const tinyxml2::XMLElement *_pluginElem) override
void	OnCurrentlyTrackedSub (const msgs::CameraTrack &_msg)
	Callback function to get data from the message.
Q_INVOKABLE void	OnRemove (const QString &_data, const QString &_type)
	Callback when a context menu item is invoked.
Q_INVOKABLE void	OnRequest (const QString &_request, const QString &_data)
	Callback when a context menu item is invoked.
Q_INVOKABLE void	SetFollowingTarget (bool &_followingTarget)
	Set whether followingTarget.
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

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]

EntityContextMenu

(

)

Constructor.

~EntityContextMenu() [1/2]

~EntityContextMenu ( )

override

Destructor.

EntityContextMenu() [2/2]

EntityContextMenu

(

)

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]

_msg

CameraTrack message

OnRemove()

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

Callback when a context menu item is invoked.

Parameters

[in]	_data	Request data
[in]	_type	Entity type

OnRequest()

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

Callback when a context menu item is invoked.

Parameters

[in]	_request	Request type
[in]	_data	Request data

SetFollowingTarget()

Q_INVOKABLE void SetFollowingTarget

(

bool &

_followingTarget

)

Set whether followingTarget.

Parameters

[in]

_followingTarget

True if followingTarget

Property Documentation

followingTarget

bool followingTarget

readwrite

followingTarget

---

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

• EntityContextMenuPlugin.hh
• EntityContextMenu.hh