utility::event::MouseButtonEvent Class Reference

Mouse button event. More...

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

Inheritance diagram for utility::event::MouseButtonEvent:

Collaboration diagram for utility::event::MouseButtonEvent:

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

Public Types
enum class	Button : std::uint8_t {   Unknown = 0 , Left = 1 , Middle = 2 , Right = 3 ,   X1 = 4 , X2 = 5 }
	Mouse buttons enumeration. More...
using	MousePosition = math::Vector2F

Public Member Functions
	MouseButtonEvent (void)
	Default constructor.
	~MouseButtonEvent (void) override
	Default destructor.
MouseButtonEvent &	setPosition (const MousePosition &position) noexcept
	Set the current mouse position.
MousePosition	getPosition (void) const noexcept
	Get the current mouse position.
MouseButtonEvent &	setButton (const Button button) noexcept
	Set the state of a mouse button.
Button	getButton (void) const noexcept
	Get the current mouse button.
MouseButtonEvent &	setPressed (const bool pressed) noexcept
	Set the pressed state of the button.
bool	isButtonPressed (void) const noexcept
	Get the pressed state of the button.
Public Member Functions inherited from utility::event::Event
	Event (void)=default
	Default constructor.
virtual	~Event (void)=default
	Virtual destructor.

Detailed Description

Mouse button event.

Represents mouse button presses/releases with position and button states.

Definition at line 41 of file mouse_button_event.hpp.

Member Typedef Documentation

MousePosition

using utility::event::MouseButtonEvent::MousePosition = math::Vector2F

Type alias for mouse position as a 2D unsigned integer vector (x, y)

Definition at line 44 of file mouse_button_event.hpp.

Member Enumeration Documentation

Button

enum class utility::event::MouseButtonEvent::Button : std::uint8_t

strong

Mouse buttons enumeration.

Definition at line 51 of file mouse_button_event.hpp.

Member Function Documentation

getButton()

MouseButtonEvent::Button utility::event::MouseButtonEvent::getButton ( void  ) const

noexcept

Get the current mouse button.

Returns

The current button.

Definition at line 64 of file mouse_button_event.cpp.

getPosition()

MouseButtonEvent::MousePosition utility::event::MouseButtonEvent::getPosition ( void  ) const

noexcept

Get the current mouse position.

Returns

The mouse position as a 2D vector (x, y).

Definition at line 53 of file mouse_button_event.cpp.

isButtonPressed()

bool utility::event::MouseButtonEvent::isButtonPressed ( void  ) const

noexcept

Get the pressed state of the button.

Returns

True if the button is pressed, false otherwise.

Definition at line 75 of file mouse_button_event.cpp.

setButton()

MouseButtonEvent & utility::event::MouseButtonEvent::setButton ( const Button  button )

noexcept

Set the state of a mouse button.

Parameters

button

The mouse button to set.

Returns

Reference to this MouseButtonEvent for method chaining.

Definition at line 58 of file mouse_button_event.cpp.

setPosition()

MouseButtonEvent & utility::event::MouseButtonEvent::setPosition ( const MousePosition &  position )

noexcept

Set the current mouse position.

Parameters

position

The mouse position as a 2D vector (x, y).

Returns

Reference to this MouseButtonEvent for method chaining.

Definition at line 46 of file mouse_button_event.cpp.

setPressed()

MouseButtonEvent & utility::event::MouseButtonEvent::setPressed ( const bool  pressed )

noexcept

Set the pressed state of the button.

Parameters

pressed

True if the button is pressed, false if released.

Returns

Reference to this MouseButtonEvent for method chaining.

Definition at line 69 of file mouse_button_event.cpp.

---

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

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