Window.h

Go to the documentation of this file.

#pragma once
 
#include <memory>
#include <filesystem>
#include <string>
#include <vector>
#include <unordered_set>
#include <spdlog/spdlog.h>
#include "ship/window/MouseStateManager.h"
#include "ship/controller/controldevice/controller/mapping/keyboard/KeyboardScancodes.h"
#include "ship/core/Component.h"
 
namespace Ship {
class Gui;
class GuiWindow;
 
struct Coords {
    int32_t x;
    int32_t y;
};
 
struct CoordsF {
    float x;
    float y;
};
 
struct WindowRect {
    int32_t Left;
    int32_t Top;
    int32_t Right;
    int32_t Bottom;
};
 
class Config;
 
class Window : public Component {
    friend class Context;
 
  public:
    explicit Window(std::shared_ptr<Config> config = nullptr);
    Window(const std::vector<std::shared_ptr<GuiWindow>>& guiWindows, std::shared_ptr<Config> config = nullptr);
    Window(std::shared_ptr<Gui> gui, std::shared_ptr<Config> config = nullptr);
    Window(std::shared_ptr<Gui> gui, std::shared_ptr<MouseStateManager> mouseStateManager,
           std::shared_ptr<Config> config = nullptr);
    virtual ~Window();
 
    virtual void Close() = 0;
    virtual void RunGuiOnly() = 0;
    virtual void StartFrame() = 0;
    virtual void EndFrame() = 0;
    virtual bool IsFrameReady() = 0;
    virtual void HandleEvents() = 0;
    virtual void SetCursorVisibility(bool visible) = 0;
    virtual uint32_t GetWidth() = 0;
    virtual uint32_t GetHeight() = 0;
    virtual float GetAspectRatio() = 0;
    virtual int32_t GetPosX() = 0;
    virtual int32_t GetPosY() = 0;
    virtual void SetMousePos(Coords pos) = 0;
    virtual Coords GetMousePos() = 0;
    virtual Coords GetMouseDelta() = 0;
    virtual CoordsF GetMouseWheel() = 0;
    virtual bool GetMouseState(MouseBtn btn) = 0;
    virtual void SetMouseCapture(bool capture) = 0;
    virtual bool IsMouseCaptured() = 0;
    virtual uint32_t GetCurrentRefreshRate() = 0;
    virtual bool SupportsWindowedFullscreen() = 0;
    virtual bool CanDisableVerticalSync() = 0;
    virtual void SetResolutionMultiplier(float multiplier) = 0;
    virtual void SetMsaaLevel(uint32_t value) = 0;
    virtual void SetFullscreen(bool isFullscreen) = 0;
    virtual bool IsFullscreen() = 0;
    virtual bool IsRunning() = 0;
    virtual const char* GetKeyName(int32_t scancode) = 0;
    virtual uintptr_t GetGfxFrameBuffer() = 0;
 
    virtual void SetCurrentDimensions(uint32_t width, uint32_t height) = 0;
    virtual void SetCurrentDimensions(uint32_t width, uint32_t height, int32_t posX, int32_t posY) = 0;
    virtual void SetCurrentDimensions(bool isFullscreen, uint32_t width, uint32_t height) = 0;
    virtual void SetCurrentDimensions(bool isFullscreen, uint32_t width, uint32_t height, int32_t posX,
                                      int32_t posY) = 0;
    virtual WindowRect GetPrimaryMonitorRect() = 0;
 
    int32_t GetWindowBackend();
    virtual std::string GetWindowBackendName();
    std::shared_ptr<std::vector<int32_t>> GetAvailableWindowBackends();
    bool IsAvailableWindowBackend(int32_t backendId);
    int32_t GetLastScancode();
    void SetLastScancode(int32_t scanCode);
    void ToggleFullscreen();
    float GetCurrentAspectRatio();
    void SaveWindowToConfig();
    std::shared_ptr<Gui> GetGui();
    bool ShouldAutoCaptureMouse();
    void SetAutoCaptureMouse(bool capture);
    bool ShouldForceCursorVisibility();
    void SetForceCursorVisibility(bool visible);
    int32_t GetFullscreenScancode();
    int32_t GetMouseCaptureScancode();
    void SetFullscreenScancode(int32_t scancode);
    void SetMouseCaptureScancode(int32_t scancode);
    std::shared_ptr<MouseStateManager> GetMouseStateManager();
 
  protected:
    void OnInit(const nlohmann::json& initArgs) override;
    void SetWindowBackend(int32_t backend);
    void AddAvailableWindowBackend(int32_t backend);
    int32_t GetSavedWindowBackend();
 
    std::shared_ptr<Config> GetConfig() const;
 
  private:
    std::shared_ptr<Gui> mGui;
    int32_t mLastScancode = -1;
    int32_t mWindowBackend;
    std::shared_ptr<MouseStateManager> mMouseStateManager;
    std::shared_ptr<std::vector<int32_t>> mAvailableWindowBackends;
    // Hold a reference to Config because Window has a Save function called on Context destructor, where the singleton
    // is no longer available.
    std::shared_ptr<Config> mConfig;
    int32_t mFullscreenScancode;
    int32_t mMouseCaptureScancode;
};
} // namespace Ship