Keyboard.h

Go to the documentation of this file.

#pragma once
#include "../FoundationBase.h"
 
#include <variant>
#include <vector>
#include <string>
 
namespace Cogs
{
  enum class Key
  {
    A,          B,            C,            D,            E,
    F,          G,            H,            I,            J,
    K,          L,            M,            N,            O,
    P,          Q,            R,            S,            T,
    U,          V,            W,            X,            Y,
    Z,
 
    Zero,       One,          Two,          Three,        Four,
    Five,       Six,          Seven,        Eight,        Nine,
 
    Left,       Right,        Up,           Down,
 
    Shift,      LeftShift,    RightShift,
    Control,    LeftControl,  RightControl,
    Alt,        LeftAlt,      RightAlt,
 
    CapsLock,
    Tab,
    Escape,
    Enter,
    Space,
 
    Insert,     Delete,       Backspace,
    Home,       End,
    PageUp,     PageDown,
 
    F1,         F2,           F3,           F4,
    F5,         F6,           F7,           F8,
    F9,         F10,          F11,          F12,
 
    Count,
    None = -1,
  };
 
  class COGSFOUNDATION_API Keyboard
  {
  public:
    struct State
    {
      bool keysDown[static_cast<size_t>(Key::Count)] = {}; 
      std::string chars; 
    };
 
    struct Event {
      enum class Type {
        Press,
        Release,
        AddChar,
        Reset
      };
 
      Type type;  
      double timestamp_ms; 
 
      std::variant<Key, std::string> data;
    };
 
    void update(); 
 
    void submitKeyDown(Key key, double timestamp); 
    void submitKeyUp(Key key, double timestamp); 
    void submitChar(std::string ch, double timestamp); 
    void submitReset(double timestamp); 
 
    // Convenience getters.
    bool isKeyDown(Key key) const { return state.keysDown[static_cast<size_t>(key)]; }
    bool isKeyUp(Key key) const { return !isKeyDown(key); }
    bool hasChar(std::string_view ch) const { return state.chars.find(ch) != std::string::npos; }
    bool wasKeyPressed(Key key) const; 
    bool wasKeyReleased(Key key) const; 
 
    // Getters for the full state and events.
    const State& getState() const { return state; }
    const std::vector<Event>& getEvents() const { return events; }
 
  private:
    State state;
    std::vector<Event> events;
 
    std::vector<Event> eventQueue;
  };
}