Gazebo Gui

API Reference

8.3.0

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

#include <GuiEvents.hh>

Public Member Functions

 HoverToScene (const math::Vector3d &_point)
 Constructor. More...
 
math::Vector3d Point () 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 - 4)
 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 3D coordinates of a user's mouse hover within the scene.

Constructor & Destructor Documentation

◆ HoverToScene()

HoverToScene ( const math::Vector3d _point)
explicit

Constructor.

Parameters
[in]_pointThe point at which the mouse is hovering within the scene

Member Function Documentation

◆ Point()

math::Vector3d Point ( ) const

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

Returns
The 3D point

Member Data Documentation

◆ kType

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

Unique type for this event.


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