Represents a mouse event. More...
#include <MouseEvent.h>
Inherits cinder::app::Event.
Public Types | |
| enum | { LEFT_DOWN = 0x0001, RIGHT_DOWN = 0x0002, MIDDLE_DOWN = 0x0004, SHIFT_DOWN = 0x0008, ALT_DOWN = 0x0010, CTRL_DOWN = 0x0020, META_DOWN = 0x0040, ACCEL_DOWN } |
Public Member Functions | |
| MouseEvent () | |
| MouseEvent (WindowRef win, int aInitiator, int aX, int aY, unsigned int aModifiers, float aWheelIncrement, uint32_t aNativeModifiers) | |
| int | getX () const |
| Returns the X coordinate of the mouse event measured in points. | |
| int | getY () const |
| Returns the Y coordinate of the mouse event measured in points. | |
| Vec2i | getPos () const |
| Returns the coordinates of the mouse event measured in points. | |
| bool | isLeft () const |
| Returns whether the initiator for the event was the left mouse button. | |
| bool | isRight () const |
| Returns whether the initiator for the event was the right mouse button. | |
| bool | isMiddle () const |
| Returns whether the initiator for the event was the middle mouse button. | |
| bool | isLeftDown () const |
| Returns whether the left mouse button was pressed during the event. | |
| bool | isRightDown () const |
| Returns whether the right mouse button was pressed during the event. | |
| bool | isMiddleDown () const |
| Returns whether the middle mouse button was pressed during the event. | |
| bool | isShiftDown () const |
| Returns whether the Shift key was pressed during the event. | |
| bool | isAltDown () const |
| Returns whether the Alt (or Option) key was pressed during the event. | |
| bool | isControlDown () const |
| Returns whether the Control key was pressed during the event. | |
| bool | isMetaDown () const |
| Returns whether the meta key was pressed during the event. Maps to the Windows key on Windows and the Command key on Mac OS X. | |
| bool | isAccelDown () const |
| Returns whether the accelerator key was pressed during the event. Maps to the Control key on Windows and the Command key on Mac OS X. | |
| float | getWheelIncrement () const |
| Returns the number of detents the user has wheeled through. Positive values correspond to wheel-up and negative to wheel-down. | |
| uint32_t | getNativeModifiers () const |
| Returns the platform-native modifier mask. | |
| bool | isHandled () const |
| Returns whether this event has been marked as handled by one of its slots, terminating the normal iteration of the event's slots. | |
| void | setHandled (bool handled=true) |
| Marks the event as handled, terminating the normal iteration of the event's slots. | |
| WindowRef | getWindow () const |
| Returns the Window in which the MouseEvent occurred. | |
| void | setWindow (const WindowRef &window) |
Public Attributes | |
| bool | mHandled |
| WindowRef | mWindow |
Represents a mouse event.
| anonymous enum |
| cinder::app::MouseEvent::MouseEvent | ( | WindowRef | win, |
| int | aInitiator, | ||
| int | aX, | ||
| int | aY, | ||
| unsigned int | aModifiers, | ||
| float | aWheelIncrement, | ||
| uint32_t | aNativeModifiers | ||
| ) |
| int cinder::app::MouseEvent::getX | ( | ) | const |
Returns the X coordinate of the mouse event measured in points.
| int cinder::app::MouseEvent::getY | ( | ) | const |
Returns the Y coordinate of the mouse event measured in points.
| Vec2i cinder::app::MouseEvent::getPos | ( | ) | const |
Returns the coordinates of the mouse event measured in points.
| bool cinder::app::MouseEvent::isLeft | ( | ) | const |
Returns whether the initiator for the event was the left mouse button.
| bool cinder::app::MouseEvent::isRight | ( | ) | const |
Returns whether the initiator for the event was the right mouse button.
| bool cinder::app::MouseEvent::isMiddle | ( | ) | const |
Returns whether the initiator for the event was the middle mouse button.
| bool cinder::app::MouseEvent::isLeftDown | ( | ) | const |
Returns whether the left mouse button was pressed during the event.
| bool cinder::app::MouseEvent::isRightDown | ( | ) | const |
Returns whether the right mouse button was pressed during the event.
| bool cinder::app::MouseEvent::isMiddleDown | ( | ) | const |
Returns whether the middle mouse button was pressed during the event.
| bool cinder::app::MouseEvent::isShiftDown | ( | ) | const |
Returns whether the Shift key was pressed during the event.
| bool cinder::app::MouseEvent::isAltDown | ( | ) | const |
Returns whether the Alt (or Option) key was pressed during the event.
| bool cinder::app::MouseEvent::isControlDown | ( | ) | const |
Returns whether the Control key was pressed during the event.
| bool cinder::app::MouseEvent::isMetaDown | ( | ) | const |
Returns whether the meta key was pressed during the event. Maps to the Windows key on Windows and the Command key on Mac OS X.
| bool cinder::app::MouseEvent::isAccelDown | ( | ) | const |
Returns whether the accelerator key was pressed during the event. Maps to the Control key on Windows and the Command key on Mac OS X.
| float cinder::app::MouseEvent::getWheelIncrement | ( | ) | const |
Returns the number of detents the user has wheeled through. Positive values correspond to wheel-up and negative to wheel-down.
| uint32_t cinder::app::MouseEvent::getNativeModifiers | ( | ) | const |
Returns the platform-native modifier mask.
| bool cinder::app::Event::isHandled | ( | ) | const [inherited] |
Returns whether this event has been marked as handled by one of its slots, terminating the normal iteration of the event's slots.
| void cinder::app::Event::setHandled | ( | bool | handled = true | ) | [inherited] |
Marks the event as handled, terminating the normal iteration of the event's slots.
| WindowRef cinder::app::Event::getWindow | ( | ) | const [inherited] |
Returns the Window in which the MouseEvent occurred.
| void cinder::app::Event::setWindow | ( | const WindowRef & | window | ) | [inherited] |
bool cinder::app::Event::mHandled [inherited] |
WindowRef cinder::app::Event::mWindow [inherited] |
Reimplemented in cinder::app::KeyEvent.