Manages the playback of an SLAnimation. More...

#include <SLAnimPlayback.h>

Public Member Functions
	SLAnimPlayback (SLAnimation *parent, SLfloat weight=1.0f)

void	playForward ()

void	playBackward ()

void	pause ()

void	skipToNextKeyframe ()

void	skipToPrevKeyframe ()

void	skipToStart ()

void	skipToEnd ()

SLfloat	localTime () const

SLAnimation *	parentAnimation ()

SLfloat	playbackRate () const

SLfloat	weight () const

SLAnimLooping	loop () const

SLbool	enabled () const

SLEasingCurve	easing () const

SLbool	changed () const

SLbool	isPlayingForward () const

SLbool	isPlayingBackward () const

SLbool	isPaused () const

SLbool	isStopped () const

void	localTime (SLfloat time)

void	playbackRate (SLfloat pr)

void	weight (SLfloat weight)

void	loop (SLAnimLooping lb)

void	enabled (SLbool val)

void	easing (SLEasingCurve ec)

void	changed (SLbool changed)

void	advanceTime (SLfloat delta)

SLfloat	calcEasingTime (SLfloat time) const
	Applies the easing time curve to the input time. More...

SLfloat	calcEasingTimeInv (SLfloat time) const

Protected Attributes
SLAnimation *	_animation
	the animation this plays is referencing More...

SLfloat	_localTime
	the current local timestamp (eased time) More...

SLfloat	_weight
	the current weight More...

SLfloat	_playbackRate
	the current playback speed More...

SLshort	_playbackDir
	the current playback direction More...

SLbool	_enabled
	is this animation running More...

SLEasingCurve	_easing
	easing modifier curve (to customize start and end point easing) More...

SLfloat	_linearLocalTime
	linear local time used for _easing propert More...

SLAnimLooping	_loopingBehaviour
	We support different looping behaviours. More...

SLbool	_gotChanged
	Did this playback change in the last frame. More...

Detailed Description

Manages the playback of an SLAnimation.

This class manages the playback state and the local time of an SLAnimation. It manages the way the time advances and how the animation loops. It has all functionality to play, pause, stop, enable, speedup and slowdown a playback. A list of all SLAnimPlayback is hold by the SLAnimManager.

It is possible to have multiple playbacks per animation. If we keep track of which nodes are affected by which SLAnimPlayback we can only manipulate these nodes for the time kept in the SLAnimPlayback. A practical example for this behaviour would be special skeleton instances that only keep track of SLAnimPlayback for their parent SLAnimSkeleton. The skeleton instance can then change its skeletal data based on the states and the actual SLAnimation has to only exist once in memory.

Definition at line 35 of file SLAnimPlayback.h.

Constructor & Destructor Documentation

◆ SLAnimPlayback()

SLAnimPlayback::SLAnimPlayback	(	SLAnimation *	parent,
		SLfloat	weight = `1.0f`
	)

Constructor

Definition at line 16 of file SLAnimPlayback.cpp.

   : _animation(parent),
     _localTime(0.0f),
     _weight(weight),
     _playbackRate(1.0f),
     _playbackDir(1),
     _enabled(true),
     _easing(EC_linear),
     _linearLocalTime(0.0f),
     _loopingBehaviour(AL_loop)
 {
 }

Member Function Documentation

◆ advanceTime()

void SLAnimPlayback::advanceTime ( SLfloat delta )

Advances the time of the playback play based on its different easing parameters.

