duckmatic.h

Go to the documentation of this file.

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

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

#ifndef __SYNFIG_STUDIO_DUCKMATIC_H
#define __SYNFIG_STUDIO_DUCKMATIC_H

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

#include <list>
#include <map>
#include <set>

#include <ETL/smart_ptr>
#include <ETL/handle>

#include <synfig/vector.h>
#include <synfig/string.h>
#include <synfig/real.h>
#include <sigc++/signal.h>
#include <sigc++/object.h>
#include <synfig/time.h>
#include <synfig/color.h>
#include <ETL/smart_ptr>

#include "duck.h"
#include <synfig/color.h>
#include <synfig/guidset.h>

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

#ifdef HASH_MAP_H
#include HASH_MAP_H
#include FUNCTIONAL_H

#ifndef __STRING_HASH__
#define __STRING_HASH__
class StringHash
{
# ifdef FUNCTIONAL_HASH_ON_STRING
    HASH_MAP_NAMESPACE::hash<synfig::String> hasher_;
# else  // FUNCTIONAL_HASH_ON_STRING
    HASH_MAP_NAMESPACE::hash<const char*> hasher_;
# endif  // FUNCTIONAL_HASH_ON_STRING
public:
    size_t operator()(const synfig::String& x)const
    {
# ifdef FUNCTIONAL_HASH_ON_STRING
        return hasher_(x);
# else  // FUNCTIONAL_HASH_ON_STRING
        return hasher_(x.c_str());
# endif  // FUNCTIONAL_HASH_ON_STRING
    }
};
#endif
#else
#include <map>
#endif

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

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

namespace synfigapp { class ValueDesc; class CanvasInterface; }
namespace synfig { class ParamDesc; }

namespace studio
{

class CanvasView;
class Duckmatic;

class DuckDrag_Base : public etl::shared_object
{
public:
    virtual void begin_duck_drag(Duckmatic* duckmatic, const synfig::Vector& begin)=0;
    virtual bool end_duck_drag(Duckmatic* duckmatic)=0;
    virtual void duck_drag(Duckmatic* duckmatic, const synfig::Vector& vector)=0;
};

class DuckDrag_Translate : public DuckDrag_Base
{
    synfig::Vector last_translate_;
    synfig::Vector drag_offset_;
    synfig::Vector snap;
    std::vector<synfig::Vector> positions;
    bool is_moving;

public:
    void begin_duck_drag(Duckmatic* duckmatic, const synfig::Vector& begin);
    bool end_duck_drag(Duckmatic* duckmatic);
    void duck_drag(Duckmatic* duckmatic, const synfig::Vector& vector);
};

class BezierDrag_Base : public etl::shared_object
{
public:
    virtual void begin_bezier_drag(Duckmatic* duckmatic, const synfig::Vector& begin, float bezier_click_pos)=0;
    virtual bool end_bezier_drag(Duckmatic* duckmatic)=0;
    virtual void bezier_drag(Duckmatic* duckmatic, const synfig::Vector& vector)=0;
};

class BezierDrag_Default : public BezierDrag_Base
{
    synfig::Vector last_translate_;
    synfig::Vector drag_offset_;
    float click_pos_;
    synfig::Vector c1_initial;
    synfig::Vector c2_initial;
    float c1_ratio;
    float c2_ratio;
    //bool c1_selected;
    //bool c2_selected;
    //Warning: unused variables c1_selected c2_selected
    bool is_moving;

public:
    void begin_bezier_drag(Duckmatic* duckmatic, const synfig::Vector& begin, float bezier_click_pos);
    bool end_bezier_drag(Duckmatic* duckmatic);
    void bezier_drag(Duckmatic* duckmatic, const synfig::Vector& vector);
};

class Duckmatic
{
    friend class DuckDrag_Base;
    friend class DuckDrag_Translate;

    /*
 -- ** -- P U B L I C   T Y P E S ---------------------------------------------
    */

public:

#ifdef HASH_MAP_H
typedef HASH_MAP_CLASS<synfig::GUID,etl::smart_ptr<synfig::Point>,synfig::GUIDHash> DuckDataMap;
#else
typedef std::map<synfig::GUID,etl::smart_ptr<synfig::Point> > DuckDataMap;
#endif

