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
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_GTKMM_CANVASVIEW_H
27 #define __SYNFIG_STUDIO_GTKMM_CANVASVIEW_H
29 /* === H E A D E R S ======================================================= */
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 #include <gtkmm/spinbutton.h>
46 #include <synfigapp/canvasinterface.h>
47 #include <synfigapp/selectionmanager.h>
49 #include <synfig/canvas.h>
50 #include <synfig/string.h>
51 #include <synfig/time.h>
54 #include "canvasproperties.h"
55 #include "canvasoptions.h"
57 #include "cellrenderer_timetrack.h"
60 #include "layertreestore.h"
61 #include "layertree.h"
62 #include "childrentreestore.h"
63 #include "childrentree.h"
64 #include "keyframetreestore.h"
65 #include "keyframetree.h"
67 #include "dialog_waypoint.h"
68 #include "dialog_keyframe.h"
69 #include "framedial.h"
70 #include "toggleducksdial.h"
71 #include "resolutiondial.h"
73 #include "duckmatic.h"
74 #include <gtkmm/scale.h>
76 #include <gtkmm/uimanager.h>
83 #include <gtkmm/toggleaction.h>
84 #include <gtkmm/radioaction.h>
85 #include <synfig/rect.h>
87 #include "adjust_window.h"
89 #include <synfig/transform.h>
91 /* === M A C R O S ========================================================= */
93 #ifndef DEBUGPOINT_CLASS
95 #define DEBUGPOINT_CLASS(x) struct debugpointclass_ ## x { debugpointclass_ ## x () { DEBUGPOINT(); } ~debugpointclass_ ## x () { DEBUGPOINT(); } } badfthguae_ ## x ;
97 #define DEBUGPOINT_CLASS(x)
101 /* === T Y P E D E F S ===================================================== */
103 /* === C L A S S E S & S T R U C T S ======================================= */
106 class TransformStack;
111 class CanvasViewUIInterface;
112 class CanvasViewSelectionManager;
114 class CellRenderer_TimeTrack;
115 class CellRenderer_ValueBase;
116 class UniversalScrubber;
123 class AudioContainer;
126 class Widget_Timeslider;
129 class Dialog_SoundSelect;
130 class Dialog_Preview;
134 class Dock_Keyframes;
136 class CanvasView : public Gtk::Window, public etl::shared_object
138 friend class UniversalScrubber;
139 friend class Dock_Layers;
140 friend class Dock_Children;
141 friend class Dock_Keyframes;
143 friend class CanvasViewUIInterface;
144 friend class CanvasViewSelectionManager;
146 friend class Duckmatic;
149 -- ** -- P U B L I C T Y P E S ---------------------------------------------
154 typedef etl::handle<CanvasView> Handle;
156 typedef etl::handle<const CanvasView> ConstHandle;
158 typedef etl::loose_handle<CanvasView> LooseHandle;
160 typedef LayerTreeStore::Model LayerTreeModel;
162 typedef ChildrenTreeStore::Model ChildrenTreeModel;
164 //! Create an instance of this class whenever doing a longer task.
165 /*! Make sure that you check the bool value of this class occasionally
166 ** to make sure the action has not been canceled. */
169 CanvasView &canvas_view_;
172 IsWorking(CanvasView &canvas_view_);
174 operator bool()const;
176 friend class IsWorking;
178 typedef synfigapp::CanvasInterface::Mode Mode;
180 void set_grid_snap_toggle(bool flag) { grid_snap_toggle->set_active(flag); }
181 void set_grid_show_toggle(bool flag) { grid_show_toggle->set_active(flag); }
184 -- ** -- P R I V A T E D A T A ---------------------------------------------
188 std::auto_ptr<WorkArea> work_area;
190 WorkArea* get_work_area() { return work_area.get(); }
193 synfig::TransformStack curr_transform_stack;
194 bool curr_transform_stack_set;
198 // DEBUGPOINT_CLASS(1);
203 // DEBUGPOINT_CLASS(2);
205 etl::loose_handle<Instance> instance_;
206 etl::handle<synfigapp::CanvasInterface> canvas_interface_;
208 // DEBUGPOINT_CLASS(3);
210 //! Sound and information to play it
211 etl::handle<AudioContainer> audio;
212 studio::Widget_Sound *disp_audio; //should this be put into thing too?
214 sigc::connection playcon;
215 sigc::connection stopcon;
217 std::auto_ptr<UniversalScrubber> universal_scrubber;
219 //! Tooltip controller
220 Gtk::Tooltips tooltips;
222 // DEBUGPOINT_CLASS(4);
224 //! TreeModel for the layers
225 LayerTreeModel layer_tree_model;
227 //! TreeModel for the the children
228 ChildrenTreeModel children_tree_model;
230 //Glib::RefPtr<LayerTreeStore> layer_tree_store_;
232 //Glib::RefPtr<ChildrenTreeStore> children_tree_store_;
234 //Glib::RefPtr<KeyframeTreeStore> keyframe_tree_store_;
236 // DEBUGPOINT_CLASS(5);
238 //std::map<synfig::String,Glib::RefPtr<Gtk::TreeModel> > tree_model_book_;
239 std::map<synfig::String,Glib::RefPtr<Glib::ObjectBase> > ref_obj_book_;
240 std::map<synfig::String,Gtk::Widget*> ext_widget_book_;
242 //! The time adjustment's scope is defined by the time_window adjustment
243 Gtk::Adjustment time_adjustment_;
245 //! The time_window adjustment governs the position of the time window on the whole time line
246 //Gtk::Adjustment time_window_adjustment_;
247 studio::Adjust_Window time_window_adjustment_;
249 LayerTree *layer_tree;
251 ChildrenTree *children_tree;
253 KeyframeTree *keyframe_tree;
255 Gtk::Widget *keyframe_tab_child;
257 Gtk::ProgressBar *progressbar;
258 Gtk::Statusbar *statusbar;
260 Gtk::TreeRow children_canvas_row;
261 Gtk::TreeRow children_valuenode_row;
263 Gtk::Button *stopbutton;
264 Gtk::Button *refreshbutton;
265 Gtk::Button *treetogglebutton; // not used
266 Gtk::Notebook *notebook; // not used
268 Gtk::Table *displaybar;
269 Gtk::Button *animatebutton;
270 Gtk::Button *keyframebutton;
271 FrameDial *framedial;
272 ToggleDucksDial *toggleducksdial;
273 bool toggling_ducks_;
274 ResolutionDial *resolutiondial;
275 bool changing_resolution_;
276 Gtk::Adjustment quality_adjustment_;
277 Gtk::SpinButton *quality_spin;
278 bool updating_quality_;
279 Gtk::CheckButton *show_grid;
280 bool toggling_show_grid;
281 //! Shows current time and allows edition
282 Widget_Time *current_time_widget;
283 void on_current_time_widget_changed();
285 //! Time slider class. Same than the Time track panel
286 std::auto_ptr<Widget_Timeslider> timeslider;
288 std::list<sigc::connection> duck_changed_connections;
290 /* DEBUGPOINT_CLASS(8);
292 Gtk::Menu duckmaskmenu;
293 DEBUGPOINT_CLASS(77);
294 Gtk::Menu qualitymenu;
298 DEBUGPOINT_CLASS(777);
300 DEBUGPOINT_CLASS(71);
301 Gtk::Menu canvasmenu;
302 DEBUGPOINT_CLASS(73);
306 DEBUGPOINT_CLASS(74);
307 Gtk::Menu newlayermenu;
308 DEBUGPOINT_CLASS(76);
311 DEBUGPOINT_CLASS(99);
312 Gtk::Menu keyframemenu;
319 Gtk::CheckMenuItem* duck_mask_position;
320 Gtk::CheckMenuItem* duck_mask_vertex;
321 Gtk::CheckMenuItem* duck_mask_tangent;
322 Gtk::CheckMenuItem* duck_mask_radius;
323 Gtk::CheckMenuItem* duck_mask_width;
324 Gtk::CheckMenuItem* duck_mask_angle;
329 Glib::RefPtr<Gtk::ToggleAction> grid_snap_toggle;
330 Glib::RefPtr<Gtk::ToggleAction> grid_show_toggle;
332 Gtk::RadioButtonGroup quality_group;
333 Gtk::RadioButtonGroup low_res_pixel_size_group;
335 Glib::RefPtr<Gtk::ActionGroup> action_group;
337 etl::handle<synfigapp::UIInterface> ui_interface_;
338 etl::handle<synfigapp::SelectionManager> selection_manager_;
342 sigc::signal<void> signal_deleted_;
344 bool rebuild_ducks_queued;
345 sigc::connection queue_rebuild_ducks_connection;
348 -- ** -- P U B L I C D A T A -----------------------------------------------
352 void queue_rebuild_ducks();
353 sigc::signal<void>& signal_deleted() { return signal_deleted_; }
357 bool duck_refresh_flag;
358 bool duck_refresh_needed;
360 //! This is for the IsWorking class.
366 -- ** -- D I A L O G S -------------------------------------------------------
371 CanvasProperties canvas_properties;
372 CanvasOptions canvas_options;
373 RenderSettings render_settings;
374 Dialog_Waypoint waypoint_dialog;
375 Dialog_Keyframe keyframe_dialog;
377 std::auto_ptr<Dialog_Preview> preview_dialog;
378 //std::auto_ptr<Dialog_PreviewOptions> previewoption_dialog;
379 std::auto_ptr<Dialog_SoundSelect> sound_dialog;
382 -- ** -- P R I V A T E M E T H O D S ---------------------------------------
387 // Constructor is private to force the use of the "create()" constructor
388 CanvasView(etl::loose_handle<Instance> instance,etl::handle<synfigapp::CanvasInterface> canvas_interface);
390 //! Constructor Helper
391 // Gtk::Widget* create_layer_tree();
393 //! Constructor Helper
394 // Gtk::Widget* create_children_tree();
396 //! Constructor Helper
397 // Gtk::Widget* create_keyframe_tree();
399 //! Constructor Helper
400 Gtk::Widget* create_status_bar();
402 //! Constructor Helper - Initializes all of the menus
405 bool duck_change_param(const synfig::Point &value,synfig::Layer::Handle layer, synfig::String param_name);
407 void refresh_time_window();
409 void time_was_changed();
411 void refresh_rend_desc();
413 void toggle_duck_mask(Duckmatic::Type type);
415 Gtk::Widget *create_work_area();
417 Gtk::Widget *create_time_bar();
419 Gtk::Widget *create_display_bar();
421 //! Pop up menu for the bezier (bline, draw) tool (?)
422 void popup_param_menu_bezier(float location, synfigapp::ValueDesc value_desc)
423 { popup_param_menu(value_desc,location,true); }
425 //! Pop up menu for the tools but not the bezier ones.
426 void popup_param_menu(synfigapp::ValueDesc value_desc, float location=0, bool bezier=false);
428 void workarea_layer_selected(synfig::Layer::Handle layer);
430 void selected_layer_color_set(synfig::Color color);
432 void register_layer_type(synfig::Layer::Book::value_type &lyr,std::map<synfig::String,Gtk::Menu*>*);
434 //! Rebuilds the "new layer" menu
435 void build_new_layer_menu(Gtk::Menu &menu);
437 void rebuild_ducks_layer_(synfig::TransformStack& transform_stack, synfig::Canvas::Handle canvas, std::set<synfig::Layer::Handle>& selected_list);
439 void decrease_low_res_pixel_size();
440 void increase_low_res_pixel_size();
441 void toggle_low_res_pixel_flag();
442 void set_quality(int x);
443 void toggle_show_grid();
446 -- ** -- P U B L I C M E T H O D S -----------------------------------------
450 const synfig::TransformStack& get_curr_transform_stack()const { return curr_transform_stack; }
452 const synfig::Rect& get_bbox()const { return bbox; }
454 Glib::RefPtr<Glib::ObjectBase> get_ref_obj(const synfig::String& x);
455 Glib::RefPtr<const Glib::ObjectBase> get_ref_obj(const synfig::String& x)const;
456 void set_ref_obj(const synfig::String& x, Glib::RefPtr<Glib::ObjectBase> y);
458 Glib::RefPtr<Gtk::TreeModel> get_tree_model(const synfig::String& x);
459 Glib::RefPtr<const Gtk::TreeModel> get_tree_model(const synfig::String& x)const;
460 void set_tree_model(const synfig::String& x, Glib::RefPtr<Gtk::TreeModel> y);
462 Gtk::Widget* get_ext_widget(const synfig::String& x);
463 void set_ext_widget(const synfig::String& x, Gtk::Widget* y);
465 //std::map<synfig::String,Gtk::Widget*>& tree_view_book() { return tree_view_book_; }
466 //std::map<synfig::String,Gtk::Widget*>& ext_widget_book() { return tree_view_book_; }
468 void popup_main_menu();
470 Smach& get_smach() { return smach_; }
472 const Smach& get_smach()const { return smach_; }
474 Smach::event_result process_event_key(EventKey x);
476 void popup_layer_menu(synfig::Layer::Handle layer);
478 virtual ~CanvasView();
480 void set_mode(Mode x) { canvas_interface()->set_mode(x); }
482 Mode get_mode()const { return canvas_interface()->get_mode(); }
484 Gtk::Adjustment &time_adjustment() { return time_adjustment_; }
486 const Gtk::Adjustment &time_adjustment()const { return time_adjustment_; }
488 studio::Adjust_Window &time_window_adjustment() { return time_window_adjustment_; }
490 const studio::Adjust_Window &time_window_adjustment()const { return time_window_adjustment_; }
492 etl::handle<synfigapp::UIInterface> get_ui_interface() { return ui_interface_;}
494 etl::handle<synfigapp::SelectionManager> get_selection_manager() { return selection_manager_; }
496 Glib::RefPtr<Gtk::TreeModel> layer_tree_store() { return get_tree_model("layers"); }
498 Glib::RefPtr<const Gtk::TreeModel> layer_tree_store()const { return get_tree_model("layers"); }
500 Glib::RefPtr<Gtk::TreeModel> children_tree_store() { return get_tree_model("children"); }
502 Glib::RefPtr<const Gtk::TreeModel> children_tree_store()const { return get_tree_model("children"); }
504 Glib::RefPtr<Gtk::TreeModel> keyframe_tree_store() { return get_tree_model("keyframes"); }
506 Glib::RefPtr<const Gtk::TreeModel> keyframe_tree_store()const { return get_tree_model("keyframes"); }
508 void set_time(synfig::Time t) { canvas_interface_->set_time(t); }
510 synfig::Time get_time() { return canvas_interface_->get_time(); }
512 etl::handle<synfig::Canvas> get_canvas()const { return canvas_interface_->get_canvas(); }
514 etl::handle<Instance> get_instance()const { return instance_; }
516 etl::handle<synfigapp::CanvasInterface> canvas_interface() { return canvas_interface_; }
518 etl::handle<const synfigapp::CanvasInterface> canvas_interface()const { return canvas_interface_; }
520 void add_actions_to_menu(Gtk::Menu *menu, const synfigapp::Action::ParamList ¶m_list, synfigapp::Action::Category category=synfigapp::Action::CATEGORY_ALL)const;
522 //! Updates the title of the window
525 //! Closes this document
526 bool close_instance();
528 //! Closes this canvas view
531 //! Stops the currently executing action
532 /*! \see get_cancel_status(), reset_cancel_status(), IsWorking */
533 void stop() { cancel=true; }
535 //! Returns the cancel status
536 /*! \see stop(), reset_cancel_status(), IsWorking */
537 bool get_cancel_status()const { return cancel; }
539 //! Resets the cancel status
540 /*! \see stop(), get_cancel_status(), IsWorking */
541 void reset_cancel_status() { cancel=false; }
543 void new_child_canvas();
545 //! Rebuilds layer_tree_store_ from the Canvas. Maintains selected items.
546 void rebuild_tables();
548 //! Builds layer_tree_store_ from the Canvas. Does not maintain selected items.
551 //! Refreshes the data for the tables
552 void refresh_tables();
554 //void rebuild_layer_table();
555 //void build_layer_table();
556 //void refresh_layer_table();
558 // void rebuild_canvas_table();
559 // void build_canvas_table();
560 // void refresh_canvas_table();
562 // void rebuild_valuenode_table();
563 // void build_valuenode_table();
564 // void refresh_valuenode_table();
567 void rebuild_ducks();
569 //bool add_to_ducks(synfigapp::ValueDesc value_desc, synfig::ParamDesc *param_desc=NULL);
571 //! Starts "playing" the animation in real-time
574 //! Shows the tables (Layer/Children)
577 //! Hides the tables (Layer/Children)
580 //! Toggles the tables
581 void toggle_tables();
583 //! Gets the table status
584 bool tables_are_visible();
586 //! Shows the time bar
589 //! Hides the time bar
592 //t Enables or disables interaction with the timebar
593 void set_sensitive_timebar(bool sensitive);
596 void time_zoom_out();
598 void add_layer(synfig::String x);
600 void show_keyframe_dialog();
602 void play_audio(float t);
607 void on_waypoint_clicked_canvasview(synfigapp::ValueDesc,std::set<synfig::Waypoint,std::less<synfig::UniqueID> >, int button);
609 void preview_option() {on_preview_option();}
613 bool is_playing() { return is_playing_; }
615 void update_quality();
618 -- ** -- S I G N A L T E R M I N A L S -------------------------------------
623 void on_select_layers();
624 void on_unselect_layers();
626 void on_input_device_changed(GdkDevice*);
628 virtual void on_hide();
630 virtual bool on_focus_in_event(GdkEventFocus*);
631 virtual bool on_focus_out_event(GdkEventFocus*);
633 //bool on_children_tree_event(GdkEvent *event);
635 bool on_keyframe_tree_event(GdkEvent *event);
637 //void on_children_edited_value(const Glib::ustring&path_string,synfig::ValueBase value);
639 void on_dirty_preview();
641 bool on_children_user_click(int, Gtk::TreeRow, ChildrenTree::ColumnID);
643 bool on_layer_user_click(int, Gtk::TreeRow, LayerTree::ColumnID);
645 // void on_layer_toggle(const Glib::ustring& path_string, Gtk::TreeModelColumn<bool> column);
647 void on_mode_changed(synfigapp::CanvasInterface::Mode mode);
649 // void on_layer_waypoint_clicked(const Glib::ustring &, synfig::ValueNode_Animated::WaypointList::iterator);
651 //void on_children_waypoint_clicked(const Glib::ustring &, synfig::ValueNode_Animated::WaypointList::iterator);
653 void on_waypoint_changed();
655 void on_waypoint_delete();
657 void on_refresh_pressed();
659 void on_id_changed();
661 void on_time_changed();
664 void on_layer_raise_pressed();
665 void on_layer_lower_pressed();
666 void on_layer_duplicate_pressed();
667 void on_layer_delete_pressed();
670 void on_keyframe_add_pressed();
672 void on_keyframe_duplicate_pressed();
674 void on_keyframe_remove_pressed();
676 void on_animate_button_pressed();
678 void on_keyframe_button_pressed();
680 void on_preview_option();
681 void on_preview_create(const PreviewInfo &);
683 void on_audio_option();
684 void on_audio_file_change(const std::string &f);
685 void on_audio_offset_change(const synfig::Time &t);
687 void on_audio_file_notify();
688 void on_audio_offset_notify();
690 bool on_duck_changed(const synfig::Point &value,const synfigapp::ValueDesc& value_desc);
691 bool on_duck_angle_changed(const synfig::Angle &rotation,const synfigapp::ValueDesc& value_desc);
693 void on_layer_toggle(synfig::Layer::Handle);
695 void on_edited_value(synfigapp::ValueDesc,synfig::ValueBase);
697 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);
699 //void on_audio_play();
700 bool on_audio_scrub();
702 void on_play_stop_pressed();
705 bool close_instance_when_safe();
706 bool on_delete_event(GdkEventAny* event);
709 -- ** -- S T A T I C P U B L I C M E T H O D S ---------------------------
714 static etl::handle<studio::CanvasView> create(etl::loose_handle<Instance> instance,etl::handle<synfig::Canvas> canvas);
715 static std::list<int>& get_pixel_sizes();
717 }; // END of class CanvasView
719 }; // END of namespace studio
721 /* === E N D =============================================================== */