Gazebo Gazebo

API Reference

6.16.0
List of all members | Public Member Functions | Static Public Attributes
EntitiesSelected Class Reference

Event that notifies when new entities have been selected. More...

#include <GuiEvents.hh>

Public Member Functions

 EntitiesSelected (const std::vector< Entity > &_entities, bool _fromUser=false)
 Constructor. More...
 
std::vector< Entity > Data () const
 Get the data sent with the event. More...
 
bool FromUser () const
 Get whether the event was generated by the user. More...
 

Static Public Attributes

static const QEvent::Type kType = QEvent::Type(QEvent::User + 1)
 Unique type for this event. More...
 

Detailed Description

Event that notifies when new entities have been selected.

Constructor & Destructor Documentation

◆ EntitiesSelected()

EntitiesSelected ( const std::vector< Entity > &  _entities,
bool  _fromUser = false 
)
inlineexplicit

Constructor.

Parameters
[in]_entitiesAll the selected entities
[in]_fromUserTrue if the event was directly generated by the user, false in case it's been propagated through a different mechanism.

Member Function Documentation

◆ Data()

std::vector<Entity> Data ( ) const
inline

Get the data sent with the event.

Returns
The entities being selected.

◆ FromUser()

bool FromUser ( ) const
inline

Get whether the event was generated by the user.

Returns
True for the user.

Member Data Documentation

◆ kType

const QEvent::Type kType = QEvent::Type(QEvent::User + 1)
static

Unique type for this event.

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