utility::event::MouseWheelEvent Class Reference

Mouse wheel event. More...

#include <headers/utility/event/mouse_wheel_event.hpp>

Inheritance diagram for utility::event::MouseWheelEvent:

Collaboration diagram for utility::event::MouseWheelEvent:

Classes
class	Factory
	Factory for creating MouseWheelEvent instances. More...

Public Member Functions
	MouseWheelEvent (void)
	Default constructor.
	~MouseWheelEvent (void) override
	Default destructor.
MouseWheelEvent &	setOffset (const math::Vector2F &offset) noexcept
	Set the scroll offset.
math::Vector2F	getOffset (void) const noexcept
	Get the scroll offset.
Public Member Functions inherited from utility::event::Event
	Event (void)=default
	Default constructor.
virtual	~Event (void)=default
	Virtual destructor.

Detailed Description

Mouse wheel event.

Represents mouse wheel scroll with offset values.

Definition at line 39 of file mouse_wheel_event.hpp.

Constructor & Destructor Documentation

MouseWheelEvent()

utility::event::MouseWheelEvent::MouseWheelEvent ( void  )

explicit

Default constructor.

Definition at line 43 of file mouse_wheel_event.cpp.

~MouseWheelEvent()

utility::event::MouseWheelEvent::~MouseWheelEvent ( void  )

override

Default destructor.

Definition at line 47 of file mouse_wheel_event.cpp.

Member Function Documentation

getOffset()

math::Vector2F utility::event::MouseWheelEvent::getOffset ( void  ) const

noexcept

Get the scroll offset.

Returns

The scroll offset as a 2D vector (x, y).

Definition at line 58 of file mouse_wheel_event.cpp.

setOffset()

MouseWheelEvent & utility::event::MouseWheelEvent::setOffset ( const math::Vector2F &  offset )

noexcept

Set the scroll offset.

Parameters

offset

The scroll offset as a 2D vector (x, y). Positive y typically means scroll up/away from user. Positive x typically means scroll right.

Returns

Reference to this MouseWheelEvent for method chaining.

Definition at line 52 of file mouse_wheel_event.cpp.

---

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

• headers/utility/event/mouse_wheel_event.hpp
• sources/event/mouse_wheel_event.cpp