Gazebo Gui

API Reference

7.2.2

Event which is called to broadcast the 2D coordinates of a user's mouse hover within the scene. More...

#include <GuiEvents.hh>

Public Member Functions

 HoverOnScene (const common::MouseEvent &_mouse)
 Constructor. More...
 
common::MouseEvent Mouse () const
 Get the point within the scene over which the user is hovering. More...
 
- Public Member Functions inherited from QEvent
 QEvent (Type type)
 
virtual ~QEvent ()
 
void accept ()
 
void ignore ()
 
bool isAccepted () const
 
void setAccepted (bool accepted)
 
bool spontaneous () const
 
Type type () const
 

Static Public Attributes

static const QEvent::Type kType = QEvent::Type(QEvent::MaxUser - 13)
 Unique type for this event. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from QEvent
int registerEventType (int hint)
 
- Properties inherited from QEvent
 accepted
 

Detailed Description

Event which is called to broadcast the 2D coordinates of a user's mouse hover within the scene.

Constructor & Destructor Documentation

◆ HoverOnScene()

HoverOnScene ( const common::MouseEvent &  _mouse)
explicit

Constructor.

Parameters
[in]_mouseThe hover mouse event on the scene

Member Function Documentation

◆ Mouse()

common::MouseEvent Mouse ( ) const

Get the point within the scene over which the user is hovering.

Returns
The 2D point

Member Data Documentation

◆ kType

const QEvent::Type kType = QEvent::Type(QEvent::MaxUser - 13)
static

Unique type for this event.


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