Murl::Logic::IStepable Interface Reference

The IStepable interface. More...

#include "murl_logic_i_stepable.h"

Inheritance diagram for Murl::Logic::IStepable:

Public Member Functions
virtual Bool	SetAppStepable (IAppStepablePtr appStepable)=0
	Set the stepable callback object. More...
virtual void	SetEnabled (Bool isEnabled)=0
	Set the Enable/Disable state of the object. More...
virtual Bool	IsEnabled () const =0
	Check if the object is enabled. More...
virtual void	Reset ()=0
	Reset the object. More...
virtual void	ProcessTick (const Logic::IState *state)=0
	Execute a logic tick. More...
virtual void	FinishTick (const Logic::IState *state)=0
	Finish a logic tick. More...

Detailed Description

The IStepable interface.

Objects implementing the IStepable interface can be registered to the IStepableObserver.
The IProcessor object provides a ready to use stepable observer.

Member Function Documentation

SetAppStepable()

virtual Bool Murl::Logic::IStepable::SetAppStepable ( IAppStepablePtr  appStepable )

pure virtual

Set the stepable callback object.

Parameters

appStepable

The stepable callback object.

Returns

true if successful.

Implemented in Murl::Logic::Stepable.

SetEnabled()

virtual void Murl::Logic::IStepable::SetEnabled ( Bool  isEnabled )

pure virtual

Set the Enable/Disable state of the object.

Execute the IAppStepable::OnSetEnabled() callback method before setting the internal enabled state.
The default enabled state is true.

Parameters

isEnabled

true for enable, false for disable.

Implemented in Murl::Logic::Stepable.

IsEnabled()

virtual Bool Murl::Logic::IStepable::IsEnabled ( ) const

pure virtual

Check if the object is enabled.

Returns

true if enabled.

Implemented in Murl::Logic::Stepable.

Reset()

virtual void Murl::Logic::IStepable::Reset ( )

pure virtual

Reset the object.

Execute the IAppStepable::OnReset() method.

Implemented in Murl::Logic::Timeline, Murl::Logic::Timeframe, Murl::Logic::Stepable, Murl::Logic::SoundFader, Murl::Logic::Animation< DataType >, and Murl::Logic::Animation< Vector >.

ProcessTick()

virtual void Murl::Logic::IStepable::ProcessTick ( const Logic::IState *  state )

pure virtual

Execute a logic tick.

Execute the IAppStepable::OnProcessTick() method if the enabled state is true.

Parameters

state

The IState object.

Implemented in Murl::Logic::Timeline, Murl::Logic::Timeframe, and Murl::Logic::Stepable.

FinishTick()

virtual void Murl::Logic::IStepable::FinishTick ( const Logic::IState *  state )

pure virtual

Finish a logic tick.

Execute the IAppStepable::OnFinishTick() method if the enabled state is true.

Parameters

state

The IState object.

Implemented in Murl::Logic::Stepable.

---

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

• murl_logic_i_stepable.h