A helper class for simple use of the IStageProcessor object. More...

#include "murl_logic_base_stage_processor.h"

Inheritance diagram for Murl::Logic::BaseStageProcessor:

Public Member Functions
	BaseStageProcessor (IFactory *factory)
	The constructor. More...

	~BaseStageProcessor () override
	The destructor. More...

	operator IStageProcessorPtr () const
	Conversion operator. More...

IStageProcessorPtr	GetStageProcessor () const
	Get the stage processor interface. More...

Bool	AddStage (IStagePtr stage) const
	Forward to IStageProcessor::AddStage() method. More...

Bool	RemoveStage (IStagePtr stage) const
	Forward to IStageProcessor::RemoveStage() method. More...

Bool	InitAddStage (const IState *state, IStagePtr stage) const
	Forward to IStageProcessor::InitAddStage() method. More...

Bool	RemoveDeInitStage (const IState *state, IStagePtr stage) const
	Forward to IStageProcessor::RemoveDeInitStage() method. More...

void	SetSwitchNodeId (const String &switchNodeId) const
	Forward to IStageProcessor::SetSwitchNodeId() method. More...

const String &	GetSwitchNodeId () const
	Forward to IStageProcessor::GetSwitchNodeId() method. More...

IStagePtr	GetStage (const String &stageId) const
	Forward to IStageProcessor::GetStage() method. More...

Bool	SetStageRunState (const String &stageId, IStage::RunState runState) const
	Forward to IStageProcessor::SetStageRunState() method. More...

Bool	IsAnyTimelineRunning () const
	Forward to IStageProcessor::IsAnyTimelineRunning() method. More...

Bool	StartIntro (const String &stageId) const
	Forward to IStageProcessor::StartIntro() method. More...

Bool	StartOutro (const String &stageId) const
	Forward to IStageProcessor::StartOutro() method. More...

Bool	StartIntro (const String &stageId, Real startTime) const
	Forward to IStageProcessor::StartIntro() method. More...

Bool	StartOutro (const String &stageId, Real endTime) const
	Forward to IStageProcessor::StartOutro() method. More...

Bool	StartIntro (const String &stageId, Real startTime, Real endTime) const
	Forward to IStageProcessor::StartIntro() method. More...

Bool	StartOutro (const String &stageId, Real startTime, Real endTime) const
	Forward to IStageProcessor::StartOutro() method. More...

Public Member Functions inherited from Murl::Logic::BaseProcessor
	BaseProcessor (IFactory *factory)
	The constructor. More...

	~BaseProcessor () override
	The destructor. More...

	operator IProcessorPtr () const
	Conversion operator. More...

IProcessorPtr	GetProcessor () const
	Get the processor interface. More...

Bool	SetAppProcessor (IAppProcessorPtr appProcessor) const
	Forward to IProcessor::SetAppProcessor() method. More...

Bool	IsInitialized () const
	Forward to IProcessor::IsInitialized() method. More...

void	SetEnabled (Bool isEnabled) const
	Forward to IProcessor::SetEnabled() method. More...

Bool	IsEnabled () const
	Forward to IProcessor::IsEnabled() method. More...

Bool	AddChild (IProcessorPtr processor) const
	Forward to IProcessor::AddChild() method. More...

Bool	RemoveChild (IProcessorPtr processor) const
	Forward to IProcessor::RemoveChild() method. More...

Bool	InitAddChild (const IState *state, IProcessorPtr processor) const
	Forward to IProcessor::InitAddChild() method. More...

Bool	RemoveDeInitChild (const IState *state, IProcessorPtr processor) const
	Forward to IProcessor::RemoveDeInitChild() method. More...

UInt32	GetNumberOfChildren () const
	Forward to IProcessor::GetNumberOfChildren() method. More...

IProcessorPtr	GetChild (UInt32 index) const
	Forward to IProcessor::GetChild() method. More...

Bool	AddStepable (IStepablePtr stepable) const
	Forward to IProcessor::AddStepable() method. More...

Bool	RemoveStepable (IStepablePtr stepable) const
	Forward to IProcessor::RemoveStepable() method. More...

Logic::IStepableObserverPtr	GetStepableObserver () const
	Forward to IProcessor::GetStepableObserver() method. More...

Bool	AddGraphNode (IObservableNodePtr observableNode) const
	Forward to IProcessor::AddGraphNode() method. More...

Bool	RemoveGraphNode (IObservableNodePtr observableNode) const
	Forward to IProcessor::RemoveGraphNode() method. More...

Bool	AreGraphNodesValid () const
	Forward to IProcessor::AreGraphNodesValid() method. More...

INodeObserverPtr	GetNodeObserverPtr () const
	Forward to IProcessor::GetNodeObserver() method. More...

INodeObserver *	GetNodeObserver () const
	Get the processor's node observer interface pointer. More...

Additional Inherited Members
Protected Member Functions inherited from Murl::Logic::BaseProcessor
Bool	OnInit (const Logic::IState *state) override
	Default implementation of IAppProcessor::OnInit() method, this method is empty and can be overwritten. More...

