YiAnimation.h

Go to the documentation of this file.

// © You i Labs Inc. 2000-2017. All rights reserved.
#ifndef _YI_ANIMATION_H_
#define _YI_ANIMATION_H_

#include "framework/YiPredef.h"
#include "utility/YiTime.h"

#include <limits>


class CYIAnimationPriv;
class CYITimeInterpolator;

class CYIAnimation : public CYITime::UpdateListener
{
public:
    enum REPEAT_MODE
    {
        REPEAT_RESTART = 0, 
        REPEAT_REVERSE      

    };

    enum STATUS
    {
        STATUS_NOT_STARTED = 0, 
        STATUS_RUNNING,         
        STATUS_PAUSED,          
        STATUS_ENDED            

    };

    enum DIRECTION
    {
        DIRECTION_FORWARD = 0, 
        DIRECTION_REVERSE,     

    };

    class Listener
    {
    public:
        virtual ~Listener(){};

        virtual void OnAnimate(CYIAnimation *pAnim, float fDataPosition);

        virtual void OnAnimationBegin(CYIAnimation *pAnimation);
        
        virtual void OnAnimationEnd(CYIAnimation *pAnimation);
    };

    static const uint64_t ANIMATION_TIME_UNDEFINED;
    static const uint64_t ANIMATION_REPEAT_COUNT_INFINITE;

    CYIAnimation();
    virtual ~CYIAnimation();

    void ChangeDirection();

    CYIAnimation::DIRECTION GetDirection() const;

    uint64_t GetDuration() const;

    uint64_t GetLastDeltaTime() const;

    CYIAnimation *GetNext() const;

    CYIAnimation *GetPrevious() const;

    void *GetUserData() const;

    CYIAnimation::STATUS GetStatus()  const;

    CYITimeInterpolator *GetTimeInterpolator() const;

    void InsertInList(CYIAnimation **ppFirstAnimation);

    void RemoveFromList(CYIAnimation **ppFirstAnimation);

    void Pause();

    void Reset();

    void AddListener(CYIAnimation::Listener *pListener);

    void RemoveListener(CYIAnimation::Listener *pListener);

    void ScaleDuration(uint64_t uNewSimpleDur);

    void SetDirection(CYIAnimation::DIRECTION direction);

    void SetDuration(uint64_t uDur);

    void SetRepeatCount(uint64_t uRepeatCount);

    void SetRepeatMode(CYIAnimation::REPEAT_MODE eRepeatMode);

    void SetStartTime(uint64_t uStartTime);

    void SetTimeInterpolator(CYITimeInterpolator *pTimeInterpolator);

    void SetNext(CYIAnimation *pAnimation);

    void SetPrevious(CYIAnimation *pAnimation);

    void SetUserData(void *pPrivData);

    void Start();

    void Terminate();

private:
    // tells the animation that a number of milliseconds have elapsed
    virtual bool OnFrameTimeUpdated(std::chrono::microseconds nFrameTime) override;

    CYIAnimation(const CYIAnimation &);
    const CYIAnimation &operator=(const CYIAnimation &);

private:
    CYIAnimationPriv *m_pPriv;
};

inline void CYIAnimation::Listener::OnAnimate(CYIAnimation * /*pAnimation*/, float /*fDataPosition*/) {}
inline void CYIAnimation::Listener::OnAnimationBegin(CYIAnimation * /*pAnimation*/) {}
inline void CYIAnimation::Listener::OnAnimationEnd(CYIAnimation * /*pAnimation*/) {}

#endif // _YI_ANIMATION_H_