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...
 
virtual ~BaseTimeline ()
 The destructor. More...
 
 operator IStepablePtr ()
 Conversion operator. More...
 
 operator ITimelinePtr ()
 Conversion operator. More...
 
- Public Member Functions inherited from Murl::Logic::Timeline
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...
 

Protected Member Functions

virtual void OnEvaluate (Double currentTime)
 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()

virtual Murl::Logic::BaseTimeline::~BaseTimeline ( )
inlinevirtual

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()

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

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

Parameters
currentTimeThe current timeline time.

Implements Murl::Logic::IAppTimeline.


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


Copyright © 2011-2018 Spraylight GmbH.