synfig-core/trunk/src/synfig/canvas.h

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file canvas.h
   3 **      \brief Canvas Class Implementation
   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_CANVAS_H
  27 #define __SYNFIG_CANVAS_H
  28
  29 /* === H E A D E R S ======================================================= */
  30
  31 #include <map>
  32 #include <list>
  33 #include <ETL/handle>
  34 #include <sigc++/signal.h>
  35 #include <sigc++/connection.h>
  36
  37 #include "vector.h"
  38 #include "string.h"
  39 #include "canvasbase.h"
  40 #include "valuenode.h"
  41 #include "keyframe.h"
  42 #include "renddesc.h"
  43 #include "node.h"
  44 #include "guid.h"
  45
  46 /* === M A C R O S ========================================================= */
  47
  48 /* version change history:
  49  *
  50  * 0.1: the original version
  51  *
  52  *      if a waypoint goes from -179 to 179 degrees, that is a 2
  53  *      degree change.  there's no way to express a 720 degree
  54  *      rotation with a single pair of waypoints
  55  *
  56  * 0.2: svn r1227
  57  *
  58  *      angles no longer wrap at -180 degrees back to 180 degrees; if
  59  *      a waypoint goes from -179 to 179 degrees, that is a rotation
  60  *      of 358 degrees.  loading a version 0.1 canvas will modify
  61  *      constant angle waypoints to that they are within 180 degrees
  62  *      of the previous waypoint's value
  63  *
  64  *      the 'straight' blend method didn't used to work properly.  it
  65  *      didn't work at all on transparent pixels in layers other than
  66  *      the PasteCanvas layer.  for example, the examples/japan.sifz
  67  *      file has a red circle (straight, amount=1.0) on top of a
  68  *      striped conical gradient.  if 'straight' was working, the
  69  *      conical gradient would be entirely obscured by the circle
  70  *      layer (even by its transparent pixels)
  71  *
  72  * 0.3: svn r1422
  73  *
  74  *      the 'straight' blend method was fixed.  loading a version 0.2
  75  *      or older canvas will replace the 'straight' blend method in
  76  *      non-pastecanvas layers with 'composite', unless they're
  77  *      completely transparent, in which case it will replace them
  78  *      with an  'alpha over' blend instead.  Images like
  79  *      examples/logo.sifz use transparent straight blends to do
  80  *      masking, which no longer works now that 'straight' blending is
  81  *      fixed.
  82  *
  83  *      Tangent lengths calculated by the "Segment Tangent" and "BLine
  84  *      Tangent" ValueNodes were scaled by a factor of 0.5.
  85  *
  86  * 0.4: svn r1856
  87  *
  88  *      Stop scaling tangents by 0.5.
  89  *
  90  * 0.5: svn r1863
  91  *
  92  *      Added "offset", "scale", and "fixed_length" links to the
  93  *      "BLine Tangent" ValueNode.
  94  */
  95
  96 #define CURRENT_CANVAS_VERSION "0.5"
  97
  98 /* === T Y P E D E F S ===================================================== */
  99
 100 /* === C L A S S E S & S T R U C T S ======================================= */
 101
 102 namespace synfig {
 103
 104 class Context;
 105 class GUID;
 106
 107 /*!     \class Canvas
 108 **      \todo writeme
 109 */
 110 class Canvas : public CanvasBase, public Node
 111 {
 112         /*
 113  --     ** -- T Y P E S -----------------------------------------------------------
 114         */
 115
 116 public:
 117         typedef etl::handle<Canvas> Handle;
 118         typedef etl::loose_handle<Canvas> LooseHandle;
 119         typedef etl::handle<const Canvas> ConstHandle;
 120
 121         typedef std::list<Handle> Children;
 122
 123         friend void synfig::optimize_layers(Time, Context, Canvas::Handle, bool seen_motion_blur);
 124
 125         /*
 126  --     ** -- D A T A -------------------------------------------------------------
 127         */
 128
 129 private:
 130
 131         //! Contains the ID string for the Canvas
 132         /*!     \see get_id(), set_id() */
 133         String id_;
 134
 135         //! Contains the name of the Canvas
 136         /*!     \see set_name(), get_name() */
 137         String name_;
 138
 139         //! Contains a description of the Canvas
 140         /*!     \see set_description(), get_description() */
 141         String description_;
 142
 143         //! Contains the canvas' version string
 144         /*!     \see set_version(), get_version() */
 145         String version_;
 146
 147         //! Contains the author's name
 148         /*!     \see set_author(), get_author() */
 149         String author_;
 150
 151         //! Contains the author's email address
 152         /*!     \todo This private parameter has no binding, so it's unusable at the moment */
 153         String email_;
 154
 155         //! File name of Canvas
 156         /*! \see get_file_name(), set_file_name() */
 157         String file_name_;
 158
 159         //! Metadata map for Canvas.
 160         /*! \see get_meta_data(), set_meta_data(), erase_meta_data() */
 161         std::map<String, String> meta_data_;
 162
 163         //! Contains a list of ValueNodes that are in this Canvas
 164         /*!     \see value_node_list(), find_value_node() */
 165         ValueNodeList value_node_list_;
 166
 167         //! \writeme
 168         KeyframeList keyframe_list_;
 169
 170         //! A handle to the parent canvas of this canvas.
 171         /*!     If canvas is a root canvas, then this handle is empty
 172         **      \see parent()
 173         */
 174         LooseHandle parent_;
 175
 176         //! List containing any child Canvases
 177         /*!     \see children() */
 178         Children children_;
 179
 180         //! Render Description for Canvas
 181         /*!     \see rend_desc() */
 182     RendDesc desc_;
 183
 184         //! Contains the value of the last call to set_time()
 185         Time cur_time_;
 186
 187         //! \writeme
 188         mutable std::map<String,Handle> externals_;
 189
 190         //! This flag is set if this canvas is "inline"
 191         bool is_inline_;
 192
 193         mutable bool is_dirty_;
 194
 195         bool op_flag_;
 196
 197         //! Layer Group database
 198         std::map<String,std::set<etl::handle<Layer> > > group_db_;
 199
 200         //! Layer Connection database
 201         std::map<etl::loose_handle<Layer>,std::vector<sigc::connection> > connections_;
 202
 203         /*
 204  -- ** -- S I G N A L S -------------------------------------------------------
 205         */
 206
 207 private:
 208
 209         //!     Group Added
 210         sigc::signal<void,String> signal_group_added_;
 211
 212         //!     Group Removed
 213         sigc::signal<void,String> signal_group_removed_;
 214
 215         //! Group Changed
 216         sigc::signal<void,String> signal_group_changed_;
 217
 218         sigc::signal<void,String,etl::handle<synfig::Layer> > signal_group_pair_added_;
 219         sigc::signal<void,String,etl::handle<synfig::Layer> > signal_group_pair_removed_;
 220
 221         //!     Layers Reordered
 222         sigc::signal<void,int*> signal_layers_reordered_;
 223
 224         //!     RendDesc Changed
 225         sigc::signal<void> signal_rend_desc_changed_;
 226
 227         //!     ID Changed
 228         sigc::signal<void> signal_id_changed_;
 229
 230         //!     Dirty
 231         //sigc::signal<void> signal_dirty_;
 232
 233         //!     FileName Changed
 234         sigc::signal<void> signal_file_name_changed_;
 235
 236         //!     Metadata Changed
 237         sigc::signal<void, String> signal_meta_data_changed_;
 238
 239         //! Key-Specific meta data changed signals
 240         std::map<String, sigc::signal<void> > signal_map_meta_data_changed_;
 241
 242
 243         //!     ValueBasenode Changed
 244         sigc::signal<void, etl::handle<ValueNode> > signal_value_node_changed_;
 245
 246         sigc::signal<void, etl::handle<ValueNode> > signal_value_node_renamed_;
 247
 248         sigc::signal<void, etl::handle<ValueNode>, etl::handle<ValueNode> > signal_value_node_child_added_;
 249
 250         sigc::signal<void, etl::handle<ValueNode>, etl::handle<ValueNode> > signal_value_node_child_removed_;
 251
 252         /*
 253  -- ** -- S I G N A L   I N T E R F A C E -------------------------------------
 254         */
 255
 256 public:
 257
 258         sigc::signal<void,String,etl::handle<synfig::Layer> >& signal_group_pair_added() { return signal_group_pair_added_; }
 259         sigc::signal<void,String,etl::handle<synfig::Layer> >& signal_group_pair_removed() { return signal_group_pair_removed_; }
 260
 261         //!     Group Added
 262         sigc::signal<void,String>& signal_group_added() { return signal_group_added_; }
 263
 264         //!     Group Removed
 265         sigc::signal<void,String>& signal_group_removed() { return signal_group_removed_; }
 266
 267         //! Group Changed
 268         sigc::signal<void,String>& signal_group_changed() { return signal_group_changed_; }
 269
 270         //!     Layers Reordered
 271         sigc::signal<void,int*>& signal_layers_reordered() { return signal_layers_reordered_; }
 272
 273         //!     RendDesc Changed
 274         sigc::signal<void>& signal_rend_desc_changed() { return signal_rend_desc_changed_; }
 275
 276         //!     ID Changed
 277         sigc::signal<void>& signal_id_changed() { return signal_id_changed_; }
 278
 279         //!     File name Changed
 280         sigc::signal<void>& signal_file_name_changed();
 281
 282         //!     Metadata Changed
 283         sigc::signal<void, String>& signal_meta_data_changed() { return signal_meta_data_changed_; }
 284
 285         //!     Metadata Changed
 286         sigc::signal<void>& signal_meta_data_changed(const String& key) { return signal_map_meta_data_changed_[key]; }
 287
 288
 289         sigc::signal<void, etl::handle<ValueNode> >& signal_value_node_changed() { return signal_value_node_changed_; }
 290
 291         sigc::signal<void, etl::handle<ValueNode> >& signal_value_node_renamed() { return signal_value_node_renamed_; }
 292
 293         //!     Dirty
 294         sigc::signal<void>& signal_dirty() { return signal_changed();   }
 295
 296         //! \writeme
 297         sigc::signal<void, etl::handle<ValueNode>, etl::handle<ValueNode> >& signal_value_node_child_added() { return signal_value_node_child_added_; }
 298
 299         //! \writeme
 300         sigc::signal<void, etl::handle<ValueNode>, etl::handle<ValueNode> >& signal_value_node_child_removed() { return signal_value_node_child_removed_; }
 301
 302         /*
 303  --     ** -- C O N S T R U C T O R S ---------------------------------------------
 304         */
 305
 306 protected:
 307
 308         Canvas(const String &name);
 309
 310 public:
 311
 312         ~Canvas();
 313
 314         /*
 315  --     ** -- M E M B E R   F U N C T I O N S -------------------------------------
 316         */
 317
 318 public:
 319
 320         //! Returns the set of layers in group
 321         std::set<etl::handle<Layer> > get_layers_in_group(const String&group);
 322
 323         //! Gets all the groups
 324         std::set<String> get_groups()const;
 325
 326         //! Gets the number of groups in this canvas
 327         int get_group_count()const;
 328
 329         //! Renames the given group
 330         void rename_group(const String&old_name,const String&new_name);
 331
 332         //! \writeme
 333         bool is_inline()const { return is_inline_; }
 334
 335         //! Returns a handle to the RendDesc for this Canvas
 336         RendDesc &rend_desc() { return desc_; }
 337
 338         //! Returns a handle to the RendDesc for this Canvas
 339         const RendDesc &rend_desc()const { return desc_; }
 340
 341         //! Gets the name of the canvas
 342         const String & get_name()const { return name_; }
 343
 344         //! Sets the name of the canvas
 345         void set_name(const String &x);
 346
 347         //! Gets the version string of the canvas
 348         const String get_version()const { return version_; }
 349
 350         //! Sets the version string of the canvas
 351         void set_version(const String &x) { version_ = x; }
 352
 353         //! Gets the author of the canvas
 354         const String & get_author()const { return author_; }
 355
 356         //! Sets the author of the canvas
 357         void set_author(const String &x);
 358
 359         //! Gets the description of the canvas
 360         const String & get_description()const { return description_; }
 361
 362         //! Sets the name of the canvas
 363         void set_description(const String &x);
 364
 365         //! Gets the ID of the canvas
 366         const String & get_id()const { return id_; }
 367
 368         //! Sets the ID of the canvas
 369         void set_id(const String &x);
 370
 371         //!     Returns the data string for the given meta data key
 372         String get_meta_data(const String& key)const;
 373
 374         //!     Returns a list of meta data keys
 375         std::list<String> get_meta_data_keys()const;
 376
 377         //! Sets a meta data key to a specific string
 378         void set_meta_data(const String& key, const String& data);
 379
 380         //! Removes a meta data key
 381         void erase_meta_data(const String& key);
 382
 383         //! \writeme
 384         String get_relative_id(etl::loose_handle<const Canvas> x)const;
 385
 386         //! \internal \writeme
 387         String _get_relative_id(etl::loose_handle<const Canvas> x)const;
 388
 389         //! Returns \c true if the Canvas is a root Canvas. \c false otherwise
 390         bool is_root()const { return !parent_; }
 391
 392         //! Returns a handle to the parent Canvas.
 393         /*! The returned handle will be empty if this is a root canvas */
 394         LooseHandle parent()const { return parent_; }
 395
 396         LooseHandle get_root()const;
 397
 398         //! Returns a list of all child canvases in this canvas
 399         std::list<Handle> &children() { return children_; }
 400
 401         //! Returns a list of all child canvases in this canvas
 402         const std::list<Handle> &children()const { return children_; }
 403
 404         //! Gets the color at the specified point
 405         //Color get_color(const Point &pos)const;
 406
 407         //! Sets the time for all the layers in the canvas
 408         void set_time(Time t)const;
 409
 410         //! \writeme
 411         Time get_time()const { return cur_time_; }
 412
 413         //! Returns the number of layers in the canvas
 414         int size()const;
 415
 416         //! Removes all the layers from the canvas
 417         void clear();
 418
 419         //! Returns true if the canvas has no layers
 420         bool empty()const;
 421
 422         //! Returns a reference to the ValueNodeList for this Canvas
 423         // ValueNodeList &value_node_list() { return value_node_list_; }
 424
 425         //! Returns a reference to the ValueNodeList for this Canvas
 426         const ValueNodeList &value_node_list()const;
 427
 428         //! Returns a reference to the KeyframeList for this Canvas
 429         KeyframeList &keyframe_list();
 430
 431         //! Returns a reference to the KeyframeList for this Canvas
 432         const KeyframeList &keyframe_list()const;
 433
 434         //! Finds the ValueNode in the Canvas with the given \a id
 435         /*!     \return If found, returns a handle to the ValueNode.
 436         **              Otherwise, returns an empty handle.
 437         */
 438         ValueNode::Handle find_value_node(const String &id);
 439
 440         //! \internal \writeme
 441         ValueNode::Handle surefind_value_node(const String &id);
 442
 443         //! Finds the ValueNode in the Canvas with the given \a id
 444         /*!     \return If found, returns a handle to the ValueNode.
 445         **              Otherwise, returns an empty handle.
 446         */
 447         ValueNode::ConstHandle find_value_node(const String &id)const;
 448
 449         //! \writeme
 450         void add_value_node(ValueNode::Handle x, const String &id);
 451
 452         //! writeme
 453         //void rename_value_node(ValueNode::Handle x, const String &id);
 454
 455         //! \writeme
 456         void remove_value_node(ValueNode::Handle x);
 457
 458         //! \writeme
 459         void remove_value_node(const String &id) { remove_value_node(find_value_node(id)); }
 460
 461         //! Finds a child Canvas in the Canvas with the given \a name
 462         /*!     \return If found, returns a handle to the child Canvas.
 463         **              If not found, it creates a new Canvas and returns it
 464         **              If an error occurs, it returns an empty handle
 465         */
 466         Handle surefind_canvas(const String &id);
 467
 468         //! Finds a child Canvas in the Canvas with the given \a id
 469         /*!     \return If found, returns a handle to the child Canvas.
 470         **              Otherwise, returns an empty handle.
 471         */
 472         Handle find_canvas(const String &id);
 473
 474         //! Finds a child Canvas in the Canvas with the given \a id
 475         /*!     \return If found, returns a handle to the child Canvas.
 476         **              Otherwise, returns an empty handle.
 477         */
 478         ConstHandle find_canvas(const String &id)const;
 479
 480         //! Sets the file path for the Canvas
 481         //void set_file_path(const String &);
 482
 483         //! Returns the file path from the file name
 484         String get_file_path()const;
 485
 486         //! Sets the filename (with path)
 487         void set_file_name(const String &);
 488
 489         //! Gets the filename (with path)
 490         String get_file_name()const;
 491
 492         //! Creates a new child canvas, and returns its handle
 493         Handle new_child_canvas();
 494
 495         //! Creates a new child canvas with an ID of \a id, and returns its handle
 496         Handle new_child_canvas(const String &id);
 497
 498         //! Adds the given canvas as a child
 499         Handle add_child_canvas(Handle child_canvas, const String &id);
 500
 501         void remove_child_canvas(Handle child_canvas);
 502
 503         etl::handle<Layer> find_layer(const Point &pos);
 504
 505         int get_depth(etl::handle<Layer>)const;
 506
 507         Context get_context()const;
 508
 509         iterator end();
 510
 511         const_iterator end()const;
 512
 513         reverse_iterator rbegin();
 514
 515         const_reverse_iterator rbegin()const;
 516
 517         etl::handle<Layer> &back();
 518
 519         void push_back(etl::handle<Layer> x);
 520
 521         void push_front(etl::handle<Layer> x);
 522
 523         void push_back_simple(etl::handle<Layer> x);
 524
 525         void insert(iterator iter,etl::handle<Layer> x);
 526         void erase(iterator iter);
 527
 528         const etl::handle<Layer> &back()const;
 529
 530         void set_inline(LooseHandle parent);
 531
 532         static Handle create();
 533
 534         static Handle create_inline(Handle parent);
 535
 536         Handle clone(const GUID& deriv_guid=GUID())const;
 537
 538 private:
 539         void add_group_pair(String group, etl::handle<Layer> layer);
 540         void remove_group_pair(String group, etl::handle<Layer> layer);
 541         void add_connection(etl::loose_handle<Layer> layer, sigc::connection connection);
 542         void disconnect_connections(etl::loose_handle<Layer> layer);
 543
 544 protected:
 545         virtual void on_changed();
 546         virtual void get_times_vfunc(Node::time_set &set) const;
 547 }; // END of class Canvas
 548
 549 void optimize_layers(Time time, Context context, Canvas::Handle op_canvas, bool seen_motion_blur=false);
 550
 551
 552 }; // END of namespace synfig
 553
 554 /* === E N D =============================================================== */
 555
 556 #endif