window.h

Go to the documentation of this file.

/*!****************************************************************//*!*
 * \file   window.h
 * \brief  Abstract, platform independent class definition module.
 * 
 * \author Sabitov Kirill
 * \date   22 June 2022
 *********************************************************************/
 
#pragma once
 
#include "input.h"
#include "../events/events.h"
#include "utilities/event/event_dispatcher.h"
 
namespace scl
{
    class window
    {
    public: 
        struct data
        {
        public:
            int  Width, Height;
            std::string Title;
 
            data() = default;
            data(const data &Other) = default;
            data(int Width, int Height, const std::string &Title) :
                Width(Width), Height(Height), Title(Title) {}
        };
 
        static const int ViewportId = 0;
 
    protected:
        window_handle Handle {};
        bool          IsInitialised { false };
        bool          IsFullscreen { false };
        data          Data {};
 
    public: 
        const data &GetWindowData() const { return Data; }
        const window_handle &GetHandle() const { return Handle; }
        bool GetIsInitialised() const { return IsInitialised; }
 
    public: 
        /*!**
         * Copying and moving constructors,
         * lvalue and rvalue copy assigment and move assigment operators
         * removal due to window concept (window loop execution at runtime).
         ***/
        window(const window &) = delete;
        window(const window &&) = delete;
        window &operator=(const window &) = delete;
        window &operator=(const window &&) = delete;
        window operator=(const window &) const = delete;
        window operator=(const window &&) const = delete;
 
        /*!*
         * Windows OS specific window construcotor.
         * Initialise window, but don't shows it and don't start message loop.
         * If initialisation successful 'IsStartupSuccess' would be set to true
         * and then window message loop could be started.
         *
         * \param Width - Width of the creating window in pixels.
         * \param Height - Height of creating window in pixels.
         * \param Name - Title of the creating window.
         * \param VSync - vertical syncrosination enabling flag.
         */
        window(int Width, int Height, const std::string &Title);
 
        /*!*
         * Create window depends on platform function.
         *
         * \param Width - Width of the creating window in pixels.
         * \param Height - Height of creating window in pixels.
         * \param Title - Title of the creating window.
         * \param VSync - vertical syncrosination enabling flag.
         * \Return Created window pointer.
         */
        static unique<window> Create(int Width, int Height, const std::string &Title);
 
        /*!*
         * Window update function.
         * 
         * \param None.
         * \return None.
         */
        virtual void Update() {}
 
        /*!*
         * Woggle window display mode (fullscreen/windowed) function.
         *
         * \param None.
         * \return None.
         */
        virtual void FlipFullscreen() {}
 
        /*!*
         * Change window title to specified.
         *
         * \param NewTitle - new window title.
         * \return None.
         */
        virtual void ChangeTitle(const std::string &NewTitle) {}
 
        /*!*
         * Window shut down function. Closes window and create window close event.
         * 
         * \param None.
         * \return None.
         */
        virtual void ShutDown() = 0;
    };
}