The ITimeline interface implementation. More...

#include "murl_logic_timeline.h"

Inheritance diagram for Murl::Logic::Timeline:

Public Member Functions

virtual ~Timeline ()
 The destructor.
 
virtual void ProcessTick (const Logic::IState *state)
 Implementation of IStepable::ProcessTick() method. More...
 
virtual IStepablePtr GetStepable ()
 Implementation of ITimeline::GetStepable() method. More...
 
virtual Bool SetAppTimeline (IAppTimelinePtr appTimeline)
 Implementation of ITimeline::SetAppTimeline() method. More...
 
virtual void Evaluate ()
 Implementation of ITimeline::Evaluate() method.
 
virtual void Reset ()
 Implementation of ITimeline::Reset() and IStepable::Reset() method.
 
virtual void ResetTo (Real startTime)
 Implementation of ITimeline::ResetTo() method. More...
 
virtual Bool Start ()
 Implementation of ITimeline::Start() method. More...
 
virtual Bool Start (Real startTime, Real endTime)
 Implementation of ITimeline::Start(Real startTime, Real endTime) method. More...
 
virtual Bool Start (Real startTime, Real endTime, SInt32 numberOfLoops)
 Implementation of ITimeline::Start(Real startTime, Real endTime, SInt32 numberOfLoops) method. More...
 
virtual Bool Start (Real startTime, Real endTime, Real loopStartTime, Real loopEndTime, SInt32 numberOfLoops)
 Implementation of ITimeline::Start(Real startTime, Real endTime, Real loopStartTime, Real loopEndTime, SInt32 numberOfLoops) method. More...
 
virtual Bool Pause ()
 Implementation of ITimeline::Pause() method. More...
 
virtual Bool Stop ()
 Implementation of ITimeline::Stop() method. More...
 
virtual Bool Rewind ()
 Implementation of ITimeline::Rewind() method. More...
 
virtual void SetStartTime (Real startTime)
 Implementation of ITimeline::SetStartTime() method. More...
 
virtual Real GetStartTime () const
 Implementation of ITimeline::GetStartTime() method. More...
 
virtual void SetEndTime (Real endTime)
 Implementation of ITimeline::SetEndTime() method. More...
 
virtual Real GetEndTime () const
 Implementation of ITimeline::GetEndTime() method. More...
 
virtual void SetLoopStartTime (Real startTime)
 Implementation of ITimeline::SetLoopStartTime() method. More...
 
virtual Real GetLoopStartTime () const
 Implementation of ITimeline::GetLoopStartTime() method. More...
 
virtual void SetLoopEndTime (Real endTime)
 Implementation of ITimeline::SetLoopEndTime() method. More...
 
virtual Real GetLoopEndTime () const
 Implementation of ITimeline::GetLoopEndTime() method. More...
 
virtual void SetNumberOfLoops (SInt32 numberOfLoops)
 Implementation of ITimeline::SetNumberOfLoops() method. More...
 
virtual SInt32 GetNumberOfLoops () const
 Implementation of ITimeline::GetNumberOfLoops() method. More...
 
virtual void SetTimeScale (Real timeScale)
 Implementation of ITimeline::SetTimeScale() method. More...
 
virtual Real GetTimeScale () const
 Implementation of ITimeline::GetTimeScale() method. More...
 
virtual void SetAutoRewindEnabled (Bool enabled)
 Implementation of ITimeline::SetAutoRewindEnabled() method. More...
 
virtual Bool IsAutoRewindEnabled () const
 Implementation of ITimeline::IsAutoRewindEnabled() method. More...
 
virtual Bool IsRunning () const
 Implementation of ITimeline::IsRunning() method. More...
 
virtual Bool IsPaused () const
 Implementation of ITimeline::IsPaused() method. More...
 
virtual Bool IsStopped () const
 Implementation of ITimeline::IsStopped() method. More...
 
virtual Bool WasStarted () const
 Implementation of ITimeline::WasStarted() method. More...
 
virtual Bool WasRunning () const
 Implementation of ITimeline::WasRunning() method. More...
 
virtual Bool IsOrWasRunning () const
 Implementation of ITimeline::IsOrWasRunning() method. More...
 
virtual Bool HasPassedTime (Real time) const
 Implementation of ITimeline::HasPassedTime() method. More...
 
virtual Bool HasPassedLoop (SInt32 loop) const
 Implementation of ITimeline::HasPassedLoop() method. More...
 
virtual Double GetCurrentTime () const
 Implementation of ITimeline::GetCurrentTime() method. More...
 
virtual Double GetRemainingTime () const
 Implementation of ITimeline::GetRemainingTime() method. More...
 
