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