YiAbstractTimeline.h

Go to the documentation of this file.

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

#include "animation/YiTimelineProxy.h"
#include "binding/YiScriptableRTTIObject.h"
#include "signal/YiSignalHandler.h"
#include "signal/YiSignal.h"

#include <glm/fwd.hpp>

class CYIAbstractTimelinePriv;
class CYISceneNode;
class CYISceneNodeProxy;

class CYIAbstractTimeline : public CYISignalHandler, public CYIScriptableRTTIObject
{
    friend class CYITimelineGroup;
    friend class CYISerialTimelineGroup;
    friend class CYIParallelTimelineGroup;
    friend class CYITimelineLoop;

public:
    enum YI_FRAME_MODE
    {
        YI_ABSOLUTE,
        YI_RELATIVE
    };

    enum STATUS
    {
        STOPPED,
        PLAYING,
    };

    enum DIRECTION
    {
        FORWARD,
        REVERSE,
    };

    virtual ~CYIAbstractTimeline();

    void Start();

    void Finish();

    void Pause();

    void Continue();

    void SetDirection(DIRECTION direction);

    DIRECTION GetDirection() const;

    STATUS GetStatus() const;

    uint64_t GetStartTime() const;

    uint64_t GetCurrentTime() const;

    float GetTimeAsPercentage() const;

    uint64_t GetTotalTime() const;

    void SeekToPercentage(float fPercentage);

    void SeekToTime(uint64_t uMillis);

    void Abort();

    void SetDisablesInput(bool bDisablesInput);

    void Track();

    void Untrack();

    void StartForward();

    void StartReverse();

    void ContinueForward();

    void ContinueReverse();

    void SetDirectionForward();

    void SetDirectionReverse();

    void SetFrameModes(YI_FRAME_MODE eStartFrameMode, YI_FRAME_MODE eEndFrameMode);

    bool SetSourcePositions(CYISceneNode *pNode, const glm::vec3 &vPosition);

    bool ClearSourcePositions(CYISceneNode *pNode);

    bool SetTargetPositions(CYISceneNode *pNode, const glm::vec3 &vPosition);

    bool ClearTargetPositions(CYISceneNode *pNode);

    const std::shared_ptr<CYITimelineProxy> &GetProxy() const;

    void SetRootNode(CYISceneNode *pRootNode);

    const std::shared_ptr<CYISceneNodeProxy> &GetRootNode() const;

    /* signals */
    CYISignal<> Playing; 
    CYISignal<> Paused; 
    CYISignal<> Aborted; 
    CYISignal<> Started; 
    CYISignal<> Completed; 

    /* supplemental signals */
    CYISignal<> PlayingForward; 
    CYISignal<> PlayingReverse; 
    CYISignal<> PausedForward; 
    CYISignal<> PausedReverse; 
    CYISignal<> StartedForward; 
    CYISignal<> StartedReverse; 
    CYISignal<> CompletedForward; 
    CYISignal<> CompletedReverse; 

protected:
    CYIAbstractTimeline(CYIAbstractTimelinePriv *pPriv);
    CYIAbstractTimelinePriv *m_pPriv;

private:
    YI_DISALLOW_COPY_AND_ASSIGN(CYIAbstractTimeline);
    YI_TYPE_BASES_WITH_SCRIPTABLE_BASE(CYIAbstractTimeline)
};

#endif /* _YI_ABSTRACT_TIMELINE_H_ */