Base class representing a renderable scene. More...

#include <scene.hpp>

Public Member Functions
	Scene (SceneManager &sceneManager)
	Constructs a Scene instance associated with a SceneManager. More...

	~Scene ()=default
	Virtual destructor for safe polymorphic destruction. More...

virtual void	Initialize ()
	Initializes scene resources and drawables. More...

virtual void	Update (float deltaTime)
	Updates all objects within the scene. More...

virtual void	Draw ()
	Renders all 3D and 2D drawables in the scene. More...

virtual void	Shutdown ()
	Releases scene-specific resources and prepares for shutdown. More...

SceneManager &	GetSceneManager ()
	Gets a reference to the SceneManager that owns this scene. More...

void	LoadScene (std::string newSceneName)
	Requests to load another scene. More...

std::shared_ptr< Camera >	GetActiveCamera3D ()
	Returns the active 3D camera of the scene. More...

std::shared_ptr< Camera2D >	GetActiveCamera2D ()
	Returns the active 2D camera of the scene. More...

template<typename T , typename V >
T *	Spawn (V arg)
	Spawns and registers a drawable of type T. More...

template<typename T >
T *	SpawnActor ()
	Spawns and registers a 3D actor of type T. More...

template<typename T >
T *	SpawnActor2D ()
	Spawns and registers a 2D actor of type T. More...

template<>
StaticMesh *	Spawn (StaticMeshParams param)

template<>
StaticMesh *	Spawn (StaticMeshParams param)

Protected Member Functions
void	DestroyDrawable3D (Drawable3D *drawable3D)
	Schedules a 3D drawable for deferred destruction. More...

void	DestroyDrawable2D (Drawable2D *drawable2D)
	Schedules a 2D drawable for deferred destruction. More...

void	DestroyActor (Actor *actor)
	Schedules a 3D actor for deferred destruction. More...

void	DestroyActor (Actor2D *actor2D)
	Schedules a 2D actor for deferred destruction. More...

void	SetBackgroundColor (glm::vec3 color)
	Sets the scene background clear color. More...

Friends
class	Drawable3D

class	Drawable2D

class	Actor

class	Actor2D

Detailed Description

Base class representing a renderable scene.

A Scene acts as a container for drawable objects (2D and 3D) and defines the update and draw lifecycle of a game or rendering context.

Derived scene classes should override Initialize(), Update(), and Draw() to implement specific logic and populate the drawable lists.

Note: Scenes are created and managed by SceneManager.

See also: SceneManager, Drawable3D, Drawable2D, Camera, Camera2D

The Scene implements a deferred destruction mechanism to guarantee safe removal of actors and drawables during update and render passes. All objects spawned via the Scene are owned and lifetime-managed by it.

Definition at line 43 of file scene.hpp.

Constructor & Destructor Documentation

◆ Scene()

rendering_engine::Scene::Scene ( SceneManager & sceneManager )

Constructs a Scene instance associated with a SceneManager.

Parameters

sceneManager Reference to the SceneManager that owns this Scene.

Definition at line 19 of file scene.cpp.

    :
    mSceneManager(sceneManager),
    mStatsOverlay(nullptr)
{}

◆ ~Scene()

rendering_engine::Scene::~Scene ( )

default

Virtual destructor for safe polymorphic destruction.

Member Function Documentation

◆ DestroyActor() [1/2]

void rendering_engine::Scene::DestroyActor ( Actor * actor )

protected

Schedules a 3D actor for deferred destruction.

The actor is not destroyed immediately. Instead, it is placed into a pending destruction queue and safely removed during the next Scene update cycle.

This ensures that destruction does not invalidate iterators or interfere with the current update/draw pass.

Parameters

actor Pointer to the actor to destroy.

Note: Do not delete actors manually. Always use Actor::Destroy().

Definition at line 159 of file scene.cpp.

{
    mPendingDestroyActors.push_back(actor);
}

◆ DestroyActor() [2/2]

void rendering_engine::Scene::DestroyActor ( Actor2D * actor2D )

protected

Schedules a 2D actor for deferred destruction.

Mirrors DestroyActor(Actor*) but operates on the 2D actor list. The actor will be safely shut down and deleted during the next flush phase.

Parameters

actor2D Pointer to the 2D actor to destroy.

Note: Do not delete actors manually. Always use Actor2D::Destroy().

Definition at line 164 of file scene.cpp.

{
    mPendingDestroyActors2D.push_back(actor2D);
}

◆ DestroyDrawable2D()

void rendering_engine::Scene::DestroyDrawable2D ( Drawable2D * drawable2D )

protected

Schedules a 2D drawable for deferred destruction.

The drawable will be shut down and removed safely during the next Scene flush cycle.

Parameters

drawable2D Pointer to the drawable to destroy.

Definition at line 154 of file scene.cpp.

{
    mPendingDestroy2D.push_back(drawable2D);
}

◆ DestroyDrawable3D()

void rendering_engine::Scene::DestroyDrawable3D ( Drawable3D * drawable3D )

protected