Definition at line 31 of file SLAnimPlayback.cpp.

 {
     if (!_enabled)
         return;
  
     if (delta == 0.0f)
         return;
  
     // preserve time before update
     SLfloat prevTime = _linearLocalTime;
  
     _linearLocalTime += delta * _playbackRate * (SLfloat)_playbackDir;
  
     // fix invalid inputs
     if (_linearLocalTime > _animation->lengthSec())
     {
         // wrap around on loop, else just stay on last frame
         switch (_loopingBehaviour)
         {
             case AL_once:
                 _linearLocalTime = _animation->lengthSec();
                 _enabled         = false;
                 break;
             case AL_loop:
                 _linearLocalTime = 0.0f;
                 break;
             case AL_pingPong:
             case AL_pingPongLoop:
                 _linearLocalTime = _animation->lengthSec();
                 _playbackDir *= -1;
                 break;
         }
     }
  
     // fix negative inputs, playback rate could be negative
     else if (_linearLocalTime < 0.0f)
     {
         while (_linearLocalTime < 0.0f)
             _linearLocalTime += _animation->lengthSec();
  
         switch (_loopingBehaviour)
         {
             case AL_once:
                 _linearLocalTime = 0.0f;
                 _enabled         = false;
                 break;
             case AL_loop: _linearLocalTime = _animation->lengthSec(); break;
             case AL_pingPong:
                 _linearLocalTime = 0.0f;
                 _enabled         = false;
                 break; // at the moment pingPong stops when reaching 0, if we start with a reverse direction this is illogical
             case AL_pingPongLoop:
                 _linearLocalTime = 0.0f;
                 _playbackDir *= -1;
                 break;
         }
     }
  
     // don't go any further, nothing's changed
     if (Utils::abs(_linearLocalTime - prevTime) < 0.0001f)
         return;
  
     // mark the playback as changed
     _gotChanged = true;
  
     // update the final eased local time
     _localTime = calcEasingTime(_linearLocalTime);
 }

◆ calcEasingTime()

SLfloat SLAnimPlayback::calcEasingTime ( SLfloat time ) const

Applies the easing time curve to the input time.

See also the declaration of the SLEasingCurve enumeration for the different easing curve type that are taken from Qt QAnimation and QEasingCurve class. See http://qt-project.org/doc/qt-4.8/qeasingcurve.html#Type-enum

Definition at line 175 of file SLAnimPlayback.cpp.

 {
     SLfloat x = time / _animation->lengthSec();
     SLfloat y = 0.0f;
  
     switch (_easing)
     {
         case EC_linear: y = x; break;
  
         case EC_inQuad: y = pow(x, 2.0f); break;
         case EC_outQuad: y = -pow(x - 1.0f, 2.0f) + 1.0f; break;
         case EC_inOutQuad: y = (x < 0.5f) ? 2.0f * pow(x, 2.0f) : -2.0f * pow(x - 1.0f, 2.0f) + 1.0f; break;
         case EC_outInQuad: y = (x < 0.5f) ? -2.0f * pow(x - 0.5f, 2.0f) + 0.5f : 2.0f * pow(x - 0.5f, 2.0f) + 0.5f; break;
  
         case EC_inCubic: y = pow(x, 3.0f); break;
         case EC_outCubic: y = pow(x - 1.0f, 3.0f) + 1.0f; break;
         case EC_inOutCubic: y = (x < 0.5f) ? 4.0f * pow(x, 3.0f) : 4.0f * pow(x - 1.0f, 3.0f) + 1.0f; break;
         case EC_outInCubic: y = 4.0f * pow(x - 0.5f, 3.0f) + 0.5f; break;
  
         case EC_inQuart: y = pow(x, 4.0f); break;
         case EC_outQuart: y = -pow(x - 1.0f, 4.0f) + 1.0f; break;
         case EC_inOutQuart: y = (x < 0.5f) ? 8.0f * pow(x, 4.0f) : -8.0f * pow(x - 1.0f, 4.0f) + 1.0f; break;
         case EC_outInQuart: y = (x < 0.5f) ? -8.0f * pow(x - 0.5f, 4.0f) + 0.5f : 8.0f * pow(x - 0.5f, 4.0f) + 0.5f; break;
  
         case EC_inQuint: y = pow(x, 5.0f); break;
         case EC_outQuint: y = pow(x - 1.0f, 5.0f) + 1.0f; break;
         case EC_inOutQuint: y = (x < 0.5f) ? 16.0f * pow(x, 5.0f) : 16.0f * pow(x - 1.0f, 5.0f) + 1.0f; break;
         case EC_outInQuint: y = 16.0f * pow(x - 0.5f, 5.0f) + 0.5f; break;
  
         case EC_inSine: y = sin(x * Utils::PI * 0.5f - Utils::PI * 0.5f) + 1.0f; break;
         case EC_outSine: y = sin(x * Utils::PI * 0.5f); break;
         case EC_inOutSine: y = 0.5f * sin(x * Utils::PI - Utils::PI * 0.5f) + 0.5f; break;
         case EC_outInSine: y = (x < 0.5f) ? 0.5f * sin(x * Utils::PI) : 0.5f * sin(x * Utils::PI - Utils::PI) + 1.0f; break;
     }
  
     return y * _animation->lengthSec();
 }

