synfig-studio/trunk/src/synfigapp/canvasinterface.h

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file canvasinterface.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_APP_CANVASINTERFACE_H
  27 #define __SYNFIG_APP_CANVASINTERFACE_H
  28
  29 /* === H E A D E R S ======================================================= */
  30
  31 //#include <synfig/canvas.h>
  32 #include <synfig/value.h>
  33 #include <sigc++/signal.h>
  34 #include <sigc++/object.h>
  35 #include <list>
  36 #include "selectionmanager.h"
  37 #include "uimanager.h"
  38 #include "value_desc.h"
  39 #include "editmode.h"
  40
  41 /* === M A C R O S ========================================================= */
  42
  43 /* === T Y P E D E F S ===================================================== */
  44
  45 /* === C L A S S E S & S T R U C T S ======================================= */
  46
  47 namespace synfig { class ValueNode_DynamicList; class Waypoint; class GUIDSet; class Canvas; };
  48
  49 namespace synfigapp {
  50
  51 namespace Action { class ParamList; class Param; class EditModeSet; };
  52
  53 class Instance;
  54 class ValueDesc;
  55
  56 class CanvasInterface : public etl::shared_object, public sigc::trackable
  57 {
  58         friend class Instance;
  59         friend class Action::EditModeSet;
  60
  61 public:
  62
  63         typedef EditMode Mode;
  64
  65 private:
  66         // Constructor is private to force the use of the "create()" constructor.
  67         CanvasInterface(etl::loose_handle<Instance> instance,etl::handle<synfig::Canvas> canvas);
  68
  69 private:
  70         etl::loose_handle<Instance> instance_;
  71         etl::handle<synfig::Canvas> canvas_;
  72         etl::handle<SelectionManager> selection_manager_;
  73         etl::handle<UIInterface> ui_interface_;
  74         synfig::Time cur_time_;
  75         Mode mode_;
  76
  77         sigc::signal<void,synfig::Layer::Handle> signal_layer_raised_;
  78         sigc::signal<void,synfig::Layer::Handle> signal_layer_lowered_;
  79         sigc::signal<void,synfig::Layer::Handle,int> signal_layer_inserted_;
  80         sigc::signal<void,synfig::Layer::Handle,int,synfig::Canvas::Handle> signal_layer_moved_;
  81         sigc::signal<void,synfig::Layer::Handle> signal_layer_removed_;
  82         sigc::signal<void,synfig::Layer::Handle,bool> signal_layer_status_changed_;
  83         sigc::signal<void,synfig::Layer::Handle,synfig::String> signal_layer_new_description_;
  84         sigc::signal<void,synfig::Canvas::Handle> signal_canvas_added_;
  85         sigc::signal<void,synfig::Canvas::Handle> signal_canvas_removed_;
  86
  87         sigc::signal<void,synfig::ValueNode::Handle> signal_value_node_added_;
  88         sigc::signal<void,synfig::ValueNode::Handle> signal_value_node_deleted_;
  89         sigc::signal<void,synfig::ValueNode::Handle,synfig::ValueNode::Handle> signal_value_node_replaced_;
  90
  91         sigc::signal<void,synfig::Keyframe> signal_keyframe_added_;
  92         sigc::signal<void,synfig::Keyframe> signal_keyframe_removed_;
  93         sigc::signal<void,synfig::Keyframe> signal_keyframe_changed_;
  94
  95         sigc::signal<void> signal_id_changed_;
  96
  97         sigc::signal<void> signal_time_changed_;
  98
  99         sigc::signal<void> signal_rend_desc_changed_;
 100
 101         sigc::signal<void,Mode> signal_mode_changed_;
 102
 103         //sigc::signal<void> signal_dirty_preview_;
 104
 105         sigc::signal<void,synfig::Layer::Handle,synfig::String> signal_layer_param_changed_;
 106
 107 public: // Signal Interface
 108
 109         sigc::signal<void,synfig::Layer::Handle,int,synfig::Canvas::Handle>& signal_layer_moved() { return signal_layer_moved_; }
 110
 111         sigc::signal<void,synfig::Layer::Handle,synfig::String>& signal_layer_new_description() { return signal_layer_new_description_; }
 112
 113         //! Signal called when layer is raised.
 114         sigc::signal<void,synfig::Layer::Handle>& signal_layer_raised() { return signal_layer_raised_; }
 115
 116         //! Signal called when layer is lowered.
 117         sigc::signal<void,synfig::Layer::Handle>& signal_layer_lowered() { return signal_layer_lowered_; }
 118
 119         //! Signal called when layer has been inserted at a given position.
 120         sigc::signal<void,synfig::Layer::Handle,int>& signal_layer_inserted() { return signal_layer_inserted_; }
 121
 122         //! Signal called when a layer has been removed from the canvas.
 123         sigc::signal<void,synfig::Layer::Handle>& signal_layer_removed() { return signal_layer_removed_; }
 124
 125         //! Signal called when the layer's active status has changed.
 126         sigc::signal<void,synfig::Layer::Handle,bool>& signal_layer_status_changed() { return signal_layer_status_changed_; }
 127
 128         //! Signal called when a canvas has been added.
 129         sigc::signal<void,etl::handle<synfig::Canvas> >& signal_canvas_added() { return signal_canvas_added_; }
 130
 131         //! Signal called when a canvas has been removed.
 132         sigc::signal<void,etl::handle<synfig::Canvas> >& signal_canvas_removed() { return signal_canvas_removed_; }
 133
 134         //! Signal called when a layer's parameter has been changed
 135         sigc::signal<void,synfig::Layer::Handle,synfig::String>& signal_layer_param_changed() { return signal_layer_param_changed_; }
 136
 137         //! Signal called when the canvas's preview needs to be updated
 138         //sigc::signal<void>& signal_dirty_preview() { return signal_dirty_preview_; }
 139         sigc::signal<void>& signal_dirty_preview() { return get_canvas()->signal_dirty(); }
 140
 141         sigc::signal<void,etl::handle<synfig::ValueNode>,etl::handle<synfig::ValueNode> >&
 142                 signal_value_node_child_added() { return get_canvas()->signal_value_node_child_added(); }
 143         sigc::signal<void,etl::handle<synfig::ValueNode>,etl::handle<synfig::ValueNode> >&
 144                 signal_value_node_child_removed() { return get_canvas()->signal_value_node_child_removed(); }
 145
 146         //! Signal called when a ValueNode has changed
 147         sigc::signal<void,etl::handle<synfig::ValueNode> >& signal_value_node_added() { return signal_value_node_added_; }
 148
 149         //! Signal called when a ValueNode has been deleted
 150         sigc::signal<void,etl::handle<synfig::ValueNode> >& signal_value_node_deleted() { return signal_value_node_deleted_; }
 151
 152         //! Signal called when a ValueNode has been changed
 153         sigc::signal<void,etl::handle<synfig::ValueNode> >& signal_value_node_changed() { return get_canvas()->signal_value_node_changed(); }
 154
 155         //! Signal called when a ValueNode has been renamed
 156         sigc::signal<void,etl::handle<synfig::ValueNode> >& signal_value_node_renamed() { return get_canvas()->signal_value_node_renamed(); }
 157
 158         //! Signal called when the mode has changed
 159         sigc::signal<void,Mode> signal_mode_changed() { return signal_mode_changed_; }
 160
 161         //! Signal called when a the ID has been changed
 162         sigc::signal<void>& signal_id_changed() { return signal_id_changed_; }
 163
 164         //! Signal called whenever the time changes
 165         sigc::signal<void> signal_time_changed() { return signal_time_changed_; }
 166
 167         //! Signal called whenever a data node has been replaced.
 168         /*!     Second ValueNode replaces first */
 169         sigc::signal<void,synfig::ValueNode::Handle,synfig::ValueNode::Handle>& signal_value_node_replaced()
 170                 { return signal_value_node_replaced_; }
 171
 172         //! Signal called whenever the RendDesc changes
 173         sigc::signal<void>& signal_rend_desc_changed() { return signal_rend_desc_changed_; }
 174
 175         sigc::signal<void,synfig::Keyframe>& signal_keyframe_added() { return signal_keyframe_added_; }
 176
 177         sigc::signal<void,synfig::Keyframe>& signal_keyframe_removed() { return signal_keyframe_removed_; }
 178
 179         sigc::signal<void,synfig::Keyframe>& signal_keyframe_changed() { return signal_keyframe_changed_; }
 180
 181 public:
 182
 183         void auto_export(const ValueDesc& value_desc);
 184
 185         void auto_export(synfig::ValueNode::Handle value_node);
 186
 187         void set_meta_data(const synfig::String& key,const synfig::String& data);
 188
 189         //! Changes the current SelectionManager object
 190         void set_selection_manager(const etl::handle<SelectionManager> &sm) { selection_manager_=sm; }
 191
 192         //! Disables the selection manager
 193         void unset_selection_manager() { selection_manager_=new NullSelectionManager(); }
 194
 195         //! Returns a handle to the current SelectionManager
 196         const etl::handle<SelectionManager> &get_selection_manager()const { return selection_manager_; }
 197
 198         //! Changes the current UIInterface object
 199         void set_ui_interface(const etl::handle<UIInterface> &uim) { ui_interface_=uim; }
 200
 201         //! Disables the UIInterface
 202         void unset_ui_interface() { ui_interface_=new DefaultUIInterface(); }
 203
 204         //! Returns a handle to the current UIInterface
 205         const etl::handle<UIInterface> &get_ui_interface() { return ui_interface_; }
 206
 207         //! Returns the Canvas associated with this interface
 208         etl::handle<synfig::Canvas> get_canvas()const { return canvas_; }
 209
 210         //! Returns the Instance associated with this interface
 211         etl::loose_handle<Instance> get_instance()const { return instance_; }
 212
 213         //! Changes the name of the canvas. Undoable.
 214         void set_name(const synfig::String &x);
 215
 216         //! Changes the description of the canvas. Undoable.
 217         void set_description(const synfig::String &x);
 218
 219         //! Changes the ID of the canvas. Undoable.
 220         void set_id(const synfig::String &x);
 221
 222         //! Convenience function to retrieve the name of the canvas
 223         synfig::String get_name()const { return get_canvas()->get_name(); }
 224
 225         //! Convenience function to retrieve the description of the canvas
 226         synfig::String get_description()const { return get_canvas()->get_description(); }
 227
 228         //! Convenience function to retrieve the ID of the canvas
 229         synfig::String get_id()const { return get_canvas()->get_id(); }
 230
 231         //! Sets the current time
 232         void set_time(synfig::Time x);
 233
 234         //! Retrieves the current time
 235         synfig::Time get_time()const;
 236
 237         //! Changes the current time to the next keyframe
 238         void jump_to_next_keyframe();
 239
 240         //! Changes the current time to the next keyframe
 241         void jump_to_prev_keyframe();
 242
 243         void seek_frame(int frames);
 244
 245         void seek_time(synfig::Time time);
 246
 247         //! \writeme
 248         void refresh_current_values();
 249
 250         //! Sets the current editing mode
 251         /*! \see Mode */
 252         void set_mode(Mode x);
 253
 254         //! Retrieves the current editing mode
 255         /*! \see Mode */
 256         Mode get_mode()const;
 257
 258         //! Creates a new layer, of type \c id at the top of the layer stack
 259         synfig::Layer::Handle add_layer(synfig::String id) { return add_layer_to(id,get_canvas()); }
 260
 261         synfig::Layer::Handle add_layer_to(synfig::String id,synfig::Canvas::Handle canvas, int depth=0);
 262
 263         bool convert(ValueDesc value_desc, synfig::String type);
 264         //! Adds the given ValueNode to the canvas.
 265         bool add_value_node(synfig::ValueNode::Handle value_node, synfig::String name);
 266
 267
 268         Action::ParamList generate_param_list(const synfigapp::ValueDesc &);
 269
 270         Action::ParamList generate_param_list(const std::list<synfigapp::ValueDesc> &);
 271
 272         void set_rend_desc(const synfig::RendDesc &rend_desc);
 273
 274         bool import(const synfig::String &filename, bool copy=false);
 275
 276
 277         void waypoint_duplicate(synfigapp::ValueDesc value_desc,synfig::Waypoint waypoint);
 278         void waypoint_duplicate(synfig::ValueNode::Handle value_node,synfig::Waypoint waypoint);
 279
 280         void waypoint_remove(synfigapp::ValueDesc value_desc,synfig::Waypoint waypoint);
 281         void waypoint_remove(synfig::ValueNode::Handle value_node,synfig::Waypoint waypoint);
 282
 283         bool change_value(synfigapp::ValueDesc value_desc,synfig::ValueBase new_value);
 284
 285
 286         int find_important_value_descs(std::vector<synfigapp::ValueDesc>& out);
 287         static int find_important_value_descs(synfig::Canvas::Handle canvas,std::vector<synfigapp::ValueDesc>& out,synfig::GUIDSet& guid_set);
 288
 289         ~CanvasInterface();
 290
 291         static etl::handle<CanvasInterface> create(etl::loose_handle<Instance> instance,etl::handle<synfig::Canvas> canvas);
 292 }; // END of class CanvasInterface
 293
 294 /*!     \class PushMode
 295 **      \brief Class that changes the mode of a CanvasInterface, and restores it on destruction.
 296 */
 297 class PushMode
 298 {
 299         CanvasInterface* canvas_interface_;
 300         CanvasInterface::Mode old_mode_;
 301 public:
 302         PushMode(etl::loose_handle<CanvasInterface> c, CanvasInterface::Mode mode):
 303                 canvas_interface_(c.get()), old_mode_(canvas_interface_->get_mode())
 304         { canvas_interface_->set_mode(mode); }
 305
 306         ~PushMode() { canvas_interface_->set_mode(old_mode_); }
 307 }; // END of class PushMode
 308
 309 }; // END of namespace studio
 310
 311 /* === E N D =============================================================== */
 312
 313 #endif