Bool	OnDeInit (const Logic::IState *state) override
	Default implementation of IAppProcessor::OnDeInit() method, this method is empty and can be overwritten. More...

void	OnProcessTick (const Logic::IState *state) override
	Default implementation of IAppProcessor::OnProcessTick() method, this method is empty and can be overwritten. More...

void	OnProcessTickChildren (const Logic::IState *state) override
	Default implementation of IAppProcessor::OnProcessTickChildren() method, this method is empty and can be overwritten. More...

void	OnProcessFrame (const Logic::IState *state) override
	Default implementation of IAppProcessor::OnProcessFrame() method, this method is empty and can be overwritten. More...

void	OnProcessFrameChildren (const Logic::IState *state) override
	Default implementation of IAppProcessor::OnProcessFrameChildren() method, this method is empty and can be overwritten. More...

void	OnFinishTick (const Logic::IState *state) override
	Default implementation of IAppProcessor::OnFinishTick() method, this method is empty and can be overwritten. More...

void	OnFinishTickChildren (const Logic::IState *state) override
	Default implementation of IAppProcessor::OnFinishTickChildren() method, this method is empty and can be overwritten. More...

void	OnFinishFrame (const Logic::IState *state) override
	Default implementation of IAppProcessor::OnFinishFrame() method, this method is empty and can be overwritten. More...

void	OnFinishFrameChildren (const Logic::IState *state) override
	Default implementation of IAppProcessor::OnFinishFrameChildren() method, this method is empty and can be overwritten. More...

void	OnBuildDebugUI (const IState *state) override
	Default implementation of IAppProcessor::OnProcessUI() method, this method is empty and can be overwritten. More...

void	OnBuildDebugUIChildren (const IState *state) override
	Default implementation of IAppProcessor::OnProcessUIChildren() method, this method is empty and can be overwritten. More...

void	OnPackageWillBeLoaded (const Logic::IState state, IPackage package) override
	Default implementation of IAppProcessor::OnPackageWillBeLoaded() method, this method is empty and can be overwritten. More...

void	OnPackageWasLoaded (const Logic::IState state, IPackage package) override
	Default implementation of IAppProcessor::OnPackageWasLoaded() method, this method is empty and can be overwritten. More...

void	OnPackageFailedLoading (const Logic::IState state, IPackage package) override
	Default implementation of IAppProcessor::OnPackageFailedLoading() method, this method is empty and can be overwritten. More...

void	OnPackageWillBeUnloaded (const Logic::IState state, IPackage package) override
	Default implementation of IAppProcessor::OnPackageWillBeUnloaded() method, this method is empty and can be overwritten. More...

void	OnPackageWasUnloaded (const Logic::IState state, IPackage package) override
	Default implementation of IAppProcessor::OnPackageWasUnloaded() method, this method is empty and can be overwritten. More...

void	OnPackageFailedUnloading (const Logic::IState state, IPackage package) override
	Default implementation of IAppProcessor::OnPackageFailedUnloading() method, this method is empty and can be overwritten. More...

void	OnRunStateChanged (const Logic::IState *state, IEnums::AppRunState currentState, IEnums::AppRunState previousState) override
	Default implementation of IAppProcessor::OnRunStateChanged() method, this method is empty and can be overwritten. More...

void	OnSetEnabled (Bool isEnabled) override
	Default implementation of IAppProcessor::OnSetEnabled() method, this method is empty and can be overwritten. More...

Detailed Description

A helper class for simple use of the IStageProcessor object.

The BaseStageProcessor class implements a BaseProcessor.
A stage processor is created and initialized at object instantiation.

Constructor & Destructor Documentation

◆ BaseStageProcessor()

Murl::Logic::BaseStageProcessor::BaseStageProcessor ( IFactory * factory )

inline

The constructor.

Creates a IStageProcessor object.

Parameters

factory The logic factory object.

◆ ~BaseStageProcessor()

Murl::Logic::BaseStageProcessor::~BaseStageProcessor ( )

inlineoverride

The destructor.

Destroys the IStageProcessor object.

Member Function Documentation

◆ operator IStageProcessorPtr()

Murl::Logic::BaseStageProcessor::operator IStageProcessorPtr ( ) const

inline

Conversion operator.

Returns: The IStageProcessor interface.

◆ GetStageProcessor()

IStageProcessorPtr Murl::Logic::BaseStageProcessor::GetStageProcessor ( ) const

inline

Get the stage processor interface.

Returns: The IStageProcessor interface.

◆ AddStage()

Bool Murl::Logic::BaseStageProcessor::AddStage ( IStagePtr stage ) const

inline

Forward to IStageProcessor::AddStage() method.

Parameters

stage The stage object to add.

Returns: true if successful.

◆ RemoveStage()

Bool Murl::Logic::BaseStageProcessor::RemoveStage ( IStagePtr stage ) const

inline

Forward to IStageProcessor::RemoveStage() method.

Parameters

stage The stage object to remove.

Returns: true if successful.

◆ InitAddStage()

Bool Murl::Logic::BaseStageProcessor::InitAddStage	(	const IState *	state,
		IStagePtr	stage
	)		const

inline

