OpenEnroth 73e68f7
Loading...
Searching...
No Matches
Protected Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
PlatformApplicationAware Class Reference

#include <PlatformApplicationAware.h>

Inheritance diagram for PlatformApplicationAware:
EngineControlComponent EngineDeterministicComponent EngineRandomComponent EngineTracePlayer EngineTraceRecorder EngineTraceSimplePlayer EngineTraceSimpleRecorder GameTraceHandler GameWindowHandler

Protected Member Functions

 ~PlatformApplicationAware ()=default
 
PlatformApplicationapplication () const
 
template<class T >
T * component () const
 
virtual void installNotify ()
 
virtual void removeNotify ()
 

Private Member Functions

void initialize (PlatformApplication *application, const PlatformComponentStorage *componentStorage)
 
void deinitialize ()
 

Private Attributes

PlatformApplication_application = nullptr
 
const PlatformComponentStorage_componentStorage = nullptr
 

Friends

class PlatformApplication
 

Detailed Description

Derive your component from PlatformApplicationAware to get access to an application instance that it was installed into.

Constructor & Destructor Documentation

◆ ~PlatformApplicationAware()

PlatformApplicationAware::~PlatformApplicationAware ( )
protecteddefault

Member Function Documentation

◆ application()

PlatformApplication * PlatformApplicationAware::application ( ) const
inlineprotected

◆ component()

template<class T >
T * PlatformApplicationAware::component ( ) const
inlineprotected

◆ deinitialize()

void PlatformApplicationAware::deinitialize ( )
inlineprivate

◆ initialize()

void PlatformApplicationAware::initialize ( PlatformApplication application,
const PlatformComponentStorage componentStorage 
)
inlineprivate

◆ installNotify()

virtual void PlatformApplicationAware::installNotify ( )
inlineprotectedvirtual

Called after installation into a PlatformApplication. application() will return non-null inside this function.

Reimplemented in EngineRandomComponent.

◆ removeNotify()

virtual void PlatformApplicationAware::removeNotify ( )
inlineprotectedvirtual

Called before removal from a PlatformApplication. application() will return non-null inside this function.

Reimplemented in EngineControlComponent, EngineDeterministicComponent, and EngineRandomComponent.

Friends And Related Function Documentation

◆ PlatformApplication

friend class PlatformApplication
friend

Member Data Documentation

◆ _application

PlatformApplication* PlatformApplicationAware::_application = nullptr
private

◆ _componentStorage

const PlatformComponentStorage* PlatformApplicationAware::_componentStorage = nullptr
private

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