keyframe.h

Go to the documentation of this file.

/* === S Y N F I G ========================================================= */
/* ========================================================================= */

/* === S T A R T =========================================================== */

#ifndef __SYNFIG_KEYFRAME_H
#define __SYNFIG_KEYFRAME_H

/* === H E A D E R S ======================================================= */

#include <ETL/handle>
#include <vector>
#include "string.h"
#include "time.h"
#include "uniqueid.h"
#include "guid.h"
#include "waypoint.h"

/* === M A C R O S ========================================================= */

/* === T Y P E D E F S ===================================================== */

/* === C L A S S E S & S T R U C T S ======================================= */

namespace synfig {

class Keyframe :  public UniqueID
{
private:

    Time time_;
    String desc_;
    GUID guid_;

    bool active_;

    Waypoint::Model waypoint_model_;
    bool has_waypoint_model_;

public:

    Keyframe();

    Keyframe(const Time &time);

    ~Keyframe();

    void set_time(Time x) { time_=x; }

    Time get_time()const { return time_; }

    void set_description(String x) { desc_=x; }

    String get_description()const { return desc_; }

    const GUID& get_guid()const { return guid_; }
    void set_guid(const GUID& x) { guid_=x; }

    void enable() { set_active(true); }


    void disable() { set_active(false); }
    

    void set_active(bool x);

    bool active()const { return active_; }

    using UniqueID::operator<;
    using UniqueID::operator==;
    using UniqueID::operator!=;
    using UniqueID::operator=;

    bool operator<(const Keyframe &rhs)const { return time_<rhs.time_; }
    bool operator<(const Time &rhs)const { return time_<rhs; }

//  bool operator==(const Keyframe &rhs)const { return id_==rhs.id_; }
    bool operator==(const Time &rhs)const { return time_==rhs; }

//  bool operator!=(const Keyframe &rhs)const { return id_!=rhs.id_; }
    bool operator!=(const Time &rhs)const { return time_!=rhs; }

    const Waypoint::Model &get_waypoint_model()const { return waypoint_model_; }
    void apply_model(const Waypoint::Model &x);
    bool has_model() const {return has_waypoint_model_; }
}; // END of class Keyframe

class KeyframeList : public std::vector<Keyframe>
{

public:

    iterator add(const Keyframe &x);

    void erase(const UniqueID &x);

    iterator find(const UniqueID &x);

    const_iterator find(const UniqueID &x)const;

    iterator find(const Time &x);

    iterator find_next(const Time &x, bool ignore_disabled = true);

    iterator find_prev(const Time &x, bool ignore_disabled = true);

    const_iterator find(const Time &x)const;
    const_iterator find_next(const Time &x, bool ignore_disabled = true)const;
    const_iterator find_prev(const Time &x, bool ignore_disabled = true)const;

    void find_prev_next(const Time& time, Time &prev, Time &next, bool ignore_disabled = true)const;

    void insert_time(const Time& location, const Time& delta);

    void dump()const;
    void sync();
};

//typedef std::list<Keyframe> KeyframeList;

}; // END of namespace synfig

/* === E N D =============================================================== */

#endif