Forward to IStageProcessor::InitAddStage() method.

Parameters

state	The IState object.
stage	The stage object to initialize and add.

Returns: true if successful.

◆ RemoveDeInitStage()

Bool Murl::Logic::BaseStageProcessor::RemoveDeInitStage	(	const IState *	state,
		IStagePtr	stage
	)		const

inline

Forward to IStageProcessor::RemoveDeInitStage() method.

Parameters

state	The IState object.
stage	The stage object to deinitialize and remove.

Returns: true if successful.

◆ SetSwitchNodeId()

void Murl::Logic::BaseStageProcessor::SetSwitchNodeId ( const String & switchNodeId ) const

inline

Forward to IStageProcessor::SetSwitchNodeId() method.

Parameters

switchNodeId The full path to the graph <Switch> instance.

Returns: true if successful.

◆ GetSwitchNodeId()

const String& Murl::Logic::BaseStageProcessor::GetSwitchNodeId ( ) const

inline

Forward to IStageProcessor::GetSwitchNodeId() method.

Returns: The switch node identifier string including the full path.

◆ GetStage()

IStagePtr Murl::Logic::BaseStageProcessor::GetStage ( const String & stageId ) const

inline

Forward to IStageProcessor::GetStage() method.

Parameters

stageId The identifier of the stage to get.

Returns: The stage object or null if the identifier is not found.

◆ SetStageRunState()

Bool Murl::Logic::BaseStageProcessor::SetStageRunState	(	const String &	stageId,
		IStage::RunState	runState
	)		const

inline

Forward to IStageProcessor::SetStageRunState() method.

Parameters

stageId	The identifier of the stage to modify.
runState	The run state to set.

Returns: true if successful.

◆ IsAnyTimelineRunning()

Bool Murl::Logic::BaseStageProcessor::IsAnyTimelineRunning ( ) const

inline

Forward to IStageProcessor::IsAnyTimelineRunning() method.

Returns: true if any stage timeline is running.

◆ StartIntro() [1/3]

Bool Murl::Logic::BaseStageProcessor::StartIntro ( const String & stageId ) const

inline

Forward to IStageProcessor::StartIntro() method.

Parameters

stageId The identifier of the stage to start.

Returns: true if successful, false if the identifier is not found or IStage::StartStageIntro() failed.

◆ StartOutro() [1/3]

Bool Murl::Logic::BaseStageProcessor::StartOutro ( const String & stageId ) const

inline

Forward to IStageProcessor::StartOutro() method.

Parameters

stageId The identifier of the stage to start.

Returns: true if successful, false if the identifier is not found or IStage::StartStageOutro() failed.

◆ StartIntro() [2/3]

Bool Murl::Logic::BaseStageProcessor::StartIntro	(	const String &	stageId,
		Real	startTime
	)		const

inline

Forward to IStageProcessor::StartIntro() method.

Parameters

stageId	The identifier of the stage to start.
startTime	The IStageTimeline intro start time.

Returns: true if successful, false if the identifier is not found or IStage::StartStageIntro() failed.

◆ StartOutro() [2/3]

Bool Murl::Logic::BaseStageProcessor::StartOutro	(	const String &	stageId,
		Real	endTime
	)		const

inline

Forward to IStageProcessor::StartOutro() method.

Parameters

stageId	The identifier of the stage to start.
endTime	The IStageTimeline outro end time.

Returns: true if successful, false if the identifier is not found or IStage::StartStageOutro() failed.

◆ StartIntro() [3/3]

Bool Murl::Logic::BaseStageProcessor::StartIntro	(	const String &	stageId,
		Real	startTime,
		Real	endTime
	)		const

inline

Forward to IStageProcessor::StartIntro() method.

Parameters

stageId	The identifier of the stage to start.
startTime	The IStageTimeline intro start time.
endTime	The IStageTimeline intro end time.

Returns: true if successful, false if the identifier is not found or IStage::StartStageIntro() failed.

◆ StartOutro() [3/3]

Bool Murl::Logic::BaseStageProcessor::StartOutro	(	const String &	stageId,
		Real	startTime,
		Real	endTime
	)		const

inline

Forward to IStageProcessor::StartOutro() method.

Parameters

stageId	The identifier of the stage to start.
startTime	The IStageTimeline outro start time.
endTime	The IStageTimeline outro end time.

Returns: true if successful, false if the identifier is not found or IStage::StartStageOutro() failed.

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

murl_logic_base_stage_processor.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BaseStageProcessor()

◆ ~BaseStageProcessor()

Member Function Documentation

◆ operator IStageProcessorPtr()

◆ GetStageProcessor()

◆ AddStage()

◆ RemoveStage()

◆ InitAddStage()

◆ RemoveDeInitStage()

◆ SetSwitchNodeId()

◆ GetSwitchNodeId()

◆ GetStage()

◆ SetStageRunState()

◆ IsAnyTimelineRunning()

◆ StartIntro() [1/3]

◆ StartOutro() [1/3]

◆ StartIntro() [2/3]

◆ StartOutro() [2/3]

◆ StartIntro() [3/3]

◆ StartOutro() [3/3]