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>
45 #include <synfigapp/canvasinterface.h>
46 #include <synfigapp/selectionmanager.h>
48 #include <synfig/canvas.h>
49 #include <synfig/string.h>
50 #include <synfig/time.h>
53 #include "canvasproperties.h"
54 #include "canvasoptions.h"
56 #include "cellrenderer_timetrack.h"
59 #include "layertreestore.h"
60 #include "layertree.h"
61 #include "childrentreestore.h"
62 #include "childrentree.h"
63 #include "keyframetreestore.h"
64 #include "keyframetree.h"
66 #include "dialog_waypoint.h"
67 #include "dialog_keyframe.h"
68 #include "framedial.h"
69 #include "toggleducksdial.h"
71 #include "duckmatic.h"
72 #include <gtkmm/scale.h>
74 #include <gtkmm/uimanager.h>
81 #include <gtkmm/toggleaction.h>
82 #include <gtkmm/radioaction.h>
83 #include <synfig/rect.h>
85 #include "adjust_window.h"
87 #include <synfig/transform.h>
89 /* === M A C R O S ========================================================= */
91 #ifndef DEBUGPOINT_CLASS
93 #define DEBUGPOINT_CLASS(x) struct debugpointclass_ ## x { debugpointclass_ ## x () { DEBUGPOINT(); } ~debugpointclass_ ## x () { DEBUGPOINT(); } } badfthguae_ ## x ;
95 #define DEBUGPOINT_CLASS(x)
99 /* === T Y P E D E F S ===================================================== */
101 /* === C L A S S E S & S T R U C T S ======================================= */
104 class TransformStack;
109 class CanvasViewUIInterface;
110 class CanvasViewSelectionManager;
112 class CellRenderer_TimeTrack;
113 class CellRenderer_ValueBase;
114 class UniversalScrubber;
121 class AudioContainer;
124 class Widget_Timeslider;
127 class Dialog_SoundSelect;
128 class Dialog_Preview;
132 class Dock_Keyframes;
134 class CanvasView : public Gtk::Window, public etl::shared_object
136 friend class UniversalScrubber;
137 friend class Dock_Layers;
138 friend class Dock_Children;
139 friend class Dock_Keyframes;
141 friend class CanvasViewUIInterface;
142 friend class CanvasViewSelectionManager;
144 friend class Duckmatic;
147 -- ** -- P U B L I C T Y P E S ---------------------------------------------
152 typedef etl::handle<CanvasView> Handle;
154 typedef etl::handle<const CanvasView> ConstHandle;
156 typedef etl::loose_handle<CanvasView> LooseHandle;
158 typedef LayerTreeStore::Model LayerTreeModel;
160 typedef ChildrenTreeStore::Model ChildrenTreeModel;
162 //! Create an instance of this class whenever doing a longer task.
163 /*! Make sure that you check the bool value of this class occasionally
164 ** to make sure the action has not been canceled. */
167 CanvasView &canvas_view_;
170 IsWorking(CanvasView &canvas_view_);
172 operator bool()const;
174 friend class IsWorking;
176 typedef synfigapp::CanvasInterface::Mode Mode;
178 void set_grid_snap_toggle(bool flag) { grid_snap_toggle->set_active(flag); }
179 void set_grid_show_toggle(bool flag) { grid_show_toggle->set_active(flag); }
182 -- ** -- P R I V A T E D A T A ---------------------------------------------
186 std::auto_ptr<WorkArea> work_area;
188 WorkArea* get_work_area() { return work_area.get(); }
191 synfig::TransformStack curr_transform_stack;
192 bool curr_transform_stack_set;
196 // DEBUGPOINT_CLASS(1);
201 // DEBUGPOINT_CLASS(2);
203 etl::loose_handle<Instance> instance_;
204 etl::handle<synfigapp::CanvasInterface> canvas_interface_;
206 // DEBUGPOINT_CLASS(3);
208 //! Sound and information to play it
209 etl::handle<AudioContainer> audio;
210 studio::Widget_Sound *disp_audio; //should this be put into thing too?
212 sigc::connection playcon;
213 sigc::connection stopcon;
215 std::auto_ptr<UniversalScrubber> universal_scrubber;
217 //! Tooltip controller
218 Gtk::Tooltips tooltips;
220 // DEBUGPOINT_CLASS(4);
222 //! TreeModel for the layers
223 LayerTreeModel layer_tree_model;
225 //! TreeModel for the the children
226 ChildrenTreeModel children_tree_model;
228 //Glib::RefPtr<LayerTreeStore> layer_tree_store_;
230 //Glib::RefPtr<ChildrenTreeStore> children_tree_store_;
232 //Glib::RefPtr<KeyframeTreeStore> keyframe_tree_store_;
234 // DEBUGPOINT_CLASS(5);
236 //std::map<synfig::String,Glib::RefPtr<Gtk::TreeModel> > tree_model_book_;
237 std::map<synfig::String,Glib::RefPtr<Glib::ObjectBase> > ref_obj_book_;
238 std::map<synfig::String,Gtk::Widget*> ext_widget_book_;
240 //! The time adjustment's scope is defined by the time_window adjustment
241 Gtk::Adjustment time_adjustment_;
243 //! The time_window adjustment governs the position of the time window on the whole time line
244 //Gtk::Adjustment time_window_adjustment_;
245 studio::Adjust_Window time_window_adjustment_;
247 LayerTree *layer_tree;
249 ChildrenTree *children_tree;
251 KeyframeTree *keyframe_tree;
253 Gtk::Widget *keyframe_tab_child;
255 Gtk::ProgressBar *progressbar;
256 Gtk::Statusbar *statusbar;
258 Gtk::TreeRow children_canvas_row;
259 Gtk::TreeRow children_valuenode_row;
261 Gtk::Button *stopbutton;
262 Gtk::Button *refreshbutton;
263 Gtk::Button *treetogglebutton; // not used
264 Gtk::Notebook *notebook; // not used
266 Gtk::Table *displaybar;
267 Gtk::Button *animatebutton;
268 Gtk::Button *keyframebutton;
269 FrameDial *framedial;
270 ToggleDucksDial *toggleducksdial;
271 bool toggling_ducks_;
274 //! Shows current time and allows edition
275 Widget_Time *current_time_widget;
276 void on_current_time_widget_changed();
278 //! Time slider class. Same than the Time track panel
279 std::auto_ptr<Widget_Timeslider> timeslider;
281 std::list<sigc::connection> duck_changed_connections;
283 /* DEBUGPOINT_CLASS(8);
285 Gtk::Menu duckmaskmenu;
286 DEBUGPOINT_CLASS(77);
287 Gtk::Menu qualitymenu;
291 DEBUGPOINT_CLASS(777);
293 DEBUGPOINT_CLASS(71);
294 Gtk::Menu canvasmenu;
295 DEBUGPOINT_CLASS(73);
299 DEBUGPOINT_CLASS(74);
300 Gtk::Menu newlayermenu;
301 DEBUGPOINT_CLASS(76);
304 DEBUGPOINT_CLASS(99);
305 Gtk::Menu keyframemenu;
312 Gtk::CheckMenuItem* duck_mask_position;
313 Gtk::CheckMenuItem* duck_mask_vertex;
314 Gtk::CheckMenuItem* duck_mask_tangent;
315 Gtk::CheckMenuItem* duck_mask_radius;
316 Gtk::CheckMenuItem* duck_mask_width;
317 Gtk::CheckMenuItem* duck_mask_angle;
322 Glib::RefPtr<Gtk::ToggleAction> grid_snap_toggle;
323 Glib::RefPtr<Gtk::ToggleAction> grid_show_toggle;
325 Gtk::RadioButtonGroup quality_group;
326 Gtk::RadioButtonGroup low_res_pixel_size_group;
328 Glib::RefPtr<Gtk::ActionGroup> action_group;
330 etl::handle<synfigapp::UIInterface> ui_interface_;
331 etl::handle<synfigapp::SelectionManager> selection_manager_;
335 sigc::signal<void> signal_deleted_;
337 bool rebuild_ducks_queued;
338 sigc::connection queue_rebuild_ducks_connection;
341 -- ** -- P U B L I C D A T A -----------------------------------------------
345 void queue_rebuild_ducks();
346 sigc::signal<void>& signal_deleted() { return signal_deleted_; }
350 bool duck_refresh_flag;
351 bool duck_refresh_needed;
353 //! This is for the IsWorking class.
359 -- ** -- D I A L O G S -------------------------------------------------------
364 CanvasProperties canvas_properties;
365 CanvasOptions canvas_options;
366 RenderSettings render_settings;
367 Dialog_Waypoint waypoint_dialog;
368 Dialog_Keyframe keyframe_dialog;
370 std::auto_ptr<Dialog_Preview> preview_dialog;
371 //std::auto_ptr<Dialog_PreviewOptions> previewoption_dialog;
372 std::auto_ptr<Dialog_SoundSelect> sound_dialog;
375 -- ** -- P R I V A T E M E T H O D S ---------------------------------------
380 // Constructor is private to force the use of the "create()" constructor
381 CanvasView(etl::loose_handle<Instance> instance,etl::handle<synfigapp::CanvasInterface> canvas_interface);
383 //! Constructor Helper
384 // Gtk::Widget* create_layer_tree();
386 //! Constructor Helper
387 // Gtk::Widget* create_children_tree();
389 //! Constructor Helper
390 // Gtk::Widget* create_keyframe_tree();
392 //! Constructor Helper
393 Gtk::Widget* create_status_bar();
395 //! Constructor Helper - Initializes all of the menus
398 bool duck_change_param(const synfig::Point &value,synfig::Layer::Handle layer, synfig::String param_name);
400 void refresh_time_window();
402 void time_was_changed();
404 void refresh_rend_desc();
406 void toggle_duck_mask(Duckmatic::Type type);
408 Gtk::Widget *create_work_area();
410 Gtk::Widget *create_time_bar();
412 Gtk::Widget *create_display_bar();
414 //! Pop up menu for the bezier (bline, draw) tool (?)
415 void popup_param_menu_bezier(float location, synfigapp::ValueDesc value_desc)
416 { popup_param_menu(value_desc,location,true); }
418 //! Pop up menu for the tools but not the bezier ones.
419 void popup_param_menu(synfigapp::ValueDesc value_desc, float location=0, bool bezier=false);
421 void workarea_layer_selected(synfig::Layer::Handle layer);
423 void selected_layer_color_set(synfig::Color color);
425 void register_layer_type(synfig::Layer::Book::value_type &lyr,std::map<synfig::String,Gtk::Menu*>*);
427 //! Rebuilds the "new layer" menu
428 void build_new_layer_menu(Gtk::Menu &menu);
430 void rebuild_ducks_layer_(synfig::TransformStack& transform_stack, synfig::Canvas::Handle canvas, std::set<synfig::Layer::Handle>& selected_list);
432 void decrease_low_res_pixel_size();
433 void increase_low_res_pixel_size();
436 -- ** -- P U B L I C M E T H O D S -----------------------------------------
440 const synfig::TransformStack& get_curr_transform_stack()const { return curr_transform_stack; }
442 const synfig::Rect& get_bbox()const { return bbox; }
444 Glib::RefPtr<Glib::ObjectBase> get_ref_obj(const synfig::String& x);
445 Glib::RefPtr<const Glib::ObjectBase> get_ref_obj(const synfig::String& x)const;
446 void set_ref_obj(const synfig::String& x, Glib::RefPtr<Glib::ObjectBase> y);
448 Glib::RefPtr<Gtk::TreeModel> get_tree_model(const synfig::String& x);
449 Glib::RefPtr<const Gtk::TreeModel> get_tree_model(const synfig::String& x)const;
450 void set_tree_model(const synfig::String& x, Glib::RefPtr<Gtk::TreeModel> y);
452 Gtk::Widget* get_ext_widget(const synfig::String& x);
453 void set_ext_widget(const synfig::String& x, Gtk::Widget* y);
455 //std::map<synfig::String,Gtk::Widget*>& tree_view_book() { return tree_view_book_; }
456 //std::map<synfig::String,Gtk::Widget*>& ext_widget_book() { return tree_view_book_; }
458 void popup_main_menu();
460 Smach& get_smach() { return smach_; }
462 const Smach& get_smach()const { return smach_; }
464 Smach::event_result process_event_key(EventKey x);
466 void popup_layer_menu(synfig::Layer::Handle layer);
468 virtual ~CanvasView();
470 void set_mode(Mode x) { canvas_interface()->set_mode(x); }
472 Mode get_mode()const { return canvas_interface()->get_mode(); }
474 Gtk::Adjustment &time_adjustment() { return time_adjustment_; }
476 const Gtk::Adjustment &time_adjustment()const { return time_adjustment_; }
478 studio::Adjust_Window &time_window_adjustment() { return time_window_adjustment_; }
480 const studio::Adjust_Window &time_window_adjustment()const { return time_window_adjustment_; }
482 etl::handle<synfigapp::UIInterface> get_ui_interface() { return ui_interface_;}
484 etl::handle<synfigapp::SelectionManager> get_selection_manager() { return selection_manager_; }
486 Glib::RefPtr<Gtk::TreeModel> layer_tree_store() { return get_tree_model("layers"); }
488 Glib::RefPtr<const Gtk::TreeModel> layer_tree_store()const { return get_tree_model("layers"); }
490 Glib::RefPtr<Gtk::TreeModel> children_tree_store() { return get_tree_model("children"); }
492 Glib::RefPtr<const Gtk::TreeModel> children_tree_store()const { return get_tree_model("children"); }
494 Glib::RefPtr<Gtk::TreeModel> keyframe_tree_store() { return get_tree_model("keyframes"); }
496 Glib::RefPtr<const Gtk::TreeModel> keyframe_tree_store()const { return get_tree_model("keyframes"); }
498 void set_time(synfig::Time t) { canvas_interface_->set_time(t); }
500 synfig::Time get_time() { return canvas_interface_->get_time(); }
502 etl::handle<synfig::Canvas> get_canvas()const { return canvas_interface_->get_canvas(); }
504 etl::handle<Instance> get_instance()const { return instance_; }
506 etl::handle<synfigapp::CanvasInterface> canvas_interface() { return canvas_interface_; }
508 etl::handle<const synfigapp::CanvasInterface> canvas_interface()const { return canvas_interface_; }
510 void add_actions_to_menu(Gtk::Menu *menu, const synfigapp::Action::ParamList ¶m_list, synfigapp::Action::Category category=synfigapp::Action::CATEGORY_ALL)const;
512 //! Updates the title of the window
515 //! Closes this document
516 bool close_instance();
518 //! Closes this canvas view
521 //! Stops the currently executing action
522 /*! \see get_cancel_status(), reset_cancel_status(), IsWorking */
523 void stop() { cancel=true; }
525 //! Returns the cancel status
526 /*! \see stop(), reset_cancel_status(), IsWorking */
527 bool get_cancel_status()const { return cancel; }
529 //! Resets the cancel status
530 /*! \see stop(), get_cancel_status(), IsWorking */
531 void reset_cancel_status() { cancel=false; }
533 void new_child_canvas();
535 //! Rebuilds layer_tree_store_ from the Canvas. Maintains selected items.
536 void rebuild_tables();
538 //! Builds layer_tree_store_ from the Canvas. Does not maintain selected items.
541 //! Refreshes the data for the tables
542 void refresh_tables();
544 //void rebuild_layer_table();
545 //void build_layer_table();
546 //void refresh_layer_table();
548 // void rebuild_canvas_table();
549 // void build_canvas_table();
550 // void refresh_canvas_table();
552 // void rebuild_valuenode_table();
553 // void build_valuenode_table();
554 // void refresh_valuenode_table();
557 void rebuild_ducks();
559 //bool add_to_ducks(synfigapp::ValueDesc value_desc, synfig::ParamDesc *param_desc=NULL);
561 //! Starts "playing" the animation in real-time
564 //! Shows the tables (Layer/Children)
567 //! Hides the tables (Layer/Children)
570 //! Toggles the tables
571 void toggle_tables();
573 //! Gets the table status
574 bool tables_are_visible();
576 //! Shows the time bar
579 //! Hides the time bar
582 //t Enables or disables interaction with the timebar
583 void set_sensitive_timebar(bool sensitive);
586 void time_zoom_out();
588 void add_layer(synfig::String x);
590 void show_keyframe_dialog();
592 void play_audio(float t);
597 void on_waypoint_clicked_canvasview(synfigapp::ValueDesc,std::set<synfig::Waypoint,std::less<synfig::UniqueID> >, int button);
599 void preview_option() {on_preview_option();}
603 bool is_playing() { return is_playing_; }
606 -- ** -- S I G N A L T E R M I N A L S -------------------------------------
611 void on_select_layers();
612 void on_unselect_layers();
614 void on_input_device_changed(GdkDevice*);
616 virtual void on_hide();
618 virtual bool on_focus_in_event(GdkEventFocus*);
619 virtual bool on_focus_out_event(GdkEventFocus*);
621 //bool on_children_tree_event(GdkEvent *event);
623 bool on_keyframe_tree_event(GdkEvent *event);
625 //void on_children_edited_value(const Glib::ustring&path_string,synfig::ValueBase value);
627 void on_dirty_preview();
629 bool on_children_user_click(int, Gtk::TreeRow, ChildrenTree::ColumnID);
631 bool on_layer_user_click(int, Gtk::TreeRow, LayerTree::ColumnID);
633 // void on_layer_toggle(const Glib::ustring& path_string, Gtk::TreeModelColumn<bool> column);
635 void on_mode_changed(synfigapp::CanvasInterface::Mode mode);
637 // void on_layer_waypoint_clicked(const Glib::ustring &, synfig::ValueNode_Animated::WaypointList::iterator);
639 //void on_children_waypoint_clicked(const Glib::ustring &, synfig::ValueNode_Animated::WaypointList::iterator);
641 void on_waypoint_changed();
643 void on_waypoint_delete();
645 void on_refresh_pressed();
647 void on_id_changed();
649 void on_time_changed();
652 void on_layer_raise_pressed();
653 void on_layer_lower_pressed();
654 void on_layer_duplicate_pressed();
655 void on_layer_delete_pressed();
658 void on_keyframe_add_pressed();
660 void on_keyframe_duplicate_pressed();
662 void on_keyframe_remove_pressed();
664 void on_animate_button_pressed();
666 void on_keyframe_button_pressed();
668 void on_preview_option();
669 void on_preview_create(const PreviewInfo &);
671 void on_audio_option();
672 void on_audio_file_change(const std::string &f);
673 void on_audio_offset_change(const synfig::Time &t);
675 void on_audio_file_notify();
676 void on_audio_offset_notify();
678 bool on_duck_changed(const synfig::Point &value,const synfigapp::ValueDesc& value_desc);
679 bool on_duck_angle_changed(const synfig::Angle &rotation,const synfigapp::ValueDesc& value_desc);
681 void on_layer_toggle(synfig::Layer::Handle);
683 void on_edited_value(synfigapp::ValueDesc,synfig::ValueBase);
685 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);
687 //void on_audio_play();
688 bool on_audio_scrub();
690 void on_play_stop_pressed();
693 bool close_instance_when_safe();
694 bool on_delete_event(GdkEventAny* event);
697 -- ** -- S T A T I C P U B L I C M E T H O D S ---------------------------
702 static etl::handle<studio::CanvasView> create(etl::loose_handle<Instance> instance,etl::handle<synfig::Canvas> canvas);
703 static std::list<int>& get_pixel_sizes();
705 }; // END of class CanvasView
707 }; // END of namespace studio
709 /* === E N D =============================================================== */