◆ calcEasingTimeInv()

SLfloat SLAnimPlayback::calcEasingTimeInv ( SLfloat time ) const

Inverse functions for the above easing curve functions.

Definition at line 215 of file SLAnimPlayback.cpp.

 {
     SLfloat x = time / _animation->lengthSec();
     SLfloat y = 0.0f;
  
     switch (_easing)
     {
         case EC_linear: y = x; break;
  
         case EC_inQuad: y = sqrt(x); break;
         case EC_outQuad: y = 1.0f - sqrt(1.0f - x); break;
         case EC_inOutQuad: y = (x < 0.5f) ? sqrt(x) / sqrt(2.0f) : 1.0f - sqrt(1.0f - x) / sqrt(2.0f); break;
         case EC_outInQuad: y = (x < 0.5f) ? 0.5f - 0.25f * sqrt(4.0f - 8.0f * x) : 0.5f + 0.25f * sqrt(8.0f * x - 4.0f); break;
  
         case EC_inCubic: y = pow(x, 1.0f / 3.0f); break;
         case EC_outCubic: y = 1.0f - pow(1.0f - x, 1.0f / 3.0f); break;
         case EC_inOutCubic: y = (x < 0.5f) ? pow(x, 1.0f / 3.0f) / pow(4.0f, 1.0f / 3.0f) : 1.0f - pow(1.0f - x, 1.0f / 3.0f) / pow(4.0f, 1.0f / 3.0f); break;
         case EC_outInCubic: y = (x < 0.5f) ? -pow((0.5f - x) / 4.0f, 1.0f / 3.0f) + 0.5f : pow((x - 0.5f) / 4.0f, 1.0f / 3.0f) + 0.5f; break;
  
         case EC_inQuart: y = pow(x, 1.0f / 4.0f); break;
         case EC_outQuart: y = 1.0f - pow(1.0f - x, 1.0f / 4.0f); break;
         case EC_inOutQuart: y = (x < 0.5f) ? pow(x, 1.0f / 4.0f) / pow(8.0f, 1.0f / 4.0f) : 1.0f - pow(1.0f - x, 1.0f / 4.0f) / pow(8.0f, 1.0f / 4.0f); break;
         case EC_outInQuart: y = (x < 0.5f) ? -pow(0.5f - x, 1.0f / 4.0f) / pow(8.0f, 1.0f / 4.0f) + 0.5f : pow(x - 0.5f, 1.0f / 4.0f) / pow(8.0f, 1.0f / 4.0f) + 0.5f; break;
  
         case EC_inQuint: y = pow(x, 1.0f / 5.0f); break;
         case EC_outQuint: y = 1.0f - pow(1.0f - x, 1.0f / 5.0f); break;
         case EC_inOutQuint: y = (x < 0.5f) ? pow(x, 1.0f / 5.0f) / pow(16.0f, 1.0f / 5.0f) : 1.0f - pow(1.0f - x, 1.0f / 5.0f) / pow(16.0f, 1.0f / 5.0f); break;
         case EC_outInQuint: y = (x < 0.5f) ? -pow(0.5f - x, 1.0f / 5.0f) / pow(16.0f, 1.0f / 5.0f) + 0.5f : pow(x - 0.5f, 1.0f / 5.0f) / pow(16.0f, 1.0f / 5.0f) + 0.5f; break;
  
         case EC_inSine: y = -2.0f * asin(1.0f - x) * Utils::ONEOVERPI + 1.0f; break;
         case EC_outSine: y = -2.0f * acos(x) * Utils::ONEOVERPI + 1.0f; break;
         case EC_inOutSine: y = acos(1.0f - 2.0f * x) * Utils::ONEOVERPI; break;
         case EC_outInSine: y = (x < 0.5f) ? asin(2.0f * x) * Utils::ONEOVERPI : asin(2.0f * (x - 1.0f)) * Utils::ONEOVERPI + 1.0f; break;
     }
  
     return y * _animation->lengthSec();
 }

◆ changed() [1/2]

SLbool SLAnimPlayback::changed ( ) const

inline

Definition at line 58 of file SLAnimPlayback.h.

58 { return _gotChanged; }

◆ changed() [2/2]

