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, 2008 Chris Moore
10 ** Copyright (c) 2009 Carlos López
12 ** This package is free software; you can redistribute it and/or
13 ** modify it under the terms of the GNU General Public License as
14 ** published by the Free Software Foundation; either version 2 of
15 ** the License, or (at your option) any later version.
17 ** This package is distributed in the hope that it will be useful,
18 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 ** General Public License for more details.
23 /* ========================================================================= */
25 /* === S T A R T =========================================================== */
27 #ifndef __SYNFIG_STUDIO_GTKMM_CANVASVIEW_H
28 #define __SYNFIG_STUDIO_GTKMM_CANVASVIEW_H
30 /* === H E A D E R S ======================================================= */
32 #include <gtkmm/window.h>
33 #include <gtkmm/image.h>
34 #include <gtkmm/tooltips.h>
35 #include <gtkmm/table.h>
36 #include <gtkmm/statusbar.h>
37 #include <gtkmm/progressbar.h>
38 #include <gtkmm/button.h>
39 #include <gtkmm/menu.h>
40 #include <gtkmm/treeview.h>
41 #include <gtkmm/treestore.h>
42 #include <gtkmm/scrolledwindow.h>
43 #include <gtkmm/notebook.h>
44 #include <gdkmm/device.h>
45 #include <gtkmm/spinbutton.h>
47 #include <synfigapp/canvasinterface.h>
48 #include <synfigapp/selectionmanager.h>
50 #include <synfig/canvas.h>
51 #include <synfig/string.h>
52 #include <synfig/time.h>
55 #include "canvasproperties.h"
56 #include "canvasoptions.h"
58 #include "cellrenderer_timetrack.h"
61 #include "layertreestore.h"
62 #include "layertree.h"
63 #include "childrentreestore.h"
64 #include "childrentree.h"
65 #include "keyframetreestore.h"
66 #include "keyframetree.h"
68 #include "dialog_waypoint.h"
69 #include "dialog_keyframe.h"
70 #include "framedial.h"
71 #include "toggleducksdial.h"
72 #include "resolutiondial.h"
74 #include "duckmatic.h"
75 #include <gtkmm/scale.h>
77 #include <gtkmm/uimanager.h>
84 #include <gtkmm/toggleaction.h>
85 #include <gtkmm/radioaction.h>
86 #include <synfig/rect.h>
88 #include "adjust_window.h"
90 #include <synfig/transform.h>
92 /* === M A C R O S ========================================================= */
94 #ifndef DEBUGPOINT_CLASS
96 #define DEBUGPOINT_CLASS(x) struct debugpointclass_ ## x { debugpointclass_ ## x () { DEBUGPOINT(); } ~debugpointclass_ ## x () { DEBUGPOINT(); } } badfthguae_ ## x ;
98 #define DEBUGPOINT_CLASS(x)
102 /* === T Y P E D E F S ===================================================== */
104 /* === C L A S S E S & S T R U C T S ======================================= */
107 class TransformStack;
112 class CanvasViewUIInterface;
113 class CanvasViewSelectionManager;
115 class CellRenderer_TimeTrack;
116 class CellRenderer_ValueBase;
117 class UniversalScrubber;
124 class AudioContainer;
127 class Widget_Timeslider;
130 class Dialog_SoundSelect;
131 class Dialog_Preview;
135 class Dock_Keyframes;
137 class CanvasView : public Gtk::Window, public etl::shared_object
139 friend class UniversalScrubber;
140 friend class Dock_Layers;
141 friend class Dock_Children;
142 friend class Dock_Keyframes;
144 friend class CanvasViewUIInterface;
145 friend class CanvasViewSelectionManager;
147 friend class Duckmatic;
150 -- ** -- P U B L I C T Y P E S ---------------------------------------------
155 typedef etl::handle<CanvasView> Handle;
157 typedef etl::handle<const CanvasView> ConstHandle;
159 typedef etl::loose_handle<CanvasView> LooseHandle;
161 typedef LayerTreeStore::Model LayerTreeModel;
163 typedef ChildrenTreeStore::Model ChildrenTreeModel;
165 //! Create an instance of this class whenever doing a longer task.
166 /*! Make sure that you check the bool value of this class occasionally
167 ** to make sure the action has not been canceled. */
170 CanvasView &canvas_view_;
173 IsWorking(CanvasView &canvas_view_);
175 operator bool()const;
177 friend class IsWorking;
179 typedef synfigapp::CanvasInterface::Mode Mode;
181 void set_grid_snap_toggle(bool flag) { grid_snap_toggle->set_active(flag); }
182 void set_grid_show_toggle(bool flag) { grid_show_toggle->set_active(flag); }
185 -- ** -- P R I V A T E D A T A ---------------------------------------------
189 std::auto_ptr<WorkArea> work_area;
191 WorkArea* get_work_area() { return work_area.get(); }
194 synfig::TransformStack curr_transform_stack;
195 bool curr_transform_stack_set;
199 // DEBUGPOINT_CLASS(1);
204 // DEBUGPOINT_CLASS(2);
206 etl::loose_handle<Instance> instance_;
207 etl::handle<synfigapp::CanvasInterface> canvas_interface_;
209 // DEBUGPOINT_CLASS(3);
211 //! Sound and information to play it
212 etl::handle<AudioContainer> audio;
213 studio::Widget_Sound *disp_audio; //should this be put into thing too?
215 sigc::connection playcon;
216 sigc::connection stopcon;
218 std::auto_ptr<UniversalScrubber> universal_scrubber;
220 //! Tooltip controller
221 Gtk::Tooltips tooltips;
223 // DEBUGPOINT_CLASS(4);
225 //! TreeModel for the layers
226 LayerTreeModel layer_tree_model;
228 //! TreeModel for the the children
229 ChildrenTreeModel children_tree_model;
231 //Glib::RefPtr<LayerTreeStore> layer_tree_store_;
233 //Glib::RefPtr<ChildrenTreeStore> children_tree_store_;
235 //Glib::RefPtr<KeyframeTreeStore> keyframe_tree_store_;
237 // DEBUGPOINT_CLASS(5);
239 //std::map<synfig::String,Glib::RefPtr<Gtk::TreeModel> > tree_model_book_;
240 std::map<synfig::String,Glib::RefPtr<Glib::ObjectBase> > ref_obj_book_;
241 std::map<synfig::String,Gtk::Widget*> ext_widget_book_;
243 //! The time adjustment's scope is defined by the time_window adjustment
244 Gtk::Adjustment time_adjustment_;
246 //! The time_window adjustment governs the position of the time window on the whole time line
247 //Gtk::Adjustment time_window_adjustment_;
248 studio::Adjust_Window time_window_adjustment_;
250 LayerTree *layer_tree;
252 ChildrenTree *children_tree;
254 KeyframeTree *keyframe_tree;
256 Gtk::Widget *keyframe_tab_child;
258 Gtk::ProgressBar *progressbar;
259 Gtk::Statusbar *statusbar;
261 Gtk::TreeRow children_canvas_row;
262 Gtk::TreeRow children_valuenode_row;
264 Gtk::Button *stopbutton;
265 Gtk::Button *refreshbutton;
266 Gtk::Button *treetogglebutton; // not used
267 Gtk::Notebook *notebook; // not used
269 Gtk::Table *displaybar;
270 Gtk::Button *animatebutton;
271 Gtk::Button *keyframebutton;
272 FrameDial *framedial;
273 ToggleDucksDial *toggleducksdial;
274 bool toggling_ducks_;
275 ResolutionDial *resolutiondial;
276 bool changing_resolution_;
277 Gtk::Adjustment quality_adjustment_;
278 Gtk::SpinButton *quality_spin;
279 Gtk::Adjustment past_onion_adjustment_;
280 Gtk::SpinButton *past_onion_spin;
281 Gtk::Adjustment future_onion_adjustment_;
282 Gtk::SpinButton *future_onion_spin;
283 bool updating_quality_;
284 Gtk::ToggleButton *show_grid;
285 Gtk::ToggleButton *snap_grid;
286 Gtk::ToggleButton *onion_skin;
287 bool toggling_show_grid;
288 bool toggling_snap_grid;
289 bool toggling_onion_skin;
290 //! Shows current time and allows edition
291 Widget_Time *current_time_widget;
292 void on_current_time_widget_changed();
294 //! Time slider class. Same than the Time track panel
295 std::auto_ptr<Widget_Timeslider> timeslider;
297 std::list<sigc::connection> duck_changed_connections;
299 /* DEBUGPOINT_CLASS(8);
301 Gtk::Menu duckmaskmenu;
302 DEBUGPOINT_CLASS(77);
303 Gtk::Menu qualitymenu;
307 DEBUGPOINT_CLASS(777);
309 DEBUGPOINT_CLASS(71);
310 Gtk::Menu canvasmenu;
311 DEBUGPOINT_CLASS(73);
315 DEBUGPOINT_CLASS(74);
316 Gtk::Menu newlayermenu;
317 DEBUGPOINT_CLASS(76);
320 DEBUGPOINT_CLASS(99);
321 Gtk::Menu keyframemenu;
328 Gtk::CheckMenuItem* duck_mask_position;
329 Gtk::CheckMenuItem* duck_mask_vertex;
330 Gtk::CheckMenuItem* duck_mask_tangent;
331 Gtk::CheckMenuItem* duck_mask_radius;
332 Gtk::CheckMenuItem* duck_mask_width;
333 Gtk::CheckMenuItem* duck_mask_angle;
338 Glib::RefPtr<Gtk::ToggleAction> grid_snap_toggle;
339 Glib::RefPtr<Gtk::ToggleAction> grid_show_toggle;
341 Gtk::RadioButtonGroup quality_group;
342 Gtk::RadioButtonGroup low_res_pixel_size_group;
344 Glib::RefPtr<Gtk::ActionGroup> action_group;
346 etl::handle<synfigapp::UIInterface> ui_interface_;
347 etl::handle<synfigapp::SelectionManager> selection_manager_;
351 sigc::signal<void> signal_deleted_;
353 bool rebuild_ducks_queued;
354 sigc::connection queue_rebuild_ducks_connection;
357 -- ** -- P U B L I C D A T A -----------------------------------------------
361 void queue_rebuild_ducks();
362 sigc::signal<void>& signal_deleted() { return signal_deleted_; }
366 bool duck_refresh_flag;
367 bool duck_refresh_needed;
369 //! This is for the IsWorking class.
375 -- ** -- D I A L O G S -------------------------------------------------------
380 CanvasProperties canvas_properties;
381 CanvasOptions canvas_options;
382 RenderSettings render_settings;
383 Dialog_Waypoint waypoint_dialog;
384 Dialog_Keyframe keyframe_dialog;
386 std::auto_ptr<Dialog_Preview> preview_dialog;
387 //std::auto_ptr<Dialog_PreviewOptions> previewoption_dialog;
388 std::auto_ptr<Dialog_SoundSelect> sound_dialog;
391 -- ** -- P R I V A T E M E T H O D S ---------------------------------------
396 // Constructor is private to force the use of the "create()" constructor
397 CanvasView(etl::loose_handle<Instance> instance,etl::handle<synfigapp::CanvasInterface> canvas_interface);
399 //! Constructor Helper
400 // Gtk::Widget* create_layer_tree();
402 //! Constructor Helper
403 // Gtk::Widget* create_children_tree();
405 //! Constructor Helper
406 // Gtk::Widget* create_keyframe_tree();
408 //! Constructor Helper
409 Gtk::Widget* create_status_bar();
411 //! Constructor Helper - Initializes all of the menus
414 bool duck_change_param(const synfig::Point &value,synfig::Layer::Handle layer, synfig::String param_name);
416 void refresh_time_window();
418 void time_was_changed();
420 void refresh_rend_desc();
422 void toggle_duck_mask(Duckmatic::Type type);
424 Gtk::Widget *create_work_area();
426 Gtk::Widget *create_time_bar();
428 Gtk::Widget *create_display_bar();
430 //! Pop up menu for the bezier (bline, draw) tool (?)
431 void popup_param_menu_bezier(float location, synfigapp::ValueDesc value_desc)
432 { popup_param_menu(value_desc,location,true); }
434 //! Pop up menu for the tools but not the bezier ones.
435 void popup_param_menu(synfigapp::ValueDesc value_desc, float location=0, bool bezier=false);
437 void workarea_layer_selected(synfig::Layer::Handle layer);
439 void selected_layer_color_set(synfig::Color color);
441 void register_layer_type(synfig::Layer::Book::value_type &lyr,std::map<synfig::String,Gtk::Menu*>*);
443 //! Rebuilds the "new layer" menu
444 void build_new_layer_menu(Gtk::Menu &menu);
446 void rebuild_ducks_layer_(synfig::TransformStack& transform_stack, synfig::Canvas::Handle canvas, std::set<synfig::Layer::Handle>& selected_list);
448 void decrease_low_res_pixel_size();
449 void increase_low_res_pixel_size();
450 void toggle_low_res_pixel_flag();
451 void set_quality(int x);
452 void set_onion_skins();
453 void toggle_show_grid();
454 void toggle_snap_grid();
455 void toggle_onion_skin();
458 -- ** -- P U B L I C M E T H O D S -----------------------------------------
462 const synfig::TransformStack& get_curr_transform_stack()const { return curr_transform_stack; }
464 const synfig::Rect& get_bbox()const { return bbox; }
466 Glib::RefPtr<Glib::ObjectBase> get_ref_obj(const synfig::String& x);
467 Glib::RefPtr<const Glib::ObjectBase> get_ref_obj(const synfig::String& x)const;
468 void set_ref_obj(const synfig::String& x, Glib::RefPtr<Glib::ObjectBase> y);
470 Glib::RefPtr<Gtk::TreeModel> get_tree_model(const synfig::String& x);
471 Glib::RefPtr<const Gtk::TreeModel> get_tree_model(const synfig::String& x)const;
472 void set_tree_model(const synfig::String& x, Glib::RefPtr<Gtk::TreeModel> y);
474 Gtk::Widget* get_ext_widget(const synfig::String& x);
475 void set_ext_widget(const synfig::String& x, Gtk::Widget* y);
477 //std::map<synfig::String,Gtk::Widget*>& tree_view_book() { return tree_view_book_; }
478 //std::map<synfig::String,Gtk::Widget*>& ext_widget_book() { return tree_view_book_; }
480 void popup_main_menu();
482 Smach& get_smach() { return smach_; }
484 const Smach& get_smach()const { return smach_; }
486 Smach::event_result process_event_key(EventKey x);
488 void popup_layer_menu(synfig::Layer::Handle layer);
490 virtual ~CanvasView();
492 void set_mode(Mode x) { canvas_interface()->set_mode(x); }
494 Mode get_mode()const { return canvas_interface()->get_mode(); }
496 Gtk::Adjustment &time_adjustment() { return time_adjustment_; }
498 const Gtk::Adjustment &time_adjustment()const { return time_adjustment_; }
500 studio::Adjust_Window &time_window_adjustment() { return time_window_adjustment_; }
502 const studio::Adjust_Window &time_window_adjustment()const { return time_window_adjustment_; }
504 etl::handle<synfigapp::UIInterface> get_ui_interface() { return ui_interface_;}
506 etl::handle<synfigapp::SelectionManager> get_selection_manager() { return selection_manager_; }
508 Glib::RefPtr<Gtk::TreeModel> layer_tree_store() { return get_tree_model("layers"); }
510 Glib::RefPtr<const Gtk::TreeModel> layer_tree_store()const { return get_tree_model("layers"); }
512 Glib::RefPtr<Gtk::TreeModel> children_tree_store() { return get_tree_model("children"); }
514 Glib::RefPtr<const Gtk::TreeModel> children_tree_store()const { return get_tree_model("children"); }
516 Glib::RefPtr<Gtk::TreeModel> keyframe_tree_store() { return get_tree_model("keyframes"); }
518 Glib::RefPtr<const Gtk::TreeModel> keyframe_tree_store()const { return get_tree_model("keyframes"); }
520 void set_time(synfig::Time t) { canvas_interface_->set_time(t); }
522 synfig::Time get_time() { return canvas_interface_->get_time(); }
524 etl::handle<synfig::Canvas> get_canvas()const { return canvas_interface_->get_canvas(); }
526 etl::handle<Instance> get_instance()const { return instance_; }
528 etl::handle<synfigapp::CanvasInterface> canvas_interface() { return canvas_interface_; }
530 etl::handle<const synfigapp::CanvasInterface> canvas_interface()const { return canvas_interface_; }
532 void add_actions_to_menu(Gtk::Menu *menu, const synfigapp::Action::ParamList ¶m_list, synfigapp::Action::Category category=synfigapp::Action::CATEGORY_ALL)const;
534 //! Updates the title of the window
537 //! Closes this document
538 bool close_instance();
540 //! Closes this canvas view
543 //! Stops the currently executing action
544 /*! \see get_cancel_status(), reset_cancel_status(), IsWorking */
545 void stop() { cancel=true; }
547 //! Returns the cancel status
548 /*! \see stop(), reset_cancel_status(), IsWorking */
549 bool get_cancel_status()const { return cancel; }
551 //! Resets the cancel status
552 /*! \see stop(), get_cancel_status(), IsWorking */
553 void reset_cancel_status() { cancel=false; }
555 void new_child_canvas();
557 //! Rebuilds layer_tree_store_ from the Canvas. Maintains selected items.
558 void rebuild_tables();
560 //! Builds layer_tree_store_ from the Canvas. Does not maintain selected items.
563 //! Refreshes the data for the tables
564 void refresh_tables();
566 //void rebuild_layer_table();
567 //void build_layer_table();
568 //void refresh_layer_table();
570 // void rebuild_canvas_table();
571 // void build_canvas_table();
572 // void refresh_canvas_table();
574 // void rebuild_valuenode_table();
575 // void build_valuenode_table();
576 // void refresh_valuenode_table();
579 void rebuild_ducks();
581 //bool add_to_ducks(synfigapp::ValueDesc value_desc, synfig::ParamDesc *param_desc=NULL);
583 //! Starts "playing" the animation in real-time
586 //! Shows the tables (Layer/Children)
589 //! Hides the tables (Layer/Children)
592 //! Toggles the tables
593 void toggle_tables();
595 //! Gets the table status
596 bool tables_are_visible();
598 //! Shows the time bar
601 //! Hides the time bar
604 //t Enables or disables interaction with the timebar
605 void set_sensitive_timebar(bool sensitive);
608 void time_zoom_out();
610 void add_layer(synfig::String x);
612 void show_keyframe_dialog();
614 void play_audio(float t);
619 void on_waypoint_clicked_canvasview(synfigapp::ValueDesc,std::set<synfig::Waypoint,std::less<synfig::UniqueID> >, int button);
621 void preview_option() {on_preview_option();}
625 bool is_playing() { return is_playing_; }
627 void update_quality();
632 -- ** -- S I G N A L T E R M I N A L S -------------------------------------
637 void on_select_layers();
638 void on_unselect_layers();
640 void on_input_device_changed(GdkDevice*);
642 virtual void on_hide();
644 virtual bool on_focus_in_event(GdkEventFocus*);
645 virtual bool on_focus_out_event(GdkEventFocus*);
647 //bool on_children_tree_event(GdkEvent *event);
649 bool on_keyframe_tree_event(GdkEvent *event);
651 //void on_children_edited_value(const Glib::ustring&path_string,synfig::ValueBase value);
653 void on_dirty_preview();
655 bool on_children_user_click(int, Gtk::TreeRow, ChildrenTree::ColumnID);
657 bool on_layer_user_click(int, Gtk::TreeRow, LayerTree::ColumnID);
659 // void on_layer_toggle(const Glib::ustring& path_string, Gtk::TreeModelColumn<bool> column);
661 void on_mode_changed(synfigapp::CanvasInterface::Mode mode);
663 // void on_layer_waypoint_clicked(const Glib::ustring &, synfig::ValueNode_Animated::WaypointList::iterator);
665 //void on_children_waypoint_clicked(const Glib::ustring &, synfig::ValueNode_Animated::WaypointList::iterator);
667 void on_waypoint_changed();
669 void on_waypoint_delete();
671 void on_refresh_pressed();
673 void on_id_changed();
675 void on_time_changed();
678 void on_layer_raise_pressed();
679 void on_layer_lower_pressed();
680 void on_layer_duplicate_pressed();
681 void on_layer_delete_pressed();
684 void on_keyframe_add_pressed();
686 void on_keyframe_duplicate_pressed();
688 void on_keyframe_remove_pressed();
690 void on_animate_button_pressed();
692 void on_keyframe_button_pressed();
694 void on_preview_option();
695 void on_preview_create(const PreviewInfo &);
697 void on_audio_option();
698 void on_audio_file_change(const std::string &f);
699 void on_audio_offset_change(const synfig::Time &t);
701 void on_audio_file_notify();
702 void on_audio_offset_notify();
704 bool on_duck_changed(const synfig::Point &value,const synfigapp::ValueDesc& value_desc);
705 bool on_duck_angle_changed(const synfig::Angle &rotation,const synfigapp::ValueDesc& value_desc);
707 void on_layer_toggle(synfig::Layer::Handle);
709 void on_edited_value(synfigapp::ValueDesc,synfig::ValueBase);
711 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);
713 //void on_audio_play();
714 bool on_audio_scrub();
716 void on_play_stop_pressed();
719 bool close_instance_when_safe();
720 bool on_delete_event(GdkEventAny* event);
723 -- ** -- S T A T I C P U B L I C M E T H O D S ---------------------------
728 static etl::handle<studio::CanvasView> create(etl::loose_handle<Instance> instance,etl::handle<synfig::Canvas> canvas);
729 static std::list<int>& get_pixel_sizes();
731 }; // END of class CanvasView
733 }; // END of namespace studio
735 /* === E N D =============================================================== */