Ketchup Engine
Loading...
Searching...
No Matches
Updatable Class Reference

#include <Updatable.h>

Inheritance diagram for Updatable:
Inheritance graph
Collaboration diagram for Updatable:
Collaboration graph

Public Member Functions

 Updatable ()
 
 Updatable (const Updatable &)=delete
 
Updatableoperator= (const Updatable &)=delete
 
virtual ~Updatable ()
 
virtual void Update ()
 Updates this Updatable. User should override this method as necessary.
 
void SubmitRegistration ()
 Submit update registration to the currently active Scene.
 
void SubmitDeregistration ()
 Submit update deregistration from the currently active Scene.
 

Private Member Functions

UpdatableManager::StorageListRef GetDeregRef ()
 
void SetDeregRef (UpdatableManager::StorageListRef ref)
 
void RegisterToScene ()
 
void DeregisterFromScene ()
 

Private Attributes

RegistrationState m_upRegState
 
UpdatableManager::StorageListRef m_deregRef
 
UpdateRegistrationCommandp_regCmd
 
UpdateDeregistrationCommandp_deregCmd
 

Friends

class UpdatableAttorney
 

Constructor & Destructor Documentation

◆ Updatable() [1/2]

Updatable::Updatable ( )

◆ Updatable() [2/2]

Updatable::Updatable ( const Updatable )
delete

◆ ~Updatable()

Updatable::~Updatable ( )
virtual

Member Function Documentation

◆ DeregisterFromScene()

void Updatable::DeregisterFromScene ( )
private

◆ GetDeregRef()

UpdatableManager::StorageListRef Updatable::GetDeregRef ( )
private

◆ operator=()

Updatable & Updatable::operator= ( const Updatable )
delete

◆ RegisterToScene()

void Updatable::RegisterToScene ( )
private

◆ SetDeregRef()

void Updatable::SetDeregRef ( UpdatableManager::StorageListRef  ref)
private

◆ SubmitDeregistration()

void Updatable::SubmitDeregistration ( )

Submit update deregistration from the currently active Scene.

Haru, 3/19/2023.

◆ SubmitRegistration()

void Updatable::SubmitRegistration ( )

Submit update registration to the currently active Scene.

Haru, 3/19/2023.

◆ Update()

virtual void Updatable::Update ( )
inlinevirtual

Updates this Updatable. User should override this method as necessary.

Haru, 3/8/2023.

Reimplemented in SongPlayer.

Friends And Related Function Documentation

◆ UpdatableAttorney

friend class UpdatableAttorney
friend

Member Data Documentation

◆ m_deregRef

UpdatableManager::StorageListRef Updatable::m_deregRef
private

◆ m_upRegState

RegistrationState Updatable::m_upRegState
private

◆ p_deregCmd

UpdateDeregistrationCommand* Updatable::p_deregCmd
private

◆ p_regCmd

UpdateRegistrationCommand* Updatable::p_regCmd
private

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