include/cinder/Timeline.h

Go to the documentation of this file.

/*
 Copyright (c) 2011, The Cinder Project, All rights reserved.
 This code is intended for use with the Cinder C++ library: http://libcinder.org

 Based on the sc-Choreograph CinderBlock by David Wicks: http://sansumbrella.com/

 Redistribution and use in source and binary forms, with or without modification, are permitted provided that
 the following conditions are met:

    * Redistributions of source code must retain the above copyright notice, this list of conditions and
    the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and
    the following disclaimer in the documentation and/or other materials provided with the distribution.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
 WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGE.
*/

#pragma once

#include "cinder/Cinder.h"
#include "cinder/TimelineItem.h"
#include "cinder/Easing.h"
#include "cinder/Tween.h"
#include "cinder/Function.h"

#include <vector>
#include <list>
#include <map>

namespace cinder {

typedef std::shared_ptr<class Cue>          CueRef;
typedef std::shared_ptr<class Timeline>     TimelineRef;
    
class Timeline : public TimelineItem {      
  public:
    static TimelineRef  create() { TimelineRef result( new Timeline() ); result->setInfinite( true ); return result; }

    void    step( float timestep );
    void    stepTo( float absoluteTime );
    
    float   getCurrentTime() const { return mCurrentTime; }
    
    template<typename T>
    typename Tween<T>::Options apply( Anim<T> *target, T endValue, float duration, EaseFn easeFunction = easeNone, typename Tween<T>::LerpFn lerpFunction = &tweenLerp<T> )
    {
        target->setParentTimeline( thisRef() );
        return applyPtr( target->ptr(), endValue, duration, easeFunction, lerpFunction );
    }

    template<typename T>
    typename Tween<T>::Options apply( Anim<T> *target, T startValue, T endValue, float duration, EaseFn easeFunction = easeNone, typename Tween<T>::LerpFn lerpFunction = &tweenLerp<T> )
    {
        target->setParentTimeline( thisRef() );
        return applyPtr( target->ptr(), startValue, endValue, duration, easeFunction, lerpFunction );
    }

    template<typename T>
    typename Tween<T>::Options appendTo( Anim<T> *target, T endValue, float duration, EaseFn easeFunction = easeNone, typename Tween<T>::LerpFn lerpFunction = &tweenLerp<T> )
    {
        target->setParentTimeline( thisRef() );
        return appendToPtr( target->ptr(), endValue, duration, easeFunction, lerpFunction );
    }

    template<typename T>
    typename Tween<T>::Options appendTo( Anim<T> *target, T startValue, T endValue, float duration, EaseFn easeFunction = easeNone, typename Tween<T>::LerpFn lerpFunction = &tweenLerp<T> )
    {
        target->setParentTimeline( thisRef() );
        return appendToPtr( target->ptr(), startValue, endValue, duration, easeFunction, lerpFunction );
    }

    template<typename T>
    typename Tween<T>::Options applyPtr( T *target, T endValue, float duration, EaseFn easeFunction = easeNone, typename Tween<T>::LerpFn lerpFunction = &tweenLerp<T> )
    {
        TweenRef<T> newTween( new Tween<T>( target, endValue, mCurrentTime, duration, easeFunction, lerpFunction ) );
        newTween->setAutoRemove( mDefaultAutoRemove );
        apply( newTween );
        return typename Tween<T>::Options( newTween, thisRef() );
    }
    
    template<typename T>
    typename Tween<T>::Options applyPtr( T *target, T startValue, T endValue, float duration, EaseFn easeFunction = easeNone, typename Tween<T>::LerpFn lerpFunction = &tweenLerp<T> ) {
        TweenRef<T> newTween( new Tween<T>( target, startValue, endValue, mCurrentTime, duration, easeFunction, lerpFunction ) );
        newTween->setAutoRemove( mDefaultAutoRemove );
        apply( newTween );
        return typename Tween<T>::Options( newTween, thisRef() );
    }

    template<typename T>
    typename Tween<T>::Options appendToPtr( T *target, T endValue, float duration, EaseFn easeFunction = easeNone, typename Tween<T>::LerpFn lerpFunction = &tweenLerp<T> ) {
        float startTime = findEndTimeOf( target );
        TweenRef<T> newTween( new Tween<T>( target, endValue, std::max( mCurrentTime, startTime ), duration, easeFunction, lerpFunction ) );
        newTween->setAutoRemove( mDefaultAutoRemove );
        insert( newTween );
        return typename Tween<T>::Options( newTween, thisRef() );
    }
    
