Magic_Game/src/kiwano/platform/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
{

KGE_DECLARE_SMART_PTR(Window);

/**
 * \~chinese
 * @brief <EFBFBD><EFBFBD><EFBFBD><EFBFBD>ָ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
 */
enum class CursorType
{
    Arrow,      ///< ָ<><D6B8>
    TextInput,  ///< <20>ı<EFBFBD>
    Hand,       ///< <20><>
    SizeAll,    ///< ָ<><D6B8><EFBFBD>ĸ<EFBFBD><C4B8><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ļ<EFBFBD>ͷ
    SizeWE,     ///< ָ<><D6B8><EFBFBD><EFBFBD><EFBFBD>ҷ<EFBFBD><D2B7><EFBFBD><EFBFBD>ļ<EFBFBD>ͷ
    SizeNS,     ///< ָ<><D6B8><EFBFBD><EFBFBD><EFBFBD>·<EFBFBD><C2B7><EFBFBD><EFBFBD>ļ<EFBFBD>ͷ
    SizeNESW,   ///< ָ<><D6B8><EFBFBD><EFBFBD><EFBFBD>µ<EFBFBD><C2B5><EFBFBD><EFBFBD>Ϸ<EFBFBD><CFB7><EFBFBD><EFBFBD>ļ<EFBFBD>ͷ
    SizeNWSE,   ///< ָ<><D6B8><EFBFBD><EFBFBD><EFBFBD>ϵ<EFBFBD><CFB5><EFBFBD><EFBFBD>·<EFBFBD><C2B7><EFBFBD><EFBFBD>ļ<EFBFBD>ͷ
};

/**
 * \~chinese
 * @brief <EFBFBD>ֱ<EFBFBD><EFBFBD><EFBFBD>
 */
struct Resolution
{
    uint32_t width;         ///< <20>ֱ<EFBFBD><D6B1>ʿ<EFBFBD><CABF><EFBFBD>
    uint32_t height;        ///< <20>ֱ<EFBFBD><D6B1>ʸ߶<CAB8>
    uint32_t refresh_rate;  ///< ˢ<><CBA2><EFBFBD><EFBFBD>
};

/**
 * \~chinese
 * @brief ͼ<EFBFBD><EFBFBD>
 */
struct Icon
{
    Icon() = default;

    Icon(const String& file_path)
        : file_path(file_path)
    {
    }

    String file_path;  ///< <20>ļ<EFBFBD>·<EFBFBD><C2B7>

#if defined(KGE_PLATFORM_WINDOWS)
    uint32_t resource_id = 0;  ///< <20><>ԴID<49><44><EFBFBD><EFBFBD><EFBFBD><EFBFBD>windows<77><73><EFBFBD><EFBFBD>Ч

    Icon(uint32_t resource_id)
        : resource_id(resource_id)
    {
    }
#endif
};


/**
 * \~chinese
 * @brief <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
 */
struct WindowConfig
{
    uint32_t width  = 640;            ///< <20><><EFBFBD>ڿ<EFBFBD><DABF><EFBFBD>
    uint32_t height = 480;            ///< <20><><EFBFBD>ڸ߶<DAB8>
    String   title  = "Kiwano Game";  ///< <20><><EFBFBD>ڱ<EFBFBD><DAB1><EFBFBD>
    Icon     icon;                    ///< <20><><EFBFBD><EFBFBD>ͼ<EFBFBD><CDBC>
    bool     resizable  = false;      ///< <20><><EFBFBD>ڴ<EFBFBD>С<EFBFBD>ɵ<EFBFBD><C9B5><EFBFBD>
    bool     fullscreen = false;      ///< <20><><EFBFBD><EFBFBD>ȫ<EFBFBD><C8AB>
};


#if defined(KGE_PLATFORM_WINDOWS)
typedef HWND WindowHandle;
#endif


/**
 * \~chinese
 * @brief <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>࣬<EFBFBD><EFBFBD><EFBFBD>ƴ<EFBFBD><EFBFBD>ڱ<EFBFBD><EFBFBD>⡢<EFBFBD><EFBFBD>С<EFBFBD><EFBFBD>ͼ<EFBFBD><EFBFBD><EFBFBD><EFBFBD>
 */
class KGE_API Window : public ObjectBase
{
public:
    /**
     * \~chinese
     * @brief <EFBFBD><EFBFBD>ʼ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
     * @param config <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
     * @throw kiwano::SystemError <EFBFBD><EFBFBD><EFBFBD>ڴ<EFBFBD><EFBFBD><EFBFBD>ʧ<EFBFBD><EFBFBD>ʱ<EFBFBD>׳<EFBFBD>
     */
    static WindowPtr Create(const WindowConfig& config);

    /**
     * \~chinese
     * @brief <EFBFBD><EFBFBD>ȡ<EFBFBD><EFBFBD><EFBFBD>ڱ<EFBFBD><EFBFBD><EFBFBD>
     * @return <EFBFBD><EFBFBD><EFBFBD>ڱ<EFBFBD><EFBFBD><EFBFBD>
     */
    String GetTitle() const;

    /**
     * \~chinese
     * @brief <EFBFBD><EFBFBD>ȡ<EFBFBD><EFBFBD><EFBFBD>ڴ<EFBFBD>С
     * @return <EFBFBD><EFBFBD><EFBFBD>ڴ<EFBFBD>С
     */
    Size GetSize() const;

    /**
     * \~chinese
     * @brief <EFBFBD><EFBFBD>ȡ<EFBFBD><EFBFBD><EFBFBD>ڿ<EFBFBD><EFBFBD><EFBFBD>
     * @return <EFBFBD><EFBFBD><EFBFBD>ڿ<EFBFBD><EFBFBD><EFBFBD>
     */
    uint32_t GetWidth() const;

    /**
     * \~chinese
     * @brief <EFBFBD><EFBFBD>ȡ<EFBFBD><EFBFBD><EFBFBD>ڸ߶<EFBFBD>
     * @return <EFBFBD><EFBFBD><EFBFBD>ڸ߶<EFBFBD>
     */
    uint32_t GetHeight() const;

    /**
     * \~chinese
     * @brief <EFBFBD><EFBFBD>ȡ<EFBFBD><EFBFBD>ǰ<EFBFBD>ֱ<EFBFBD><EFBFBD><EFBFBD>
     */
    Resolution GetCurrentResolution() const;

    /**
     * \~chinese
     * @brief <EFBFBD><EFBFBD>ȡ<EFBFBD><EFBFBD><EFBFBD>ھ<EFBFBD><EFBFBD><EFBFBD>
     */
    WindowHandle GetHandle() const;

    /**
     * \~chinese
     * @brief <EFBFBD><EFBFBD>ȡ֧<EFBFBD>ֵ<EFBFBD><EFBFBD><EFBFBD>Ļ<EFBFBD>ֱ<EFBFBD><EFBFBD><EFBFBD><EFBFBD>б<EFBFBD>
     */
    virtual Vector<Resolution> GetResolutions() = 0;

    /**
     * \~chinese
     * @brief <EFBFBD><EFBFBD><EFBFBD>ñ<EFBFBD><EFBFBD><EFBFBD>
     * @param title <EFBFBD><EFBFBD><EFBFBD><EFBFBD>
     */
    virtual void SetTitle(const String& title) = 0;

    /**
     * \~chinese
     * @brief <EFBFBD><EFBFBD><EFBFBD>ô<EFBFBD><EFBFBD><EFBFBD>ͼ<EFBFBD><EFBFBD>
     * @param icon ͼ<EFBFBD><EFBFBD>
     */
    virtual void SetIcon(Icon icon) = 0;

    /**
     * \~chinese
     * @brief <EFBFBD><EFBFBD><EFBFBD>ô<EFBFBD><EFBFBD>ڷֱ<EFBFBD><EFBFBD><EFBFBD>
     * @param width <EFBFBD>ֱ<EFBFBD><EFBFBD>ʿ<EFBFBD><EFBFBD><EFBFBD>
     * @param height <EFBFBD>ֱ<EFBFBD><EFBFBD>ʸ߶<EFBFBD>
     * @param fullscreen <EFBFBD>Ƿ<EFBFBD>ȫ<EFBFBD><EFBFBD>
     */
    virtual void SetResolution(uint32_t width, uint32_t height, bool fullscreen) = 0;

    /**
     * \~chinese
     * @brief <EFBFBD><EFBFBD><EFBFBD>ô<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>С<EFBFBD><EFBFBD>С
     * @param width <EFBFBD><EFBFBD>С<EFBFBD><EFBFBD><EFBFBD>ڿ<EFBFBD><EFBFBD><EFBFBD>
     * @param height <EFBFBD><EFBFBD>С<EFBFBD><EFBFBD><EFBFBD>ڸ߶<EFBFBD>
     */
    virtual void SetMinimumSize(uint32_t width, uint32_t height) = 0;

    /**
     * \~chinese
     * @brief <EFBFBD><EFBFBD><EFBFBD>ô<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>С
     * @param width <EFBFBD><EFBFBD><EFBFBD>󴰿ڿ<EFBFBD><EFBFBD><EFBFBD>
     * @param height <EFBFBD><EFBFBD><EFBFBD>󴰿ڸ߶<EFBFBD>
     */
    virtual void SetMaximumSize(uint32_t width, uint32_t height) = 0;

    /**
     * \~chinese
     * @brief <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ָ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
     * @param cursor <EFBFBD><EFBFBD><EFBFBD><EFBFBD>ָ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
     */
    virtual void SetCursor(CursorType cursor) = 0;

    /**
     * \~chinese
     * @brief <EFBFBD><EFBFBD>ѯ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>¼<EFBFBD>
     * @return <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>¼<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>еĵ<EFBFBD>һ<EFBFBD><EFBFBD><EFBFBD>¼<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ӷ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ƴ<EFBFBD>, <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ϊ<EFBFBD><EFBFBD><EFBFBD>򷵻ؿ<EFBFBD>ָ<EFBFBD><EFBFBD>
     */
    EventPtr PollEvent();

    /**
     * \~chinese
     * @brief <EFBFBD><EFBFBD><EFBFBD>¼<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
     * @param evt <EFBFBD>¼<EFBFBD>
     */
    void PushEvent(EventPtr evt);

    /**
     * \~chinese
     * @brief <EFBFBD><EFBFBD>ȡ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>¼<EFBFBD>
     */
    virtual void PumpEvents() = 0;

    /**
     * \~chinese
     * @brief <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ƿ<EFBFBD><EFBFBD><EFBFBD>Ҫ<EFBFBD>ر<EFBFBD>
     */
    bool ShouldClose();

    /**
     * \~chinese
     * @brief <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ƿ<EFBFBD><EFBFBD><EFBFBD>Ҫ<EFBFBD>ر<EFBFBD>
     */
    void SetShouldClose(bool should);

protected:
    Window();

    virtual ~Window();

protected:
    bool                 should_close_;
    bool                 is_fullscreen_;
    uint32_t             width_;
    uint32_t             height_;
    uint32_t             min_width_;
    uint32_t             min_height_;
    uint32_t             max_width_;
    uint32_t             max_height_;
    Resolution           resolution_;
    WindowHandle         handle_;
    String               title_;
    std::queue<EventPtr> event_queue_;
};

}  // namespace kiwano