The IStageProcessor interface.
More...
#include <murl_logic_i_stage_processor.h>
The IStageProcessor interface.
The IStageProcessor is handling a set of IStage objects. The IStage::RunState is controlled by the IStageProcessor.
Optional a graph <Switch> identifier can be specified to automatically select a sub graph attached to a switch child. The graph switch identifier must be set by SetSwitchNodeId() and each IStage registered to the IStageHandler can specify a switch identifier for selecting the active child of the switch at IStage::RUN_STATE_BEGIN_INTRO.
Additional IProcessor objects can be added to the IStageProcessor object by using myStageProc->GetProcessor(myStageProc)->AddChild(). The IProcessor (OnInit, OnProcessTick, OnProcessFrame) is always executed before the stage execution.
Inherited by Murl::Logic::StageProcessor.
◆ GetProcessor()
virtual IProcessorPtr Murl::Logic::IStageProcessor::GetProcessor |
( |
| ) |
|
|
pure virtual |
Get the processor interface from a stage-processor object.
The IStageProcessor conforms to the IProcessor interface.
- Returns
- The processor interface shared pointer.
◆ AddStage()
virtual Bool Murl::Logic::IStageProcessor::AddStage |
( |
IStagePtr |
stage | ) |
|
|
pure virtual |
Add a stage object.
- Parameters
-
stage | The stage object to add. |
- Returns
- true if successful.
◆ RemoveStage()
virtual Bool Murl::Logic::IStageProcessor::RemoveStage |
( |
IStagePtr |
stage | ) |
|
|
pure virtual |
Remove a stage object.
- Parameters
-
stage | The stage object to remove. |
- Returns
- true if successful.
◆ InitAddStage()
virtual Bool Murl::Logic::IStageProcessor::InitAddStage |
( |
const IState * |
state, |
|
|
IStagePtr |
stage |
|
) |
| |
|
pure virtual |
Initialize and add a stage object.
- Parameters
-
state | The IState object. |
stage | The stage object to initialize and add. |
- Returns
- true if successful.
◆ RemoveDeInitStage()
virtual Bool Murl::Logic::IStageProcessor::RemoveDeInitStage |
( |
const IState * |
state, |
|
|
IStagePtr |
stage |
|
) |
| |
|
pure virtual |
Remove and deinitialize a stage object.
- Parameters
-
state | The IState object. |
stage | The stage object to deinitialize and remove. |
- Returns
- true if successful.
◆ SetSwitchNodeId()
virtual Bool Murl::Logic::IStageProcessor::SetSwitchNodeId |
( |
const String & |
switchNodeId | ) |
|
|
pure virtual |
Set the graph switch node identifier.
Must be set before the stage processor is initialized.
- Parameters
-
switchNodeId | The full path to the graph <Switch> instance. |
- Returns
- true if successful.
◆ GetSwitchNodeId()
virtual const String& Murl::Logic::IStageProcessor::GetSwitchNodeId |
( |
| ) |
const |
|
pure virtual |
Get the graph switch node identifier.
- Returns
- The switch node identifier string including the full path.
◆ GetStage()
virtual IStagePtr Murl::Logic::IStageProcessor::GetStage |
( |
const String & |
stageId | ) |
const |
|
pure virtual |
Get a stage object by name.
- Parameters
-
stageId | The identifier of the stage to get. |
- Returns
- The stage object or null if the identifier is not found.
◆ SetStageRunState()
Set the current run state of a stage.
- Parameters
-
stageId | The identifier of the stage to modify. |
runState | The run state to set. |
- Returns
- true if successful.
◆ IsAnyTimelineRunning()
virtual Bool Murl::Logic::IStageProcessor::IsAnyTimelineRunning |
( |
| ) |
const |
|
pure virtual |
Check if any stage's IStageTimeline is running.
- Returns
- true if any stage timeline is running.
◆ StartIntro() [1/3]
virtual Bool Murl::Logic::IStageProcessor::StartIntro |
( |
const String & |
stageId | ) |
|
|
pure virtual |
◆ StartOutro() [1/3]
virtual Bool Murl::Logic::IStageProcessor::StartOutro |
( |
const String & |
stageId | ) |
|
|
pure virtual |
◆ StartIntro() [2/3]
virtual Bool Murl::Logic::IStageProcessor::StartIntro |
( |
const String & |
stageId, |
|
|
Real |
startTime |
|
) |
| |
|
pure virtual |
◆ StartOutro() [2/3]
virtual Bool Murl::Logic::IStageProcessor::StartOutro |
( |
const String & |
stageId, |
|
|
Real |
endTime |
|
) |
| |
|
pure virtual |
◆ StartIntro() [3/3]
virtual Bool Murl::Logic::IStageProcessor::StartIntro |
( |
const String & |
stageId, |
|
|
Real |
startTime, |
|
|
Real |
endTime |
|
) |
| |
|
pure virtual |
◆ StartOutro() [3/3]
virtual Bool Murl::Logic::IStageProcessor::StartOutro |
( |
const String & |
stageId, |
|
|
Real |
startTime, |
|
|
Real |
endTime |
|
) |
| |
|
pure virtual |
The documentation for this interface was generated from the following file:
- murl_logic_i_stage_processor.h