1 /* === S Y N F I G ========================================================= */
2 /*! \file layer_pastecanvas.h
3 ** \brief Header file for implementation of the "Paste Canvas" layer
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_LAYER_PASTEIMAGE_H
27 #define __SYNFIG_LAYER_PASTEIMAGE_H
29 /* === H E A D E R S ======================================================= */
31 #include "layer_composite.h"
36 #include "canvasbase.h"
40 /* === M A C R O S ========================================================= */
42 /* === T Y P E D E F S ===================================================== */
44 /* === C L A S S E S & S T R U C T S ======================================= */
48 class Layer_PasteCanvas : public Layer_Composite, public Layer_NoDeform
50 SYNFIG_LAYER_MODULE_EXT
55 etl::loose_handle<synfig::Canvas> canvas;
57 //! Recursion depth counter
64 mutable Time curr_time;
72 sigc::connection child_changed_connection;
74 // Nasty hack: Remember whether we called an extra ref() when
75 // setting the canvas, so we know whether to call an extra unref()
76 // when finished with the canvas.
80 // The root canvas is destructed first. That sets the
81 // Layer::canvas_ (the parent canvas) of any PasteCanvas layer it
82 // contains to nil, due to a call to Layer::set_canvas(0),
83 // triggered by the connection made when Layer::set_canvas
84 // originally set its canvas_ member to point to the root canvas.
85 // ~Canvas does begin_delete() which triggers that connection.
87 // After ~Canvas has run, the members of the root canvas are
88 // freed, including its children_ list. If this was the last
89 // reference to the child canvas that the pastecanvas uses, that
90 // child canvas will Layer_PasteCanvas::set_sub_canvas(0) on the
91 // PasteCanvas layer to set its canvas (the child, pasted canvas)
92 // not to refer to the soon-to-be destroys child canvas. But
93 // set_sub_canvas() originally looked at the value of
94 // Layer::canvas_ (the parent canvas, obtained via
95 // Layer::get_canvas()) to decide whether to do an extra ref() on
96 // canvas (the child canvas). We need to unref() it now if we
97 // did, but we've forgotten whether we did. So we use this
98 // 'extra_reference' member to store that decision.
102 virtual void on_canvas_set();
104 void set_muck_with_time(bool x=false) { muck_with_time_=x; }
106 etl::handle<synfig::Canvas> get_sub_canvas()const { return canvas; }
107 void set_sub_canvas(etl::handle<synfig::Canvas> x);
109 Real get_zoom()const { return zoom; }
111 Time get_time_offset()const { return time_offset; }
113 Point get_origin()const { return origin; }
116 virtual ~Layer_PasteCanvas();
118 virtual String get_local_name()const;
120 virtual bool set_param(const String & param, const synfig::ValueBase &value);
122 virtual ValueBase get_param(const String & param)const;
124 virtual Color get_color(Context context, const Point &pos)const;
126 virtual void set_time(Context context, Time time)const;
128 virtual bool accelerated_render(Context context,Surface *surface,int quality, const RendDesc &renddesc, ProgressCallback *cb)const;
130 virtual Vocab get_param_vocab()const;
132 virtual synfig::Rect get_bounding_rect()const;
134 virtual synfig::Layer::Handle hit_check(synfig::Context context, const synfig::Point &point)const;
137 virtual void get_times_vfunc(Node::time_set &set) const;
139 }; // END of class Layer_PasteCanvas
141 }; // END of namespace synfig
143 /* === E N D =============================================================== */