Schedules a 3D drawable for deferred destruction.

The drawable will be shut down and removed safely during the next Scene flush cycle.

Parameters

drawable3D Pointer to the drawable to destroy.

Definition at line 149 of file scene.cpp.

{
    mPendingDestroy3D.push_back(drawable3D);
}

◆ Draw()

void rendering_engine::Scene::Draw ( )

virtual

Renders all 3D and 2D drawables in the scene.

The base implementation can iterate through mDrawables3D and mDrawables2D to call each object�s Draw() method, using the active cameras.

Definition at line 85 of file scene.cpp.

{
    if (mActiveCamera3D)
    {
        for (auto& drawable3D : mDrawables3D)
        {
            drawable3D->Draw(*mActiveCamera3D);
        }
    }
 
    if (mActiveCamera2D)
    {
        for (auto& drawable2D : mDrawables2D)
        {
            drawable2D->Draw(*mActiveCamera2D);
        }
    }
}

◆ GetActiveCamera2D()

std::shared_ptr< Camera2D > rendering_engine::Scene::GetActiveCamera2D ( )

Returns the active 2D camera of the scene.

Returns: Active 2D camera.

Definition at line 144 of file scene.cpp.

{
    return mActiveCamera2D;
}

◆ GetActiveCamera3D()

std::shared_ptr< Camera > rendering_engine::Scene::GetActiveCamera3D ( )

Returns the active 3D camera of the scene.

Returns: Active 3D camera.

Definition at line 139 of file scene.cpp.

{
    return mActiveCamera3D;
}

◆ GetSceneManager()

SceneManager & rendering_engine::Scene::GetSceneManager ( )

Gets a reference to the SceneManager that owns this scene.

Returns: Reference to the owning SceneManager.

Definition at line 129 of file scene.cpp.

{
    return mSceneManager;
}

◆ Initialize()

void rendering_engine::Scene::Initialize ( )

virtual

Initializes scene resources and drawables.

Called once when the scene becomes active. Derived classes should override this to load assets and create objects.

Definition at line 25 of file scene.cpp.

{
    mActiveCamera3D = std::make_shared<Camera>(*mSceneManager.GetApplication());
    mActiveCamera3D->Initialize();
 
    mActiveCamera2D = std::make_shared<Camera2D>(*mSceneManager.GetApplication());
    mActiveCamera2D->Initialize();
 
    AppConfig appConfig = Utility::ReadConfigFile();
    if (appConfig.showStatsOverlay)
    {
        mStatsOverlay = SpawnActor2D<StatsOverlay>();
        const float screenWidth = mSceneManager.GetApplication()->GetScreenSettings().width;
        const float screenHeight = mSceneManager.GetApplication()->GetScreenSettings().height;
        const float x = screenWidth / 2 - 200.0f;
        const float y = -screenHeight / 2 + 130.0f;
        mStatsOverlay->SetPosition(glm::vec2(x, y));
    }
}

◆ LoadScene()

void rendering_engine::Scene::LoadScene ( std::string newSceneName )

Requests to load another scene.

Parameters

newSceneName The name of the registered scene to load next.

This function delegates to SceneManager::LoadScene().

Definition at line 134 of file scene.cpp.

{
    mSceneManager.LoadScene(newSceneName);
}

◆ SetBackgroundColor()

void rendering_engine::Scene::SetBackgroundColor ( glm::vec3 color )

protected

Sets the scene background clear color.

Parameters

color Linear-space RGB color.

Definition at line 220 of file scene.cpp.

{
    mSceneManager.GetRenderResourceContext().renderer->SetDefaultColor(color.r, color.g, color.b);
}

◆ Shutdown()

void rendering_engine::Scene::Shutdown ( )

virtual

Releases scene-specific resources and prepares for shutdown.

Called when the scene is being unloaded or replaced.

Definition at line 104 of file scene.cpp.

{
    // Finish any queued destroys first (so we don't double-delete later)
    FlushDestroyed();
 
    // Destroy drawables FIRST (they may reference actor transforms as parents)
    for (auto* d : mDrawables2D) { if (d) { d->Shutdown(); delete d; } }
    mDrawables2D.clear();
 
    for (auto* d : mDrawables3D) { if (d) { d->Shutdown(); delete d; } }
    mDrawables3D.clear();
 
    // Now destroy actors
    for (auto* a : mActors) { if (a) { a->Shutdown(); delete a; } }
    mActors.clear();
 
    for (auto* a : mActors2D) { if (a) { a->Shutdown(); delete a; } }
    mActors2D.clear();
 
    mPendingDestroy2D.clear();
    mPendingDestroy3D.clear();
    mPendingDestroyActors.clear();
    mPendingDestroyActors2D.clear();
}

◆ Spawn() [1/3]

template<>

StaticMesh * rendering_engine::Scene::Spawn ( StaticMeshParams param )

◆ Spawn() [2/3]

template<>

StaticMesh * rendering_engine::Scene::Spawn ( StaticMeshParams param )

Definition at line 41 of file spawn_drawables.hpp.

