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

An event class representing the motion of a mouse's scroll wheel input device. More...

#include <omGUIInputMouseWheelEvent.h>

Public Member Functions

 MouseWheelEvent (const Vector2f &newDelta, const Vector2f &newPosition)
 Create a new mouse wheel event with the mouse scroll wheel's delta and mouse position. More...
 
const Vector2f & getDelta () const
 Return the relative motion of the mouse wheel on both axes. More...
 
void setDelta (const Vector2f &newDelta)
 Set the relative motion of the mouse wheel on both axes. More...
 
const Vector2f & getPosition () const
 Return the position of the mouse when the mouse wheel event occurred. More...
 
void setPosition (const Vector2f &newPosition)
 Set the position of the mouse when the mouse wheel event occurred. More...
 
const TimegetTime () const
 Return the absolute time since the epoch when the mouse wheel event occurred. More...
 
void setTime (const Time &newTime)
 Set the absolute time since the epoch when the mouse wheel 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 class representing the motion of a mouse's scroll wheel input device.

It contains the relative motion in internal units of the the mouse's scroll wheel since the last mouse wheel event. Both horizontal and vertical scrolling is handled by the event.

Constructor & Destructor Documentation

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

Create a new mouse wheel event with the mouse scroll wheel's delta and mouse position.

Member Function Documentation

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

Return the relative motion of the mouse wheel on both axes.

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

Set the relative motion of the mouse wheel on both axes.

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

Return the position of the mouse when the mouse wheel event occurred.

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

Set the position of the mouse when the mouse wheel event occurred.

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

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

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

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

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

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

void om::gui::input::MouseWheelEvent::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: