spark::events::MouseScrolledEvent Class Reference

A class representing a mouse scrolled event. More...

#include <MouseEvents.h>

Inheritance diagram for spark::events::MouseScrolledEvent:

Public Member Functions
	MouseScrolledEvent (float offset)
	Instantiates a new MouseScrolledEvent for the given offsets.
float	offset () const
	Gets the scroll offset.
Public Member Functions inherited from spark::events::Event
	Event (const Event &other)=default
	Event (Event &&other) noexcept=default
Event &	operator= (const Event &other)=default
Event &	operator= (Event &&other) noexcept=default
virtual EventType	eventType () const =0
	Gets the type of the event.
virtual int	eventCategoryFlags () const =0
	Gets the category flags of the event.
bool	isInCategory (const EventCategory &category) const
	Checks if the event is in the specified category.
Public Member Functions inherited from spark::rtti::HasRtti
	HasRtti (const HasRtti &other)=default
	HasRtti (HasRtti &&other) noexcept=default
HasRtti &	operator= (const HasRtti &other)=default
HasRtti &	operator= (HasRtti &&other) noexcept=default
virtual RttiBase &	rttiInstance () const =0

Additional Inherited Members
Public Attributes inherited from spark::events::Event
bool	handled = false

Detailed Description

A class representing a mouse scrolled event.

Constructor & Destructor Documentation

MouseScrolledEvent()

spark::events::MouseScrolledEvent::MouseScrolledEvent ( float offset )

explicit

Instantiates a new MouseScrolledEvent for the given offsets.

Parameters

offset

The offset of the mouse wheel from the previous position.

Member Function Documentation

offset()

float spark::events::MouseScrolledEvent::offset ( ) const

nodiscard

Gets the scroll offset.

Returns

A float representing the scroll offset from the previous position.