Murl::Logic::IAppProcessor Interface Referenceabstract

The IAppProcessor interface. More...

#include "murl_logic_i_app_processor.h"

Inheritance diagram for Murl::Logic::IAppProcessor:

Public Member Functions

virtual Bool OnInit (const Logic::IState *state)=0
 Called by IProcessor at initialization. More...
 
virtual Bool OnDeInit (const Logic::IState *state)=0
 Called by IProcessor at deinitialization. More...
 
virtual void OnProcessTick (const Logic::IState *state)=0
 Called by IProcessor each logic tick if enabled. More...
 
virtual void OnProcessTickChildren (const Logic::IState *state)=0
 Called by IProcessor after processing children's OnProcessTick() each logic tick if enabled. More...
 
virtual void OnProcessFrame (const Logic::IState *state)=0
 Called by IProcessor each frame tick if enabled. More...
 
virtual void OnProcessFrameChildren (const Logic::IState *state)=0
 Called by IProcessor after processing children's OnProcessFrame() each frame tick if enabled. More...
 
virtual void OnFinishTick (const Logic::IState *state)=0
 Called by IProcessor each logic tick if enabled. More...
 
virtual void OnFinishTickChildren (const Logic::IState *state)=0
 Called by IProcessor after processing children's OnFinishTick() each logic tick if enabled. More...
 
virtual void OnFinishFrame (const Logic::IState *state)=0
 Called by IProcessor each frame tick if enabled. More...
 
virtual void OnFinishFrameChildren (const Logic::IState *state)=0
 Called by IProcessor after processing children's OnFinishFrame() each frame tick if enabled. More...
 
virtual void OnPackageWillBeLoaded (const Logic::IState *state, IPackage *package)=0
 Called by IProcessor to report the beginning of package loading. More...
 
virtual void OnPackageWasLoaded (const Logic::IState *state, IPackage *package)=0
 Called by IProcessor to report the succesful loading of a package. More...
 
virtual void OnPackageFailedLoading (const Logic::IState *state, IPackage *package)=0
 Called by IProcessor to report failed loading a package. More...
 
virtual void OnPackageWillBeUnloaded (const Logic::IState *state, IPackage *package)=0
 Called by IProcessor to report the beginning of package unloading. More...
 
virtual void OnPackageWasUnloaded (const Logic::IState *state, IPackage *package)=0
 Called by IProcessor to report the succesful unloading of a package. More...
 
virtual void OnPackageFailedUnloading (const Logic::IState *state, IPackage *package)=0
 Called by IProcessor to report failed unloading a package. More...
 
virtual void OnRunStateChanged (const Logic::IState *state, IEnums::AppRunState currentState, IEnums::AppRunState previousState)=0
 Called by IProcessor to report a change of the application run state. More...
 
virtual void OnSetEnabled (Bool isEnabled)=0
 Called by IProcessor::SetEnabled(). More...
 

Detailed Description

The IAppProcessor interface.

This interface is used by the IProcessor object to callback the app.

Member Function Documentation

◆ OnInit()

virtual Bool Murl::Logic::IAppProcessor::OnInit ( const Logic::IState state)
pure virtual

Called by IProcessor at initialization.

Parameters
stateThe IState object.
Returns
true if successful, should return false if any initialization failed.

Implemented in Murl::Logic::BaseProcessor.

◆ OnDeInit()

virtual Bool Murl::Logic::IAppProcessor::OnDeInit ( const Logic::IState state)
pure virtual

Called by IProcessor at deinitialization.

Parameters
stateThe IState object.
Returns
true if successful, should return false if any deinitialization failed.

Implemented in Murl::Logic::BaseProcessor.

◆ OnProcessTick()

virtual void Murl::Logic::IAppProcessor::OnProcessTick ( const Logic::IState state)
pure virtual

Called by IProcessor each logic tick if enabled.

Parameters
stateThe IState object.

Implemented in Murl::Logic::BaseProcessor.

◆ OnProcessTickChildren()

virtual void Murl::Logic::IAppProcessor::OnProcessTickChildren ( const Logic::IState state)
pure virtual

Called by IProcessor after processing children's OnProcessTick() each logic tick if enabled.

Parameters
stateThe IState object.

Implemented in Murl::Logic::BaseProcessor.

◆ OnProcessFrame()

virtual void Murl::Logic::IAppProcessor::OnProcessFrame ( const Logic::IState state)
pure virtual

Called by IProcessor each frame tick if enabled.

Parameters
stateThe IState object.

Implemented in Murl::Logic::BaseProcessor.

◆ OnProcessFrameChildren()