    typedef studio::DuckMap DuckMap;

    typedef studio::Duck Duck;

    struct Stroke;

    struct Bezier;

    class Push;

    friend class Push;

    typedef Duck::Type Type;

    typedef std::list<float> GuideList;

    /*
 -- ** -- P R I V A T E   D A T A ---------------------------------------------
    */

private:

    etl::loose_handle<synfigapp::CanvasInterface> canvas_interface;

    Type type_mask;

    DuckMap duck_map;

    DuckDataMap duck_data_share_map;

    std::list<etl::handle<Stroke> > stroke_list_;

    std::list<etl::handle<Stroke> > persistent_stroke_list_;

    synfig::GUIDSet selected_ducks;

    synfig::GUID last_duck_guid;

    std::list<etl::handle<Bezier> > bezier_list_;

    //synfig::Vector snap;

    etl::handle<DuckDrag_Base> duck_dragger_;

    etl::handle<BezierDrag_Base> bezier_dragger_;

    sigc::signal<void> signal_duck_selection_changed_;

    sigc::signal<void> signal_strokes_changed_;

    sigc::signal<void> signal_grid_changed_;

    mutable sigc::signal<void> signal_sketch_saved_;

    GuideList guide_list_x_;
    GuideList guide_list_y_;

    mutable synfig::String sketch_filename_;

    synfig::TransformStack curr_transform_stack;
    bool curr_transform_stack_set;
    std::list<sigc::connection> duck_changed_connections;

    bool alternative_mode_;
    bool lock_animation_mode_;

    /*
 -- ** -- P R O T E C T E D   D A T A -----------------------------------------
    */

protected:

    etl::handle<Bezier> selected_bezier;

    synfig::Time cur_time;


    bool grid_snap;

    bool guide_snap;


    synfig::Vector grid_size;
    synfig::Color grid_color;
    synfig::Color guides_color;

    float zoom;                 
    float prev_zoom;            

    bool show_persistent_strokes;

    bool axis_lock;

    /*
 -- ** -- P R I V A T E   M E T H O D S ---------------------------------------
    */

private:

    synfig::Vector last_translate_;
    synfig::Vector drag_offset_;

    //etl::handle<Duck> selected_duck;

    void connect_signals(const Duck::Handle &duck, const synfigapp::ValueDesc& value_desc, CanvasView &canvas_view);

    /*
 -- ** -- P U B L I C   M E T H O D S -----------------------------------------
    */

public:

    Duckmatic(etl::loose_handle<synfigapp::CanvasInterface> canvas_interface);
    virtual ~Duckmatic();

    void set_alternative_mode(bool x) { alternative_mode_=x; }
    bool get_alternative_mode()const { return alternative_mode_; }

    void set_lock_animation_mode(bool x) { lock_animation_mode_=x; }
    bool get_lock_animation_mode()const { return lock_animation_mode_; }

    sigc::signal<void>& signal_duck_selection_changed() { return signal_duck_selection_changed_; }
    sigc::signal<void>& signal_strokes_changed() { return signal_strokes_changed_; }
    sigc::signal<void>& signal_grid_changed() { return signal_grid_changed_; }
    sigc::signal<void>& signal_sketch_saved() { return signal_sketch_saved_; }

    GuideList& get_guide_list_x() { return guide_list_x_; }
    GuideList& get_guide_list_y() { return guide_list_y_; }
    const GuideList& get_guide_list_x()const { return guide_list_x_; }
    const GuideList& get_guide_list_y()const { return guide_list_y_; }

    void set_guide_snap(bool x=true);
    bool get_guide_snap()const { return guide_snap; }
    void toggle_guide_snap() { set_guide_snap(!get_guide_snap()); }
    void set_guides_color(const synfig::Color &c);
    const synfig::Color &get_guides_color()const { return guides_color;}

    void set_grid_snap(bool x=true);

    bool get_grid_snap()const { return grid_snap; }

