Now that it doesn't matter which half of a waypoint you click on, we don't need to...
[synfig.git] / synfig-studio / trunk / src / gtkmm / canvasview.h
1 /* === S Y N F I G ========================================================= */
2 /*!     \file canvasview.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_GTKMM_CANVASVIEW_H
27 #define __SYNFIG_STUDIO_GTKMM_CANVASVIEW_H
28
29 /* === H E A D E R S ======================================================= */
30
31 #include <gtkmm/window.h>
32 #include <gtkmm/image.h>
33 #include <gtkmm/tooltips.h>
34 #include <gtkmm/table.h>
35 #include <gtkmm/statusbar.h>
36 #include <gtkmm/progressbar.h>
37 #include <gtkmm/button.h>
38 #include <gtkmm/menu.h>
39 #include <gtkmm/treeview.h>
40 #include <gtkmm/treestore.h>
41 #include <gtkmm/scrolledwindow.h>
42 #include <gtkmm/notebook.h>
43 #include <gdkmm/device.h>
44
45 #include <synfigapp/canvasinterface.h>
46 #include <synfigapp/selectionmanager.h>
47
48 #include <synfig/canvas.h>
49 #include <synfig/string.h>
50 #include <synfig/time.h>
51
52 #include "instance.h"
53 #include "canvasproperties.h"
54 #include "canvasoptions.h"
55 #include "render.h"
56 #include "cellrenderer_timetrack.h"
57 #include "app.h"
58
59 #include "layertreestore.h"
60 #include "layertree.h"
61 #include "childrentreestore.h"
62 #include "childrentree.h"
63 #include "keyframetreestore.h"
64 #include "keyframetree.h"
65
66 #include "dialog_waypoint.h"
67 #include "dialog_keyframe.h"
68
69 #include "duckmatic.h"
70 #include <gtkmm/scale.h>
71
72 #include <gtkmm/uimanager.h>
73
74 #include "smach.h"
75
76 #include <memory>
77 #include <set>
78 #include <map>
79 #include <gtkmm/toggleaction.h>
80 #include <gtkmm/radioaction.h>
81 #include <synfig/rect.h>
82
83 #include "adjust_window.h"
84
85 #include <synfig/transform.h>
86
87 /* === M A C R O S ========================================================= */
88
89 #ifndef DEBUGPOINT_CLASS
90 #if     _DEBUG
91 #define DEBUGPOINT_CLASS(x)             struct debugpointclass_ ## x { debugpointclass_ ## x () { DEBUGPOINT(); } ~debugpointclass_ ## x () { DEBUGPOINT(); } } badfthguae_ ## x ;
92 #else
93 #define DEBUGPOINT_CLASS(x)
94 #endif
95 #endif
96
97 /* === T Y P E D E F S ===================================================== */
98
99 /* === C L A S S E S & S T R U C T S ======================================= */
100
101 namespace synfig {
102         class TransformStack;
103 }
104
105 namespace studio {
106
107 class CanvasViewUIInterface;
108 class CanvasViewSelectionManager;
109
110 class CellRenderer_TimeTrack;
111 class CellRenderer_ValueBase;
112 class UniversalScrubber;
113 class WorkArea;
114
115 class Duckmatic;
116
117 class Preview;
118 struct PreviewInfo;
119 class AudioContainer;
120
121 class Widget_Sound;
122 class Widget_Timeslider;
123 class Widget_Time;
124
125 class Dialog_SoundSelect;
126 class Dialog_Preview;
127
128 class Dock_Layers;
129 class Dock_Children;
130 class Dock_Keyframes;
131
132 class CanvasView : public Gtk::Window, public etl::shared_object
133 {
134         friend class UniversalScrubber;
135         friend class Dock_Layers;
136         friend class Dock_Children;
137         friend class Dock_Keyframes;
138
139         friend class CanvasViewUIInterface;
140         friend class CanvasViewSelectionManager;
141
142         friend class Duckmatic;
143
144         /*
145  -- ** -- P U B L I C   T Y P E S ---------------------------------------------
146         */
147
148 public:
149
150         typedef etl::handle<CanvasView> Handle;
151
152         typedef etl::handle<const CanvasView> ConstHandle;
153
154         typedef etl::loose_handle<CanvasView> LooseHandle;
155
156         typedef LayerTreeStore::Model LayerTreeModel;
157
158         typedef ChildrenTreeStore::Model ChildrenTreeModel;
159
160         //! Create an instance of this class whenever doing a longer task.
161         /*! Make sure that you check the bool value of this class occasionally
162         **      to make sure the action has not been canceled. */
163         class IsWorking
164         {
165                 CanvasView &canvas_view_;
166
167         public:
168                 IsWorking(CanvasView &canvas_view_);
169                 ~IsWorking();
170                 operator bool()const;
171         };
172         friend class IsWorking;
173
174         typedef synfigapp::CanvasInterface::Mode Mode;
175
176         /*
177  -- ** -- P R I V A T E   D A T A ---------------------------------------------
178         */
179
180 public:
181         std::auto_ptr<WorkArea> work_area;
182
183         WorkArea* get_work_area() { return work_area.get(); }
184 private:
185
186         synfig::TransformStack curr_transform_stack;
187         bool curr_transform_stack_set;
188
189         synfig::Rect bbox;
190
191         // DEBUGPOINT_CLASS(1);
192
193         //! State Machine
194         Smach smach_;
195
196         // DEBUGPOINT_CLASS(2);
197
198         etl::loose_handle<Instance> instance_;
199         etl::handle<synfigapp::CanvasInterface> canvas_interface_;
200
201         // DEBUGPOINT_CLASS(3);
202
203         //! Sound and information to play it
204         etl::handle<AudioContainer>             audio;
205         studio::Widget_Sound                    *disp_audio; //should this be put into thing too?
206
207         sigc::connection                                playcon;
208         sigc::connection                                stopcon;
209
210         std::auto_ptr<UniversalScrubber> universal_scrubber;
211
212         //! Tooltip controller
213         Gtk::Tooltips tooltips;
214
215         // DEBUGPOINT_CLASS(4);
216
217         //! TreeModel for the layers
218         LayerTreeModel layer_tree_model;
219
220         //! TreeModel for the the children
221         ChildrenTreeModel children_tree_model;
222
223         //Glib::RefPtr<LayerTreeStore> layer_tree_store_;
224
225         //Glib::RefPtr<ChildrenTreeStore> children_tree_store_;
226
227         //Glib::RefPtr<KeyframeTreeStore> keyframe_tree_store_;
228
229         // DEBUGPOINT_CLASS(5);
230
231         //std::map<synfig::String,Glib::RefPtr<Gtk::TreeModel> > tree_model_book_;
232         std::map<synfig::String,Glib::RefPtr<Glib::ObjectBase> > ref_obj_book_;
233         std::map<synfig::String,Gtk::Widget*> ext_widget_book_;
234
235         //! The time adjustment's scope is defined by the time_window adjustment
236         Gtk::Adjustment time_adjustment_;
237
238         //! The time_window adjustment governs the position of the time window on the whole time line
239         //Gtk::Adjustment time_window_adjustment_;
240         studio::Adjust_Window time_window_adjustment_;
241
242         LayerTree *layer_tree;
243
244         ChildrenTree *children_tree;
245
246         KeyframeTree *keyframe_tree;
247
248         Gtk::Widget *keyframe_tab_child;
249
250         Gtk::ProgressBar *progressbar;
251         Gtk::Statusbar *statusbar;
252
253         Gtk::TreeRow children_canvas_row;
254         Gtk::TreeRow children_valuenode_row;
255
256         Gtk::Button *stopbutton;
257         Gtk::Button *refreshbutton;
258         Gtk::Button *treetogglebutton;
259         Gtk::Notebook *notebook;
260         Gtk::Widget *timebar;
261
262         Widget_Time *current_time_widget;
263         void on_current_time_widget_changed();
264
265         std::auto_ptr<Widget_Timeslider>                timeslider;
266
267         std::list<sigc::connection> duck_changed_connections;
268
269         Gtk::Button *animatebutton;
270         Gtk::Button *keyframebutton;
271
272 /*      DEBUGPOINT_CLASS(8);
273
274         Gtk::Menu duckmaskmenu;
275         DEBUGPOINT_CLASS(77);
276         Gtk::Menu qualitymenu;
277         DEBUGPOINT_CLASS(6);
278
279         Gtk::Menu filemenu;
280         DEBUGPOINT_CLASS(777);
281         Gtk::Menu editmenu;
282         DEBUGPOINT_CLASS(71);
283         Gtk::Menu canvasmenu;
284         DEBUGPOINT_CLASS(73);
285 public:
286         Gtk::Menu layermenu;
287 private:
288         DEBUGPOINT_CLASS(74);
289         Gtk::Menu newlayermenu;
290         DEBUGPOINT_CLASS(76);
291         Gtk::Menu viewmenu;
292
293         DEBUGPOINT_CLASS(99);
294         Gtk::Menu keyframemenu;
295
296         Gtk::Menu parammenu;
297         DEBUGPOINT_CLASS(9);
298         Gtk::Menu trackmenu;
299         DEBUGPOINT_CLASS(7);
300
301         Gtk::CheckMenuItem* duck_mask_position;
302         Gtk::CheckMenuItem* duck_mask_vertex;
303         Gtk::CheckMenuItem* duck_mask_tangent;
304         Gtk::CheckMenuItem* duck_mask_radius;
305         Gtk::CheckMenuItem* duck_mask_width;
306         Gtk::CheckMenuItem* duck_mask_angle;
307 */
308         Gtk::Menu parammenu;
309
310         Glib::RefPtr<Gtk::ToggleAction> duck_mask_position;
311         Glib::RefPtr<Gtk::ToggleAction> duck_mask_vertex;
312         Glib::RefPtr<Gtk::ToggleAction> duck_mask_tangent;
313         Glib::RefPtr<Gtk::ToggleAction> duck_mask_radius;
314         Glib::RefPtr<Gtk::ToggleAction> duck_mask_width;
315         Glib::RefPtr<Gtk::ToggleAction> duck_mask_angle;
316
317         Gtk::RadioButtonGroup quality_group;
318         Gtk::RadioButtonGroup low_res_pixel_size_group;
319
320         Glib::RefPtr<Gtk::ActionGroup> action_group;
321
322         etl::handle<synfigapp::UIInterface> ui_interface_;
323         etl::handle<synfigapp::SelectionManager> selection_manager_;
324
325         bool is_playing_;
326
327         sigc::signal<void> signal_deleted_;
328
329         bool rebuild_ducks_queued;
330         sigc::connection queue_rebuild_ducks_connection;
331
332         /*
333  -- ** -- P U B L I C   D A T A -----------------------------------------------
334         */
335
336 public:
337         void queue_rebuild_ducks();
338         sigc::signal<void>& signal_deleted() { return signal_deleted_; }
339
340         Gtk::Menu mainmenu;
341
342         bool duck_refresh_flag;
343         bool duck_refresh_needed;
344
345         //! This is for the IsWorking class.
346         int working_depth;
347
348         bool cancel;
349
350         /*
351  -- ** -- D I A L O G S -------------------------------------------------------
352         */
353
354 public:
355
356         CanvasProperties canvas_properties;
357         CanvasOptions canvas_options;
358         RenderSettings render_settings;
359         Dialog_Waypoint waypoint_dialog;
360         Dialog_Keyframe keyframe_dialog;
361
362         std::auto_ptr<Dialog_Preview>                   preview_dialog;
363         //std::auto_ptr<Dialog_PreviewOptions>  previewoption_dialog;
364         std::auto_ptr<Dialog_SoundSelect>               sound_dialog;
365
366         /*
367  -- ** -- P R I V A T E   M E T H O D S ---------------------------------------
368         */
369
370 private:
371
372         // Constructor is private to force the use of the "create()" constructor
373         CanvasView(etl::loose_handle<Instance> instance,etl::handle<synfigapp::CanvasInterface> canvas_interface);
374
375         //! Constructor Helper
376         // Gtk::Widget* create_layer_tree();
377
378         //! Constructor Helper
379         // Gtk::Widget* create_children_tree();
380
381         //! Constructor Helper
382         // Gtk::Widget* create_keyframe_tree();
383
384         //! Constructor Helper
385         Gtk::Widget* create_status_bar();
386
387         //! Constructor Helper - Initializes all of the menus
388         void init_menus();
389
390         bool duck_change_param(const synfig::Point &value,synfig::Layer::Handle layer, synfig::String param_name);
391
392         void refresh_time_window();
393
394         void time_was_changed();
395
396         void refresh_rend_desc();
397
398         void toggle_duck_mask(Duckmatic::Type type);
399
400         Gtk::Widget *create_work_area();
401
402         Gtk::Widget *create_time_bar();
403
404         void popup_param_menu_bezier(float location, synfigapp::ValueDesc value_desc)
405         { popup_param_menu(value_desc,location); }
406
407         void popup_param_menu(synfigapp::ValueDesc value_desc, float location=0);
408
409         void workarea_layer_selected(synfig::Layer::Handle layer);
410
411         void selected_layer_color_set(synfig::Color color);
412
413         void register_layer_type(synfig::Layer::Book::value_type &lyr,std::map<synfig::String,Gtk::Menu*>*);
414
415         //! Rebuilds the "new layer" menu
416         void build_new_layer_menu(Gtk::Menu &menu);
417
418         void rebuild_ducks_layer_(synfig::TransformStack& transform_stack, synfig::Canvas::Handle canvas, std::set<synfig::Layer::Handle>& selected_list);
419
420         void decrease_low_res_pixel_size();
421         void increase_low_res_pixel_size();
422
423         /*
424  -- ** -- P U B L I C   M E T H O D S -----------------------------------------
425         */
426
427 public:
428         const synfig::TransformStack& get_curr_transform_stack()const { return curr_transform_stack; }
429
430         const synfig::Rect& get_bbox()const { return bbox; }
431
432         Glib::RefPtr<Glib::ObjectBase> get_ref_obj(const synfig::String& x);
433         Glib::RefPtr<const Glib::ObjectBase> get_ref_obj(const synfig::String& x)const;
434         void set_ref_obj(const synfig::String& x, Glib::RefPtr<Glib::ObjectBase> y);
435
436         Glib::RefPtr<Gtk::TreeModel> get_tree_model(const synfig::String& x);
437         Glib::RefPtr<const Gtk::TreeModel> get_tree_model(const synfig::String& x)const;
438         void set_tree_model(const synfig::String& x, Glib::RefPtr<Gtk::TreeModel> y);
439
440         Gtk::Widget* get_ext_widget(const synfig::String& x);
441         void set_ext_widget(const synfig::String& x, Gtk::Widget* y);
442
443         //std::map<synfig::String,Gtk::Widget*>& tree_view_book() { return tree_view_book_; }
444         //std::map<synfig::String,Gtk::Widget*>& ext_widget_book() { return tree_view_book_; }
445
446         void popup_main_menu();
447
448         Smach& get_smach() { return smach_; }
449
450         const Smach& get_smach()const { return smach_; }
451
452         Smach::event_result process_event_key(EventKey x);
453
454         void popup_layer_menu(synfig::Layer::Handle layer);
455
456         virtual ~CanvasView();
457
458         void set_mode(Mode x) { canvas_interface()->set_mode(x); }
459
460         Mode get_mode()const { return canvas_interface()->get_mode(); }
461
462         Gtk::Adjustment &time_adjustment() { return time_adjustment_; }
463
464         const Gtk::Adjustment &time_adjustment()const { return time_adjustment_; }
465
466         studio::Adjust_Window &time_window_adjustment() { return time_window_adjustment_; }
467
468         const studio::Adjust_Window &time_window_adjustment()const { return time_window_adjustment_; }
469
470         etl::handle<synfigapp::UIInterface> get_ui_interface() { return ui_interface_;}
471
472         etl::handle<synfigapp::SelectionManager> get_selection_manager() { return selection_manager_; }
473
474         Glib::RefPtr<Gtk::TreeModel> layer_tree_store() { return get_tree_model("layers"); }
475
476         Glib::RefPtr<const Gtk::TreeModel> layer_tree_store()const { return get_tree_model("layers"); }
477
478         Glib::RefPtr<Gtk::TreeModel> children_tree_store() { return get_tree_model("children"); }
479
480         Glib::RefPtr<const Gtk::TreeModel> children_tree_store()const { return get_tree_model("children"); }
481
482         Glib::RefPtr<Gtk::TreeModel> keyframe_tree_store() { return get_tree_model("keyframes"); }
483
484         Glib::RefPtr<const Gtk::TreeModel> keyframe_tree_store()const { return get_tree_model("keyframes"); }
485
486         void set_time(synfig::Time t) { canvas_interface_->set_time(t); }
487
488         synfig::Time get_time() { return canvas_interface_->get_time(); }
489
490         etl::handle<synfig::Canvas> get_canvas()const { return canvas_interface_->get_canvas(); }
491
492         etl::handle<Instance> get_instance()const { return instance_; }
493
494         etl::handle<synfigapp::CanvasInterface> canvas_interface() { return canvas_interface_; }
495
496         etl::handle<const synfigapp::CanvasInterface> canvas_interface()const { return canvas_interface_; }
497
498         void add_actions_to_menu(Gtk::Menu *menu,   const synfigapp::Action::ParamList &param_list, synfigapp::Action::Category category=synfigapp::Action::CATEGORY_ALL)const;
499
500         //! Updates the title of the window
501         void update_title();
502
503         //! Closes this document
504         bool close_instance();
505
506         //! Closes this canvas view
507         bool close_view();
508
509         //!     Stops the currently executing action
510         /*! \see get_cancel_status(), reset_cancel_status(), IsWorking */
511         void stop() { cancel=true; }
512
513         //! Returns the cancel status
514         /*! \see stop(), reset_cancel_status(), IsWorking */
515         bool get_cancel_status()const { return cancel; }
516
517         //! Resets the cancel status
518         /*! \see stop(), get_cancel_status(), IsWorking */
519         void reset_cancel_status() { cancel=false; }
520
521         void new_child_canvas();
522
523         //! Rebuilds layer_tree_store_ from the Canvas. Maintains selected items.
524         void rebuild_tables();
525
526         //! Builds layer_tree_store_ from the Canvas. Does not maintain selected items.
527         void build_tables();
528
529         //! Refreshes the data for the tables
530         void refresh_tables();
531
532         //void rebuild_layer_table();
533         //void build_layer_table();
534         //void refresh_layer_table();
535
536 //      void rebuild_canvas_table();
537 //      void build_canvas_table();
538 //      void refresh_canvas_table();
539
540 //      void rebuild_valuenode_table();
541 //      void build_valuenode_table();
542 //      void refresh_valuenode_table();
543
544         //! \writeme
545         void rebuild_ducks();
546
547         //bool add_to_ducks(synfigapp::ValueDesc value_desc, synfig::ParamDesc *param_desc=NULL);
548
549         //! Starts "playing" the animation in real-time
550         void play();
551
552         //! Shows the tables (Layer/Children)
553         void show_tables();
554
555         //! Hides the tables (Layer/Children)
556         void hide_tables();
557
558         //! Toggles the tables
559         void toggle_tables();
560
561         //! Gets the table status
562         bool tables_are_visible();
563
564         //! Shows the time bar
565         void show_timebar();
566
567         //! Hides the time bar
568         void hide_timebar();
569
570         //t Enables or disables interaction with the timebar
571         void set_sensitive_timebar(bool sensitive);
572
573         void time_zoom_in();
574         void time_zoom_out();
575
576         void add_layer(synfig::String x);
577
578         void show_keyframe_dialog();
579
580         void play_audio(float t);
581         void stop_audio();
582
583         void image_import();
584
585         void on_waypoint_clicked_canvasview(synfigapp::ValueDesc,std::set<synfig::Waypoint,std::less<synfig::UniqueID> >, int button);
586
587         void preview_option() {on_preview_option();}
588
589         void present();
590
591         bool is_playing() { return is_playing_; }
592
593         /*
594  -- ** -- S I G N A L   T E R M I N A L S -------------------------------------
595         */
596
597 private:
598
599         void on_unselect_layers();
600
601         void on_input_device_changed(GdkDevice*);
602
603         virtual void on_hide();
604
605         virtual bool on_focus_in_event(GdkEventFocus*);
606         virtual bool on_focus_out_event(GdkEventFocus*);
607
608         //bool on_children_tree_event(GdkEvent *event);
609
610         bool on_keyframe_tree_event(GdkEvent *event);
611
612         //void on_children_edited_value(const Glib::ustring&path_string,synfig::ValueBase value);
613
614         void on_dirty_preview();
615
616         bool on_children_user_click(int, Gtk::TreeRow, ChildrenTree::ColumnID);
617
618         bool on_layer_user_click(int, Gtk::TreeRow, LayerTree::ColumnID);
619
620 //      void on_layer_toggle(const Glib::ustring& path_string, Gtk::TreeModelColumn<bool> column);
621
622         void on_mode_changed(synfigapp::CanvasInterface::Mode mode);
623
624 //      void on_layer_waypoint_clicked(const Glib::ustring &, synfig::ValueNode_Animated::WaypointList::iterator);
625
626         //void on_children_waypoint_clicked(const Glib::ustring &, synfig::ValueNode_Animated::WaypointList::iterator);
627
628         void on_waypoint_changed();
629
630         void on_waypoint_delete();
631
632         void on_refresh_pressed();
633
634         void on_id_changed();
635
636         void on_time_changed();
637
638         /*
639         void on_layer_raise_pressed();
640         void on_layer_lower_pressed();
641         void on_layer_duplicate_pressed();
642         void on_layer_delete_pressed();
643         */
644
645         void on_keyframe_add_pressed();
646
647         void on_keyframe_duplicate_pressed();
648
649         void on_keyframe_remove_pressed();
650
651         void on_animate_button_pressed();
652
653         void on_keyframe_button_pressed();
654
655         void on_preview_option();
656         void on_preview_create(const PreviewInfo &);
657
658         void on_audio_option();
659         void on_audio_file_change(const std::string &f);
660         void on_audio_offset_change(const synfig::Time &t);
661
662         void on_audio_file_notify();
663         void on_audio_offset_notify();
664
665         bool on_duck_changed(const synfig::Point &value,const synfigapp::ValueDesc& value_desc);
666         bool on_duck_angle_changed(const synfig::Angle &rotation,const synfigapp::ValueDesc& value_desc);
667
668         void on_layer_toggle(synfig::Layer::Handle);
669
670         void on_edited_value(synfigapp::ValueDesc,synfig::ValueBase);
671
672         void on_drop_drag_data_received(const Glib::RefPtr<Gdk::DragContext>& context, int x, int y, const Gtk::SelectionData& selection_data, guint info, guint time);
673
674         //void on_audio_play();
675         bool on_audio_scrub();
676
677 protected:
678         bool close_instance_when_safe();
679         bool on_delete_event(GdkEventAny* event);
680
681         /*
682  -- ** -- S T A T I C   P U B L I C   M E T H O D S ---------------------------
683         */
684
685 public:
686
687         static etl::handle<studio::CanvasView> create(etl::loose_handle<Instance> instance,etl::handle<synfig::Canvas> canvas);
688         static std::list<int>& get_pixel_sizes();
689
690 }; // END of class CanvasView
691
692 }; // END of namespace studio
693
694 /* === E N D =============================================================== */
695
696 #endif