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

#include "murl_logic_base_timeline.h"

Inheritance diagram for Murl::Logic::BaseTimeline:

Public Member Functions
	BaseTimeline ()
	The default constructor. More...

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

	operator IStepablePtr ()
	Conversion operator. More...

	operator ITimelinePtr ()
	Conversion operator. More...

Public Member Functions inherited from Murl::Logic::Timeline
	~Timeline () override
	The destructor.

void	ProcessTick (const Logic::IState *state) override
	Implementation of IStepable::ProcessTick() method. More...

IStepablePtr	GetStepable () override
	Implementation of ITimeline::GetStepable() method. More...

Bool	SetAppTimeline (IAppTimelinePtr appTimeline) override
	Implementation of ITimeline::SetAppTimeline() method. More...

void	Evaluate () override
	Implementation of ITimeline::Evaluate() method.

void	Reset () override
	Implementation of ITimeline::Reset() and IStepable::Reset() method.

void	ResetTo (Real startTime) override
	Implementation of ITimeline::ResetTo() method. More...

Bool	Start () override
	Implementation of ITimeline::Start() method. More...

Bool	Start (Real startTime, Real endTime) override
	Implementation of ITimeline::Start(Real startTime, Real endTime) method. More...

Bool	Start (Real startTime, Real endTime, SInt32 numberOfLoops) override
	Implementation of ITimeline::Start(Real startTime, Real endTime, SInt32 numberOfLoops) method. More...

Bool	Start (Real startTime, Real endTime, Real loopStartTime, Real loopEndTime, SInt32 numberOfLoops) override
	Implementation of ITimeline::Start(Real startTime, Real endTime, Real loopStartTime, Real loopEndTime, SInt32 numberOfLoops) method. More...

Bool	Pause () override
	Implementation of ITimeline::Pause() method. More...

Bool	Stop () override
	Implementation of ITimeline::Stop() method. More...

Bool	Rewind () override
	Implementation of ITimeline::Rewind() method. More...

void	SetStartTime (Real startTime) override
	Implementation of ITimeline::SetStartTime() method. More...

Real	GetStartTime () const override
	Implementation of ITimeline::GetStartTime() method. More...

void	SetEndTime (Real endTime) override
	Implementation of ITimeline::SetEndTime() method. More...

Real	GetEndTime () const override
	Implementation of ITimeline::GetEndTime() method. More...

void	SetLoopStartTime (Real startTime) override
	Implementation of ITimeline::SetLoopStartTime() method. More...

Real	GetLoopStartTime () const override
	Implementation of ITimeline::GetLoopStartTime() method. More...

void	SetLoopEndTime (Real endTime) override
	Implementation of ITimeline::SetLoopEndTime() method. More...

Real	GetLoopEndTime () const override
	Implementation of ITimeline::GetLoopEndTime() method. More...

void	SetNumberOfLoops (SInt32 numberOfLoops) override
	Implementation of ITimeline::SetNumberOfLoops() method. More...

SInt32	GetNumberOfLoops () const override
	Implementation of ITimeline::GetNumberOfLoops() method. More...

void	SetTimeScale (Real timeScale) override
	Implementation of ITimeline::SetTimeScale() method. More...

Real	GetTimeScale () const override
	Implementation of ITimeline::GetTimeScale() method. More...

void	SetAutoRewindEnabled (Bool enabled) override
	Implementation of ITimeline::SetAutoRewindEnabled() method. More...

Bool	IsAutoRewindEnabled () const override
	Implementation of ITimeline::IsAutoRewindEnabled() method. More...

Bool	IsRunning () const override
	Implementation of ITimeline::IsRunning() method. More...

Bool	IsPaused () const override
	Implementation of ITimeline::IsPaused() method. More...

Bool	IsStopped () const override
	Implementation of ITimeline::IsStopped() method. More...

Bool	WasStarted () const override
	Implementation of ITimeline::WasStarted() method. More...

