ecstasy::integration::event Namespace Reference

Event integration. More...

Classes
struct	Event
	Event class. More...
class	EventListeners
	Event listeners component type. More...
class	EventsManager
	Static helper class to handle ecstasy events. More...
class	Gamepad
	Current Gamepad state. More...
struct	GamepadAxisEvent
	Event describing a gamepad axis value change. More...
struct	GamepadButtonEvent
	Event describing a gamepad button pressed or released. More...
struct	GamepadButtonPressedEvent
	Event describing a gamepad button pressed. More...
struct	GamepadButtonReleasedEvent
	Event describing a gamepad button released. More...
class	GamepadCombinationListener
	Listener of a button combination. More...
struct	GamepadConnectedEvent
	Event describing a gamepad connection or disconnection. More...
class	Gamepads
	Current Gamepads states. More...
class	GamepadSequenceListener
	Listener of a button sequence. More...
class	Keyboard
	Current Keyboard state. More...
class	KeyCombinationListener
	Listener of a key combination. More...
struct	KeyEvent
	Event describing a key pressed or released. More...
struct	KeyPressedEvent
	Event describing a key pressed. More...
struct	KeyReleasedEvent
	Event describing a key released. More...
class	KeySequenceListener
	Listener of a key sequence. More...
class	Mouse
	Current mouse state. More...
struct	MouseButtonEvent
	Event describing when a mouse button is pressed or released. More...
struct	MouseButtonPressedEvent
	Event describing when a mouse button is pressed. More...
struct	MouseButtonReleasedEvent
	Event describing when a mouse button is released. More...
struct	MouseMoveEvent
	Event describing when the mouse move. More...
struct	MouseWheelScrollEvent
	Event describing when a mouse wheel is scrolled. More...
struct	TextEnteredEvent
	Event describing a text (character) entered. More...

Typedefs
template<typename E >
using	EventListener = std::function< void(Registry &, Entity, const E &)>
	Event listener component type.
using	GamepadAxisListener = EventListener< GamepadAxisEvent >
	GamepadAxisEvent listener.
using	GamepadButtonListener = EventListener< GamepadButtonEvent >
	GamepadButtonEvent listener.
using	GamepadConnectedListener = EventListener< GamepadConnectedEvent >
	GamepadConnectedEvent listener.
using	KeyListener = EventListener< KeyEvent >
	KeyEvent listener.
using	MouseButtonListener = EventListener< MouseButtonEvent >
	MouseButtonEvent listener.
using	MouseMoveListener = EventListener< MouseMoveEvent >
	MouseMoveEvent listener.
using	MouseWheelScrollListener = EventListener< MouseWheelScrollEvent >
	MouseWheelScrollEvent listener.
using	TextEnteredListener = EventListener< TextEnteredEvent >
	TextEnteredEvent listener.

Functions
template<typename E >
static void	callListeners (Registry &registry, const E &event)
static void	callKeyListeners (Registry &registry, const KeyEvent &event)
static void	callGamepadListeners (Registry &registry, const GamepadButtonEvent &event)

Detailed Description

Event integration.

Includes input states and event listeners for keyboard, mouse and gamepad.

Note

This is only a event handling integration: event detection is not included.

Enabled by ECSTASY_INTEGRATIONS_EVENT.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2022-11-18)

Typedef Documentation

EventListener

template<typename E >

using ecstasy::integration::event::EventListener = typedef std::function<void(Registry &, Entity, const E &)>

Event listener component type.

Template Parameters

E	Event type to listen to.

Author

Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since

1.0.0 (2022-11-18)

Definition at line 36 of file EventListeners.hpp.

GamepadAxisListener

using ecstasy::integration::event::GamepadAxisListener = typedef EventListener<GamepadAxisEvent>

GamepadAxisEvent listener.

Definition at line 22 of file GamepadAxisListener.hpp.

GamepadButtonListener

using ecstasy::integration::event::GamepadButtonListener = typedef EventListener<GamepadButtonEvent>

