6f1f87ef69ae560d82283281d1db78e0d362ab83
[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         void set_grid_snap_toggle(bool flag) { grid_snap_toggle->set_active(flag); }
177         void set_grid_show_toggle(bool flag) { grid_show_toggle->set_active(flag); }
178
179         /*
180  -- ** -- P R I V A T E   D A T A ---------------------------------------------
181         */
182
183 public:
184         std::auto_ptr<WorkArea> work_area;
185
186         WorkArea* get_work_area() { return work_area.get(); }
187 private:
188
189         synfig::TransformStack curr_transform_stack;
190         bool curr_transform_stack_set;
191
192         synfig::Rect bbox;
193
194         // DEBUGPOINT_CLASS(1);
195
196         //! State Machine
197         Smach smach_;
198
199         // DEBUGPOINT_CLASS(2);
200
201         etl::loose_handle<Instance> instance_;
202         etl::handle<synfigapp::CanvasInterface> canvas_interface_;
203
204         // DEBUGPOINT_CLASS(3);
205
206         //! Sound and information to play it
207         etl::handle<AudioContainer>             audio;
208         studio::Widget_Sound                    *disp_audio; //should this be put into thing too?
209
210         sigc::connection                                playcon;
211         sigc::connection                                stopcon;
212
213         std::auto_ptr<UniversalScrubber> universal_scrubber;
214
215         //! Tooltip controller
216         Gtk::Tooltips tooltips;
217
218         // DEBUGPOINT_CLASS(4);
219
220         //! TreeModel for the layers
221         LayerTreeModel layer_tree_model;
222
223         //! TreeModel for the the children
224         ChildrenTreeModel children_tree_model;
225
226         //Glib::RefPtr<LayerTreeStore> layer_tree_store_;
227
228         //Glib::RefPtr<ChildrenTreeStore> children_tree_store_;
229
230         //Glib::RefPtr<KeyframeTreeStore> keyframe_tree_store_;
231
232         // DEBUGPOINT_CLASS(5);
233
234         //std::map<synfig::String,Glib::RefPtr<Gtk::TreeModel> > tree_model_book_;
235         std::map<synfig::String,Glib::RefPtr<Glib::ObjectBase> > ref_obj_book_;
236         std::map<synfig::String,Gtk::Widget*> ext_widget_book_;
237
238         //! The time adjustment's scope is defined by the time_window adjustment
239         Gtk::Adjustment time_adjustment_;
240
241         //! The time_window adjustment governs the position of the time window on the whole time line
242         //Gtk::Adjustment time_window_adjustment_;
243         studio::Adjust_Window time_window_adjustment_;
244
245         LayerTree *layer_tree;
246
247         ChildrenTree *children_tree;
248
249         KeyframeTree *keyframe_tree;
250
251         Gtk::Widget *keyframe_tab_child;
252
253         Gtk::ProgressBar *progressbar;
254         Gtk::Statusbar *statusbar;
255
256         Gtk::TreeRow children_canvas_row;
257         Gtk::TreeRow children_valuenode_row;
258
259         Gtk::Button *stopbutton;
260         Gtk::Button *refreshbutton;
261         Gtk::Button *treetogglebutton;  // not used
262         Gtk::Notebook *notebook; // not used
263         Gtk::Widget *timebar;
264         Gtk::Button *animatebutton;
265         Gtk::Button *keyframebutton;
266
267
268         //! Shows current time and allows edition
269         Widget_Time *current_time_widget;
270         void on_current_time_widget_changed();
271
272         //! Time slider class. Same than the Time track panel
273         std::auto_ptr<Widget_Timeslider> timeslider;
274
275         std::list<sigc::connection> duck_changed_connections;
276
277 /*      DEBUGPOINT_CLASS(8);
278
279         Gtk::Menu duckmaskmenu;
280         DEBUGPOINT_CLASS(77);
281         Gtk::Menu qualitymenu;
282         DEBUGPOINT_CLASS(6);
283
284         Gtk::Menu filemenu;
285         DEBUGPOINT_CLASS(777);
286         Gtk::Menu editmenu;
287         DEBUGPOINT_CLASS(71);
288         Gtk::Menu canvasmenu;
289         DEBUGPOINT_CLASS(73);
290 public:
291         Gtk::Menu layermenu;
292 private:
293         DEBUGPOINT_CLASS(74);
294         Gtk::Menu newlayermenu;
295         DEBUGPOINT_CLASS(76);
296         Gtk::Menu viewmenu;
297
298         DEBUGPOINT_CLASS(99);
299         Gtk::Menu keyframemenu;
300
301         Gtk::Menu parammenu;
302         DEBUGPOINT_CLASS(9);
303         Gtk::Menu trackmenu;
304         DEBUGPOINT_CLASS(7);
305
306         Gtk::CheckMenuItem* duck_mask_position;
307         Gtk::CheckMenuItem* duck_mask_vertex;
308         Gtk::CheckMenuItem* duck_mask_tangent;
309         Gtk::CheckMenuItem* duck_mask_radius;
310         Gtk::CheckMenuItem* duck_mask_width;
311         Gtk::CheckMenuItem* duck_mask_angle;
312 */
313         //! Menu members
314         Gtk::Menu parammenu;
315
316         Glib::RefPtr<Gtk::ToggleAction> grid_snap_toggle;
317         Glib::RefPtr<Gtk::ToggleAction> grid_show_toggle;
318
319         Gtk::RadioButtonGroup quality_group;
320         Gtk::RadioButtonGroup low_res_pixel_size_group;
321
322         Glib::RefPtr<Gtk::ActionGroup> action_group;
323
324         etl::handle<synfigapp::UIInterface> ui_interface_;
325         etl::handle<synfigapp::SelectionManager> selection_manager_;
326
327         bool is_playing_;
328
329         sigc::signal<void> signal_deleted_;
330
331         bool rebuild_ducks_queued;
332         sigc::connection queue_rebuild_ducks_connection;
333
334         /*
335  -- ** -- P U B L I C   D A T A -----------------------------------------------
336         */
337
338 public:
339         void queue_rebuild_ducks();
340         sigc::signal<void>& signal_deleted() { return signal_deleted_; }
341
342         Gtk::Menu mainmenu;
343
344         bool duck_refresh_flag;
345         bool duck_refresh_needed;
346
347         //! This is for the IsWorking class.
348         int working_depth;
349
350         bool cancel;
351
352         /*
353  -- ** -- D I A L O G S -------------------------------------------------------
354         */
355
356 public:
357
358         CanvasProperties canvas_properties;
359         CanvasOptions canvas_options;
360         RenderSettings render_settings;
361         Dialog_Waypoint waypoint_dialog;
362         Dialog_Keyframe keyframe_dialog;
363
364         std::auto_ptr<Dialog_Preview>                   preview_dialog;
365         //std::auto_ptr<Dialog_PreviewOptions>  previewoption_dialog;
366         std::auto_ptr<Dialog_SoundSelect>               sound_dialog;
367
368         /*
369  -- ** -- P R I V A T E   M E T H O D S ---------------------------------------
370         */
371
372 private:
373
374         // Constructor is private to force the use of the "create()" constructor
375         CanvasView(etl::loose_handle<Instance> instance,etl::handle<synfigapp::CanvasInterface> canvas_interface);
376
377         //! Constructor Helper
378         // Gtk::Widget* create_layer_tree();
379
380         //! Constructor Helper
381         // Gtk::Widget* create_children_tree();
382
383         //! Constructor Helper
384         // Gtk::Widget* create_keyframe_tree();
385
386         //! Constructor Helper
387         Gtk::Widget* create_status_bar();
388
389         //! Constructor Helper - Initializes all of the menus
390         void init_menus();
391
392         bool duck_change_param(const synfig::Point &value,synfig::Layer::Handle layer, synfig::String param_name);
393
394         void refresh_time_window();
395
396         void time_was_changed();
397
398         void refresh_rend_desc();
399
400         void toggle_duck_mask(Duckmatic::Type type);
401
402         Gtk::Widget *create_work_area();
403
404         Gtk::Widget *create_time_bar();
405
406         //! Pop up menu for the bezier (bline, draw) tool (?)
407         void popup_param_menu_bezier(float location, synfigapp::ValueDesc value_desc)
408         { popup_param_menu(value_desc,location,true); }
409
410         //! Pop up menu for the tools but not the bezier ones.
411         void popup_param_menu(synfigapp::ValueDesc value_desc, float location=0, bool bezier=false);
412
413         void workarea_layer_selected(synfig::Layer::Handle layer);
414
415         void selected_layer_color_set(synfig::Color color);
416
417         void register_layer_type(synfig::Layer::Book::value_type &lyr,std::map<synfig::String,Gtk::Menu*>*);
418
419         //! Rebuilds the "new layer" menu
420         void build_new_layer_menu(Gtk::Menu &menu);
421
422         void rebuild_ducks_layer_(synfig::TransformStack& transform_stack, synfig::Canvas::Handle canvas, std::set<synfig::Layer::Handle>& selected_list);
423
424         void decrease_low_res_pixel_size();
425         void increase_low_res_pixel_size();
426
427         /*
428  -- ** -- P U B L I C   M E T H O D S -----------------------------------------
429         */
430
431 public:
432         const synfig::TransformStack& get_curr_transform_stack()const { return curr_transform_stack; }
433
434         const synfig::Rect& get_bbox()const { return bbox; }
435
436         Glib::RefPtr<Glib::ObjectBase> get_ref_obj(const synfig::String& x);
437         Glib::RefPtr<const Glib::ObjectBase> get_ref_obj(const synfig::String& x)const;
438         void set_ref_obj(const synfig::String& x, Glib::RefPtr<Glib::ObjectBase> y);
439
440         Glib::RefPtr<Gtk::TreeModel> get_tree_model(const synfig::String& x);
441         Glib::RefPtr<const Gtk::TreeModel> get_tree_model(const synfig::String& x)const;
442         void set_tree_model(const synfig::String& x, Glib::RefPtr<Gtk::TreeModel> y);
443
444         Gtk::Widget* get_ext_widget(const synfig::String& x);
445         void set_ext_widget(const synfig::String& x, Gtk::Widget* y);
446
447         //std::map<synfig::String,Gtk::Widget*>& tree_view_book() { return tree_view_book_; }
448         //std::map<synfig::String,Gtk::Widget*>& ext_widget_book() { return tree_view_book_; }
449
450         void popup_main_menu();
451
452         Smach& get_smach() { return smach_; }
453
454         const Smach& get_smach()const { return smach_; }
455
456         Smach::event_result process_event_key(EventKey x);
457
458         void popup_layer_menu(synfig::Layer::Handle layer);
459
460         virtual ~CanvasView();
461
462         void set_mode(Mode x) { canvas_interface()->set_mode(x); }
463
464         Mode get_mode()const { return canvas_interface()->get_mode(); }
465
466         Gtk::Adjustment &time_adjustment() { return time_adjustment_; }
467
468         const Gtk::Adjustment &time_adjustment()const { return time_adjustment_; }
469
470         studio::Adjust_Window &time_window_adjustment() { return time_window_adjustment_; }
471
472         const studio::Adjust_Window &time_window_adjustment()const { return time_window_adjustment_; }
473
474         etl::handle<synfigapp::UIInterface> get_ui_interface() { return ui_interface_;}
475
476         etl::handle<synfigapp::SelectionManager> get_selection_manager() { return selection_manager_; }
477
478         Glib::RefPtr<Gtk::TreeModel> layer_tree_store() { return get_tree_model("layers"); }
479
480         Glib::RefPtr<const Gtk::TreeModel> layer_tree_store()const { return get_tree_model("layers"); }
481
482         Glib::RefPtr<Gtk::TreeModel> children_tree_store() { return get_tree_model("children"); }
483
484         Glib::RefPtr<const Gtk::TreeModel> children_tree_store()const { return get_tree_model("children"); }
485
486         Glib::RefPtr<Gtk::TreeModel> keyframe_tree_store() { return get_tree_model("keyframes"); }
487
488         Glib::RefPtr<const Gtk::TreeModel> keyframe_tree_store()const { return get_tree_model("keyframes"); }
489
490         void set_time(synfig::Time t) { canvas_interface_->set_time(t); }
491
492         synfig::Time get_time() { return canvas_interface_->get_time(); }
493
494         etl::handle<synfig::Canvas> get_canvas()const { return canvas_interface_->get_canvas(); }
495
496         etl::handle<Instance> get_instance()const { return instance_; }
497
498         etl::handle<synfigapp::CanvasInterface> canvas_interface() { return canvas_interface_; }
499
500         etl::handle<const synfigapp::CanvasInterface> canvas_interface()const { return canvas_interface_; }
501
502         void add_actions_to_menu(Gtk::Menu *menu,   const synfigapp::Action::ParamList &param_list, synfigapp::Action::Category category=synfigapp::Action::CATEGORY_ALL)const;
503
504         //! Updates the title of the window
505         void update_title();
506
507         //! Closes this document
508         bool close_instance();
509
510         //! Closes this canvas view
511         bool close_view();
512
513         //!     Stops the currently executing action
514         /*! \see get_cancel_status(), reset_cancel_status(), IsWorking */
515         void stop() { cancel=true; }
516
517         //! Returns the cancel status
518         /*! \see stop(), reset_cancel_status(), IsWorking */
519         bool get_cancel_status()const { return cancel; }
520
521         //! Resets the cancel status
522         /*! \see stop(), get_cancel_status(), IsWorking */
523         void reset_cancel_status() { cancel=false; }
524
525         void new_child_canvas();
526
527         //! Rebuilds layer_tree_store_ from the Canvas. Maintains selected items.
528         void rebuild_tables();
529
530         //! Builds layer_tree_store_ from the Canvas. Does not maintain selected items.
531         void build_tables();
532
533         //! Refreshes the data for the tables
534         void refresh_tables();
535
536         //void rebuild_layer_table();
537         //void build_layer_table();
538         //void refresh_layer_table();
539
540 //      void rebuild_canvas_table();
541 //      void build_canvas_table();
542 //      void refresh_canvas_table();
543
544 //      void rebuild_valuenode_table();
545 //      void build_valuenode_table();
546 //      void refresh_valuenode_table();
547
548         //! \writeme
549         void rebuild_ducks();
550
551         //bool add_to_ducks(synfigapp::ValueDesc value_desc, synfig::ParamDesc *param_desc=NULL);
552
553         //! Starts "playing" the animation in real-time
554         void play();
555
556         //! Shows the tables (Layer/Children)
557         void show_tables();
558
559         //! Hides the tables (Layer/Children)
560         void hide_tables();
561
562         //! Toggles the tables
563         void toggle_tables();
564
565         //! Gets the table status
566         bool tables_are_visible();
567
568         //! Shows the time bar
569         void show_timebar();
570
571         //! Hides the time bar
572         void hide_timebar();
573
574         //t Enables or disables interaction with the timebar
575         void set_sensitive_timebar(bool sensitive);
576
577         void time_zoom_in();
578         void time_zoom_out();
579
580         void add_layer(synfig::String x);
581
582         void show_keyframe_dialog();
583
584         void play_audio(float t);
585         void stop_audio();
586
587         void image_import();
588
589         void on_waypoint_clicked_canvasview(synfigapp::ValueDesc,std::set<synfig::Waypoint,std::less<synfig::UniqueID> >, int button);
590
591         void preview_option() {on_preview_option();}
592
593         void present();
594
595         bool is_playing() { return is_playing_; }
596
597         /*
598  -- ** -- S I G N A L   T E R M I N A L S -------------------------------------
599         */
600
601 private:
602
603         void on_select_layers();
604         void on_unselect_layers();
605
606         void on_input_device_changed(GdkDevice*);
607
608         virtual void on_hide();
609
610         virtual bool on_focus_in_event(GdkEventFocus*);
611         virtual bool on_focus_out_event(GdkEventFocus*);
612
613         //bool on_children_tree_event(GdkEvent *event);
614
615         bool on_keyframe_tree_event(GdkEvent *event);
616
617         //void on_children_edited_value(const Glib::ustring&path_string,synfig::ValueBase value);
618
619         void on_dirty_preview();
620
621         bool on_children_user_click(int, Gtk::TreeRow, ChildrenTree::ColumnID);
622
623         bool on_layer_user_click(int, Gtk::TreeRow, LayerTree::ColumnID);
624
625 //      void on_layer_toggle(const Glib::ustring& path_string, Gtk::TreeModelColumn<bool> column);
626
627         void on_mode_changed(synfigapp::CanvasInterface::Mode mode);
628
629 //      void on_layer_waypoint_clicked(const Glib::ustring &, synfig::ValueNode_Animated::WaypointList::iterator);
630
631         //void on_children_waypoint_clicked(const Glib::ustring &, synfig::ValueNode_Animated::WaypointList::iterator);
632
633         void on_waypoint_changed();
634
635         void on_waypoint_delete();
636
637         void on_refresh_pressed();
638
639         void on_id_changed();
640
641         void on_time_changed();
642
643         /*
644         void on_layer_raise_pressed();
645         void on_layer_lower_pressed();
646         void on_layer_duplicate_pressed();
647         void on_layer_delete_pressed();
648         */
649
650         void on_keyframe_add_pressed();
651
652         void on_keyframe_duplicate_pressed();
653
654         void on_keyframe_remove_pressed();
655
656         void on_animate_button_pressed();
657
658         void on_keyframe_button_pressed();
659
660         void on_preview_option();
661         void on_preview_create(const PreviewInfo &);
662
663         void on_audio_option();
664         void on_audio_file_change(const std::string &f);
665         void on_audio_offset_change(const synfig::Time &t);
666
667         void on_audio_file_notify();
668         void on_audio_offset_notify();
669
670         bool on_duck_changed(const synfig::Point &value,const synfigapp::ValueDesc& value_desc);
671         bool on_duck_angle_changed(const synfig::Angle &rotation,const synfigapp::ValueDesc& value_desc);
672
673         void on_layer_toggle(synfig::Layer::Handle);
674
675         void on_edited_value(synfigapp::ValueDesc,synfig::ValueBase);
676
677         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);
678
679         //void on_audio_play();
680         bool on_audio_scrub();
681
682 protected:
683         bool close_instance_when_safe();
684         bool on_delete_event(GdkEventAny* event);
685
686         /*
687  -- ** -- S T A T I C   P U B L I C   M E T H O D S ---------------------------
688         */
689
690 public:
691
692         static etl::handle<studio::CanvasView> create(etl::loose_handle<Instance> instance,etl::handle<synfig::Canvas> canvas);
693         static std::list<int>& get_pixel_sizes();
694
695 }; // END of class CanvasView
696
697 }; // END of namespace studio
698
699 /* === E N D =============================================================== */
700
701 #endif