All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Types | Public Member Functions | Public Attributes | List of all members
gazebo::common::MouseEvent Class Reference

Generic description of a mouse event. More...

#include <common/common.hh>

Collaboration diagram for gazebo::common::MouseEvent:
Collaboration graph
[legend]

Public Types

enum  Buttons { NO_BUTTON = 0x0, LEFT = 0x1, MIDDLE = 0x2, RIGHT = 0x4 }
 Standard mouse buttons enumeration. More...
 
enum  EventType {
  NO_EVENT, MOVE, PRESS, RELEASE,
  SCROLL
}
 Mouse event types enumeration. More...
 

Public Member Functions

 MouseEvent ()
 Constructor. More...
 

Public Attributes

bool alt
 Alt key press flag. More...
 
unsigned int button
 The button which caused the event. More...
 
unsigned int buttons
 State of the buttons when the event was generated. More...
 
bool control
 Control key press flag. More...
 
bool dragging
 Flag for mouse drag motion. More...
 
float moveScale
 Scaling factor. More...
 
math::Vector2i pos
 Mouse pointer position on the screen. More...
 
math::Vector2i pressPos
 Position of button press. More...
 
math::Vector2i prevPos
 Previous position. More...
 
math::Vector2i scroll
 Scroll position. More...
 
bool shift
 Shift key press flag. More...
 
EventType type
 Event type. More...
 

Detailed Description

Generic description of a mouse event.

Member Enumeration Documentation

Standard mouse buttons enumeration.

Enumerator
NO_BUTTON 
LEFT 
MIDDLE 
RIGHT 

Mouse event types enumeration.

Enumerator
NO_EVENT 
MOVE 
PRESS 
RELEASE 
SCROLL 

Constructor & Destructor Documentation

gazebo::common::MouseEvent::MouseEvent ( )
inline

Constructor.

Member Data Documentation

bool gazebo::common::MouseEvent::alt

Alt key press flag.

unsigned int gazebo::common::MouseEvent::button

The button which caused the event.

unsigned int gazebo::common::MouseEvent::buttons

State of the buttons when the event was generated.

bool gazebo::common::MouseEvent::control

Control key press flag.

bool gazebo::common::MouseEvent::dragging

Flag for mouse drag motion.

float gazebo::common::MouseEvent::moveScale

Scaling factor.

math::Vector2i gazebo::common::MouseEvent::pos

Mouse pointer position on the screen.

math::Vector2i gazebo::common::MouseEvent::pressPos

Position of button press.

math::Vector2i gazebo::common::MouseEvent::prevPos

Previous position.

math::Vector2i gazebo::common::MouseEvent::scroll

Scroll position.

bool gazebo::common::MouseEvent::shift

Shift key press flag.

EventType gazebo::common::MouseEvent::type

Event type.


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