KeySequenceListener.hpp

Go to the documentation of this file.

 
 
#ifndef ECSTASY_INTEGRATIONS_EVENT_LISTENERS_KEYSEQUENCELISTENER_HPP_
#define ECSTASY_INTEGRATIONS_EVENT_LISTENERS_KEYSEQUENCELISTENER_HPP_
 
#include <functional>
#include <vector>
#include "ecstasy/integrations/event/inputs/Keyboard.hpp"
#include "ecstasy/resources/entity/Entity.hpp"
 
namespace ecstasy
{
    class Registry;
}
 
namespace ecstasy::integration::event
{
    struct KeyEvent;
 
    class KeySequenceListener {
      public:
        using Callback = std::function<void(Registry &, Entity, const KeySequenceListener &)>;
 
        KeySequenceListener(const std::vector<Keyboard::Key> &sequence, Callback callback) noexcept;
 
        ~KeySequenceListener() noexcept = default;
 
        bool update(const KeyEvent &event) noexcept;
 
        [[nodiscard]] bool isComplete() const noexcept;
 
        void reset() noexcept;
 
        void operator()(Registry &registry, Entity e, bool force = false);
 
        void setSequence(const std::vector<Keyboard::Key> &newSequence) noexcept;
 
        [[nodiscard]] constexpr const std::vector<Keyboard::Key> &getSequence() const noexcept
        {
            return _sequence;
        }
 
        [[nodiscard]] constexpr std::vector<Keyboard::Key> &getSequence() noexcept
        {
            return _sequence;
        }
 
        [[nodiscard]] constexpr const Callback &getCallback() const noexcept
        {
            return _callback;
        }
 
        // clang-format off
        // clang-format on
        [[nodiscard]] constexpr Keyboard::Key getHeldKey() const noexcept
        {
            return _heldKey;
        }
 
        [[nodiscard]] constexpr const std::vector<Keyboard::Key> &getValidatedKeys() const noexcept
        {
            return _validatedKeys;
        }
 
      private:
        // Sequence to watch for.
        std::vector<Keyboard::Key> _sequence;
        // Validated keys.
        std::vector<Keyboard::Key> _validatedKeys;
        // Current key held (if any, @ref Keyboard::Key::Unknown otherwise).
        Keyboard::Key _heldKey;
        // Callback called when the sequence is validated.
        Callback _callback;
    };
} // namespace ecstasy::integration::event
 
#endif /* !ECSTASY_INTEGRATIONS_EVENT_LISTENERS_KEYSEQUENCELISTENER_HPP_ */