Murl::Logic::IAppStage Interface Referenceabstract

The IAppStage interface. More...

#include "murl_logic_i_app_stage.h"

Inheritance diagram for Murl::Logic::IAppStage:

Public Member Functions

virtual Bool OnInitStage (const Logic::IState *state, Logic::IStageProcessor *stageProcessor)=0
 Called by IStage::InitStage(). More...
 
virtual Bool OnDeInitStage (const Logic::IState *state, Logic::IStageProcessor *stageProcessor)=0
 Called by IStage::DeInitStage(). More...
 
virtual void OnProcessStageTickBeginIntro (const Logic::IState *state, Logic::IStageProcessor *stageProcessor)=0
 Called by IStage::ProcessStageTickSelf() for IStage::RUN_STATE_BEGIN_INTRO. More...
 
virtual void OnProcessStageTickRunIntro (const Logic::IState *state, Logic::IStageProcessor *stageProcessor)=0
 Called by IStage::ProcessStageTickSelf() for IStage::RUN_STATE_RUN_INTRO. More...
 
virtual void OnProcessStageTickBeginRun (const Logic::IState *state, Logic::IStageProcessor *stageProcessor)=0
 Called by IStage::ProcessStageTickSelf() for IStage::RUN_STATE_BEGIN_RUN. More...
 
virtual void OnProcessStageTickRun (const Logic::IState *state, Logic::IStageProcessor *stageProcessor)=0
 Called by IStage::ProcessStageTickSelf() for IStage::RUN_STATE_RUN. More...
 
virtual void OnProcessStageTickBeginOutro (const Logic::IState *state, Logic::IStageProcessor *stageProcessor)=0
 Called by IStage::ProcessStageTickSelf() for IStage::RUN_STATE_BEGIN_OUTRO. More...
 
virtual void OnProcessStageTickRunOutro (const Logic::IState *state, Logic::IStageProcessor *stageProcessor)=0
 Called by IStage::ProcessStageTickSelf() for IStage::RUN_STATE_RUN_OUTRO. More...
 
virtual void OnProcessStageTickStop (const Logic::IState *state, Logic::IStageProcessor *stageProcessor)=0
 Called by IStage::ProcessStageTickSelf() at finish of IStage::RUN_STATE_RUN_OUTRO. More...
 
virtual void OnProcessStageTick (const Logic::IState *state, Logic::IStageProcessor *stageProcessor)=0
 Called by IStage::ProcessStageTickSelf(). More...
 
virtual void OnProcessStageFrame (const Logic::IState *state, Logic::IStageProcessor *stageProcessor)=0
 Called by IStage::ProcessStageFrameSelf(). More...
 
virtual void OnFinishStageTick (const Logic::IState *state, Logic::IStageProcessor *stageProcessor)=0
 Called by IStage::FinishStageTickSelf(). More...
 
virtual void OnFinishStageFrame (const Logic::IState *state, Logic::IStageProcessor *stageProcessor)=0
 Called by IStage::FinishStageFrameSelf(). More...
 

Detailed Description

The IAppStage interface.

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

Member Function Documentation

◆ OnInitStage()

virtual Bool Murl::Logic::IAppStage::OnInitStage ( const Logic::IState state,
Logic::IStageProcessor stageProcessor 
)
pure virtual

Called by IStage::InitStage().

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

Implemented in Murl::Logic::BaseStage.

◆ OnDeInitStage()

virtual Bool Murl::Logic::IAppStage::OnDeInitStage ( const Logic::IState state,
Logic::IStageProcessor stageProcessor 
)
pure virtual

Called by IStage::DeInitStage().

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

Implemented in Murl::Logic::BaseStage.

◆ OnProcessStageTickBeginIntro()

virtual void Murl::Logic::IAppStage::OnProcessStageTickBeginIntro ( const Logic::IState state,
Logic::IStageProcessor stageProcessor 
)
pure virtual

Called by IStage::ProcessStageTickSelf() for IStage::RUN_STATE_BEGIN_INTRO.

Parameters
stateThe IState object.
stageProcessorThe corresponding IStageProcessor object.

Implemented in Murl::Logic::BaseStage.

◆ OnProcessStageTickRunIntro()

virtual void Murl::Logic::IAppStage::OnProcessStageTickRunIntro ( const Logic::IState state,
Logic::IStageProcessor stageProcessor 
)
pure virtual

