Scene.h

Go to the documentation of this file.

// File: Scene.h
// Description: Component that marks the scene SceneManager uses this to identify scenes
// Author(s): Aidan Hartman (aidan.hartman@digipen.edu) Basic Implementation
//            Marcelo Escamilla (marcelo.escamilla@digipen.edu) JSON Serialization
// 2025 / 10 / 20
// (C) Digipen 2025
// //   ____   __                  __  __
// // /\__  _\/\ \                /\ \/\ \
// // \/_/\ \/\ \ \___      __    \ \ \_\ \    ___   __  __    ____     __
// //    \ \ \ \ \  _ `\  /'__`\   \ \  _  \  / __`\/\ \/\ \  /',__\  /'__`\
// //     \ \ \ \ \ \ \ \/\  __/    \ \ \ \ \/\ \L\ \ \ \_\ \/\__, `\/\  __/
// //      \ \_\ \ \_\ \_\ \____\    \ \_\ \_\ \____/\ \____/\/\____/\ \____\
// //       \/_/  \/_/\/_/\/____/     \/_/\/_/\/___/  \/___/  \/___/  \/____/
#pragma once
 
#include "Framework/Component.h"
 
#include <stack>
 
#include "System/SceneManager.h"
 
 
class Scene : public Component
{
public:
    static auto bindLuaTypes(sol::state& lua) -> void;
    static auto getEnum() -> ComponentTypeEnum
    {
        return cScene;
    }
    Scene();
    explicit Scene(std::string name);
 
    Scene(const Scene&)                    = default;
    auto operator=(const Scene&) -> Scene& = default;
    ~Scene() override;
    Scene(Scene&& other) noexcept                    = default;
    auto operator=(Scene&& other) noexcept -> Scene& = default;
 
    auto clone() const -> std::unique_ptr<GameObject> override;
 
    auto componentShowMenu() -> void override;
    auto onUpdate(float dt) -> void override;
    auto onRender() -> void override;
    auto onEnterEngine() -> void override;
    auto load(const Stream& stream) -> void override;
    auto save(Stream& stream) const -> void override;
 
    auto endWindow() -> void override
    {
    } // for debug ImGUI
 
    [[nodiscard]] auto name() const -> const std::string&;
    auto name(const std::string& name) -> void;
 
    auto activate() -> void;
    auto deactivate() -> void;

    auto applyState(SceneState newState) -> SceneState;
 
    auto pushState(SceneState newState) -> void;
 
    auto popState() -> void;
 
    friend auto to_json(json& j, const Scene& p) -> void;
    friend auto from_json(const json& j, Scene& p) -> void;
 
    auto getParentScene() const -> Scene*;
 
 
private:
    std::string _name;
    std::stack<SceneState> stack;
    Scene* parentScene      = nullptr;
    bool _pausesOtherScenes = false;
    bool _mainScene         = false;
    bool _alwaysRenders     = false;
    bool _registered        = false;
 
    auto updateParent() -> void;
 
};