GamepadButtonEvent listener.

Definition at line 22 of file GamepadButtonListener.hpp.

GamepadConnectedListener

using ecstasy::integration::event::GamepadConnectedListener = typedef EventListener<GamepadConnectedEvent>

GamepadConnectedEvent listener.

Definition at line 22 of file GamepadConnectedListener.hpp.

KeyListener

using ecstasy::integration::event::KeyListener = typedef EventListener<KeyEvent>

KeyEvent listener.

Definition at line 22 of file KeyListener.hpp.

MouseButtonListener

using ecstasy::integration::event::MouseButtonListener = typedef EventListener<MouseButtonEvent>

MouseButtonEvent listener.

Definition at line 22 of file MouseButtonListener.hpp.

MouseMoveListener

using ecstasy::integration::event::MouseMoveListener = typedef EventListener<MouseMoveEvent>

MouseMoveEvent listener.

Definition at line 22 of file MouseMoveListener.hpp.

MouseWheelScrollListener

using ecstasy::integration::event::MouseWheelScrollListener = typedef EventListener<MouseWheelScrollEvent>

MouseWheelScrollEvent listener.

Definition at line 22 of file MouseWheelScrollListener.hpp.

TextEnteredListener

using ecstasy::integration::event::TextEnteredListener = typedef EventListener<TextEnteredEvent>

TextEnteredEvent listener.

Definition at line 22 of file TextEnteredListener.hpp.

Function Documentation

callGamepadListeners()

static void ecstasy::integration::event::callGamepadListeners ( Registry &  registry, const GamepadButtonEvent &  event  )

static

Definition at line 66 of file EventsManager.cpp.

    {
        for (auto [entity, listener, listeners, sequence, combination] :
            registry
                .select<Entities, Maybe<EventListener<GamepadButtonEvent>>, Maybe<EventListeners<GamepadButtonEvent>>,
                    Maybe<GamepadSequenceListener>, Maybe<GamepadCombinationListener>>()
                .where<Or<EventListener<GamepadButtonEvent>, EventListeners<GamepadButtonEvent>,
                    GamepadSequenceListener, GamepadCombinationListener>>()) {
            if (listener)
                listener.value()(registry, entity, event);
            if (listeners)
                listeners.value()(registry, entity, event);
            if (sequence && sequence.value().get().update(event))
                sequence.value()(registry, entity);
            if (combination && combination.value().get().update(event))
                combination.value()(registry, entity);
        }
    }

callKeyListeners()

static void ecstasy::integration::event::callKeyListeners ( Registry &  registry, const KeyEvent &  event  )

static

Definition at line 47 of file EventsManager.cpp.

    {
        for (auto [entity, listener, listeners, sequence, combination] :
            registry
                .select<Entities, Maybe<EventListener<KeyEvent>>, Maybe<EventListeners<KeyEvent>>,
                    Maybe<KeySequenceListener>, Maybe<KeyCombinationListener>>()
                .where<Or<EventListener<KeyEvent>, EventListeners<KeyEvent>, KeySequenceListener,
                    KeyCombinationListener>>()) {
            if (listener)
                listener.value()(registry, entity, event);
            if (listeners)
                listeners.value()(registry, entity, event);
            if (sequence && sequence.value().get().update(event))
                sequence.value()(registry, entity);
            if (combination && combination.value().get().update(event))
                combination.value()(registry, entity);
        }
    }

callListeners()

template<typename E >

static void ecstasy::integration::event::callListeners ( Registry &  registry, const E &  event  )

static

Definition at line 35 of file EventsManager.cpp.

    {
        for (auto [entity, listener, listeners] :
            registry.select<Entities, Maybe<EventListener<E>>, Maybe<EventListeners<E>>>()
                .template where<Or<EventListener<E>, EventListeners<E>>>()) {
            if (listener)
                listener.value()(registry, entity, event);
            if (listeners)
                listeners.value()(registry, entity, event);
        }
    }