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/core/event/Event.h>
#include <kiwano/macros.h>
#include <kiwano/math/Math.h>

namespace kiwano
{

/**
 * \~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><EFBFBD>࣬<EFBFBD><EFBFBD><EFBFBD>ƴ<EFBFBD><EFBFBD>ڱ<EFBFBD><EFBFBD>⡢<EFBFBD><EFBFBD>С<EFBFBD><EFBFBD>ͼ<EFBFBD><EFBFBD><EFBFBD><EFBFBD>
 */
class KGE_API Window : protected Noncopyable
{
public:
    /**
     * \~chinese
     * @brief <EFBFBD><EFBFBD>ȡ<EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʵ<EFBFBD><EFBFBD>
     */
    static Window& GetInstance();

    /**
     * \~chinese
     * @brief <EFBFBD><EFBFBD>ʼ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
     * @param title <EFBFBD><EFBFBD><EFBFBD><EFBFBD>
     * @param width <EFBFBD><EFBFBD><EFBFBD><EFBFBD>
     * @param height <EFBFBD>߶<EFBFBD>
     * @param icon ͼ<EFBFBD><EFBFBD><EFBFBD><EFBFBD>ԴID
     * @param resizable <EFBFBD><EFBFBD><EFBFBD>ڴ<EFBFBD>С<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
     * @param fullscreen ȫ<EFBFBD><EFBFBD>ģʽ
     * @throw std::runtime_error <EFBFBD><EFBFBD><EFBFBD>ڴ<EFBFBD><EFBFBD><EFBFBD>ʧ<EFBFBD><EFBFBD>ʱ<EFBFBD>׳<EFBFBD>
     */
    virtual void Create(String const& title, uint32_t width, uint32_t height, uint32_t icon = 0, bool resizable = false,
                        bool fullscreen = false) = 0;

    /**
     * \~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>
     * @param title <EFBFBD><EFBFBD><EFBFBD><EFBFBD>
     */
    virtual void SetTitle(String const& title) = 0;

    /**
     * \~chinese
     * @brief <EFBFBD><EFBFBD><EFBFBD>ô<EFBFBD><EFBFBD><EFBFBD>ͼ<EFBFBD><EFBFBD>
     * @param icon_resource ͼ<EFBFBD><EFBFBD><EFBFBD><EFBFBD>ԴID
     */
    virtual void SetIcon(uint32_t icon_resource) = 0;

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

    /**
     * \~chinese
     * @brief <EFBFBD><EFBFBD><EFBFBD><EFBFBD>ȫ<EFBFBD><EFBFBD>ģʽ
     * @param fullscreen <EFBFBD>Ƿ<EFBFBD>ȫ<EFBFBD><EFBFBD>
     * @param width <EFBFBD><EFBFBD><EFBFBD>ڿ<EFBFBD><EFBFBD><EFBFBD>
     * @param height <EFBFBD><EFBFBD><EFBFBD>ڸ߶<EFBFBD>
     */
    virtual void SetFullscreen(bool fullscreen) = 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>\n
     *         <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><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
     * @param evt <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>¼<EFBFBD>
     */
    void PushEvent(EventPtr evt);

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

    /**
     * \~chinese
     * @brief <EFBFBD><EFBFBD><EFBFBD>ٴ<EFBFBD><EFBFBD><EFBFBD>
     */
    virtual void Destroy();

protected:
    Window();

    ~Window();

    virtual void PumpEvents() = 0;

protected:
    bool                 should_close_;
    uint32_t             width_;
    uint32_t             height_;
    String               title_;
    std::queue<EventPtr> event_queue_;
};

}  // namespace kiwano