Om  1.0.0
A universal framework for multimedia simulation
Public Member Functions | List of all members
om::gui::input::MouseMotionEvent Class Reference

An event object representing the movement of a mouse input device. More...

#include <omGUIInputMouseMotionEvent.h>

Public Member Functions

 MouseMotionEvent (const Vector2f &newDelta, const Vector2f &newPosition)
 Create a new mouse motion event with the mouse's relative motion and position in pixels. More...
 
const Vector2f & getDelta () const
 Return the relative motion in pixels of the mouse. More...
 
void setDelta (const Vector2f &newDelta)
 Set the relative motion in pixels of the mouse. More...
 
const Vector2f & getPosition () const
 Get the current position of the mouse in screen coordinates. More...
 
void setPosition (const Vector2f &newPosition)
 Set the current position of the mouse in screen coordinates. More...
 
const TimegetTime () const
 Return the absolute time since the epoch when the mouse motion event occurred. More...
 
void setTime (const Time &newTime)
 Set the absolute time since the epoch when the mouse motion event occurred. More...
 
const ModifiersgetModifiers () const
 Return the modifier flags that were set when the event occurred. More...
 
void setModifiers (const Modifiers &newModifiers)
 Set the modifier flags that were set when the event occurred. More...
 

Detailed Description

An event object representing the movement of a mouse input device.

It contains the position in pixels of the the mouse at the time of the event, as well as the relative motion in pixels since the last mouse motion event.

Constructor & Destructor Documentation

om::gui::input::MouseMotionEvent::MouseMotionEvent ( const Vector2f &  newDelta,
const Vector2f &  newPosition 
)
inline

Create a new mouse motion event with the mouse's relative motion and position in pixels.

Member Function Documentation

const Vector2f& om::gui::input::MouseMotionEvent::getDelta ( ) const
inline

Return the relative motion in pixels of the mouse.

void om::gui::input::MouseMotionEvent::setDelta ( const Vector2f &  newDelta)
inline

Set the relative motion in pixels of the mouse.

const Vector2f& om::gui::input::MouseMotionEvent::getPosition ( ) const
inline

Get the current position of the mouse in screen coordinates.

void om::gui::input::MouseMotionEvent::setPosition ( const Vector2f &  newPosition)
inline

Set the current position of the mouse in screen coordinates.

const Time& om::gui::input::MouseMotionEvent::getTime ( ) const
inline

Return the absolute time since the epoch when the mouse motion event occurred.

void om::gui::input::MouseMotionEvent::setTime ( const Time newTime)
inline

Set the absolute time since the epoch when the mouse motion event occurred.

const Modifiers& om::gui::input::MouseMotionEvent::getModifiers ( ) const
inline

Return the modifier flags that were set when the event occurred.

void om::gui::input::MouseMotionEvent::setModifiers ( const Modifiers newModifiers)
inline

Set the modifier flags that were set when the event occurred.


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