Remove .gitignore do nothing is ignored.
[synfig.git] / synfig-core / trunk / src / synfig / layer_pastecanvas.h
index 652bf7a..2d4714c 100644 (file)
@@ -1,28 +1,30 @@
-/* === S I N F G =========================================================== */
+/* === S Y N F I G ========================================================= */
 /*!    \file layer_pastecanvas.h
-**     \brief Template Header
+**     \brief Header file for implementation of the "Paste Canvas" layer
 **
-**     $Id: layer_pastecanvas.h,v 1.2 2005/01/24 03:08:18 darco Exp $
+**     $Id$
 **
 **     \legal
-**     Copyright (c) 2002 Robert B. Quattlebaum Jr.
+**     Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
+**     Copyright (c) 2007, 2008 Chris Moore
 **
-**     This software and associated documentation
-**     are CONFIDENTIAL and PROPRIETARY property of
-**     the above-mentioned copyright holder.
+**     This package is free software; you can redistribute it and/or
+**     modify it under the terms of the GNU General Public License as
+**     published by the Free Software Foundation; either version 2 of
+**     the License, or (at your option) any later version.
 **
-**     You may not copy, print, publish, or in any
-**     other way distribute this software without
-**     a prior written agreement with
-**     the copyright holder.
+**     This package is distributed in the hope that it will be useful,
+**     but WITHOUT ANY WARRANTY; without even the implied warranty of
+**     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+**     General Public License for more details.
 **     \endlegal
 */
 /* ========================================================================= */
 
 /* === S T A R T =========================================================== */
 
-#ifndef __SINFG_LAYER_PASTEIMAGE_H
-#define __SINFG_LAYER_PASTEIMAGE_H
+#ifndef __SYNFIG_LAYER_PASTEIMAGE_H
+#define __SYNFIG_LAYER_PASTEIMAGE_H
 
 /* === H E A D E R S ======================================================= */
 
 
 /* === C L A S S E S & S T R U C T S ======================================= */
 
-namespace sinfg {
-       
+namespace synfig {
+
 class Layer_PasteCanvas : public Layer_Composite, public Layer_NoDeform
 {
-       SINFG_LAYER_MODULE_EXT
+       SYNFIG_LAYER_MODULE_EXT
 private:
 
        Vector origin;
+       Vector focus;
 
-       etl::loose_handle<sinfg::Canvas> canvas;
+       etl::loose_handle<synfig::Canvas> canvas;
 
        //! Recursion depth counter
        mutable int depth;
@@ -61,24 +64,68 @@ private:
 
        mutable Time curr_time;
 
-       bool optimize_layers(sinfg::Context context,sinfg::CanvasBase&)const;
+       bool muck_with_time_;
 
-       bool do_not_muck_with_time_;
-       
        bool children_lock;
 
        mutable Rect bounds;
 
        sigc::connection child_changed_connection;
+
+       // Nasty hack: Remember whether we called an extra ref() when
+       // setting the canvas, so we know whether to call an extra unref()
+       // when finished with the canvas.
+       //
+       // Here's the story:
+       //
+       // The root canvas is destructed first.  That sets the
+       // Layer::canvas_ (the parent canvas) of any PasteCanvas layer it
+       // contains to nil, due to a call to Layer::set_canvas(0),
+       // triggered by the connection made when Layer::set_canvas
+       // originally set its canvas_ member to point to the root canvas.
+       // ~Canvas does begin_delete() which triggers that connection.
+       //
+       // After ~Canvas has run, the members of the root canvas are
+       // freed, including its children_ list.  If this was the last
+       // reference to the child canvas that the pastecanvas uses, that
+       // child canvas will Layer_PasteCanvas::set_sub_canvas(0) on the
+       // PasteCanvas layer to set its canvas (the child, pasted canvas)
+       // not to refer to the soon-to-be destroys child canvas.  But
+       // set_sub_canvas() originally looked at the value of
+       // Layer::canvas_ (the parent canvas, obtained via
+       // Layer::get_canvas()) to decide whether to do an extra ref() on
+       // canvas (the child canvas).  We need to unref() it now if we
+       // did, but we've forgotten whether we did.  So we use this
+       // 'extra_reference' member to store that decision.
+       bool extra_reference;
+
+       /*
+ -- ** -- S I G N A L S -------------------------------------------------------
+       */
+
+private:
+
+       sigc::signal<void> signal_subcanvas_changed_;
+
+       /*
+ -- ** -- S I G N A L   I N T E R F A C E -------------------------------------
+       */
+
 public:
 
+       sigc::signal<void>& signal_subcanvas_changed() { return signal_subcanvas_changed_; }
+
+public:
+
+       void update_renddesc();
+
        virtual void on_canvas_set();
 
-       void set_do_not_muck_with_time(bool x=true) { do_not_muck_with_time_=true; }
+       void set_muck_with_time(bool x=false) { muck_with_time_=x; }
+
+       etl::handle<synfig::Canvas> get_sub_canvas()const { return canvas; }
+       void set_sub_canvas(etl::handle<synfig::Canvas> x);
 
-       etl::handle<sinfg::Canvas> get_sub_canvas()const { return canvas; }
-       void set_sub_canvas(etl::handle<sinfg::Canvas> x);
-       
        Real get_zoom()const { return zoom; }
 
        Time get_time_offset()const { return time_offset; }
@@ -89,8 +136,8 @@ public:
        virtual ~Layer_PasteCanvas();
 
        virtual String get_local_name()const;
-       
-       virtual bool set_param(const String & param, const sinfg::ValueBase &value);
+
+       virtual bool set_param(const String & param, const synfig::ValueBase &value);
 
        virtual ValueBase get_param(const String & param)const;
 
@@ -102,16 +149,16 @@ public:
 
        virtual Vocab get_param_vocab()const;
 
-       virtual sinfg::Rect get_bounding_rect()const;
+       virtual synfig::Rect get_bounding_rect()const;
+
+       virtual synfig::Layer::Handle hit_check(synfig::Context context, const synfig::Point &point)const;
 
-       virtual sinfg::Layer::Handle hit_check(sinfg::Context context, const sinfg::Point &point)const;
-       
 protected:
-       virtual void get_times_vfunc(Node::time_set &set) const;        
+       virtual void get_times_vfunc(Node::time_set &set) const;
 
 }; // END of class Layer_PasteCanvas
 
-}; // END of namespace sinfg
+}; // END of namespace synfig
 
 /* === E N D =============================================================== */