virtual void SetCurrentTime (Double time)
 Implementation of ITimeline::SetCurrentTime() method. More...
 
virtual SInt32 GetCurrentLoop () const
 Implementation of ITimeline::GetCurrentLoop() method. More...
 
virtual SInt32 GetRemainingLoops () const
 Implementation of ITimeline::GetRemainingLoops() method. More...
 
virtual Bool SetCurrentLoop (SInt32 loop)
 Implementation of ITimeline::SetCurrentLoop() method. More...
 
virtual IEnums::AnimationState GetCurrentState () const
 Implementation of ITimeline::GetCurrentState() method. More...
 
- Public Member Functions inherited from Murl::Logic::Stepable
virtual ~Stepable ()
 The destructor.
 
virtual Bool SetAppStepable (IAppStepablePtr appStepable)
 Implementation of IStepable::SetAppStepable() method. More...
 
virtual void SetEnabled (Bool isEnabled)
 Implementation of IStepable::SetEnabled() method. More...
 
virtual Bool IsEnabled () const
 Implementation of IStepable::IsEnabled() method. More...
 
virtual void FinishTick (const Logic::IState *state)
 Implementation of IStepable::FinishTick() method. More...
 

Static Public Member Functions

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

The ITimeline interface implementation.

Member Function Documentation

◆ Create()

static ITimelinePtr Murl::Logic::Timeline::Create ( )
static

Create a timeline object.

Returns
The created timeline object, or null if failed.

◆ ProcessTick()

virtual void Murl::Logic::Timeline::ProcessTick ( const Logic::IState state)
virtual

Implementation of IStepable::ProcessTick() method.

Parameters
stateThe IState object.

Reimplemented from Murl::Logic::Stepable.

◆ GetStepable()

virtual IStepablePtr Murl::Logic::Timeline::GetStepable ( )
virtual

Implementation of ITimeline::GetStepable() method.

Returns
The stepable interface shared pointer.

Implements Murl::Logic::ITimeline.

Referenced by Murl::Logic::BaseTimeline::operator IStepablePtr(), and Murl::Logic::Animation< Vector >::operator IStepablePtr().

◆ SetAppTimeline()

virtual Bool Murl::Logic::Timeline::SetAppTimeline ( IAppTimelinePtr  appTimeline)
virtual

Implementation of ITimeline::SetAppTimeline() method.

Parameters
appTimelineThe timeline callback object.
Returns
true if successful.

Implements Murl::Logic::ITimeline.

Referenced by Murl::Logic::Animation< Vector >::Animation(), and Murl::Logic::BaseTimeline::BaseTimeline().

◆ ResetTo()

virtual void Murl::Logic::Timeline::ResetTo ( Real  startTime)
virtual

Implementation of ITimeline::ResetTo() method.

Parameters
startTimeThe start time in seconds.

Implements Murl::Logic::ITimeline.

◆ Start() [1/4]

virtual Bool Murl::Logic::Timeline::Start ( )
virtual

◆ Start() [2/4]

virtual Bool Murl::Logic::Timeline::Start ( Real  startTime,
Real  endTime 
)
virtual

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

Parameters
startTimeThe start time in seconds.
endTimeThe end time in seconds.
Returns
true if successful.

Implements Murl::Logic::ITimeline.

◆ Start() [3/4]

virtual Bool Murl::Logic::Timeline::Start ( Real  startTime,
Real  endTime,
SInt32  numberOfLoops 
)
virtual

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

Parameters
startTimeThe start time in seconds.
endTimeThe end time in seconds.
numberOfLoopsNumber of loops.
Returns
true if successful.

Implements Murl::Logic::ITimeline.

◆ Start() [4/4]

virtual Bool Murl::Logic::Timeline::Start ( Real  startTime,
Real  endTime,
Real  loopStartTime,
Real  loopEndTime,
SInt32  numberOfLoops 
)
virtual

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

Parameters
startTimeThe start time in seconds.
endTimeThe end time in seconds.
loopStartTimeThe loop start time in seconds.
loopEndTimeThe loop end time in seconds.
numberOfLoopsNumber of loops.
Returns
true if successful.

Implements Murl::Logic::ITimeline.

◆ Pause()

virtual Bool Murl::Logic::Timeline::Pause ( )
virtual

Implementation of ITimeline::Pause() method.

Returns
true if timeline was paused, false if timeline is not running.

Implements Murl::Logic::ITimeline.

◆ Stop()

virtual Bool Murl::Logic::Timeline::Stop ( )
virtual

Implementation of ITimeline::Stop() method.