virtual void Murl::Logic::IAppProcessor::OnProcessFrameChildren ( const Logic::IState state)
pure virtual

Called by IProcessor after processing children's OnProcessFrame() each frame tick if enabled.

Parameters
stateThe IState object.

Implemented in Murl::Logic::BaseProcessor.

◆ OnFinishTick()

virtual void Murl::Logic::IAppProcessor::OnFinishTick ( const Logic::IState state)
pure virtual

Called by IProcessor each logic tick if enabled.

Parameters
stateThe IState object.

Implemented in Murl::Logic::BaseProcessor.

◆ OnFinishTickChildren()

virtual void Murl::Logic::IAppProcessor::OnFinishTickChildren ( const Logic::IState state)
pure virtual

Called by IProcessor after processing children's OnFinishTick() each logic tick if enabled.

Parameters
stateThe IState object.

Implemented in Murl::Logic::BaseProcessor.

◆ OnFinishFrame()

virtual void Murl::Logic::IAppProcessor::OnFinishFrame ( const Logic::IState state)
pure virtual

Called by IProcessor each frame tick if enabled.

Parameters
stateThe IState object.

Implemented in Murl::Logic::BaseProcessor.

◆ OnFinishFrameChildren()

virtual void Murl::Logic::IAppProcessor::OnFinishFrameChildren ( const Logic::IState state)
pure virtual

Called by IProcessor after processing children's OnFinishFrame() each frame tick if enabled.

Parameters
stateThe IState object.

Implemented in Murl::Logic::BaseProcessor.

◆ OnPackageWillBeLoaded()

virtual void Murl::Logic::IAppProcessor::OnPackageWillBeLoaded ( const Logic::IState state,
IPackage package 
)
pure virtual

Called by IProcessor to report the beginning of package loading.

Parameters
stateThe IState object.
packageThe package to load.

Implemented in Murl::Logic::BaseProcessor.

◆ OnPackageWasLoaded()

virtual void Murl::Logic::IAppProcessor::OnPackageWasLoaded ( const Logic::IState state,
IPackage package 
)
pure virtual

Called by IProcessor to report the succesful loading of a package.

Parameters
stateThe IState object.
packageThe package to load.

Implemented in Murl::Logic::BaseProcessor.

◆ OnPackageFailedLoading()

virtual void Murl::Logic::IAppProcessor::OnPackageFailedLoading ( const Logic::IState state,
IPackage package 
)
pure virtual

Called by IProcessor to report failed loading a package.

Parameters
stateThe IState object.
packageThe package to load.

Implemented in Murl::Logic::BaseProcessor.

◆ OnPackageWillBeUnloaded()

virtual void Murl::Logic::IAppProcessor::OnPackageWillBeUnloaded ( const Logic::IState state,
IPackage package 
)
pure virtual

Called by IProcessor to report the beginning of package unloading.

Parameters
stateThe IState object.
packageThe package to load.

Implemented in Murl::Logic::BaseProcessor.

◆ OnPackageWasUnloaded()

virtual void Murl::Logic::IAppProcessor::OnPackageWasUnloaded ( const Logic::IState state,
IPackage package 
)
pure virtual

Called by IProcessor to report the succesful unloading of a package.

Parameters
stateThe IState object.
packageThe package to load.

Implemented in Murl::Logic::BaseProcessor.

◆ OnPackageFailedUnloading()

virtual void Murl::Logic::IAppProcessor::OnPackageFailedUnloading ( const Logic::IState state,
IPackage package 
)
pure virtual

Called by IProcessor to report failed unloading a package.

Parameters
stateThe IState object.
packageThe package to load.

Implemented in Murl::Logic::BaseProcessor.

◆ OnRunStateChanged()

virtual void Murl::Logic::IAppProcessor::OnRunStateChanged ( const Logic::IState state,
IEnums::AppRunState  currentState,
IEnums::AppRunState  previousState 
)
pure virtual

Called by IProcessor to report a change of the application run state.

Parameters
stateThe IState object.
currentStateThe current run state.
previousStateThe previous run state.

Implemented in Murl::Logic::BaseProcessor.

◆ OnSetEnabled()

virtual void Murl::Logic::IAppProcessor::OnSetEnabled ( Bool  isEnabled)
pure virtual

Called by IProcessor::SetEnabled().

This method is used to track the enabled state.

Parameters
isEnabledtrue if enabled.

Implemented in Murl::Logic::BaseProcessor.


The documentation for this interface was generated from the following file:
  • murl_logic_i_app_processor.h


Copyright © 2011-2018 Spraylight GmbH.