void SLAnimPlayback::changed ( SLbool changed )

inline

Definition at line 71 of file SLAnimPlayback.h.

71 { _gotChanged = changed; }

SLAnimPlayback::changed

SLbool changed() const

Definition: SLAnimPlayback.h:58

◆ easing() [1/2]

SLEasingCurve SLAnimPlayback::easing ( ) const

inline

Definition at line 57 of file SLAnimPlayback.h.

57 { return _easing; }

◆ easing() [2/2]

void SLAnimPlayback::easing ( SLEasingCurve ec )

inline

Definition at line 70 of file SLAnimPlayback.h.

70 { _easing = ec; }

◆ enabled() [1/2]

SLbool SLAnimPlayback::enabled ( ) const

inline

Definition at line 56 of file SLAnimPlayback.h.

56 { return _enabled; }

◆ enabled() [2/2]

void SLAnimPlayback::enabled ( SLbool val )

inline

Definition at line 69 of file SLAnimPlayback.h.

69 { _enabled = val; }

◆ isPaused()

SLbool SLAnimPlayback::isPaused ( ) const

inline

Definition at line 61 of file SLAnimPlayback.h.

61 { return _enabled && _playbackDir == 0; }

◆ isPlayingBackward()

SLbool SLAnimPlayback::isPlayingBackward ( ) const

inline

Definition at line 60 of file SLAnimPlayback.h.

60 { return _enabled && _playbackDir == -1; }

◆ isPlayingForward()

SLbool SLAnimPlayback::isPlayingForward ( ) const

inline

Definition at line 59 of file SLAnimPlayback.h.

59 { return _enabled && _playbackDir == 1; }

◆ isStopped()

SLbool SLAnimPlayback::isStopped ( ) const

inline

Definition at line 62 of file SLAnimPlayback.h.

62 { return !_enabled; }

◆ localTime() [1/2]

SLfloat SLAnimPlayback::localTime ( ) const

inline

Definition at line 51 of file SLAnimPlayback.h.

51 { return _localTime; }

◆ localTime() [2/2]

void SLAnimPlayback::localTime ( SLfloat time )

Setter for the local time parameter. Takes the currently active easing curve into consideration.

Definition at line 158 of file SLAnimPlayback.cpp.

 {
     // Set the eased time
     _localTime = time;
  
     // calculate the equivalent linear time from the new eased time
     _linearLocalTime = calcEasingTimeInv(time);
  
     // mark changed
     _gotChanged = true;
 }

◆ loop() [1/2]

SLAnimLooping SLAnimPlayback::loop ( ) const

inline

Definition at line 55 of file SLAnimPlayback.h.

55 { return _loopingBehaviour; }

◆ loop() [2/2]

void SLAnimPlayback::loop ( SLAnimLooping lb )

inline

Definition at line 68 of file SLAnimPlayback.h.

68 { _loopingBehaviour = lb; }

◆ parentAnimation()

SLAnimation* SLAnimPlayback::parentAnimation ( )

inline

Definition at line 52 of file SLAnimPlayback.h.

52 { return _animation; }

◆ pause()

void SLAnimPlayback::pause ( )

Set this playback to be paused.

Definition at line 118 of file SLAnimPlayback.cpp.

 {
     // a paused anmation is an enabled animation that has a 0 direction multiplier
     _enabled     = true;
     _playbackDir = 0;
 }

◆ playbackRate() [1/2]

SLfloat SLAnimPlayback::playbackRate ( ) const

inline

Definition at line 53 of file SLAnimPlayback.h.

53 { return _playbackRate; }

◆ playbackRate() [2/2]

void SLAnimPlayback::playbackRate ( SLfloat pr )

inline

Definition at line 66 of file SLAnimPlayback.h.

66 { _playbackRate = pr; }

◆ playBackward()

void SLAnimPlayback::playBackward ( )

Set this playback to be playing backward.

Definition at line 110 of file SLAnimPlayback.cpp.

 {
     _enabled     = true;
     _playbackDir = -1;
 }

◆ playForward()

void SLAnimPlayback::playForward ( )

Set this playback to be playing forward.

Definition at line 102 of file SLAnimPlayback.cpp.

 {
     _enabled     = true;
     _playbackDir = 1;
 }

◆ skipToEnd()

void SLAnimPlayback::skipToEnd ( )

