Magic_Game/src/kiwano/platform/Runner.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/Time.h>
#include <kiwano/platform/Window.h>
#include <kiwano/render/Color.h>
#include <kiwano/render/Texture.h>
#include <kiwano/utils/Ticker.h>


namespace kiwano
{

class Application;

KGE_DECLARE_SMART_PTR(Runner);

/**
 * \~chinese
 * @brief <EFBFBD><EFBFBD>Ϸ<EFBFBD><EFBFBD><EFBFBD><EFBFBD>
 */
struct Settings
{
    WindowConfig window;          ///< <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    Color        bg_color;        ///< <20><><EFBFBD><EFBFBD>ɫ
    Duration     frame_interval;  ///< ֡<><D6A1><EFBFBD><EFBFBD>
    bool         vsync_enabled;   ///< <20><>ֱͬ<D6B1><CDAC>
    bool         debug_mode;      ///< <20><><EFBFBD><EFBFBD>ģʽ

    Settings()
        : bg_color(Color::Black)
        , frame_interval(0)
        , vsync_enabled(true)
        , debug_mode(false)
    {
    }
};

/**
 * \~chinese
 * @brief <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
 */
class KGE_API Runner : public ObjectBase
{
public:
    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    /// @param main_window <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    static RunnerPtr Create(Settings settings);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    /// @param main_window <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    /// @param on_ready Ӧ<>ó<EFBFBD><C3B3><EFBFBD><EFBFBD><EFBFBD>ʼ<EFBFBD><CABC><EFBFBD><EFBFBD><EFBFBD>ɺ<EFBFBD>ִ<EFBFBD>еĻص<C4BB><D8B5><EFBFBD><EFBFBD><EFBFBD>
    /// @param on_destroy Ӧ<>ó<EFBFBD><C3B3><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʱִ<CAB1>еĻص<C4BB><D8B5><EFBFBD><EFBFBD><EFBFBD>
    static RunnerPtr Create(Settings settings, Function<void()> on_ready, Function<void()> on_destroy = nullptr);

    Runner();

    virtual ~Runner();

    /// \~chinese
    /// @brief <20><>ʼ<EFBFBD><CABC><EFBFBD><EFBFBD><EFBFBD>ɴ<EFBFBD><C9B4><EFBFBD>
    /// @details <20><><EFBFBD>ظú<D8B8><C3BA><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ӧ<EFBFBD>ó<EFBFBD><C3B3><EFBFBD><EFBFBD><EFBFBD>ʼ<EFBFBD><CABC><EFBFBD><EFBFBD><EFBFBD>ɺ<EFBFBD><C9BA>Զ<EFBFBD>ִ<EFBFBD><D6B4>
    virtual void OnReady();

    /// \~chinese
    /// @brief Ӧ<>ó<EFBFBD><C3B3><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ٴ<EFBFBD><D9B4><EFBFBD>
    /// @details <20><><EFBFBD>ظú<D8B8><C3BA><EFBFBD><EFBFBD>Դ<EFBFBD><D4B4><EFBFBD>Ӧ<EFBFBD>ó<EFBFBD><C3B3><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʱ<EFBFBD><CAB1><EFBFBD><EFBFBD>Ϊ<EFBFBD><CEAA><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Դ<EFBFBD><D4B4><EFBFBD>յ<EFBFBD>
    virtual void OnDestroy();

    /// \~chinese
    /// @brief Ӧ<>ó<EFBFBD><C3B3><EFBFBD><EFBFBD>رմ<D8B1><D5B4><EFBFBD>
    /// @details <20><><EFBFBD>ظú<D8B8><C3BA><EFBFBD><EFBFBD>Դ<EFBFBD><D4B4><EFBFBD><EFBFBD>û<EFBFBD><C3BB>ر<EFBFBD>Ӧ<EFBFBD>ó<EFBFBD><C3B3><EFBFBD>ʱ<EFBFBD><CAB1><EFBFBD><EFBFBD>Ϊ<EFBFBD><CEAA><EFBFBD>籣<EFBFBD><E7B1A3><EFBFBD>û<EFBFBD><C3BB><EFBFBD><EFBFBD>ݵ<EFBFBD>
    /// @return <20><><EFBFBD><EFBFBD>true<75><65><EFBFBD><EFBFBD><EFBFBD>û<EFBFBD><C3BB>رճ<D8B1><D5B3>򣬷<EFBFBD><F2A3ACB7><EFBFBD><EFBFBD><EFBFBD>ֹ<EFBFBD><D6B9><EFBFBD><EFBFBD><EFBFBD>ر<EFBFBD>
    virtual bool OnClose();

    /// \~chinese
    /// @brief Ӧ<>ó<EFBFBD><C3B3><EFBFBD><EFBFBD><EFBFBD>ѭ<EFBFBD><D1AD>
    /// @param dt ʱ<><CAB1><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    /// @details <20><><EFBFBD>ظú<D8B8><C3BA><EFBFBD><EFBFBD>Կ<EFBFBD><D4BF>Ƴ<EFBFBD><C6B3><EFBFBD><EFBFBD><EFBFBD>ѭ<EFBFBD><D1AD>
    /// @return <20><><EFBFBD><EFBFBD>false<73>˳<EFBFBD><CBB3><EFBFBD>ѭ<EFBFBD><D1AD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ѭ<EFBFBD><D1AD>
    virtual bool MainLoop(Duration dt);

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD><C8A1><EFBFBD><EFBFBD>
    WindowPtr GetWindow() const;

    /// \~chinese
    /// @brief <20><><EFBFBD>ô<EFBFBD><C3B4><EFBFBD>
    void SetWindow(WindowPtr window);

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD><C8A1><EFBFBD><EFBFBD>
    Settings GetSettings() const;

    /// \~chinese
    /// @brief <20><>ȡ֡<C8A1><D6A1>ʱ<EFBFBD><CAB1>
    TickerPtr GetFrameTicker() const;

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD>֡<EFBFBD><D6A1>ʱ<EFBFBD><CAB1>
    void SetFrameTicker(TickerPtr ticker);

protected:
    /// \~chinese
    /// @brief <20>޸<EFBFBD><DEB8><EFBFBD><EFBFBD><EFBFBD>
    void SetSettings(Settings settings);

private:
    friend class Application;

    void InitSettings();

private:
    Settings  settings_;
    WindowPtr main_window_;
    TickerPtr frame_ticker_;
};

inline void Runner::OnReady() {}

inline void Runner::OnDestroy() {}

inline bool Runner::OnClose()
{
    return true;
}

inline WindowPtr Runner::GetWindow() const
{
    return main_window_;
}

inline void Runner::SetWindow(WindowPtr window)
{
    main_window_ = window;
}

inline Settings Runner::GetSettings() const
{
    return settings_;
}

inline void Runner::SetSettings(Settings settings)
{
    settings_ = settings;
}

inline TickerPtr Runner::GetFrameTicker() const
{
    return frame_ticker_;
}

inline void Runner::SetFrameTicker(TickerPtr ticker)
{
    frame_ticker_ = ticker;
}

}  // namespace kiwano