Window.h

Go to the documentation of this file.

#pragma once

// STD. includes
#include <iostream>
#define GL_SILENCE_DEPRECATION
// GLEW
#include <GL/glew.h>
// GLFW
#include <GLFW/glfw3.h>
#include <glm/glm.hpp>

#include <src/utils/glassert.h>

namespace fireworks { namespace graphics {

#define MAX_KEYS     1024
#define MAX_BUTTONS  32

    enum Keys
    {
        UNKNOWN = GLFW_KEY_UNKNOWN,
        SPACE = GLFW_KEY_SPACE,
        APOSTROPHE = GLFW_KEY_APOSTROPHE,
        COMMA = GLFW_KEY_COMMA,
        MINUS = GLFW_KEY_MINUS,
        PERIOD = GLFW_KEY_PERIOD,
        SLASH = GLFW_KEY_SLASH,
        NUM0 = GLFW_KEY_0,
        NUM1 = GLFW_KEY_1,
        NUM2 = GLFW_KEY_2,
        NUM3 = GLFW_KEY_3,
        NUM4 = GLFW_KEY_4,
        NUM5 = GLFW_KEY_5,
        NUM6 = GLFW_KEY_6,
        NUM7 = GLFW_KEY_7,
        NUM8 = GLFW_KEY_8,
        NUM9 = GLFW_KEY_9,
        SEMICOLON = GLFW_KEY_SEMICOLON,
        EQUAL = GLFW_KEY_EQUAL,
        A = GLFW_KEY_A,
        B = GLFW_KEY_B,
        C = GLFW_KEY_C,
        D = GLFW_KEY_D,
        E = GLFW_KEY_E,
        F = GLFW_KEY_F,
        G = GLFW_KEY_G,
        H = GLFW_KEY_H,
        I = GLFW_KEY_I,
        J = GLFW_KEY_J,
        K = GLFW_KEY_K,
        L = GLFW_KEY_L,
        M = GLFW_KEY_M,
        N = GLFW_KEY_N,
        O = GLFW_KEY_O,
        P = GLFW_KEY_P,
        Q = GLFW_KEY_Q,
        R = GLFW_KEY_R,
        S = GLFW_KEY_S,
        T = GLFW_KEY_T,
        U = GLFW_KEY_U,
        V = GLFW_KEY_V,
        W = GLFW_KEY_W,
        X = GLFW_KEY_X,
        Y = GLFW_KEY_Y,
        Z = GLFW_KEY_Z,
        LEFT_BRACKET = GLFW_KEY_LEFT_BRACKET,
        BACKSLASH = GLFW_KEY_BACKSLASH,
        RIGHT_BRACKET = GLFW_KEY_RIGHT_BRACKET,
        GRAVE_ACCENT = GLFW_KEY_GRAVE_ACCENT,
        WORLD_1 = GLFW_KEY_WORLD_1,
        WORLD_2 = GLFW_KEY_WORLD_2,
        ESCAPE = GLFW_KEY_ESCAPE,
        ENTER = GLFW_KEY_ENTER,
        TAB = GLFW_KEY_TAB,
        BACKSPACE = GLFW_KEY_BACKSPACE,
        INSERT = GLFW_KEY_INSERT,
        DELETE = GLFW_KEY_DELETE,
        RIGHT = GLFW_KEY_RIGHT,
        LEFT = GLFW_KEY_LEFT,
        DOWN = GLFW_KEY_DOWN,
        UP = GLFW_KEY_UP,
        PAGE_UP = GLFW_KEY_PAGE_UP,
        PAGE_DOWN = GLFW_KEY_PAGE_DOWN,
        HOME = GLFW_KEY_HOME,
        END = GLFW_KEY_END,
        CAPS_LOCK = GLFW_KEY_CAPS_LOCK,
        SCROLL_LOCK = GLFW_KEY_SCROLL_LOCK,
        NUM_LOCK = GLFW_KEY_NUM_LOCK,
        PRINT_SCREEN = GLFW_KEY_PRINT_SCREEN,
        PAUSE = GLFW_KEY_PAUSE,
        F1 = GLFW_KEY_F1,
        F2 = GLFW_KEY_F2,
        F3 = GLFW_KEY_F3,
        F4 = GLFW_KEY_F4,
        F5 = GLFW_KEY_F5,
        F6 = GLFW_KEY_F6,
        F7 = GLFW_KEY_F7,
        F8 = GLFW_KEY_F8,
        F9 = GLFW_KEY_F9,
        F10 = GLFW_KEY_F10,
        F11 = GLFW_KEY_F11,
        F12 = GLFW_KEY_F12,
        F13 = GLFW_KEY_F13,
        F14 = GLFW_KEY_F14,
        F15 = GLFW_KEY_F15,
        F16 = GLFW_KEY_F16,
        F17 = GLFW_KEY_F17,
        F18 = GLFW_KEY_F18,
        F19 = GLFW_KEY_F19,
        F20 = GLFW_KEY_F20,
        F21 = GLFW_KEY_F21,
        F22 = GLFW_KEY_F22,
        F23 = GLFW_KEY_F23,
        F24 = GLFW_KEY_F24,
        F25 = GLFW_KEY_F25,
        KP_0 = GLFW_KEY_KP_0,
        KP_1 = GLFW_KEY_KP_1,
        KP_2 = GLFW_KEY_KP_2,
        KP_3 = GLFW_KEY_KP_3,
        KP_4 = GLFW_KEY_KP_4,
        KP_5 = GLFW_KEY_KP_5,
        KP_6 = GLFW_KEY_KP_6,
        KP_7 = GLFW_KEY_KP_7,
        KP_8 = GLFW_KEY_KP_8,
        KP_9 = GLFW_KEY_KP_9,
        KP_DECIMAL = GLFW_KEY_KP_DECIMAL,
        KP_DIVIDE = GLFW_KEY_KP_DIVIDE,
        KP_MULTIPLY = GLFW_KEY_KP_MULTIPLY,
        KP_SUBTRACT = GLFW_KEY_KP_SUBTRACT,
        KP_ADD = GLFW_KEY_KP_ADD,
        KP_ENTER = GLFW_KEY_KP_ENTER,
        KP_EQUAL = GLFW_KEY_KP_EQUAL,
        LEFT_SHIFT = GLFW_KEY_LEFT_SHIFT,
        LEFT_CONTROL = GLFW_KEY_LEFT_CONTROL,
        LEFT_ALT = GLFW_KEY_LEFT_ALT,
        LEFT_SUPER = GLFW_KEY_LEFT_SUPER,
        RIGHT_SHIFT = GLFW_KEY_RIGHT_SHIFT,
        RIGHT_CONTROL = GLFW_KEY_RIGHT_CONTROL,
        RIGHT_ALT = GLFW_KEY_RIGHT_ALT,
        RIGHT_SUPER = GLFW_KEY_RIGHT_SUPER,
        MENU = GLFW_KEY_MENU,
        MOUSE_BUTTON_1 = GLFW_MOUSE_BUTTON_1,
        MOUSE_BUTTON_2 = GLFW_MOUSE_BUTTON_2,
        MOUSE_BUTTON_3 = GLFW_MOUSE_BUTTON_3,
        MOUSE_BUTTON_4 = GLFW_MOUSE_BUTTON_4,
        MOUSE_BUTTON_5 = GLFW_MOUSE_BUTTON_5,
        MOUSE_BUTTON_6 = GLFW_MOUSE_BUTTON_6,
        MOUSE_BUTTON_7 = GLFW_MOUSE_BUTTON_7,
        MOUSE_BUTTON_8 = GLFW_MOUSE_BUTTON_8,
        MOUSE_BUTTON_LAST = GLFW_MOUSE_BUTTON_LAST,
        MOUSE_BUTTON_LEFT = GLFW_MOUSE_BUTTON_LEFT,
        MOUSE_BUTTON_RIGHT = GLFW_MOUSE_BUTTON_RIGHT,
        MOUSE_BUTTON_MIDDLE = GLFW_MOUSE_BUTTON_MIDDLE
    };

