Window.h

// Copyright (c) 2016-2018 Kiwano - Nomango
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
 
#pragma once
#include <kiwano/core/Common.h>
#include <kiwano/base/ObjectBase.h>
#include <kiwano/event/Event.h>
#include <kiwano/math/Math.h>
 
namespace kiwano
{
 
enum class CursorType
{
    Arrow,      
    TextInput,  
    Hand,       
    SizeAll,    
    SizeWE,     
    SizeNS,     
    SizeNESW,   
    SizeNWSE,   
    No,         
};
 
struct Resolution
{
    uint32_t width        = 0;  
    uint32_t height       = 0;  
    uint32_t refresh_rate = 0;  
 
    Resolution() = default;
 
    Resolution(uint32_t width, uint32_t height, uint32_t refresh_rate)
        : width(width)
        , height(height)
        , refresh_rate(refresh_rate)
    {
    }
};
 
struct Icon
{
    Icon() = default;
 
    Icon(StringView file_path)
        : file_path(file_path)
    {
    }
 
    String file_path;  
 
#if defined(KGE_PLATFORM_WINDOWS)
    uint32_t resource_id = 0;  
 
    Icon(uint32_t resource_id)
        : resource_id(resource_id)
    {
    }
#endif
};
 
struct WindowConfig
{
    uint32_t width  = 640;            
    uint32_t height = 480;            
    String   title  = "Kiwano Game";  
    Icon     icon;                    
    bool     resizable  = false;      
    bool     fullscreen = false;      
};
 
#if defined(KGE_PLATFORM_WINDOWS)
typedef HWND WindowHandle;
#endif
 
class KGE_API Window : public ObjectBase
{
public:
    static RefPtr<Window> Create(const WindowConfig& config);
 
    String GetTitle() const;
 
    int GetPosX() const;
 
    int GetPosY() const;
 
    Size GetLogicalSize() const;
 
    uint32_t GetRealWidth() const;
 
    uint32_t GetRealHeight() const;
 
    float GetDPI() const;
 
    float GetDPIScale() const;
 
    Resolution GetCurrentResolution() const;
 
    WindowHandle GetHandle() const;
 
    virtual Vector<Resolution> GetResolutions() = 0;
 
    virtual void SetTitle(StringView title) = 0;
 
    virtual void SetIcon(Icon icon) = 0;
 
    virtual void SetResolution(uint32_t width, uint32_t height, bool fullscreen) = 0;
 
    virtual void SetMinimumSize(uint32_t width, uint32_t height) = 0;
 
    virtual void SetMaximumSize(uint32_t width, uint32_t height) = 0;
 
    virtual void SetCursor(CursorType cursor) = 0;
 
    RefPtr<Event> PollEvent();
 
    void PushEvent(RefPtr<Event> evt);
 
    virtual void PumpEvents() = 0;
 
    bool ShouldClose() const;
 
    void SetShouldClose(bool should);
 
    virtual void SetImmEnabled(bool enable) = 0;
 
    void SetKeyEventsIgnored(bool ignored);
 
protected:
    Window();
 
    virtual ~Window();
 
protected:
    bool                      should_close_;
    bool                      is_fullscreen_;
    bool                      ignore_key_events_;
    int                       pos_x_;
    int                       pos_y_;
    uint32_t                  real_width_;
    uint32_t                  real_height_;
    uint32_t                  min_width_;
    uint32_t                  min_height_;
    uint32_t                  max_width_;
    uint32_t                  max_height_;
    float                     dpi_;
    Size                      logical_size_;
    Resolution                resolution_;
    WindowHandle              handle_;
    String                    title_;
    std::queue<RefPtr<Event>> event_queue_;
};
 
}  // namespace kiwano