1 /* === S Y N F I G ========================================================= */
3 ** \brief Canvas Class Implementation
8 ** Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
9 ** Copyright (c) 2007 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_CANVAS_H
27 #define __SYNFIG_CANVAS_H
29 /* === H E A D E R S ======================================================= */
34 #include <sigc++/signal.h>
35 #include <sigc++/connection.h>
39 #include "canvasbase.h"
40 #include "valuenode.h"
46 /* === M A C R O S ========================================================= */
48 /* version change history:
50 * 0.1: the original version
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
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
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)
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'
79 #define CURRENT_CANVAS_VERSION "0.3"
81 /* === T Y P E D E F S ===================================================== */
83 /* === C L A S S E S & S T R U C T S ======================================= */
93 class Canvas : public CanvasBase, public Node
96 -- ** -- T Y P E S -----------------------------------------------------------
100 typedef etl::handle<Canvas> Handle;
101 typedef etl::loose_handle<Canvas> LooseHandle;
102 typedef etl::handle<const Canvas> ConstHandle;
104 typedef std::list<Handle> Children;
106 friend void synfig::optimize_layers(Time, Context, Canvas::Handle, bool seen_motion_blur);
109 -- ** -- D A T A -------------------------------------------------------------
114 //! Contains the ID string for the Canvas
115 /*! \see get_id(), set_id() */
118 //! Contains the name of the Canvas
119 /*! \see set_name(), get_name() */
122 //! Contains a description of the Canvas
123 /*! \see set_description(), get_description() */
126 //! Contains the canvas' version string
127 /*! \see set_version(), get_version() */
130 //! Contains the author's name
131 /*! \see set_author(), get_author() */
134 //! Contains the author's email address
135 /*! \todo This private parameter has no binding, so it's unusable at the moment */
138 //! File name of Canvas
139 /*! \see get_file_name(), set_file_name() */
142 //! Metadata map for Canvas.
143 /*! \see get_meta_data(), set_meta_data(), erase_meta_data() */
144 std::map<String, String> meta_data_;
146 //! Contains a list of ValueNodes that are in this Canvas
147 /*! \see value_node_list(), find_value_node() */
148 ValueNodeList value_node_list_;
151 KeyframeList keyframe_list_;
153 //! A handle to the parent canvas of this canvas.
154 /*! If canvas is a root canvas, then this handle is empty
159 //! List containing any child Canvases
160 /*! \see children() */
163 //! Render Description for Canvas
164 /*! \see rend_desc() */
167 //! Contains the value of the last call to set_time()
171 mutable std::map<String,Handle> externals_;
173 //! This flag is set if this canvas is "inline"
176 mutable bool is_dirty_;
180 //! Layer Group database
181 std::map<String,std::set<etl::handle<Layer> > > group_db_;
183 //! Layer Connection database
184 std::map<etl::loose_handle<Layer>,std::vector<sigc::connection> > connections_;
187 -- ** -- S I G N A L S -------------------------------------------------------
193 sigc::signal<void,String> signal_group_added_;
196 sigc::signal<void,String> signal_group_removed_;
199 sigc::signal<void,String> signal_group_changed_;
201 sigc::signal<void,String,etl::handle<synfig::Layer> > signal_group_pair_added_;
202 sigc::signal<void,String,etl::handle<synfig::Layer> > signal_group_pair_removed_;
205 sigc::signal<void,int*> signal_layers_reordered_;
208 sigc::signal<void> signal_rend_desc_changed_;
211 sigc::signal<void> signal_id_changed_;
214 //sigc::signal<void> signal_dirty_;
217 sigc::signal<void> signal_file_name_changed_;
220 sigc::signal<void, String> signal_meta_data_changed_;
222 //! Key-Specific meta data changed signals
223 std::map<String, sigc::signal<void> > signal_map_meta_data_changed_;
226 //! ValueBasenode Changed
227 sigc::signal<void, etl::handle<ValueNode> > signal_value_node_changed_;
229 sigc::signal<void, etl::handle<ValueNode> > signal_value_node_renamed_;
231 sigc::signal<void, etl::handle<ValueNode>, etl::handle<ValueNode> > signal_value_node_child_added_;
233 sigc::signal<void, etl::handle<ValueNode>, etl::handle<ValueNode> > signal_value_node_child_removed_;
236 -- ** -- S I G N A L I N T E R F A C E -------------------------------------
241 sigc::signal<void,String,etl::handle<synfig::Layer> >& signal_group_pair_added() { return signal_group_pair_added_; }
242 sigc::signal<void,String,etl::handle<synfig::Layer> >& signal_group_pair_removed() { return signal_group_pair_removed_; }
245 sigc::signal<void,String>& signal_group_added() { return signal_group_added_; }
248 sigc::signal<void,String>& signal_group_removed() { return signal_group_removed_; }
251 sigc::signal<void,String>& signal_group_changed() { return signal_group_changed_; }
254 sigc::signal<void,int*>& signal_layers_reordered() { return signal_layers_reordered_; }
257 sigc::signal<void>& signal_rend_desc_changed() { return signal_rend_desc_changed_; }
260 sigc::signal<void>& signal_id_changed() { return signal_id_changed_; }
262 //! File name Changed
263 sigc::signal<void>& signal_file_name_changed();
266 sigc::signal<void, String>& signal_meta_data_changed() { return signal_meta_data_changed_; }
269 sigc::signal<void>& signal_meta_data_changed(const String& key) { return signal_map_meta_data_changed_[key]; }
272 sigc::signal<void, etl::handle<ValueNode> >& signal_value_node_changed() { return signal_value_node_changed_; }
274 sigc::signal<void, etl::handle<ValueNode> >& signal_value_node_renamed() { return signal_value_node_renamed_; }
277 sigc::signal<void>& signal_dirty() { return signal_changed(); }
280 sigc::signal<void, etl::handle<ValueNode>, etl::handle<ValueNode> >& signal_value_node_child_added() { return signal_value_node_child_added_; }
283 sigc::signal<void, etl::handle<ValueNode>, etl::handle<ValueNode> >& signal_value_node_child_removed() { return signal_value_node_child_removed_; }
286 -- ** -- C O N S T R U C T O R S ---------------------------------------------
291 Canvas(const String &name);
298 -- ** -- M E M B E R F U N C T I O N S -------------------------------------
303 //! Returns the set of layers in group
304 std::set<etl::handle<Layer> > get_layers_in_group(const String&group);
306 //! Gets all the groups
307 std::set<String> get_groups()const;
309 //! Gets the number of groups in this canvas
310 int get_group_count()const;
312 //! Renames the given group
313 void rename_group(const String&old_name,const String&new_name);
316 bool is_inline()const { return is_inline_; }
318 //! Returns a handle to the RendDesc for this Canvas
319 RendDesc &rend_desc() { return desc_; }
321 //! Returns a handle to the RendDesc for this Canvas
322 const RendDesc &rend_desc()const { return desc_; }
324 //! Gets the name of the canvas
325 const String & get_name()const { return name_; }
327 //! Sets the name of the canvas
328 void set_name(const String &x);
330 //! Gets the version string of the canvas
331 const String get_version()const { return version_; }
333 //! Sets the version string of the canvas
334 void set_version(const String &x) { version_ = x; }
336 //! Gets the author of the canvas
337 const String & get_author()const { return author_; }
339 //! Sets the author of the canvas
340 void set_author(const String &x);
342 //! Gets the description of the canvas
343 const String & get_description()const { return description_; }
345 //! Sets the name of the canvas
346 void set_description(const String &x);
348 //! Gets the ID of the canvas
349 const String & get_id()const { return id_; }
351 //! Sets the ID of the canvas
352 void set_id(const String &x);
354 //! Returns the data string for the given meta data key
355 String get_meta_data(const String& key)const;
357 //! Returns a list of meta data keys
358 std::list<String> get_meta_data_keys()const;
360 //! Sets a meta data key to a specific string
361 void set_meta_data(const String& key, const String& data);
363 //! Removes a meta data key
364 void erase_meta_data(const String& key);
367 String get_relative_id(etl::loose_handle<const Canvas> x)const;
369 //! \internal \writeme
370 String _get_relative_id(etl::loose_handle<const Canvas> x)const;
372 //! Returns \c true if the Canvas is a root Canvas. \c false otherwise
373 bool is_root()const { return !parent_; }
375 //! Returns a handle to the parent Canvas.
376 /*! The returned handle will be empty if this is a root canvas */
377 LooseHandle parent()const { return parent_; }
379 LooseHandle get_root()const;
381 //! Returns a list of all child canvases in this canvas
382 std::list<Handle> &children() { return children_; }
384 //! Returns a list of all child canvases in this canvas
385 const std::list<Handle> &children()const { return children_; }
387 //! Gets the color at the specified point
388 //Color get_color(const Point &pos)const;
390 //! Sets the time for all the layers in the canvas
391 void set_time(Time t)const;
394 Time get_time()const { return cur_time_; }
396 //! Returns the number of layers in the canvas
399 //! Removes all the layers from the canvas
402 //! Returns true if the canvas has no layers
405 //! Returns a reference to the ValueNodeList for this Canvas
406 // ValueNodeList &value_node_list() { return value_node_list_; }
408 //! Returns a reference to the ValueNodeList for this Canvas
409 const ValueNodeList &value_node_list()const;
411 //! Returns a reference to the KeyframeList for this Canvas
412 KeyframeList &keyframe_list();
414 //! Returns a reference to the KeyframeList for this Canvas
415 const KeyframeList &keyframe_list()const;
417 //! Finds the ValueNode in the Canvas with the given \a id
418 /*! \return If found, returns a handle to the ValueNode.
419 ** Otherwise, returns an empty handle.
421 ValueNode::Handle find_value_node(const String &id);
423 //! \internal \writeme
424 ValueNode::Handle surefind_value_node(const String &id);
426 //! Finds the ValueNode in the Canvas with the given \a id
427 /*! \return If found, returns a handle to the ValueNode.
428 ** Otherwise, returns an empty handle.
430 ValueNode::ConstHandle find_value_node(const String &id)const;
433 void add_value_node(ValueNode::Handle x, const String &id);
436 //void rename_value_node(ValueNode::Handle x, const String &id);
439 void remove_value_node(ValueNode::Handle x);
442 void remove_value_node(const String &id) { remove_value_node(find_value_node(id)); }
444 //! Finds a child Canvas in the Canvas with the given \a name
445 /*! \return If found, returns a handle to the child Canvas.
446 ** If not found, it creates a new Canvas and returns it
447 ** If an error occurs, it returns an empty handle
449 Handle surefind_canvas(const String &id);
451 //! Finds a child Canvas in the Canvas with the given \a id
452 /*! \return If found, returns a handle to the child Canvas.
453 ** Otherwise, returns an empty handle.
455 Handle find_canvas(const String &id);
457 //! Finds a child Canvas in the Canvas with the given \a id
458 /*! \return If found, returns a handle to the child Canvas.
459 ** Otherwise, returns an empty handle.
461 ConstHandle find_canvas(const String &id)const;
463 //! Sets the file path for the Canvas
464 //void set_file_path(const String &);
466 //! Returns the file path from the file name
467 String get_file_path()const;
469 //! Sets the filename (with path)
470 void set_file_name(const String &);
472 //! Gets the filename (with path)
473 String get_file_name()const;
475 //! Creates a new child canvas, and returns its handle
476 Handle new_child_canvas();
478 //! Creates a new child canvas with an ID of \a id, and returns its handle
479 Handle new_child_canvas(const String &id);
481 //! Adds the given canvas as a child
482 Handle add_child_canvas(Handle child_canvas, const String &id);
484 void remove_child_canvas(Handle child_canvas);
486 etl::handle<Layer> find_layer(const Point &pos);
488 int get_depth(etl::handle<Layer>)const;
490 Context get_context()const;
494 const_iterator end()const;
496 reverse_iterator rbegin();
498 const_reverse_iterator rbegin()const;
500 etl::handle<Layer> &back();
502 void push_back(etl::handle<Layer> x);
504 void push_front(etl::handle<Layer> x);
506 void push_back_simple(etl::handle<Layer> x);
508 void insert(iterator iter,etl::handle<Layer> x);
509 void erase(iterator iter);
511 const etl::handle<Layer> &back()const;
513 void set_inline(LooseHandle parent);
515 static Handle create();
517 static Handle create_inline(Handle parent);
519 Handle clone(const GUID& deriv_guid=GUID())const;
522 void add_group_pair(String group, etl::handle<Layer> layer);
523 void remove_group_pair(String group, etl::handle<Layer> layer);
524 void add_connection(etl::loose_handle<Layer> layer, sigc::connection connection);
525 void disconnect_connections(etl::loose_handle<Layer> layer);
528 virtual void on_changed();
529 virtual void get_times_vfunc(Node::time_set &set) const;
530 }; // END of class Canvas
532 void optimize_layers(Time time, Context context, Canvas::Handle op_canvas, bool seen_motion_blur=false);
535 }; // END of namespace synfig
537 /* === E N D =============================================================== */