The Joe Engine
Joe's engine programming playground
JoeEngine::JETransformComponentManager Class Reference

The Transform Component Manager class. More...

#include <TransformComponentManager.h>

Inheritance diagram for JoeEngine::JETransformComponentManager:
JoeEngine::JEComponentManager

Public Member Functions

 JETransformComponentManager ()=default
 Default constructor. More...
 
virtual ~JETransformComponentManager ()=default
 Destructor (default). More...
 
void Update (JEEngineInstance *engineInstance) override
 Update transform components. More...
 
void AddNewComponent (uint32_t entityID) override
 Add new transform component. More...
 
void RemoveComponent (uint32_t entityID) override
 Remove transform component. More...
 
TransformComponentGetComponent (uint32_t entityID) const
 Get transform component. More...
 
const PackedArray< TransformComponent > & GetComponentList () const
 Get list of transform components. More...
 
- Public Member Functions inherited from JoeEngine::JEComponentManager
 JEComponentManager ()=default
 Default constructor. More...
 
virtual ~JEComponentManager ()=default
 Destructor (default). More...
 

Detailed Description

The Transform Component Manager class.

Contains all transform components in a packed array of data.

See also
JEEngineInstance

Constructor & Destructor Documentation

◆ JETransformComponentManager()

JoeEngine::JETransformComponentManager::JETransformComponentManager ( )
default

Default constructor.

No specific behavior.

◆ ~JETransformComponentManager()

virtual JoeEngine::JETransformComponentManager::~JETransformComponentManager ( )
virtualdefault

Destructor (default).

Member Function Documentation

◆ AddNewComponent()

void JoeEngine::JETransformComponentManager::AddNewComponent ( uint32_t  entityID)
overridevirtual

Add new transform component.

Adds a new, default-constructed transform component to the packed array of transform components at the specified entity index. Overrides purely virtual function declared in JEComponentManager.

Parameters
entityIDthe id of the entity to add the transform component to

Implements JoeEngine::JEComponentManager.

◆ GetComponent()

TransformComponent * JoeEngine::JETransformComponentManager::GetComponent ( uint32_t  entityID) const

Get transform component.

Gets the transform component attached to the entity ID.

Parameters
entityIDthe entity ID whose transform component to return
Returns
pointer to the transform component attached to the entity ID

◆ GetComponentList()

const PackedArray< TransformComponent > & JoeEngine::JETransformComponentManager::GetComponentList ( ) const

Get list of transform components.

Gets the member list of transform components.

Returns
the packed array of transform components.

◆ RemoveComponent()

void JoeEngine::JETransformComponentManager::RemoveComponent ( uint32_t  entityID)
overridevirtual

Remove transform component.

Removes the transform component from the packed array of transform components at the specified entity index. Overrides purely virtual function declared in JEComponentManager.

Parameters
entityIDthe id of the entity to remove the transform component from

Implements JoeEngine::JEComponentManager.

◆ Update()

void JoeEngine::JETransformComponentManager::Update ( JEEngineInstance engineInstance)
overridevirtual

Update transform components.

Updates all stored transform components. Currently, updating transform components does nothing. Overrides purely virtual function declared in JEComponentManager.

Parameters
engineInstancea reference to the current JEEngineInstance object if needed for certain API calls

Implements JoeEngine::JEComponentManager.


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