{
    mDrawables3D.push_back(new StaticMesh(mSceneManager.GetRenderResourceContext(), *this, param));
    StaticMesh* staticMesh = static_cast<StaticMesh*>(mDrawables3D.back());
    staticMesh->Initialize();
    return staticMesh;
}

◆ Spawn() [3/3]

template<typename T , typename V >

T * rendering_engine::Scene::Spawn ( V arg )

Spawns and registers a drawable of type T.

All drawables must be created via this function to ensure correct Scene-level ownership and lifecycle management. Creation logic is provided by explicit template specializations.

Template Parameters

T	Drawable type.
V	Construction argument type.

Parameters

arg	Construction argument.

Returns: Pointer to the created drawable.

◆ SpawnActor()

template<typename T >

T * rendering_engine::Scene::SpawnActor

inline

Spawns and registers a 3D actor of type T.

The actor is:

Allocated and owned by the Scene.
Stored internally in the 3D actor list.
Automatically initialized via Initialize().

The Scene manages the full lifecycle of the actor, including deferred destruction and Shutdown() invocation.

Template Parameters

T	Type deriving from Actor.

Returns: Pointer to the created actor instance.

Note: The returned pointer is owned by the Scene. Do not manually delete the actor.

See also: DestroyActor(), SpawnActor2D()

Definition at line 262 of file scene.hpp.

{
    static_assert(std::is_base_of_v<Actor, T>,
        "SpawnActor<T>: T must derive from Actor");
 
    mActors.push_back(new T(*this));
    T* ptr = static_cast<T*>(mActors.back());
 
    ptr->Initialize();
    return ptr;
}

◆ SpawnActor2D()

template<typename T >

T * rendering_engine::Scene::SpawnActor2D

inline

Spawns and registers a 2D actor of type T.

The actor is:

Allocated and owned by the Scene.
Stored internally in the 2D actor list.
Automatically initialized via Initialize().

This function mirrors SpawnActor() but operates in the 2D domain. 2D actors use SceneComponent2D for hierarchical transformations.

Template Parameters

T	Type deriving from Actor2D.

Returns: Pointer to the created 2D actor instance.

Note: The returned pointer is owned by the Scene. Do not manually delete the actor.

See also: SpawnActor(), DestroyActor(Actor2D*)

Definition at line 275 of file scene.hpp.

{
    static_assert(std::is_base_of_v<Actor2D, T>,
        "SpawnActor<T>: T must derive from Actor2D");
 
    mActors2D.push_back(new T(*this));
    T* ptr = static_cast<T*>(mActors2D.back());
 
    ptr->Initialize();
    return ptr;
}

◆ Update()

void rendering_engine::Scene::Update ( float deltaTime )

virtual

Updates all objects within the scene.

Parameters

deltaTime Time elapsed since the last frame (in milliseconds).

Called once per frame. Override to implement per-frame logic such as animation, physics updates, or scene transitions.

Definition at line 45 of file scene.cpp.

{
    // Update cameras
    if (mActiveCamera2D)
    {
        mActiveCamera2D->Update(deltaTime);
    }
    if (mActiveCamera3D)
    {
        // TO DO - uncomment
        //mActiveCamera3D->Update(deltaTime);
    }
 
    for (auto& actor : mActors)
    {
        if (!actor->IsPendingDestroy())
        {
            actor->Update(deltaTime);
        }
    }
    for (auto& actor2D : mActors2D)
    {
        if (!actor2D->IsPendingDestroy())
        {
            actor2D->Update(deltaTime);
        }
    }
 
    for (auto& drawable2D : mDrawables2D)
    {
        drawable2D->Update(deltaTime);
    }
    for (auto& drawable3D : mDrawables3D)
    {
        drawable3D->Update(deltaTime);
    }
 
    FlushDestroyed();
}

Friends And Related Function Documentation

◆ Actor

friend class Actor

friend

Definition at line 47 of file scene.hpp.

◆ Actor2D

friend class Actor2D

friend

Definition at line 48 of file scene.hpp.

◆ Drawable2D

friend class Drawable2D

friend

Definition at line 46 of file scene.hpp.

◆ Drawable3D

friend class Drawable3D

friend

Definition at line 45 of file scene.hpp.

The documentation for this class was generated from the following files:

Public Member Functions

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Scene()

◆ ~Scene()

Member Function Documentation

◆ DestroyActor() [1/2]

◆ DestroyActor() [2/2]

◆ DestroyDrawable2D()

◆ DestroyDrawable3D()

◆ Draw()

◆ GetActiveCamera2D()

◆ GetActiveCamera3D()

◆ GetSceneManager()

◆ Initialize()

◆ LoadScene()

◆ SetBackgroundColor()

◆ Shutdown()

◆ Spawn() [1/3]

◆ Spawn() [2/3]

◆ Spawn() [3/3]

◆ SpawnActor()

◆ SpawnActor2D()

◆ Update()

Friends And Related Function Documentation

◆ Actor

◆ Actor2D

◆ Drawable2D

◆ Drawable3D