    template<typename T>
    typename Tween<T>::Options appendToPtr( T *target, T startValue, T endValue, float duration, EaseFn easeFunction = easeNone, typename Tween<T>::LerpFn lerpFunction = &tweenLerp<T> ) {
        float startTime = findEndTimeOf( target );
        TweenRef<T> newTween( new Tween<T>( target, startValue, endValue, std::max( mCurrentTime, startTime ), duration, easeFunction, lerpFunction ) );
        newTween->setAutoRemove( mDefaultAutoRemove );
        insert( newTween );
        return typename Tween<T>::Options( newTween, thisRef() );
    }

    CueRef add( const std::function<void ()> &action, float atTime );

    template<typename T>
    FnTweenRef<T> applyFn( const std::function<void (T)> &fn, T startValue, T endValue, float duration, const EaseFn &easeFunction = easeNone, const typename Tween<T>::LerpFn &lerpFunction = &tweenLerp<T> ) {
        FnTweenRef<T> newTween( new FnTween<T>( fn, startValue, endValue, mCurrentTime, duration, easeFunction, lerpFunction ) );
        newTween->setAutoRemove( mDefaultAutoRemove );
        apply( newTween );
        return newTween;
    }

    void appendPingPong();

    void apply( TimelineItemRef item );
    
    void add( TimelineItemRef item );
    void insert( TimelineItemRef item );
    void insert( TimelineItemRef item, float atTime ) { item->mStartTime = atTime; insert( item ); }

    size_t              getNumItems() const { return mItems.size(); }
    bool                empty() const { return mItems.empty(); }
    TimelineItemRef     find( void *target ) const;
    TimelineItemRef     findLast( void *target ) const;
    TimelineItemRef     findLastEnd( void *target ) const;
    float               findEndTimeOf( void *target, bool *found = NULL ) const;
    void                remove( TimelineItemRef item );
    void                removeTarget( void *target );
    void                cloneAndReplaceTarget( void *target, void *replacementTarget );
    void                replaceTarget( void *target, void *replacementTarget );
    
    void clear();
    void reset( bool unsetStarted = false );

    void    setDefaultAutoRemove( bool defaultAutoRemove ) { mDefaultAutoRemove = defaultAutoRemove; }
    bool    getDefaultAutoRemove() const { return mDefaultAutoRemove; }

    void    itemTimeChanged( TimelineItem *item );

    TimelineRef thisRef() { 
        TimelineItemRef thisTimelineItem = TimelineItem::thisRef();
        TimelineRef result = std::static_pointer_cast<Timeline>( thisTimelineItem );
        return result;
    }

    virtual void    stepTo( float absoluteTime, bool reverse ) { stepTo( absoluteTime ); }
    
  protected:  
    Timeline();
    
    virtual void reverse();
    virtual TimelineItemRef cloneReverse() const;
    virtual TimelineItemRef clone() const;
    virtual void start( bool reverse ) {} // no-op
    virtual void loopStart();
    virtual void update( float absTime );
    virtual void complete( bool reverse ) {} // no-op

    void                        eraseMarked();
    virtual float               calcDuration() const;

    bool                        mDefaultAutoRemove;
    float                       mCurrentTime;
    
    std::multimap<void*,TimelineItemRef>        mItems;
    
  private:
    Timeline( const Timeline &rhs ); // private to prevent copying; use clone() method instead
    Timeline& operator=( const Timeline &rhs ); // not defined to prevent copying
};

class Cue : public TimelineItem {
  public:
    Cue( const std::function<void ()> &fn, float atTime = 0 );

    CueRef  create( const std::function<void ()> &fn, float atTime = 0 ) { return CueRef( new Cue( fn, atTime ) ); }

    void                    setFn( const std::function<void ()> &fn ) { mFunction = fn; }
    std::function<void ()>  getFn() const { return mFunction; }
    
  protected:
    virtual void                reverse() { /* no-op */ }
    virtual TimelineItemRef cloneReverse() const;
    virtual TimelineItemRef clone() const;

    virtual void start( bool reverse ) {} // starting is a no-op for Cues
    virtual void loopStart();
    virtual void update( float relativeTime ) {} // update is a no-op for Cues
    virtual void complete( bool reverse ) {} // completion is a no-op for Cues
    virtual bool updateAtLoopStart() { return true; }
  
    std::function<void ()>      mFunction;
};

} // namespace cinder