Bool	WasRunning () const override
	Implementation of ITimeline::WasRunning() method. More...

Bool	IsOrWasRunning () const override
	Implementation of ITimeline::IsOrWasRunning() method. More...

Bool	HasPassedTime (Real time) const override
	Implementation of ITimeline::HasPassedTime() method. More...

Bool	HasPassedLoop (SInt32 loop) const override
	Implementation of ITimeline::HasPassedLoop() method. More...

Double	GetCurrentTime () const override
	Implementation of ITimeline::GetCurrentTime() method. More...

Double	GetRemainingTime () const override
	Implementation of ITimeline::GetRemainingTime() method. More...

void	SetCurrentTime (Double time) override
	Implementation of ITimeline::SetCurrentTime() method. More...

SInt32	GetCurrentLoop () const override
	Implementation of ITimeline::GetCurrentLoop() method. More...

SInt32	GetRemainingLoops () const override
	Implementation of ITimeline::GetRemainingLoops() method. More...

Bool	SetCurrentLoop (SInt32 loop) override
	Implementation of ITimeline::SetCurrentLoop() method. More...

IEnums::AnimationState	GetCurrentState () const override
	Implementation of ITimeline::GetCurrentState() method. More...

Public Member Functions inherited from Murl::Logic::Stepable
	~Stepable () override
	The destructor.

Bool	SetAppStepable (IAppStepablePtr appStepable) override
	Implementation of IStepable::SetAppStepable() method. More...

void	SetEnabled (Bool isEnabled) override
	Implementation of IStepable::SetEnabled() method. More...

Bool	IsEnabled () const override
	Implementation of IStepable::IsEnabled() method. More...

void	FinishTick (const Logic::IState *state) override
	Implementation of IStepable::FinishTick() method. More...

Protected Member Functions
void	OnEvaluate (Double currentTime) override
	Default implementation of IAppTimeline::OnEvaluate() method, this method is empty and can be overwritten. More...

Additional Inherited Members
Static Public Member Functions inherited from Murl::Logic::Timeline
static ITimelinePtr	Create ()
	Create a timeline object. More...

Static Public Member Functions inherited from Murl::Logic::Stepable
static IStepablePtr	Create ()
	Create a stepable object. More...

Detailed Description

A helper class for simple use of the ITimeline object.

The BaseTimeline class implements the IAppTimeline app interface.
A logic timeline is created and initialized at object instantiation.

Constructor & Destructor Documentation

◆ BaseTimeline()

Murl::Logic::BaseTimeline::BaseTimeline ( )

inline

The default constructor.

Creates a ITimeline object and setup the timeline app interface.

References Murl::Logic::Timeline::SetAppTimeline().

◆ ~BaseTimeline()

Murl::Logic::BaseTimeline::~BaseTimeline ( )

inlineoverride

The destructor.

Destroys the ITimeline object.

Member Function Documentation

◆ operator IStepablePtr()

Murl::Logic::BaseTimeline::operator IStepablePtr ( )

inline

Conversion operator.

Returns: The IStepable interface.

References Murl::Logic::Timeline::GetStepable().

◆ operator ITimelinePtr()

Murl::Logic::BaseTimeline::operator ITimelinePtr ( )

inline

Conversion operator.

Returns: The ITimeline interface.

◆ OnEvaluate()

void Murl::Logic::BaseTimeline::OnEvaluate ( Double currentTime )

inlineoverrideprotectedvirtual

Default implementation of IAppTimeline::OnEvaluate() method, this method is empty and can be overwritten.

Parameters

currentTime The current timeline time.

Implements Murl::Logic::IAppTimeline.

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

murl_logic_base_timeline.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BaseTimeline()

◆ ~BaseTimeline()

Member Function Documentation

◆ operator IStepablePtr()

◆ operator ITimelinePtr()

◆ OnEvaluate()