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 #ifndef __STRING_HASH__
  56 #define __STRING_HASH__
  57 class StringHash
  58 {
  59         HASH_MAP_NAMESPACE::hash<const char*> hasher_;
  60 public:
  61         size_t operator()(const synfig::String& x)const
  62         {
  63                 return hasher_(x.c_str());
  64         }
  65 };
  66 #endif
  67 #else
  68 #include <map>
  69 #endif
  70
  71 /* === T Y P E D E F S ===================================================== */
  72
  73 /* === C L A S S E S & S T R U C T S ======================================= */
  74
  75 namespace synfigapp { class ValueDesc; }
  76 namespace synfig { class ParamDesc; }
  77
  78 namespace studio
  79 {
  80
  81 class CanvasView;
  82 class Duckmatic;
  83
  84 class DuckDrag_Base : public etl::shared_object
  85 {
  86 public:
  87         virtual void begin_duck_drag(Duckmatic* duckmatic, const synfig::Vector& begin)=0;
  88         virtual bool end_duck_drag(Duckmatic* duckmatic)=0;
  89         virtual void duck_drag(Duckmatic* duckmatic, const synfig::Vector& vector)=0;
  90 };
  91
  92 class DuckDrag_Translate : public DuckDrag_Base
  93 {
  94         synfig::Vector last_translate_;
  95         synfig::Vector drag_offset_;
  96         synfig::Vector snap;
  97         std::vector<synfig::Vector> positions;
  98
  99 public:
 100         void begin_duck_drag(Duckmatic* duckmatic, const synfig::Vector& begin);
 101         bool end_duck_drag(Duckmatic* duckmatic);
 102         void duck_drag(Duckmatic* duckmatic, const synfig::Vector& vector);
 103 };
 104
 105 /*! \class Duckmatic
 106 **
 107 **      This class helps organize any of the devices displayed in
 108 **      the work area that the user may want to interact with.
 109 **      This includes ducks, beziers, and strokes
 110 **
 111 **      \note At some point I'll probably rename this class to "DuckOMatic".
 112 */
 113 class Duckmatic
 114 {
 115         friend class DuckDrag_Base;
 116         friend class DuckDrag_Translate;
 117
 118         /*
 119  -- ** -- P U B L I C   T Y P E S ---------------------------------------------
 120         */
 121
 122 public:
 123
 124 #ifdef HASH_MAP_H
 125 typedef HASH_MAP_CLASS<synfig::GUID,etl::smart_ptr<synfig::Point>,synfig::GUIDHash> DuckDataMap;
 126 #else
 127 typedef std::map<synfig::GUID,etl::smart_ptr<synfig::Point> > DuckDataMap;
 128 #endif
 129
 130         typedef studio::DuckMap DuckMap;
 131
 132         typedef studio::Duck Duck;
 133
 134         struct Stroke;
 135
 136         struct Bezier;
 137
 138         class Push;
 139
 140         friend class Push;
 141
 142         typedef Duck::Type Type;
 143
 144         typedef std::list<float> GuideList;
 145
 146         /*
 147  -- ** -- P R I V A T E   D A T A ---------------------------------------------
 148         */
 149
 150 private:
 151
 152         Type type_mask;
 153
 154         DuckMap duck_map;
 155
 156         DuckDataMap duck_data_share_map;
 157
 158         std::list<etl::handle<Stroke> > stroke_list_;
 159
 160         std::list<etl::handle<Stroke> > persistent_stroke_list_;
 161
 162         synfig::GUIDSet selected_ducks;
 163
 164         synfig::GUID last_duck_guid;
 165
 166         std::list<etl::handle<Bezier> > bezier_list_;
 167
 168         //! I cannot recall what this is for
 169         //synfig::Vector snap;
 170
 171         etl::handle<DuckDrag_Base> duck_dragger_;
 172
 173         sigc::signal<void> signal_duck_selection_changed_;
 174
 175         sigc::signal<void> signal_strokes_changed_;
 176
 177         sigc::signal<void> signal_grid_changed_;
 178
 179         mutable sigc::signal<void> signal_sketch_saved_;
 180
 181         GuideList guide_list_x_;
 182         GuideList guide_list_y_;
 183
 184         mutable synfig::String sketch_filename_;
 185
 186         /*
 187  -- ** -- P R O T E C T E D   D A T A -----------------------------------------
 188         */
 189
 190 protected:
 191
 192         etl::handle<Bezier> selected_bezier;
 193
 194         synfig::Time cur_time;
 195
 196         //! This flag is set if operations should snap to the grid
 197         /*! \todo perhaps there should be two of these flags, one for each axis?
 198         **      \see show_grid, grid_size */
 199         bool grid_snap;
 200
 201         bool guide_snap;
 202
 203         //! This vector describes the grid size.
 204         /*! \see grid_snap, show_grid */
 205         synfig::Vector grid_size;
 206
 207         bool show_persistent_strokes;
 208
 209         bool axis_lock;
 210
 211         /*
 212  -- ** -- P R I V A T E   M E T H O D S ---------------------------------------
 213         */
 214
 215 private:
 216
 217         synfig::Vector last_translate_;
 218         synfig::Vector drag_offset_;
 219
 220         //etl::handle<Duck> selected_duck;
 221
 222
 223         /*
 224  -- ** -- P U B L I C   M E T H O D S -----------------------------------------
 225         */
 226
 227 public:
 228
 229         Duckmatic();
 230         virtual ~Duckmatic();
 231
 232         sigc::signal<void>& signal_duck_selection_changed() { return signal_duck_selection_changed_; }
 233         sigc::signal<void>& signal_strokes_changed() { return signal_strokes_changed_; }
 234         sigc::signal<void>& signal_grid_changed() { return signal_grid_changed_; }
 235         sigc::signal<void>& signal_sketch_saved() { return signal_sketch_saved_; }
 236
 237         GuideList& get_guide_list_x() { return guide_list_x_; }
 238         GuideList& get_guide_list_y() { return guide_list_y_; }
 239         const GuideList& get_guide_list_x()const { return guide_list_x_; }
 240         const GuideList& get_guide_list_y()const { return guide_list_y_; }
 241
 242         void set_guide_snap(bool x=true);
 243         bool get_guide_snap()const { return guide_snap; }
 244         void toggle_guide_snap() { set_guide_snap(!get_guide_snap()); }
 245
 246         //! Sets the state of the grid snap flag
 247         void set_grid_snap(bool x=true);
 248
 249         //! Gets the state of the grid snap flag
 250         bool get_grid_snap()const { return grid_snap; }
 251
 252         void enable_grid_snap() { set_grid_snap(true); }
 253
 254         void disable_grid_snap() { set_grid_snap(false); }
 255
 256         void toggle_grid_snap() { set_grid_snap(!grid_snap); }
 257
 258         synfig::Point snap_point_to_grid(const synfig::Point& x, float radius=0.1)const;
 259
 260         bool get_show_persistent_strokes()const { return show_persistent_strokes; }
 261         void set_show_persistent_strokes(bool x);
 262
 263         //! Sets the size of the grid
 264         void set_grid_size(const synfig::Vector &s);
 265
 266         //! Returns the size of the grid
 267         const synfig::Vector &get_grid_size()const { return grid_size; }
 268
 269
 270         const synfig::Time &get_time()const { return cur_time; }
 271
 272         bool get_axis_lock()const { return axis_lock; }
 273         void set_axis_lock(bool x) { axis_lock=x; }
 274
 275         void set_time(synfig::Time x) { cur_time=x; }
 276
 277         bool is_duck_group_selectable(const etl::handle<Duck>& x)const;
 278
 279         //const DuckMap& duck_map()const { return duck_map; }
 280         DuckList get_duck_list()const;
 281
 282         const std::list<etl::handle<Bezier> >& bezier_list()const { return bezier_list_; }
 283
 284         const std::list<etl::handle<Stroke> >& stroke_list()const { return stroke_list_; }
 285
 286         const std::list<etl::handle<Stroke> >& persistent_stroke_list()const { return persistent_stroke_list_; }
 287
 288         std::list<etl::handle<Stroke> >& persistent_stroke_list() { return persistent_stroke_list_; }
 289
 290         //! \todo We should modify this to support multiple selections
 291         etl::handle<Duck> get_selected_duck()const;
 292
 293         DuckList get_selected_ducks()const;
 294
 295         //! Returns \a true if the given duck is currently selected
 296         bool duck_is_selected(const etl::handle<Duck> &duck)const;
 297
 298
 299         void refresh_selected_ducks();
 300
 301         void clear_selected_ducks();
 302
 303         int count_selected_ducks()const;
 304
 305         void toggle_select_duck(const etl::handle<Duck> &duck);
 306
 307         void select_duck(const etl::handle<Duck> &duck);
 308
 309         void toggle_select_ducks_in_box(const synfig::Vector& tl,const synfig::Vector& br);
 310
 311         void select_ducks_in_box(const synfig::Vector& tl,const synfig::Vector& br);
 312
 313         void unselect_duck(const etl::handle<Duck> &duck);
 314
 315         void start_duck_drag(const synfig::Vector& offset);
 316         void translate_selected_ducks(const synfig::Vector& vector);
 317         bool end_duck_drag();
 318
 319         void signal_edited_selected_ducks();
 320
 321         void signal_user_click_selected_ducks(int button);
 322
 323
 324         etl::handle<Duck> find_similar_duck(etl::handle<Duck> duck);
 325         etl::handle<Duck> add_similar_duck(etl::handle<Duck> duck);
 326
 327         void add_stroke(etl::smart_ptr<std::list<synfig::Point> > stroke_point_list, const synfig::Color& color=synfig::Color(0,0,0));
 328
 329         void add_persistent_stroke(etl::smart_ptr<std::list<synfig::Point> > stroke_point_list, const synfig::Color& color=synfig::Color(0,0,0));
 330
 331         void clear_persistent_strokes();
 332
 333         void add_duck(const etl::handle<Duck> &duck);
 334
 335         void add_bezier(const etl::handle<Bezier> &bezier);
 336
 337         void erase_duck(const etl::handle<Duck> &duck);
 338
 339         void erase_bezier(const etl::handle<Bezier> &bezier);
 340
 341         //! Returns the last duck added
 342         etl::handle<Duck> last_duck()const;
 343
 344         etl::handle<Bezier> last_bezier()const;
 345
 346         //! \note parameter is in canvas coordinates
 347         /*!     A radius of "zero" will have an unlimited radius */
 348         etl::handle<Duck> find_duck(synfig::Point pos, synfig::Real radius=0, Duck::Type type=Duck::TYPE_DEFAULT);
 349
 350         GuideList::iterator find_guide_x(synfig::Point pos, float radius=0.1);
 351         GuideList::iterator find_guide_y(synfig::Point pos, float radius=0.1);
 352         GuideList::const_iterator find_guide_x(synfig::Point pos, float radius=0.1)const { return const_cast<Duckmatic*>(this)->find_guide_x(pos,radius); }
 353         GuideList::const_iterator find_guide_y(synfig::Point pos, float radius=0.1)const { return const_cast<Duckmatic*>(this)->find_guide_y(pos,radius); }
 354
 355         //! \note parameter is in canvas coordinates
 356         /*!     A radius of "zero" will have an unlimited radius */
 357         //etl::handle<Bezier> find_bezier(synfig::Point pos, synfig::Real radius=0);
 358
 359         //! \note parameter is in canvas coordinates
 360         /*!     A radius of "zero" will have an unlimited radius */
 361         etl::handle<Bezier> find_bezier(synfig::Point pos, synfig::Real radius=0, float* location=0);
 362
 363         etl::handle<Bezier> find_bezier(synfig::Point pos, synfig::Real scale, synfig::Real radius, float* location=0);
 364
 365         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);
 366
 367         //! \writeme
 368         void set_type_mask(Type x) { type_mask=x; }
 369
 370         //! \writeme
 371         Type get_type_mask()const { return type_mask; }
 372
 373         void select_all_ducks();
 374
 375         void clear_ducks();
 376
 377         bool save_sketch(const synfig::String& filename)const;
 378         bool load_sketch(const synfig::String& filename);
 379         const synfig::String& get_sketch_filename()const { return sketch_filename_; }
 380
 381         void set_duck_dragger(etl::handle<DuckDrag_Base> x) { duck_dragger_=x; }
 382         etl::handle<DuckDrag_Base> get_duck_dragger()const { return duck_dragger_; }
 383         void clear_duck_dragger() { duck_dragger_=new DuckDrag_Translate(); }
 384 }; // END of class Duckmatic
 385
 386
 387 /*! \class Duckmatic::Push
 388 **      \writeme */
 389 class Duckmatic::Push
 390 {
 391         Duckmatic *duckmatic_;
 392         DuckMap duck_map;
 393         std::list<etl::handle<Bezier> > bezier_list_;
 394         std::list<etl::handle<Stroke> > stroke_list_;
 395         DuckDataMap duck_data_share_map;
 396         etl::handle<DuckDrag_Base> duck_dragger_;
 397
 398         bool needs_restore;
 399
 400 public:
 401         Push(Duckmatic *duckmatic_);
 402         ~Push();
 403         void restore();
 404 }; // END of class Duckmatic::Push
 405
 406 /*! \struct Duckmatic::Bezier
 407 **      \writeme */
 408 struct Duckmatic::Bezier : public etl::shared_object
 409 {
 410 private:
 411         sigc::signal<void,float> signal_user_click_[5];
 412 public:
 413
 414         etl::handle<Duck> p1,p2,c1,c2;
 415         bool is_valid()const { return p1 && p2 && c1 && c2; }
 416
 417         sigc::signal<void,float> &signal_user_click(int i=0) { assert(i>=0); assert(i<5); return signal_user_click_[i]; }
 418 }; // END of struct Duckmatic::Bezier
 419
 420 /*! \struct Duckmatic::Stroke
 421 **      \writeme */
 422 struct Duckmatic::Stroke : public etl::shared_object
 423 {
 424 private:
 425         sigc::signal<void,float> signal_user_click_[5];
 426 public:
 427
 428         etl::smart_ptr<std::list<synfig::Point> > stroke_data;
 429
 430         synfig::Color color;
 431
 432         bool is_valid()const { return (bool)stroke_data; }
 433
 434         sigc::signal<void,float> &signal_user_click(int i=0) { assert(i>=0); assert(i<5); return signal_user_click_[i]; }
 435 }; // END of struct Duckmatic::Stroke
 436
 437 }; // END of namespace studio
 438
 439 /* === E N D =============================================================== */
 440
 441 #endif