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