    // Forward decelerations of friend functions
    static void glfw_initialisation_error(int error, const char* description);
    static void key_callback(GLFWwindow* window, int key, int scancode, int action, int mods);
    static void window_resize_callback(GLFWwindow* window, int width, int height);
    static void mouse_button_callback(GLFWwindow* window, int button, int action, int mods);
    static void mouse_position_callback(GLFWwindow* window, double xpos, double ypos);

    class Window
    {
    public:
        glm::vec4 backgroundColor;
        float deltaMouseX;
        float deltaMouseY;
    private:
        // FIXME: probably use a custom string class later instead of std::string or char*(character pointer)'s
        const char*     m_Title;
        int m_Width,    m_Height;
        GLFWwindow*     m_Window;
        bool            m_Closed;
        bool            m_HeldKeys[MAX_KEYS];
        bool            m_PressedKeys[MAX_KEYS];
        bool            m_ReleasedKeys[MAX_KEYS];
        bool            m_HeldMouseButtons[MAX_BUTTONS];
        bool            m_PressedMouseButtons[MAX_BUTTONS];
        bool            m_ReleasedMouseButtons[MAX_BUTTONS];
        double          m_MouseX = 0;
        double          m_MouseY = 0;
        bool            firstMouse;
        float           lastMouseX;
        float           lastMouseY;
    public:
        Window(const char *title, int width, int height);

        ~Window();

        void clear() const;

        void update() const;

        bool closed() const;

        inline int getWidth() const { return m_Width; }

        inline int getHeight() const { return m_Height; }

        inline GLFWwindow* getGLFWwindow() const { return m_Window; }

        bool isKeyPressed(unsigned int keycode);

        bool isKeyReleased(unsigned int keycode);

        bool isKeyHeld(unsigned int keycode) const;

        bool isMouseButtonPressed(unsigned int button);

        // TODO: To be implemented
        bool isMouseButtonReleased(unsigned int button);

        bool isMouseButtonHeld(unsigned int button) const;

        // TODO: Make the function return a Vec2 once the engine specific vector math API is added to the namespace
        void getMousePosition(double& x, double& y) const;
    private :
        bool init();
        // TODO: Add reference to the GLFW keycode Enums list for the key parameter and also for the mods param(add the reference to the bit fields)

        friend void key_callback(GLFWwindow* window, int key, int scancode, int action, int mods);

        friend void window_resize_callback(GLFWwindow* window, int width, int height);

        // TODO: Add reference to the GLFW mouse_button Enums list for the button parameter and also for the mods param(add the reference to the bit fields)
        friend void mouse_button_callback(GLFWwindow* window, int button, int action, int mods);

        friend void mouse_position_callback(GLFWwindow* window, double xpos, double ypos);
    };

} }