synfig-studio/trunk/src/gtkmm/duckmatic.h

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file duckmatic.h
   3 **      \brief Template Header
   4 **
   5 **      $Id$
   6 **
   7 **      \legal
   8 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
   9 **      Copyright (c) 2007 Chris Moore
  10 **
  11 **      This package is free software; you can redistribute it and/or
  12 **      modify it under the terms of the GNU General Public License as
  13 **      published by the Free Software Foundation; either version 2 of
  14 **      the License, or (at your option) any later version.
  15 **
  16 **      This package is distributed in the hope that it will be useful,
  17 **      but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 **      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19 **      General Public License for more details.
  20 **      \endlegal
  21 */
  22 /* ========================================================================= */
  23
  24 /* === S T A R T =========================================================== */
  25
  26 #ifndef __SYNFIG_STUDIO_DUCKMATIC_H
  27 #define __SYNFIG_STUDIO_DUCKMATIC_H
  28
  29 /* === H E A D E R S ======================================================= */
  30
  31 #include <list>
  32 #include <map>
  33 #include <set>
  34
  35 #include <ETL/smart_ptr>
  36 #include <ETL/handle>
  37
  38 #include <synfig/vector.h>
  39 #include <synfig/string.h>
  40 #include <synfig/real.h>
  41 #include <sigc++/signal.h>
  42 #include <sigc++/object.h>
  43 #include <synfig/time.h>
  44 #include <synfig/color.h>
  45 #include <ETL/smart_ptr>
  46
  47 #include "duck.h"
  48 #include <synfig/color.h>
  49 #include <synfig/guidset.h>
  50
  51 /* === M A C R O S ========================================================= */
  52
  53 #ifdef HASH_MAP_H
  54 #include HASH_MAP_H
  55 #include FUNCTIONAL_H
  56
  57 #ifndef __STRING_HASH__
  58 #define __STRING_HASH__
  59 class StringHash
  60 {
  61 # ifdef FUNCTIONAL_HASH_ON_STRING
  62         HASH_MAP_NAMESPACE::hash<synfig::String> hasher_;
  63 # else  // FUNCTIONAL_HASH_ON_STRING
  64         HASH_MAP_NAMESPACE::hash<const char*> hasher_;
  65 # endif  // FUNCTIONAL_HASH_ON_STRING
  66 public:
  67         size_t operator()(const synfig::String& x)const
  68         {
  69 # ifdef FUNCTIONAL_HASH_ON_STRING
  70                 return hasher_(x);
  71 # else  // FUNCTIONAL_HASH_ON_STRING
  72                 return hasher_(x.c_str());
  73 # endif  // FUNCTIONAL_HASH_ON_STRING
  74         }
  75 };
  76 #endif
  77 #else
  78 #include <map>
  79 #endif
  80
  81 //! If defined, only allow radius ducks to be in the top right
  82 //! quadrant of the plane.  This makes it very easy to set the
  83 //! corresponding parameter to zero (by dragging down and left)
  84 #define RESTRICT_RADIUS_DUCKS_TO_ONE_QUARTER
  85
  86 /* === T Y P E D E F S ===================================================== */
  87
  88 /* === C L A S S E S & S T R U C T S ======================================= */
  89
  90 namespace synfigapp { class ValueDesc; }
  91 namespace synfig { class ParamDesc; }
  92
  93 namespace studio
  94 {
  95
  96 class CanvasView;
  97 class Duckmatic;
  98
  99 class DuckDrag_Base : public etl::shared_object
 100 {
 101 public:
 102         virtual void begin_duck_drag(Duckmatic* duckmatic, const synfig::Vector& begin)=0;
 103         virtual bool end_duck_drag(Duckmatic* duckmatic)=0;
 104         virtual void duck_drag(Duckmatic* duckmatic, const synfig::Vector& vector)=0;
 105 };
 106
 107 class DuckDrag_Translate : public DuckDrag_Base
 108 {
 109         synfig::Vector last_translate_;
 110         synfig::Vector drag_offset_;
 111         synfig::Vector snap;
 112         std::vector<synfig::Vector> positions;
 113
 114 public:
 115         void begin_duck_drag(Duckmatic* duckmatic, const synfig::Vector& begin);
 116         bool end_duck_drag(Duckmatic* duckmatic);
 117         void duck_drag(Duckmatic* duckmatic, const synfig::Vector& vector);
 118 };
 119
 120 /*! \class Duckmatic
 121 **
 122 **      This class helps organize any of the devices displayed in
 123 **      the work area that the user may want to interact with.
 124 **      This includes ducks, beziers, and strokes
 125 **
 126 **      \note At some point I'll probably rename this class to "DuckOMatic".
 127 */
 128 class Duckmatic
 129 {
 130         friend class DuckDrag_Base;
 131         friend class DuckDrag_Translate;
 132
 133         /*
 134  -- ** -- P U B L I C   T Y P E S ---------------------------------------------
 135         */
 136
 137 public:
 138
 139 #ifdef HASH_MAP_H
 140 typedef HASH_MAP_CLASS<synfig::GUID,etl::smart_ptr<synfig::Point>,synfig::GUIDHash> DuckDataMap;
 141 #else
 142 typedef std::map<synfig::GUID,etl::smart_ptr<synfig::Point> > DuckDataMap;
 143 #endif
 144
 145         typedef studio::DuckMap DuckMap;
 146
 147         typedef studio::Duck Duck;
 148
 149         struct Stroke;
 150
 151         struct Bezier;
 152
 153         class Push;
 154
 155         friend class Push;
 156
 157         typedef Duck::Type Type;
 158
 159         typedef std::list<float> GuideList;
 160
 161         /*
 162  -- ** -- P R I V A T E   D A T A ---------------------------------------------
 163         */
 164
 165 private:
 166
 167         Type type_mask;
 168
 169         DuckMap duck_map;
 170
 171         DuckDataMap duck_data_share_map;
 172
 173         std::list<etl::handle<Stroke> > stroke_list_;
 174
 175         std::list<etl::handle<Stroke> > persistent_stroke_list_;
 176
 177         synfig::GUIDSet selected_ducks;
 178
 179         synfig::GUID last_duck_guid;
 180
 181         std::list<etl::handle<Bezier> > bezier_list_;
 182
 183         //! I cannot recall what this is for
 184         //synfig::Vector snap;
 185
 186         etl::handle<DuckDrag_Base> duck_dragger_;
 187
 188         sigc::signal<void> signal_duck_selection_changed_;
 189
 190         sigc::signal<void> signal_strokes_changed_;
 191
 192         sigc::signal<void> signal_grid_changed_;
 193
 194         mutable sigc::signal<void> signal_sketch_saved_;
 195
 196         GuideList guide_list_x_;
 197         GuideList guide_list_y_;
 198
 199         mutable synfig::String sketch_filename_;
 200
 201         //! whether the display is flipped vertically or horizontally
 202         bool flip_x_, flip_y_;
 203
 204         /*
 205  -- ** -- P R O T E C T E D   D A T A -----------------------------------------
 206         */
 207
 208 protected:
 209
 210         etl::handle<Bezier> selected_bezier;
 211
 212         synfig::Time cur_time;
 213
 214         //! This flag is set if operations should snap to the grid
 215         /*! \todo perhaps there should be two of these flags, one for each axis?
 216         **      \see show_grid, grid_size */
 217         bool grid_snap;
 218
 219         bool guide_snap;
 220
 221         //! This vector describes the grid size.
 222         /*! \see grid_snap, show_grid */
 223         synfig::Vector grid_size;
 224
 225         bool show_persistent_strokes;
 226
 227         bool axis_lock;
 228
 229         /*
 230  -- ** -- P R I V A T E   M E T H O D S ---------------------------------------
 231         */
 232
 233 private:
 234
 235         synfig::Vector last_translate_;
 236         synfig::Vector drag_offset_;
 237
 238         //etl::handle<Duck> selected_duck;
 239
 240
 241         /*
 242  -- ** -- P U B L I C   M E T H O D S -----------------------------------------
 243         */
 244
 245 public:
 246
 247         Duckmatic();
 248         virtual ~Duckmatic();
 249
 250         void set_flip_x(bool flip_x);
 251         void set_flip_y(bool flip_y);
 252
 253         sigc::signal<void>& signal_duck_selection_changed() { return signal_duck_selection_changed_; }
 254         sigc::signal<void>& signal_strokes_changed() { return signal_strokes_changed_; }
 255         sigc::signal<void>& signal_grid_changed() { return signal_grid_changed_; }
 256         sigc::signal<void>& signal_sketch_saved() { return signal_sketch_saved_; }
 257
 258         GuideList& get_guide_list_x() { return guide_list_x_; }
 259         GuideList& get_guide_list_y() { return guide_list_y_; }
 260         const GuideList& get_guide_list_x()const { return guide_list_x_; }
 261         const GuideList& get_guide_list_y()const { return guide_list_y_; }
 262
 263         void set_guide_snap(bool x=true);
 264         bool get_guide_snap()const { return guide_snap; }
 265         void toggle_guide_snap() { set_guide_snap(!get_guide_snap()); }
 266
 267         //! Sets the state of the grid snap flag
 268         void set_grid_snap(bool x=true);
 269
 270         //! Gets the state of the grid snap flag
 271         bool get_grid_snap()const { return grid_snap; }
 272
 273         void enable_grid_snap() { set_grid_snap(true); }
 274
 275         void disable_grid_snap() { set_grid_snap(false); }
 276
 277         void toggle_grid_snap() { set_grid_snap(!grid_snap); }
 278
 279         synfig::Point snap_point_to_grid(const synfig::Point& x, float radius=0.1)const;
 280
 281         bool get_show_persistent_strokes()const { return show_persistent_strokes; }
 282         void set_show_persistent_strokes(bool x);
 283
 284         //! Sets the size of the grid
 285         void set_grid_size(const synfig::Vector &s);
 286
 287         //! Returns the size of the grid
 288         const synfig::Vector &get_grid_size()const { return grid_size; }
 289
 290
 291         const synfig::Time &get_time()const { return cur_time; }
 292
 293         bool get_axis_lock()const { return axis_lock; }
 294         void set_axis_lock(bool x) { axis_lock=x; }
 295
 296         void set_time(synfig::Time x) { cur_time=x; }
 297
 298         bool is_duck_group_selectable(const etl::handle<Duck>& x)const;
 299
 300         //const DuckMap& duck_map()const { return duck_map; }
 301         DuckList get_duck_list()const;
 302
 303         const std::list<etl::handle<Bezier> >& bezier_list()const { return bezier_list_; }
 304
 305         const std::list<etl::handle<Stroke> >& stroke_list()const { return stroke_list_; }
 306
 307         const std::list<etl::handle<Stroke> >& persistent_stroke_list()const { return persistent_stroke_list_; }
 308
 309         std::list<etl::handle<Stroke> >& persistent_stroke_list() { return persistent_stroke_list_; }
 310
 311         //! \todo We should modify this to support multiple selections
 312         etl::handle<Duck> get_selected_duck()const;
 313
 314         DuckList get_selected_ducks()const;
 315
 316         //! Returns \a true if the given duck is currently selected
 317         bool duck_is_selected(const etl::handle<Duck> &duck)const;
 318
 319
 320         void refresh_selected_ducks();
 321
 322         void clear_selected_ducks();
 323
 324         int count_selected_ducks()const;
 325
 326         void toggle_select_duck(const etl::handle<Duck> &duck);
 327
 328         void select_duck(const etl::handle<Duck> &duck);
 329
 330         void toggle_select_ducks_in_box(const synfig::Vector& tl,const synfig::Vector& br);
 331
 332         void select_ducks_in_box(const synfig::Vector& tl,const synfig::Vector& br);
 333
 334         void unselect_duck(const etl::handle<Duck> &duck);
 335
 336         void start_duck_drag(const synfig::Vector& offset);
 337         void translate_selected_ducks(const synfig::Vector& vector);
 338         bool end_duck_drag();
 339
 340         void signal_edited_selected_ducks();
 341
 342         void signal_user_click_selected_ducks(int button);
 343
 344
 345         etl::handle<Duck> find_similar_duck(etl::handle<Duck> duck);
 346         etl::handle<Duck> add_similar_duck(etl::handle<Duck> duck);
 347
 348         void add_stroke(etl::smart_ptr<std::list<synfig::Point> > stroke_point_list, const synfig::Color& color=synfig::Color(0,0,0));
 349
 350         void add_persistent_stroke(etl::smart_ptr<std::list<synfig::Point> > stroke_point_list, const synfig::Color& color=synfig::Color(0,0,0));
 351
 352         void clear_persistent_strokes();
 353
 354         void add_duck(const etl::handle<Duck> &duck);
 355
 356         void add_bezier(const etl::handle<Bezier> &bezier);
 357
 358         void erase_duck(const etl::handle<Duck> &duck);
 359
 360         void erase_bezier(const etl::handle<Bezier> &bezier);
 361
 362         //! Returns the last duck added
 363         etl::handle<Duck> last_duck()const;
 364
 365         etl::handle<Bezier> last_bezier()const;
 366
 367         //! \note parameter is in canvas coordinates
 368         /*!     A radius of "zero" will have an unlimited radius */
 369         etl::handle<Duck> find_duck(synfig::Point pos, synfig::Real radius=0, Duck::Type type=Duck::TYPE_DEFAULT);
 370
 371         GuideList::iterator find_guide_x(synfig::Point pos, float radius=0.1);
 372         GuideList::iterator find_guide_y(synfig::Point pos, float radius=0.1);
 373         GuideList::const_iterator find_guide_x(synfig::Point pos, float radius=0.1)const { return const_cast<Duckmatic*>(this)->find_guide_x(pos,radius); }
 374         GuideList::const_iterator find_guide_y(synfig::Point pos, float radius=0.1)const { return const_cast<Duckmatic*>(this)->find_guide_y(pos,radius); }
 375
 376         //! \note parameter is in canvas coordinates
 377         /*!     A radius of "zero" will have an unlimited radius */
 378         //etl::handle<Bezier> find_bezier(synfig::Point pos, synfig::Real radius=0);
 379
 380         //! \note parameter is in canvas coordinates
 381         /*!     A radius of "zero" will have an unlimited radius */
 382         etl::handle<Bezier> find_bezier(synfig::Point pos, synfig::Real radius=0, float* location=0);
 383
 384         etl::handle<Bezier> find_bezier(synfig::Point pos, synfig::Real scale, synfig::Real radius, float* location=0);
 385
 386         bool add_to_ducks(const synfigapp::ValueDesc& value_desc,etl::handle<CanvasView> canvas_view, const synfig::TransformStack& transform_stack_, synfig::ParamDesc *param_desc=0, int multiple=0);
 387
 388         //! \writeme
 389         void set_type_mask(Type x) { type_mask=x; }
 390
 391         //! \writeme
 392         Type get_type_mask()const { return type_mask; }
 393
 394         void select_all_ducks();
 395
 396         void clear_ducks();
 397
 398         bool save_sketch(const synfig::String& filename)const;
 399         bool load_sketch(const synfig::String& filename);
 400         const synfig::String& get_sketch_filename()const { return sketch_filename_; }
 401
 402         void set_duck_dragger(etl::handle<DuckDrag_Base> x) { duck_dragger_=x; }
 403         etl::handle<DuckDrag_Base> get_duck_dragger()const { return duck_dragger_; }
 404         void clear_duck_dragger() { duck_dragger_=new DuckDrag_Translate(); }
 405 }; // END of class Duckmatic
 406
 407
 408 /*! \class Duckmatic::Push
 409 **      \writeme */
 410 class Duckmatic::Push
 411 {
 412         Duckmatic *duckmatic_;
 413         DuckMap duck_map;
 414         std::list<etl::handle<Bezier> > bezier_list_;
 415         std::list<etl::handle<Stroke> > stroke_list_;
 416         DuckDataMap duck_data_share_map;
 417         etl::handle<DuckDrag_Base> duck_dragger_;
 418
 419         bool needs_restore;
 420
 421 public:
 422         Push(Duckmatic *duckmatic_);
 423         ~Push();
 424         void restore();
 425 }; // END of class Duckmatic::Push
 426
 427 /*! \struct Duckmatic::Bezier
 428 **      \writeme */
 429 struct Duckmatic::Bezier : public etl::shared_object
 430 {
 431 private:
 432         sigc::signal<void,float> signal_user_click_[5];
 433 public:
 434
 435         etl::handle<Duck> p1,p2,c1,c2;
 436         bool is_valid()const { return p1 && p2 && c1 && c2; }
 437
 438         sigc::signal<void,float> &signal_user_click(int i=0) { assert(i>=0); assert(i<5); return signal_user_click_[i]; }
 439 }; // END of struct Duckmatic::Bezier
 440
 441 /*! \struct Duckmatic::Stroke
 442 **      \writeme */
 443 struct Duckmatic::Stroke : public etl::shared_object
 444 {
 445 private:
 446         sigc::signal<void,float> signal_user_click_[5];
 447 public:
 448
 449         etl::smart_ptr<std::list<synfig::Point> > stroke_data;
 450
 451         synfig::Color color;
 452
 453         bool is_valid()const { return (bool)stroke_data; }
 454
 455         sigc::signal<void,float> &signal_user_click(int i=0) { assert(i>=0); assert(i<5); return signal_user_click_[i]; }
 456 }; // END of struct Duckmatic::Stroke
 457
 458 }; // END of namespace studio
 459
 460 /* === E N D =============================================================== */
 461
 462 #endif