Loading...
Searching...
No Matches
Quasar::MouseScrolledEvent Class Referencefinal
Sent when the mouse wheel or the touchpad scrolls. More...
#include <quasar/events/MouseEvent.h>
Inheritance diagram for Quasar::MouseScrolledEvent:
Public Member Functions | |
| MouseScrolledEvent (float xOffset, float yOffset) | |
| Creates the event with the scroll offsets. | |
| float | GetXOffset () const |
| Returns the horizontal offset. It is positive when scrolling to the right. | |
| float | GetYOffset () const |
| Returns the vertical offset. It is positive when the wheel turns away from the user. | |
| std::string | ToString () const override |
| Returns the event with the offsets, for example "MouseScrolled: 0, 1". | |
| Public Member Functions inherited from Quasar::EventOf< EventType::MouseScrolled, EventCategory::Input|EventCategory::Mouse > | |
| EventType | GetType () const override |
| Returns the type of the event. | |
| EventCategory | GetCategories () const override |
| Returns all the categories of the event. | |
| Public Member Functions inherited from Quasar::Event | |
| const char * | GetName () const |
| Returns the name of the type of the event, for example "KeyPressed". | |
| bool | IsInCategory (EventCategory category) const |
| Returns true if the event belongs to the given category. | |
| bool | IsHandled () const |
| Returns true if the event was handled. | |
| void | SetHandled (bool handled) |
| Marks the event as handled, or not handled. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Quasar::EventOf< EventType::MouseScrolled, EventCategory::Input|EventCategory::Mouse > | |
| static constexpr EventType | GetStaticType () |
| Returns the type of this event class. | |
| Protected Member Functions inherited from Quasar::Event | |
| Event ()=default | |
| Creates an event that is not handled. | |
Detailed Description
Sent when the mouse wheel or the touchpad scrolls.
A standard mouse wheel only gives vertical offsets, of 1 per notch. Touchpads also give horizontal offsets, with fractional values.
Member Function Documentation
◆ ToString()
|
inlineoverridevirtual |
Returns the event with the offsets, for example "MouseScrolled: 0, 1".
Reimplemented from Quasar::Event.
The documentation for this class was generated from the following file:
- quasar/events/MouseEvent.h
