YiTimelineBackingStore.h

Go to the documentation of this file.

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

#include "animation/YiTimelineTrack.h"
#include "animation/YiMarkerData.h"

class CYISceneNode;
class CYITimeline;
class CYITimelineBackingStorePriv;

class CYITimelineBackingStore : public std::enable_shared_from_this<CYITimelineBackingStore>
{
    friend class CYITimelineBackingStorePriv;

public:

    CYITimelineBackingStore();
    virtual ~CYITimelineBackingStore();

    CYITimelineTrack *AddTrack(uint32_t nTrackID, CYITimelineTrack::ATTRIBUTE_TYPE attribute, const CYIString &targetName);
    void AddMarker(const CYIString &name, uint32_t uStartTime, uint32_t uDuration, const std::list<CYITimelineTrack::TRACK_IDENTIFIER> &rTracksSelection, const std::map<CYIString, CYIString> &rMarkerProperties);
    void AddMarker(CYIMarkerData::MARKER_ID eMarkerID, uint32_t uStartTime, uint32_t uDuration, const std::list<CYITimelineTrack::TRACK_IDENTIFIER> &rTracksSelection, const std::map<CYIString, CYIString> &rMarkerProperties);

    std::unique_ptr<CYITimeline> CreateTimeline(CYISceneNode *pRootNode = nullptr);
    std::unique_ptr<CYITimeline> CreateTimeline(const CYIString &markerName, CYISceneNode *pRootNode = nullptr);
    std::unique_ptr<CYITimeline> CreateTimeline(CYIMarkerData::MARKER_ID eMarkerID, CYISceneNode *pRootNode = nullptr);
    std::unique_ptr<CYITimeline> CreateTimelineFromMarkerIndex(uint32_t uMarkerIndex, CYISceneNode *pRootNode = nullptr);
    std::unique_ptr<CYITimeline> CreateTimeline(uint32_t uStartTime, uint32_t uDuration, CYISceneNode *pRootNode = nullptr);

    void Finalize();

    virtual uint32_t GetTotalTime() const;
    const CYITimelineTrack *GetTrack(uint32_t uTrackID) const;
    const CYITimelineTrack *GetTrack(CYITimelineTrack::ATTRIBUTE_TYPE eAttribute, const CYIString &name) const;
    uint32_t GetTrackCount() const;
    uint32_t GetMarkerCount() const;

    const CYIMarkerData *GetMarkerData(const CYIString &rMarkerName) const;
    const CYIString &GetMarkerNameFromMarkerIndex(uint32_t uMarkerIndex) const;

    int32_t GetApproximateSize() const;

private:

    CYITimelineBackingStore(const CYITimelineBackingStore &);
    const CYITimelineBackingStore &operator =(const CYITimelineBackingStore &);
    CYITimelineBackingStorePriv  *m_pPriv;
};

#endif /* _YI_TIMELINE_BACKING_STORE_H_ */