Magic_Game/src/kiwano/base/Director.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/2d/Actor.h>
#include <kiwano/2d/Stage.h>
#include <kiwano/2d/Transition.h>
#include <kiwano/base/Module.h>

namespace kiwano
{
/**
 * \~chinese
 * @brief <EFBFBD><EFBFBD><EFBFBD><EFBFBD>
 * @details <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>ת
 * @see kiwano::Stage
 */
class KGE_API Director
    : public Singleton<Director>
    , public UpdateModule
    , public RenderModule
    , public EventModule
{
    friend Singleton<Director>;

public:
    /**
     * \~chinese
     * @brief <EFBFBD>л<EFBFBD><EFBFBD><EFBFBD>̨
     * @param[in] stage <EFBFBD><EFBFBD>̨
     * @param[in] transition <EFBFBD><EFBFBD><EFBFBD>ɶ<EFBFBD><EFBFBD><EFBFBD>
     */
    void EnterStage(StagePtr stage, TransitionPtr transition = nullptr);

    /**
     * \~chinese
     * @brief <EFBFBD>л<EFBFBD><EFBFBD><EFBFBD>̨<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ǰ<EFBFBD><EFBFBD>̨<EFBFBD><EFBFBD><EFBFBD>浽ջ<EFBFBD><EFBFBD>
     * @param[in] stage <EFBFBD><EFBFBD>̨
     * @param[in] transition <EFBFBD><EFBFBD><EFBFBD>ɶ<EFBFBD><EFBFBD><EFBFBD>
     */
    void PushStage(StagePtr stage, TransitionPtr transition = nullptr);

    /**
     * \~chinese
     * @brief <EFBFBD>˳<EFBFBD><EFBFBD><EFBFBD>ǰ<EFBFBD><EFBFBD>̨<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>л<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>һ<EFBFBD><EFBFBD><EFBFBD><EFBFBD>̨
     * @param[in] transition <EFBFBD><EFBFBD><EFBFBD>ɶ<EFBFBD><EFBFBD><EFBFBD>
     */
    void PopStage(TransitionPtr transition = nullptr);

    /**
     * \~chinese
     * @brief <EFBFBD><EFBFBD>ȡ<EFBFBD><EFBFBD>ǰ<EFBFBD><EFBFBD>̨
     * @return <EFBFBD><EFBFBD><EFBFBD>ص<EFBFBD>ǰ<EFBFBD><EFBFBD>̨<EFBFBD><EFBFBD>ָ<EFBFBD><EFBFBD>
     */
    StagePtr GetCurrentStage();

    /**
     * \~chinese
     * @brief <EFBFBD><EFBFBD><EFBFBD>û<EFBFBD><EFBFBD><EFBFBD><EFBFBD>ý<EFBFBD>ɫ<EFBFBD>߽<EFBFBD><EFBFBD><EFBFBD>Ⱦ<EFBFBD><EFBFBD><EFBFBD><EFBFBD>
     * @param enabled <EFBFBD>Ƿ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
     */
    void SetRenderBorderEnabled(bool enabled);

    /**
     * \~chinese
     * @brief <EFBFBD><EFBFBD>ʾ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ص<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ϣ
     * @param show <EFBFBD>Ƿ<EFBFBD><EFBFBD><EFBFBD>ʾ
     */
    void ShowDebugInfo(bool show = true);

    /**
     * \~chinese
     * @brief <EFBFBD>˳<EFBFBD><EFBFBD><EFBFBD>ǰ<EFBFBD><EFBFBD>̨<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>̨ջ
     */
    void ClearStages();

public:
    void SetupModule() override {}

    void DestroyModule() override {}

    void OnUpdate(Duration dt) override;

    void OnRender(RenderContext& ctx) override;

    void HandleEvent(Event* evt) override;

    virtual ~Director();

private:
    Director();

private:
    bool            render_border_enabled_;
    Stack<StagePtr> stages_;
    StagePtr        current_stage_;
    StagePtr        next_stage_;
    ActorPtr        debug_actor_;
    TransitionPtr   transition_;
};
}  // namespace kiwano