Base class for mouse button events. More...

#include <MouseEvent.h>

Inheritance diagram for Muto::MouseButtonEvent:

Public Member Functions
int	GetMouseButton () const
	Get the mouse button associated with the event.

Public Member Functions inherited from Muto::Event
virtual int	GetCategoryFlags () const =0
	Get the category flags of the event.

virtual EventType	GetEventType () const =0
	Get the type of the event.

virtual const char *	GetName () const =0
	Get the name of the event.

bool	IsInCategory (EventCategory category)
	Check if the event is in a specific category.

virtual std::string	ToString () const
	Convert the event to a string representation.

virtual	~Event ()=default

Protected Member Functions
	MouseButtonEvent (int button)
	Construct a MouseButtonEvent with the specified button.

Protected Attributes
int	m_Button

Additional Inherited Members
Public Attributes inherited from Muto::Event
bool	Handled = false
	Indicates whether the event has been handled.

Detailed Description

Base class for mouse button events.

Constructor & Destructor Documentation

◆ MouseButtonEvent()

Muto::MouseButtonEvent::MouseButtonEvent ( int button )

inlineprotected

Construct a MouseButtonEvent with the specified button.

Parameters

button The mouse button associated with the event. Restricted specific construction to derived classes.

93 : m_Button(button) {

94 }

Muto::MouseButtonEvent::m_Button

int m_Button

Definition MouseEvent.h:95

Muto::CreateScope

constexpr Scope< T > CreateScope(Args &&... args)

Creates a Scope (unique_ptr) for the given type and constructor arguments.

Definition Defines_Macros.h:51

References m_Button.

Referenced by Muto::MouseButtonPressedEvent::MouseButtonPressedEvent(), and Muto::MouseButtonReleasedEvent::MouseButtonReleasedEvent().

Member Function Documentation

◆ GetMouseButton()

int Muto::MouseButtonEvent::GetMouseButton ( ) const

inline

Get the mouse button associated with the event.

84{ return m_Button; }

References m_Button.

Referenced by Muto::MouseButtonPressedEvent::ToString(), and Muto::MouseButtonReleasedEvent::ToString().

Member Data Documentation

◆ m_Button

int Muto::MouseButtonEvent::m_Button

protected

Referenced by GetMouseButton(), and MouseButtonEvent().

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

Muto/src/Events/MouseEvent.h

Public Member Functions

Protected Member Functions

Protected Attributes