Returns
true if timeline was stopped, false if timeline is already stopped.

Implements Murl::Logic::ITimeline.

◆ Rewind()

virtual Bool Murl::Logic::Timeline::Rewind ( )
virtual

Implementation of ITimeline::Rewind() method.

Returns
true if successful.

Implements Murl::Logic::ITimeline.

◆ SetStartTime()

virtual void Murl::Logic::Timeline::SetStartTime ( Real  startTime)
virtual

Implementation of ITimeline::SetStartTime() method.

Parameters
startTimeThe start time in seconds.

Implements Murl::Logic::ITimeline.

Referenced by Murl::Logic::Animation< Vector >::SetStartTimeFromKey().

◆ GetStartTime()

virtual Real Murl::Logic::Timeline::GetStartTime ( ) const
virtual

Implementation of ITimeline::GetStartTime() method.

Returns
The start time in seconds.

Implements Murl::Logic::ITimeline.

◆ SetEndTime()

virtual void Murl::Logic::Timeline::SetEndTime ( Real  endTime)
virtual

Implementation of ITimeline::SetEndTime() method.

Parameters
endTimeThe end time in seconds.

Implements Murl::Logic::ITimeline.

Referenced by Murl::Logic::Animation< Vector >::SetEndTimeFromKey().

◆ GetEndTime()

virtual Real Murl::Logic::Timeline::GetEndTime ( ) const
virtual

Implementation of ITimeline::GetEndTime() method.

Returns
The end time in seconds.

Implements Murl::Logic::ITimeline.

◆ SetLoopStartTime()

virtual void Murl::Logic::Timeline::SetLoopStartTime ( Real  startTime)
virtual

Implementation of ITimeline::SetLoopStartTime() method.

Parameters
startTimeThe loop start time in seconds.

Implements Murl::Logic::ITimeline.

Referenced by Murl::Logic::Animation< Vector >::SetLoopStartTimeFromKey().

◆ GetLoopStartTime()

virtual Real Murl::Logic::Timeline::GetLoopStartTime ( ) const
virtual

Implementation of ITimeline::GetLoopStartTime() method.

Returns
The loop start time in seconds.

Implements Murl::Logic::ITimeline.

◆ SetLoopEndTime()

virtual void Murl::Logic::Timeline::SetLoopEndTime ( Real  endTime)
virtual

Implementation of ITimeline::SetLoopEndTime() method.

Parameters
endTimeThe loop end time in seconds.

Implements Murl::Logic::ITimeline.

Referenced by Murl::Logic::Animation< Vector >::SetLoopEndTimeFromKey().

◆ GetLoopEndTime()

virtual Real Murl::Logic::Timeline::GetLoopEndTime ( ) const
virtual

Implementation of ITimeline::GetLoopEndTime() method.

Returns
The loop end time in seconds.

Implements Murl::Logic::ITimeline.

◆ SetNumberOfLoops()

virtual void Murl::Logic::Timeline::SetNumberOfLoops ( SInt32  numberOfLoops)
virtual

Implementation of ITimeline::SetNumberOfLoops() method.

Parameters
numberOfLoopsNumber of loops.

Implements Murl::Logic::ITimeline.

◆ GetNumberOfLoops()

virtual SInt32 Murl::Logic::Timeline::GetNumberOfLoops ( ) const
virtual

Implementation of ITimeline::GetNumberOfLoops() method.

Returns
The number of loops.

Implements Murl::Logic::ITimeline.

◆ SetTimeScale()

virtual void Murl::Logic::Timeline::SetTimeScale ( Real  timeScale)
virtual

Implementation of ITimeline::SetTimeScale() method.

Parameters
timeScaleThe time scale factor.

Implements Murl::Logic::ITimeline.

◆ GetTimeScale()

virtual Real Murl::Logic::Timeline::GetTimeScale ( ) const
virtual

Implementation of ITimeline::GetTimeScale() method.

Returns
true The time scale factor.

Implements Murl::Logic::ITimeline.

◆ SetAutoRewindEnabled()

virtual void Murl::Logic::Timeline::SetAutoRewindEnabled ( Bool  enabled)
virtual

Implementation of ITimeline::SetAutoRewindEnabled() method.

Parameters
enabledEnable automatic rewind if true.

Implements Murl::Logic::ITimeline.

◆ IsAutoRewindEnabled()

virtual Bool Murl::Logic::Timeline::IsAutoRewindEnabled ( ) const
virtual

Implementation of ITimeline::IsAutoRewindEnabled() method.

Returns
true if automatic rewind.

Implements Murl::Logic::ITimeline.

◆ IsRunning()