Called by IStage::ProcessStageTickSelf() for IStage::RUN_STATE_RUN_INTRO.

Parameters
stateThe IState object.
stageProcessorThe corresponding IStageProcessor object.

Implemented in Murl::Logic::BaseStage.

◆ OnProcessStageTickBeginRun()

virtual void Murl::Logic::IAppStage::OnProcessStageTickBeginRun ( const Logic::IState state,
Logic::IStageProcessor stageProcessor 
)
pure virtual

Called by IStage::ProcessStageTickSelf() for IStage::RUN_STATE_BEGIN_RUN.

Parameters
stateThe IState object.
stageProcessorThe corresponding IStageProcessor object.

Implemented in Murl::Logic::BaseStage.

◆ OnProcessStageTickRun()

virtual void Murl::Logic::IAppStage::OnProcessStageTickRun ( const Logic::IState state,
Logic::IStageProcessor stageProcessor 
)
pure virtual

Called by IStage::ProcessStageTickSelf() for IStage::RUN_STATE_RUN.

Parameters
stateThe IState object.
stageProcessorThe corresponding IStageProcessor object.

Implemented in Murl::Logic::BaseStage.

◆ OnProcessStageTickBeginOutro()

virtual void Murl::Logic::IAppStage::OnProcessStageTickBeginOutro ( const Logic::IState state,
Logic::IStageProcessor stageProcessor 
)
pure virtual

Called by IStage::ProcessStageTickSelf() for IStage::RUN_STATE_BEGIN_OUTRO.

Parameters
stateThe IState object.
stageProcessorThe corresponding IStageProcessor object.

Implemented in Murl::Logic::BaseStage.

◆ OnProcessStageTickRunOutro()

virtual void Murl::Logic::IAppStage::OnProcessStageTickRunOutro ( const Logic::IState state,
Logic::IStageProcessor stageProcessor 
)
pure virtual

Called by IStage::ProcessStageTickSelf() for IStage::RUN_STATE_RUN_OUTRO.

Parameters
stateThe IState object.
stageProcessorThe corresponding IStageProcessor object.

Implemented in Murl::Logic::BaseStage.

◆ OnProcessStageTickStop()

virtual void Murl::Logic::IAppStage::OnProcessStageTickStop ( const Logic::IState state,
Logic::IStageProcessor stageProcessor 
)
pure virtual

Called by IStage::ProcessStageTickSelf() at finish of IStage::RUN_STATE_RUN_OUTRO.

Parameters
stateThe IState object.
stageProcessorThe corresponding IStageProcessor object.

Implemented in Murl::Logic::BaseStage.

◆ OnProcessStageTick()

virtual void Murl::Logic::IAppStage::OnProcessStageTick ( const Logic::IState state,
Logic::IStageProcessor stageProcessor 
)
pure virtual

Called by IStage::ProcessStageTickSelf().

Parameters
stateThe IState object.
stageProcessorThe corresponding IStageProcessor object.

Implemented in Murl::Logic::BaseStage.

◆ OnProcessStageFrame()

virtual void Murl::Logic::IAppStage::OnProcessStageFrame ( const Logic::IState state,
Logic::IStageProcessor stageProcessor 
)
pure virtual

Called by IStage::ProcessStageFrameSelf().

Parameters
stateThe IState object.
stageProcessorThe corresponding IStageProcessor object.

Implemented in Murl::Logic::BaseStage.

◆ OnFinishStageTick()

virtual void Murl::Logic::IAppStage::OnFinishStageTick ( const Logic::IState state,
Logic::IStageProcessor stageProcessor 
)
pure virtual

Called by IStage::FinishStageTickSelf().

Parameters
stateThe IState object.
stageProcessorThe corresponding IStageProcessor object.

Implemented in Murl::Logic::BaseStage.

◆ OnFinishStageFrame()

virtual void Murl::Logic::IAppStage::OnFinishStageFrame ( const Logic::IState state,
Logic::IStageProcessor stageProcessor 
)
pure virtual

Called by IStage::FinishStageFrameSelf().

Parameters
stateThe IState object.
stageProcessorThe corresponding IStageProcessor object.

Implemented in Murl::Logic::BaseStage.


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


Copyright © 2011-2018 Spraylight GmbH.