    void enable_grid_snap() { set_grid_snap(true); }

    void disable_grid_snap() { set_grid_snap(false); }

    void toggle_grid_snap() { set_grid_snap(!grid_snap); }

    synfig::Point snap_point_to_grid(const synfig::Point& x)const;

    bool get_show_persistent_strokes()const { return show_persistent_strokes; }
    void set_show_persistent_strokes(bool x);

    void set_grid_size(const synfig::Vector &s);
    void set_grid_color(const synfig::Color &c);

    const synfig::Vector &get_grid_size()const { return grid_size; }
    const synfig::Color &get_grid_color()const { return grid_color;}

    const synfig::Time &get_time()const { return cur_time; }

    bool get_axis_lock()const { return axis_lock; }
    void set_axis_lock(bool x) { axis_lock=x; }

    void set_time(synfig::Time x) { cur_time=x; }

    bool is_duck_group_selectable(const etl::handle<Duck>& x)const;

    //const DuckMap& duck_map()const { return duck_map; }
    DuckList get_duck_list()const;

    const std::list<etl::handle<Bezier> >& bezier_list()const { return bezier_list_; }

    const std::list<etl::handle<Stroke> >& stroke_list()const { return stroke_list_; }

    const std::list<etl::handle<Stroke> >& persistent_stroke_list()const { return persistent_stroke_list_; }

    std::list<etl::handle<Stroke> >& persistent_stroke_list() { return persistent_stroke_list_; }

    /*
 -- ** -- D U C K  S E L E C T I O N  M E T H O D S----------------------------
    */

    etl::handle<Duck> get_selected_duck()const;

    DuckList get_selected_ducks()const;

    DuckList get_ducks_in_box(const synfig::Vector& tl,const synfig::Vector& br)const;

    void refresh_selected_ducks();
    void clear_selected_ducks();

    int count_selected_ducks()const;

    bool duck_is_selected(const etl::handle<Duck> &duck)const;

    void toggle_select_duck(const etl::handle<Duck> &duck);

    void select_duck(const etl::handle<Duck> &duck);

    void unselect_duck(const etl::handle<Duck> &duck);


    void toggle_select_ducks_in_box(const synfig::Vector& tl,const synfig::Vector& br);

    void select_ducks_in_box(const synfig::Vector& tl,const synfig::Vector& br);


    const synfig::TransformStack& get_curr_transform_stack()const { return curr_transform_stack; }

    inline void clear_curr_transform_stack() { curr_transform_stack.clear(); curr_transform_stack_set=false; }


    etl::handle<Bezier> get_selected_bezier()const;


    void start_duck_drag(const synfig::Vector& offset);


    void translate_selected_ducks(const synfig::Vector& vector);

    void update_ducks();

    bool end_duck_drag();

    // bezier drags (similar to duck drags)
    void start_bezier_drag(const synfig::Vector& offset, float bezier_click_pos);

    void translate_selected_bezier(const synfig::Vector& vector);

    bool end_bezier_drag();


    void signal_user_click_selected_ducks(int button);


    void signal_edited_duck(const etl::handle<Duck> &duck, bool moving = false);


    void signal_edited_selected_ducks(bool moving = false);

    bool on_duck_changed(const studio::Duck &duck,const synfigapp::ValueDesc& value_desc);

    etl::handle<Duck> find_similar_duck(etl::handle<Duck> duck);
    etl::handle<Duck> add_similar_duck(etl::handle<Duck> duck);

    void add_stroke(etl::smart_ptr<std::list<synfig::Point> > stroke_point_list, const synfig::Color& color=synfig::Color(0,0,0));

    void add_persistent_stroke(etl::smart_ptr<std::list<synfig::Point> > stroke_point_list, const synfig::Color& color=synfig::Color(0,0,0));

    void clear_persistent_strokes();

    void add_duck(const etl::handle<Duck> &duck);

    void add_bezier(const etl::handle<Bezier> &bezier);

    void erase_duck(const etl::handle<Duck> &duck);

    void erase_bezier(const etl::handle<Bezier> &bezier);