virtual Bool Murl::Logic::Timeline::IsRunning ( ) const
virtual

Implementation of ITimeline::IsRunning() method.

Returns
true if running.

Implements Murl::Logic::ITimeline.

◆ IsPaused()

virtual Bool Murl::Logic::Timeline::IsPaused ( ) const
virtual

Implementation of ITimeline::IsPaused() method.

Returns
true if paused.

Implements Murl::Logic::ITimeline.

◆ IsStopped()

virtual Bool Murl::Logic::Timeline::IsStopped ( ) const
virtual

Implementation of ITimeline::IsStopped() method.

Returns
true if stopped.

Implements Murl::Logic::ITimeline.

◆ WasStarted()

virtual Bool Murl::Logic::Timeline::WasStarted ( ) const
virtual

Implementation of ITimeline::WasStarted() method.

Returns
true if started.

Implements Murl::Logic::ITimeline.

◆ WasRunning()

virtual Bool Murl::Logic::Timeline::WasRunning ( ) const
virtual

Implementation of ITimeline::WasRunning() method.

Returns
true if stopped.

Implements Murl::Logic::ITimeline.

Referenced by Murl::Logic::SoundFader::OnEvaluateAnimation().

◆ IsOrWasRunning()

virtual Bool Murl::Logic::Timeline::IsOrWasRunning ( ) const
virtual

Implementation of ITimeline::IsOrWasRunning() method.

Returns
true if IsRunning() or WasRunning() is true.

Implements Murl::Logic::ITimeline.

◆ HasPassedTime()

virtual Bool Murl::Logic::Timeline::HasPassedTime ( Real  time) const
virtual

Implementation of ITimeline::HasPassedTime() method.

Parameters
timeThe time to check in seconds.
Returns
true if the current time has passed a specified time within the most recent tick.

Implements Murl::Logic::ITimeline.

Referenced by Murl::Logic::Animation< Vector >::HasPassedTimeFromKey().

◆ HasPassedLoop()

virtual Bool Murl::Logic::Timeline::HasPassedLoop ( SInt32  loop) const
virtual

Implementation of ITimeline::HasPassedLoop() method.

Parameters
loopThe loop number to check.
Returns
true if the current loop has passed a specified loop within the most recent tick.

Implements Murl::Logic::ITimeline.

◆ GetCurrentTime()

virtual Double Murl::Logic::Timeline::GetCurrentTime ( ) const
virtual

Implementation of ITimeline::GetCurrentTime() method.

Returns
The current time in seconds.

Implements Murl::Logic::ITimeline.

Referenced by Murl::Logic::Animation< Vector >::IsOnTimeFromKey(), and Murl::Logic::SoundFader::OnEvaluateAnimation().

◆ GetRemainingTime()

virtual Double Murl::Logic::Timeline::GetRemainingTime ( ) const
virtual

Implementation of ITimeline::GetRemainingTime() method.

Returns
The remaining time in seconds.

Implements Murl::Logic::ITimeline.

◆ SetCurrentTime()

virtual void Murl::Logic::Timeline::SetCurrentTime ( Double  time)
virtual

Implementation of ITimeline::SetCurrentTime() method.

Parameters
timeThe current time to set in seconds.

Implements Murl::Logic::ITimeline.

◆ GetCurrentLoop()

virtual SInt32 Murl::Logic::Timeline::GetCurrentLoop ( ) const
virtual

Implementation of ITimeline::GetCurrentLoop() method.

Returns
The current loop, 0 if number of loops is 0.

Implements Murl::Logic::ITimeline.

◆ GetRemainingLoops()

virtual SInt32 Murl::Logic::Timeline::GetRemainingLoops ( ) const
virtual

Implementation of ITimeline::GetRemainingLoops() method.

Returns
The remaining loops, -1 if number of loops is < 0, 0 if number of loops is 0 or intro/outro is running.

Implements Murl::Logic::ITimeline.

◆ SetCurrentLoop()

virtual Bool Murl::Logic::Timeline::SetCurrentLoop ( SInt32  loop)
virtual

Implementation of ITimeline::SetCurrentLoop() method.

Parameters
loopThe current loop to set.
Returns
true if successful, false if the loop number is out of range.

Implements Murl::Logic::ITimeline.

◆ GetCurrentState()

virtual IEnums::AnimationState Murl::Logic::Timeline::GetCurrentState ( ) const
virtual

Implementation of ITimeline::GetCurrentState() method.

Returns
The current animation state.

Implements Murl::Logic::ITimeline.


The documentation for this class was generated from the following file:
  • murl_logic_timeline.h


Copyright © 2011-2018 Spraylight GmbH.