YiTimelineKeyTime.h

Go to the documentation of this file.

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

#include "framework/YiPredef.h"
#include "animation/YiVariant.h"
#include "animation/YiAnimation.h"
#include "binding/YiScriptableObject.h"

class CYITimelineKeyTimePriv;

class CYITimelineKeyTime : public CYIScriptableObject
{
public:
    enum INTERPOLATION_TYPE
    {
        LINEAR, 
        BEZIER, 
        HOLD 
    };

    struct EASE
    {
        float fSpeedIn;
        float fInfluenceIn;
        float fSpeedOut;
        float fInfluenceOut;
    };

    struct SPATIAL_EASE
    {
        float fX;
        float fY;
        float fZ;
    };

    struct KEYTIME_SETUP
    {
        KEYTIME_SETUP();

        INTERPOLATION_TYPE          eInterpolationType;
        uint32_t uTime;
        CYIVariant                  value;
        std::vector<EASE>           easeValues;
        SPATIAL_EASE                spatialEaseIn;
        SPATIAL_EASE                spatialEaseOut;
    };

    static const uint32_t MAX_EASE_DIMENSIONS = 3;

    CYITimelineKeyTime();
    virtual ~CYITimelineKeyTime();

    void CalculateValue(const CYITimelineKeyTime *pPrevious, float fDataPositions[MAX_EASE_DIMENSIONS], uint32_t uDimensionCount, CYIVariant &rOutValue) const;

    void                 ClearInterpolators();

    uint32_t GetDuration() const;
    void SetDuration(uint32_t uDuration);

    uint32_t GetAbsoluteTime() const;
    void SetAbsoluteTime(uint32_t uAbsoluteTime);

    const EASE *GetEase(uint32_t uDimensionIndex) const;
    uint32_t GetEaseDimensionCount() const;
    INTERPOLATION_TYPE   GetInterpolationType() const;
    const CYIVariant    &GetKeyValue() const;

    float GetKeyValueAsFloat(uint32_t nDimensionIndex) const;

    const SPATIAL_EASE  *GetSpatialEaseIn() const;
    const SPATIAL_EASE  *GetSpatialEaseOut() const;
    CYITimeInterpolator *GetTimeInterpolator(uint32_t uValueIndex);

    void                 InitKeyTime(const CYITimelineKeyTime::KEYTIME_SETUP *pKeytimeSetup);

    void SetSpatialInterpolator(float fC0, float fC1, float fC2, float fC3, uint32_t uDimensionIndex);
    void SetTimeInterpolator(std::unique_ptr<CYITimeInterpolator> pInterpolator, uint32_t uDimensionIndex);

    void                 DumpSpatialInterpolatorData();

    int32_t GetApproximateSize() const;

private:

    CYITimelineKeyTime(const CYITimelineKeyTime &);
    const CYITimelineKeyTime &operator =(const CYITimelineKeyTime &);
    CYITimelineKeyTimePriv     *m_pPriv;
};

#endif // _YI_TIMELINE_KEY_TIME_H_