YiTimelineKeyTime.h

Go to the documentation of this file.

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

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

class CYITimelineKeyTime
{
public:
    enum class InterpolationType : uint8_t
    {
        Linear, 
        Bezier, 
        Hold 
    };

    struct EASE
    {
        float speedIn;
        float influenceIn;
        float speedOut;
        float influenceOut;
    };

    struct SPATIAL_EASE
    {
        float x;
        float y;
        float z;
    };

    struct KEYTIME_SETUP
    {
        KEYTIME_SETUP();

        InterpolationType interpolationType;
        uint32_t time;
        CYIVariant value;
        std::vector<EASE> easeValues;
        SPATIAL_EASE spatialEaseIn;
        SPATIAL_EASE spatialEaseOut;
    };

    static const uint32_t MAX_EASE_DIMENSIONS = 3;

    CYITimelineKeyTime();
    CYITimelineKeyTime(CYITimelineKeyTime &&);
    ~CYITimelineKeyTime();

    CYITimelineKeyTime &operator=(CYITimelineKeyTime &&);

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

    void ClearInterpolators();

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

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

    const EASE *GetEase(size_t dimensionIndex) const;
    size_t GetEaseDimensionCount() const;
    InterpolationType GetInterpolationType() const;
    const CYIVariant &GetKeyValue() const;

    float GetKeyValueAsFloat(size_t dimensionIndex) const;

    const SPATIAL_EASE *GetSpatialEaseIn() const;
    const SPATIAL_EASE *GetSpatialEaseOut() const;
    CYITimeInterpolator *GetTimeInterpolator(size_t valueIndex);

    void InitKeyTime(CYITimelineKeyTime::KEYTIME_SETUP &&keytimeSetup);

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

    void SetSpatialInterpolator(float c0, float c1, float c2, float c3, size_t dimensionIndex);
    void SetTimeInterpolator(std::unique_ptr<CYITimeInterpolator> pInterpolator, size_t dimensionIndex);

    void DumpSpatialInterpolatorData();

    size_t GetApproximateSize() const;

private:
    struct BezierData;

    CYITimelineKeyTime(const CYITimelineKeyTime &) = delete;
    const CYITimelineKeyTime &operator=(const CYITimelineKeyTime &) = delete;

    void EnsureBezierDataObjectExists();

    CYIVariant m_keyValue;
    uint32_t m_duration;
    uint32_t m_absoluteTime;
    CYITimelineKeyTime::InterpolationType m_interpolationType;

    std::unique_ptr<BezierData> m_pBezierData;
};

#endif // _YI_TIMELINE_KEY_TIME_H_