1 /* === S Y N F I G ========================================================= */
3 ** \brief Template Header
8 ** Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
9 ** Copyright (c) 2007 Chris Moore
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.
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.
22 /* ========================================================================= */
24 /* === S T A R T =========================================================== */
26 #ifndef __SYNFIG_STUDIO_DUCKMATIC_H
27 #define __SYNFIG_STUDIO_DUCKMATIC_H
29 /* === H E A D E R S ======================================================= */
35 #include <ETL/smart_ptr>
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>
48 #include <synfig/color.h>
49 #include <synfig/guidset.h>
51 /* === M A C R O S ========================================================= */
57 #ifndef __STRING_HASH__
58 #define __STRING_HASH__
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
67 size_t operator()(const synfig::String& x)const
69 # ifdef FUNCTIONAL_HASH_ON_STRING
71 # else // FUNCTIONAL_HASH_ON_STRING
72 return hasher_(x.c_str());
73 # endif // FUNCTIONAL_HASH_ON_STRING
81 #define RESTRICT_RADIUS_DUCKS_TO_ONE_QUARTER
83 /* === T Y P E D E F S ===================================================== */
85 /* === C L A S S E S & S T R U C T S ======================================= */
87 namespace synfigapp { class ValueDesc; }
88 namespace synfig { class ParamDesc; }
96 class DuckDrag_Base : public etl::shared_object
99 virtual void begin_duck_drag(Duckmatic* duckmatic, const synfig::Vector& begin)=0;
100 virtual bool end_duck_drag(Duckmatic* duckmatic)=0;
101 virtual void duck_drag(Duckmatic* duckmatic, const synfig::Vector& vector)=0;
104 class DuckDrag_Translate : public DuckDrag_Base
106 synfig::Vector last_translate_;
107 synfig::Vector drag_offset_;
109 std::vector<synfig::Vector> positions;
112 void begin_duck_drag(Duckmatic* duckmatic, const synfig::Vector& begin);
113 bool end_duck_drag(Duckmatic* duckmatic);
114 void duck_drag(Duckmatic* duckmatic, const synfig::Vector& vector);
119 ** This class helps organize any of the devices displayed in
120 ** the work area that the user may want to interact with.
121 ** This includes ducks, beziers, and strokes
123 ** \note At some point I'll probably rename this class to "DuckOMatic".
127 friend class DuckDrag_Base;
128 friend class DuckDrag_Translate;
131 -- ** -- P U B L I C T Y P E S ---------------------------------------------
137 typedef HASH_MAP_CLASS<synfig::GUID,etl::smart_ptr<synfig::Point>,synfig::GUIDHash> DuckDataMap;
139 typedef std::map<synfig::GUID,etl::smart_ptr<synfig::Point> > DuckDataMap;
142 typedef studio::DuckMap DuckMap;
144 typedef studio::Duck Duck;
154 typedef Duck::Type Type;
156 typedef std::list<float> GuideList;
159 -- ** -- P R I V A T E D A T A ---------------------------------------------
168 DuckDataMap duck_data_share_map;
170 std::list<etl::handle<Stroke> > stroke_list_;
172 std::list<etl::handle<Stroke> > persistent_stroke_list_;
174 synfig::GUIDSet selected_ducks;
176 synfig::GUID last_duck_guid;
178 std::list<etl::handle<Bezier> > bezier_list_;
180 //! I cannot recall what this is for
181 //synfig::Vector snap;
183 etl::handle<DuckDrag_Base> duck_dragger_;
185 sigc::signal<void> signal_duck_selection_changed_;
187 sigc::signal<void> signal_strokes_changed_;
189 sigc::signal<void> signal_grid_changed_;
191 mutable sigc::signal<void> signal_sketch_saved_;
193 GuideList guide_list_x_;
194 GuideList guide_list_y_;
196 mutable synfig::String sketch_filename_;
198 //! whether the display is flipped vertically or horizontally
199 bool flip_x_, flip_y_;
202 -- ** -- P R O T E C T E D D A T A -----------------------------------------
207 etl::handle<Bezier> selected_bezier;
209 synfig::Time cur_time;
211 //! This flag is set if operations should snap to the grid
212 /*! \todo perhaps there should be two of these flags, one for each axis?
213 ** \see show_grid, grid_size */
218 //! This vector describes the grid size.
219 /*! \see grid_snap, show_grid */
220 synfig::Vector grid_size;
222 bool show_persistent_strokes;
227 -- ** -- P R I V A T E M E T H O D S ---------------------------------------
232 synfig::Vector last_translate_;
233 synfig::Vector drag_offset_;
235 //etl::handle<Duck> selected_duck;
239 -- ** -- P U B L I C M E T H O D S -----------------------------------------
245 virtual ~Duckmatic();
247 void set_flip_x(bool flip_x);
248 void set_flip_y(bool flip_y);
250 sigc::signal<void>& signal_duck_selection_changed() { return signal_duck_selection_changed_; }
251 sigc::signal<void>& signal_strokes_changed() { return signal_strokes_changed_; }
252 sigc::signal<void>& signal_grid_changed() { return signal_grid_changed_; }
253 sigc::signal<void>& signal_sketch_saved() { return signal_sketch_saved_; }
255 GuideList& get_guide_list_x() { return guide_list_x_; }
256 GuideList& get_guide_list_y() { return guide_list_y_; }
257 const GuideList& get_guide_list_x()const { return guide_list_x_; }
258 const GuideList& get_guide_list_y()const { return guide_list_y_; }
260 void set_guide_snap(bool x=true);
261 bool get_guide_snap()const { return guide_snap; }
262 void toggle_guide_snap() { set_guide_snap(!get_guide_snap()); }
264 //! Sets the state of the grid snap flag
265 void set_grid_snap(bool x=true);
267 //! Gets the state of the grid snap flag
268 bool get_grid_snap()const { return grid_snap; }
270 void enable_grid_snap() { set_grid_snap(true); }
272 void disable_grid_snap() { set_grid_snap(false); }
274 void toggle_grid_snap() { set_grid_snap(!grid_snap); }
276 synfig::Point snap_point_to_grid(const synfig::Point& x, float radius=0.1)const;
278 bool get_show_persistent_strokes()const { return show_persistent_strokes; }
279 void set_show_persistent_strokes(bool x);
281 //! Sets the size of the grid
282 void set_grid_size(const synfig::Vector &s);
284 //! Returns the size of the grid
285 const synfig::Vector &get_grid_size()const { return grid_size; }
288 const synfig::Time &get_time()const { return cur_time; }
290 bool get_axis_lock()const { return axis_lock; }
291 void set_axis_lock(bool x) { axis_lock=x; }
293 void set_time(synfig::Time x) { cur_time=x; }
295 bool is_duck_group_selectable(const etl::handle<Duck>& x)const;
297 //const DuckMap& duck_map()const { return duck_map; }
298 DuckList get_duck_list()const;
300 const std::list<etl::handle<Bezier> >& bezier_list()const { return bezier_list_; }
302 const std::list<etl::handle<Stroke> >& stroke_list()const { return stroke_list_; }
304 const std::list<etl::handle<Stroke> >& persistent_stroke_list()const { return persistent_stroke_list_; }
306 std::list<etl::handle<Stroke> >& persistent_stroke_list() { return persistent_stroke_list_; }
308 //! \todo We should modify this to support multiple selections
309 etl::handle<Duck> get_selected_duck()const;
311 DuckList get_selected_ducks()const;
313 //! Returns \a true if the given duck is currently selected
314 bool duck_is_selected(const etl::handle<Duck> &duck)const;
317 void refresh_selected_ducks();
319 void clear_selected_ducks();
321 int count_selected_ducks()const;
323 void toggle_select_duck(const etl::handle<Duck> &duck);
325 void select_duck(const etl::handle<Duck> &duck);
327 void toggle_select_ducks_in_box(const synfig::Vector& tl,const synfig::Vector& br);
329 void select_ducks_in_box(const synfig::Vector& tl,const synfig::Vector& br);
331 void unselect_duck(const etl::handle<Duck> &duck);
333 void start_duck_drag(const synfig::Vector& offset);
334 void translate_selected_ducks(const synfig::Vector& vector);
335 bool end_duck_drag();
337 void signal_edited_selected_ducks();
339 void signal_user_click_selected_ducks(int button);
342 etl::handle<Duck> find_similar_duck(etl::handle<Duck> duck);
343 etl::handle<Duck> add_similar_duck(etl::handle<Duck> duck);
345 void add_stroke(etl::smart_ptr<std::list<synfig::Point> > stroke_point_list, const synfig::Color& color=synfig::Color(0,0,0));
347 void add_persistent_stroke(etl::smart_ptr<std::list<synfig::Point> > stroke_point_list, const synfig::Color& color=synfig::Color(0,0,0));
349 void clear_persistent_strokes();
351 void add_duck(const etl::handle<Duck> &duck);
353 void add_bezier(const etl::handle<Bezier> &bezier);
355 void erase_duck(const etl::handle<Duck> &duck);
357 void erase_bezier(const etl::handle<Bezier> &bezier);
359 //! Returns the last duck added
360 etl::handle<Duck> last_duck()const;
362 etl::handle<Bezier> last_bezier()const;
364 //! \note parameter is in canvas coordinates
365 /*! A radius of "zero" will have an unlimited radius */
366 etl::handle<Duck> find_duck(synfig::Point pos, synfig::Real radius=0, Duck::Type type=Duck::TYPE_DEFAULT);
368 GuideList::iterator find_guide_x(synfig::Point pos, float radius=0.1);
369 GuideList::iterator find_guide_y(synfig::Point pos, float radius=0.1);
370 GuideList::const_iterator find_guide_x(synfig::Point pos, float radius=0.1)const { return const_cast<Duckmatic*>(this)->find_guide_x(pos,radius); }
371 GuideList::const_iterator find_guide_y(synfig::Point pos, float radius=0.1)const { return const_cast<Duckmatic*>(this)->find_guide_y(pos,radius); }
373 //! \note parameter is in canvas coordinates
374 /*! A radius of "zero" will have an unlimited radius */
375 //etl::handle<Bezier> find_bezier(synfig::Point pos, synfig::Real radius=0);
377 //! \note parameter is in canvas coordinates
378 /*! A radius of "zero" will have an unlimited radius */
379 etl::handle<Bezier> find_bezier(synfig::Point pos, synfig::Real radius=0, float* location=0);
381 etl::handle<Bezier> find_bezier(synfig::Point pos, synfig::Real scale, synfig::Real radius, float* location=0);
383 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);
386 void set_type_mask(Type x) { type_mask=x; }
389 Type get_type_mask()const { return type_mask; }
391 void select_all_ducks();
395 bool save_sketch(const synfig::String& filename)const;
396 bool load_sketch(const synfig::String& filename);
397 const synfig::String& get_sketch_filename()const { return sketch_filename_; }
399 void set_duck_dragger(etl::handle<DuckDrag_Base> x) { duck_dragger_=x; }
400 etl::handle<DuckDrag_Base> get_duck_dragger()const { return duck_dragger_; }
401 void clear_duck_dragger() { duck_dragger_=new DuckDrag_Translate(); }
402 }; // END of class Duckmatic
405 /*! \class Duckmatic::Push
407 class Duckmatic::Push
409 Duckmatic *duckmatic_;
411 std::list<etl::handle<Bezier> > bezier_list_;
412 std::list<etl::handle<Stroke> > stroke_list_;
413 DuckDataMap duck_data_share_map;
414 etl::handle<DuckDrag_Base> duck_dragger_;
419 Push(Duckmatic *duckmatic_);
422 }; // END of class Duckmatic::Push
424 /*! \struct Duckmatic::Bezier
426 struct Duckmatic::Bezier : public etl::shared_object
429 sigc::signal<void,float> signal_user_click_[5];
432 etl::handle<Duck> p1,p2,c1,c2;
433 bool is_valid()const { return p1 && p2 && c1 && c2; }
435 sigc::signal<void,float> &signal_user_click(int i=0) { assert(i>=0); assert(i<5); return signal_user_click_[i]; }
436 }; // END of struct Duckmatic::Bezier
438 /*! \struct Duckmatic::Stroke
440 struct Duckmatic::Stroke : public etl::shared_object
443 sigc::signal<void,float> signal_user_click_[5];
446 etl::smart_ptr<std::list<synfig::Point> > stroke_data;
450 bool is_valid()const { return (bool)stroke_data; }
452 sigc::signal<void,float> &signal_user_click(int i=0) { assert(i>=0); assert(i<5); return signal_user_click_[i]; }
453 }; // END of struct Duckmatic::Stroke
455 }; // END of namespace studio
457 /* === E N D =============================================================== */