rendering_engine::DrawableComponent Class Reference

Abstract base for all drawable (renderable) objects in the engine. More...

#include <drawable_component.hpp>

Inherited by rendering_engine::Drawable2D, and rendering_engine::Drawable3D.

Public Member Functions
	DrawableComponent (RenderResourceContext renderContext, Scene &scene)
	Constructs the DrawableComponent with a resource context. More...
virtual	~DrawableComponent ()=default
	Virtual destructor. More...
virtual void	Initialize ()
	Initializes render resource pointers (material, mesh, etc.). Must be called after setting material and mesh names. More...
virtual void	Update (float deltaTime)=0
	Updates logic (animation, movement, etc.) for this drawable. More...
virtual void	Shutdown ()
	Releases all render resources owned by this drawable. More...
virtual void	Destroy ()
	Requests destruction of this drawable. More...
void	UpdateOnTick (bool in)
	DrawableComponent (const DrawableComponent &)=delete
DrawableComponent &	operator= (const DrawableComponent &)=delete

Protected Member Functions
void	AddRenderBatch (std::string meshName, std::string materialName)

Protected Attributes
RenderResourceContext	mRenderContext
Scene &	mScene
std::vector< RenderBatch >	mRenderBatches
bool	bUpdateOnTick

Detailed Description

Abstract base for all drawable (renderable) objects in the engine.

Provides core functionality for accessing render resources (meshes, materials, textures) and defines the initialization, update, and draw lifecycle for renderable entities.

Derived classes (such as Drawable2D and Drawable3D) implement type-specific behavior for spatial transforms, camera use, and render submission.

Note

Not copyable or assignable.

See also

Drawable2D, Drawable3D

Definition at line 47 of file drawable_component.hpp.

Constructor & Destructor Documentation

DrawableComponent() [1/2]

rendering_engine::DrawableComponent::DrawableComponent	(	RenderResourceContext	renderContext,
		Scene &	scene
	)

Constructs the DrawableComponent with a resource context.

Parameters

renderContext

Rendering resource context (renderer, caches).

Definition at line 16 of file drawable_component.cpp.

    :
    mRenderContext(renderContext),
    mScene(scene),
    bUpdateOnTick(true)
{
}

~DrawableComponent()

virtual rendering_engine::DrawableComponent::~DrawableComponent ( )

virtualdefault

Virtual destructor.

DrawableComponent() [2/2]

rendering_engine::DrawableComponent::DrawableComponent ( const DrawableComponent &  )

delete

Member Function Documentation

AddRenderBatch()

void rendering_engine::DrawableComponent::AddRenderBatch ( std::string  meshName, std::string  materialName  )

protected

Definition at line 58 of file drawable_component.cpp.

{
    RenderBatch renderBatch;
    renderBatch.meshName = meshName;
    renderBatch.materialName = materialName;
 
    mRenderBatches.push_back(std::move(renderBatch));
}

Destroy()

void rendering_engine::DrawableComponent::Destroy ( )

virtual

Requests destruction of this drawable.

Schedules the drawable for deferred removal via the owning Scene. The drawable is not destroyed immediately; actual cleanup is performed at a safe point during the Scene update cycle.

Note

This function must be used instead of deleting the object directly.

Reimplemented in rendering_engine::Drawable2D, and rendering_engine::Drawable3D.

Definition at line 49 of file drawable_component.cpp.

{
}

Initialize()

void rendering_engine::DrawableComponent::Initialize ( )

virtual

Initializes render resource pointers (material, mesh, etc.). Must be called after setting material and mesh names.

Reimplemented in rendering_engine::Drawable2D, rendering_engine::Drawable3D, rendering_engine::Quad2D, rendering_engine::Rectangle2D, rendering_engine::Sprite2D, rendering_engine::StaticMesh, and rendering_engine::TextBlock2D.

Definition at line 24 of file drawable_component.cpp.

{
    for (auto& renderBatch : mRenderBatches)
    {
        renderBatch.renderResources = std::unique_ptr<IRenderResources>(mRenderContext.renderer->ProvideRenderResources());
        Material* material = mRenderContext.materialCache->GetMaterial(renderBatch.materialName);
        renderBatch.materialParameters = material->PackMaterialParameters();
        MeshDataGpu* meshData = mRenderContext.meshCache->GetMeshResources(renderBatch.meshName).get();
 
        renderBatch.renderResources->Initialize(material, meshData, mRenderContext.textureCache);
    }
}

operator=()

DrawableComponent & rendering_engine::DrawableComponent::operator= ( const DrawableComponent &  )

delete

Shutdown()

void rendering_engine::DrawableComponent::Shutdown ( )

virtual

Releases all render resources owned by this drawable.

Called internally by the Scene during destruction or scene shutdown. This function must free GPU and CPU-side render resources but must not remove the drawable from Scene containers.

Definition at line 37 of file drawable_component.cpp.

{
    for (auto& renderBatch : mRenderBatches)
    {
        if (renderBatch.renderResources)
        {
            renderBatch.renderResources->Shutdown();
        }
    }
    mRenderBatches.clear();
}

Update()

virtual void rendering_engine::DrawableComponent::Update ( float  deltaTime )

pure virtual

Updates logic (animation, movement, etc.) for this drawable.

Parameters

deltaTime

Time step (seconds).

Implemented in rendering_engine::Drawable2D, rendering_engine::Drawable3D, rendering_engine::Quad2D, rendering_engine::Rectangle2D, rendering_engine::Sprite2D, rendering_engine::StaticMesh, and rendering_engine::TextBlock2D.

UpdateOnTick()

void rendering_engine::DrawableComponent::UpdateOnTick

(

bool

in

)

Definition at line 53 of file drawable_component.cpp.

{
    bUpdateOnTick = in;
}

Member Data Documentation

bUpdateOnTick

bool rendering_engine::DrawableComponent::bUpdateOnTick

protected

Definition at line 104 of file drawable_component.hpp.

mRenderBatches

std::vector<RenderBatch> rendering_engine::DrawableComponent::mRenderBatches

protected

Definition at line 102 of file drawable_component.hpp.

mRenderContext

RenderResourceContext rendering_engine::DrawableComponent::mRenderContext

protected

Definition at line 100 of file drawable_component.hpp.

mScene

Scene& rendering_engine::DrawableComponent::mScene

protected

Definition at line 101 of file drawable_component.hpp.

---

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

• drawable_component.hpp
• drawable_component.cpp