Class MouseButtonEvent

• Defined in File MouseEvent.h

Inheritance Relationships

Base Type

• public TRAP::Events::Event (Class Event)

Derived Types

• public TRAP::Events::MouseButtonPressEvent (Class MouseButtonPressEvent)

• public TRAP::Events::MouseButtonReleaseEvent (Class MouseButtonReleaseEvent)

Class Documentation

class MouseButtonEvent : public TRAP::Events::Event

Mouse button event base class.

Remark

Headless mode: This class is not available in headless mode.

Subclassed by TRAP::Events::MouseButtonPressEvent, TRAP::Events::MouseButtonReleaseEvent

Public Functions

consteval MouseButtonEvent(const MouseButtonEvent&) noexcept = delete

Copy constructor.

consteval MouseButtonEvent &operator=(const MouseButtonEvent&) noexcept = delete

Copy assignment operator.

constexpr ~MouseButtonEvent() override = default

Destructor.

constexpr Input::MouseButton GetMouseButton() const noexcept

Retrieve the affected mouse button.

Returns:

Mouse button.

virtual constexpr EventCategory GetCategoryFlags() const noexcept override

Retrieve the category flags of the event.

Returns:

Combination of one or more EventCategory’s.

Protected Functions

explicit constexpr MouseButtonEvent(Input::MouseButton button) noexcept

Constructor.

Parameters:

button – Affected mouse button.

constexpr MouseButtonEvent(MouseButtonEvent&&) noexcept = default

Move constructor.

constexpr MouseButtonEvent &operator=(MouseButtonEvent&&) noexcept = default

Move assignment operator.