    etl::handle<Duck> last_duck()const;

    etl::handle<Bezier> last_bezier()const;


    etl::handle<Duck> find_duck(synfig::Point pos, synfig::Real radius=0, Duck::Type type=Duck::TYPE_DEFAULT);

    GuideList::iterator find_guide_x(synfig::Point pos, float radius=0.1);
    GuideList::iterator find_guide_y(synfig::Point pos, float radius=0.1);
    GuideList::const_iterator find_guide_x(synfig::Point pos, float radius=0.1)const { return const_cast<Duckmatic*>(this)->find_guide_x(pos,radius); }
    GuideList::const_iterator find_guide_y(synfig::Point pos, float radius=0.1)const { return const_cast<Duckmatic*>(this)->find_guide_y(pos,radius); }


    //etl::handle<Bezier> find_bezier(synfig::Point pos, synfig::Real radius=0);


    etl::handle<Bezier> find_bezier(synfig::Point pos, synfig::Real radius=0, float* location=0);

    etl::handle<Bezier> find_bezier(synfig::Point pos, synfig::Real scale, synfig::Real radius, float* location=0);

    void add_ducks_layers(synfig::Canvas::Handle canvas, std::set<synfig::Layer::Handle>& selected_layer_set, etl::handle<CanvasView> canvas_view, synfig::TransformStack& transform_stack);

    bool add_to_ducks(const synfigapp::ValueDesc& value_desc,etl::handle<CanvasView> canvas_view, const synfig::TransformStack& transform_stack_, synfig::ParamDesc *param_desc=0);

    void set_type_mask(Type x) { type_mask=x; }

    Type get_type_mask()const { return type_mask; }

    void select_all_ducks();
    void unselect_all_ducks();

    void clear_ducks();

    bool save_sketch(const synfig::String& filename)const;
    bool load_sketch(const synfig::String& filename);
    const synfig::String& get_sketch_filename()const { return sketch_filename_; }

    void set_duck_dragger(etl::handle<DuckDrag_Base> x) { duck_dragger_=x; }
    etl::handle<DuckDrag_Base> get_duck_dragger()const { return duck_dragger_; }
    void clear_duck_dragger() { duck_dragger_=new DuckDrag_Translate(); }


    void set_bezier_dragger(etl::handle<BezierDrag_Base> x) { bezier_dragger_=x; }
    etl::handle<BezierDrag_Base> get_bezier_dragger()const { return bezier_dragger_; }
    void clear_bezier_dragger() { bezier_dragger_=new BezierDrag_Default(); }
}; // END of class Duckmatic


class Duckmatic::Push
{
    Duckmatic *duckmatic_;
    DuckMap duck_map;
    std::list<etl::handle<Bezier> > bezier_list_;
    std::list<etl::handle<Stroke> > stroke_list_;
    DuckDataMap duck_data_share_map;
    etl::handle<DuckDrag_Base> duck_dragger_;

    bool needs_restore;

public:
    Push(Duckmatic *duckmatic_);
    ~Push();
    void restore();
}; // END of class Duckmatic::Push

struct Duckmatic::Bezier : public etl::shared_object
{
private:
    sigc::signal<void,float> signal_user_click_[5];
public:

    etl::handle<Duck> p1,p2,c1,c2;
    bool is_valid()const { return p1 && p2 && c1 && c2; }

    sigc::signal<void,float> &signal_user_click(int i=0) { assert(i>=0); assert(i<5); return signal_user_click_[i]; }
}; // END of struct Duckmatic::Bezier

struct Duckmatic::Stroke : public etl::shared_object
{
private:
    sigc::signal<void,float> signal_user_click_[5];
public:

    etl::smart_ptr<std::list<synfig::Point> > stroke_data;

    synfig::Color color;

    bool is_valid()const { return (bool)stroke_data; }

    sigc::signal<void,float> &signal_user_click(int i=0) { assert(i>=0); assert(i<5); return signal_user_click_[i]; }
}; // END of struct Duckmatic::Stroke

}; // END of namespace studio

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

#endif