rendering_engine::Drawable2D Class Reference

2D drawable component for rendering objects in 2D space. More...

#include <drawable_2d.hpp>

Inherits rendering_engine::DrawableComponent.

Inherited by rendering_engine::Quad2D, rendering_engine::Rectangle2D, rendering_engine::Sprite2D, and rendering_engine::TextBlock2D.

Public Member Functions
	Drawable2D (RenderResourceContext renderContext, Scene &scene)
	Constructs the Drawable2D with a resource context. More...
void	Initialize () override
	Initializes render resources. More...
void	Update (float deltaTime) override
	Updates model matrix (and any other logic). More...
virtual void	Draw (const Camera2D &camera)=0
	Submits this quad to the renderer for drawing. More...
void	SetPosition (const glm::vec2 &position)
	Sets the quad position in 2D space. More...
void	SetRotation (float angleDegrees)
	Sets the quad rotation. More...
void	SetScale (const glm::vec2 &scale)
	Sets the quad scale along each axis. More...
const glm::vec2 &	GetPosition () const
	Gets the quad position. More...
float	GetRotation () const
	Gets the quad rotation angle (degrees). More...
const glm::vec2 &	GetScale () const
	Gets the quad scale. More...
SceneComponent2D &	GetTransform ()
	Access to the underlying SceneComponent2D (transform). More...
const SceneComponent2D &	GetTransform () const
void	Destroy () override
	Requests destruction of this drawable. More...
Public Member Functions inherited from rendering_engine::DrawableComponent
	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 Attributes
SceneComponent2D	mSceneComponent
Protected Attributes inherited from rendering_engine::DrawableComponent
RenderResourceContext	mRenderContext
Scene &	mScene
std::vector< RenderBatch >	mRenderBatches
bool	bUpdateOnTick

Additional Inherited Members
Protected Member Functions inherited from rendering_engine::DrawableComponent
void	AddRenderBatch (std::string meshName, std::string materialName)

Detailed Description

2D drawable component for rendering objects in 2D space.

Encapsulates a 2D transform (SceneComponent2D). Provides per-frame update, transform access, and render submission.

Note

Not copyable or assignable.

See also

DrawableComponent, SceneComponent2D, Camera2D

Definition at line 26 of file drawable_2d.hpp.

Constructor & Destructor Documentation

Drawable2D()

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

Constructs the Drawable2D with a resource context.

Parameters

renderContext

Rendering resource context (renderer, caches).

Definition at line 7 of file drawable_2d.cpp.

    :
    DrawableComponent(renderContext, scene)
{}

Member Function Documentation

Destroy()

void rendering_engine::Drawable2D::Destroy ( )

overridevirtual

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 from rendering_engine::DrawableComponent.

Definition at line 65 of file drawable_2d.cpp.

{
    mScene.DestroyDrawable2D(this);
}

Draw()

virtual void rendering_engine::Drawable2D::Draw ( const Camera2D &  camera )

pure virtual

Submits this quad to the renderer for drawing.

Implemented in rendering_engine::Quad2D, rendering_engine::Rectangle2D, rendering_engine::Sprite2D, and rendering_engine::TextBlock2D.

GetPosition()

const glm::vec2 & rendering_engine::Drawable2D::GetPosition

(

)

const

Gets the quad position.

Definition at line 40 of file drawable_2d.cpp.

{
    return mSceneComponent.GetPosition();
}

GetRotation()

float rendering_engine::Drawable2D::GetRotation

(

)

const

Gets the quad rotation angle (degrees).

Definition at line 45 of file drawable_2d.cpp.

{
    return mSceneComponent.GetRotation();
}

GetScale()

const glm::vec2 & rendering_engine::Drawable2D::GetScale

(

)

const

Gets the quad scale.

Definition at line 50 of file drawable_2d.cpp.

{
    return mSceneComponent.GetScale();
}

GetTransform() [1/2]

SceneComponent2D & rendering_engine::Drawable2D::GetTransform

(

)

Access to the underlying SceneComponent2D (transform).

Definition at line 55 of file drawable_2d.cpp.

{
    return mSceneComponent;
}

GetTransform() [2/2]

const SceneComponent2D & rendering_engine::Drawable2D::GetTransform

(

)

const

Definition at line 60 of file drawable_2d.cpp.

{
    return mSceneComponent;
}

Initialize()

void rendering_engine::Drawable2D::Initialize ( )

overridevirtual

Initializes render resources.

Reimplemented from rendering_engine::DrawableComponent.

Reimplemented in rendering_engine::Quad2D, rendering_engine::Rectangle2D, rendering_engine::Sprite2D, and rendering_engine::TextBlock2D.

Definition at line 12 of file drawable_2d.cpp.

{
    DrawableComponent::Initialize();
}

SetPosition()

void rendering_engine::Drawable2D::SetPosition

(

const glm::vec2 &

position

)

Sets the quad position in 2D space.

Parameters

position

New position vector (x, y).

Definition at line 25 of file drawable_2d.cpp.

{
    mSceneComponent.SetPosition(position);
}

SetRotation()

void rendering_engine::Drawable2D::SetRotation

(

float

angleDegrees

)

Sets the quad rotation.

Parameters

angleDegrees

Rotation angle in degrees (counterclockwise).

Definition at line 30 of file drawable_2d.cpp.

{
    mSceneComponent.SetRotation(angleDegrees);
}

SetScale()

void rendering_engine::Drawable2D::SetScale

(

const glm::vec2 &

scale

)

Sets the quad scale along each axis.

Parameters

scale

New scale vector (x, y).

Definition at line 35 of file drawable_2d.cpp.

{
    mSceneComponent.SetScale(scale);
}

Update()

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

overridevirtual

Updates model matrix (and any other logic).

Parameters

deltaTime

Time step (seconds).

Implements rendering_engine::DrawableComponent.

Reimplemented in rendering_engine::Quad2D, rendering_engine::Rectangle2D, rendering_engine::Sprite2D, and rendering_engine::TextBlock2D.

Definition at line 17 of file drawable_2d.cpp.

{
    if (bUpdateOnTick)
    {
        mSceneComponent.UpdateWorldMatrix();
    }
}

Member Data Documentation

mSceneComponent

SceneComponent2D rendering_engine::Drawable2D::mSceneComponent

protected

Definition at line 97 of file drawable_2d.hpp.

---

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

• drawable_2d.hpp
• drawable_2d.cpp