Set the local time of this animation to the end time.

Definition at line 150 of file SLAnimPlayback.cpp.

 {
     localTime(_animation->lengthSec());
 }

◆ skipToNextKeyframe()

void SLAnimPlayback::skipToNextKeyframe ( )

Set the local time of this playback to be on the time of the next keyframe.

Definition at line 127 of file SLAnimPlayback.cpp.

 {
     SLfloat time = _animation->nextKeyframeTime(_localTime);
     localTime(time);
 }

◆ skipToPrevKeyframe()

void SLAnimPlayback::skipToPrevKeyframe ( )

Set the local time of this playback to be on the time of the previous keyframe.

Definition at line 135 of file SLAnimPlayback.cpp.

 {
     SLfloat time = _animation->prevKeyframeTime(_localTime);
     localTime(time);
 }

◆ skipToStart()

void SLAnimPlayback::skipToStart ( )

Set the local time of this playback to the starting time.

Definition at line 143 of file SLAnimPlayback.cpp.

 {
     localTime(0.0f);
 }

◆ weight() [1/2]

SLfloat SLAnimPlayback::weight ( ) const

inline

Definition at line 54 of file SLAnimPlayback.h.

54 { return _weight; }

◆ weight() [2/2]

void SLAnimPlayback::weight ( SLfloat weight )

inline

Definition at line 67 of file SLAnimPlayback.h.

67 { _weight = weight; }

Member Data Documentation

◆ _animation

SLAnimation* SLAnimPlayback::_animation

protected

the animation this plays is referencing

Definition at line 79 of file SLAnimPlayback.h.

◆ _easing

SLEasingCurve SLAnimPlayback::_easing

protected

easing modifier curve (to customize start and end point easing)

Definition at line 85 of file SLAnimPlayback.h.

◆ _enabled

SLbool SLAnimPlayback::_enabled

protected

is this animation running

Definition at line 84 of file SLAnimPlayback.h.

◆ _gotChanged

SLbool SLAnimPlayback::_gotChanged

protected

Did this playback change in the last frame.

Definition at line 88 of file SLAnimPlayback.h.

◆ _linearLocalTime

SLfloat SLAnimPlayback::_linearLocalTime

protected

linear local time used for _easing propert

Definition at line 86 of file SLAnimPlayback.h.

◆ _localTime

SLfloat SLAnimPlayback::_localTime

protected

the current local timestamp (eased time)

Definition at line 80 of file SLAnimPlayback.h.

◆ _loopingBehaviour

SLAnimLooping SLAnimPlayback::_loopingBehaviour

protected

We support different looping behaviours.

Definition at line 87 of file SLAnimPlayback.h.

◆ _playbackDir

SLshort SLAnimPlayback::_playbackDir

protected

the current playback direction

Definition at line 83 of file SLAnimPlayback.h.

◆ _playbackRate

SLfloat SLAnimPlayback::_playbackRate

protected

the current playback speed

Definition at line 82 of file SLAnimPlayback.h.

◆ _weight

SLfloat SLAnimPlayback::_weight

protected

the current weight

Definition at line 81 of file SLAnimPlayback.h.

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SLAnimPlayback()

Member Function Documentation

◆ advanceTime()

◆ calcEasingTime()

◆ calcEasingTimeInv()

◆ changed() [1/2]

◆ changed() [2/2]

◆ easing() [1/2]

◆ easing() [2/2]

◆ enabled() [1/2]

◆ enabled() [2/2]

◆ isPaused()

◆ isPlayingBackward()

◆ isPlayingForward()

◆ isStopped()

◆ localTime() [1/2]

◆ localTime() [2/2]

◆ loop() [1/2]

◆ loop() [2/2]

◆ parentAnimation()

◆ pause()

◆ playbackRate() [1/2]

◆ playbackRate() [2/2]

◆ playBackward()

◆ playForward()

◆ skipToEnd()

◆ skipToNextKeyframe()

◆ skipToPrevKeyframe()

◆ skipToStart()

◆ weight() [1/2]

◆ weight() [2/2]

Member Data Documentation

◆ _animation

◆ _easing

◆ _enabled

◆ _gotChanged

◆ _linearLocalTime

◆ _localTime

◆ _loopingBehaviour

◆ _playbackDir

◆ _playbackRate

◆ _weight