layer_pastecanvas.h

Go to the documentation of this file.

/* === S Y N F I G ========================================================= */
/* ========================================================================= */

/* === S T A R T =========================================================== */

#ifndef __SYNFIG_LAYER_PASTECANVAS_H
#define __SYNFIG_LAYER_PASTECANVAS_H

/* === H E A D E R S ======================================================= */

#include "layer_composite.h"
#include <synfig/color.h>
#include <synfig/vector.h>
#include <synfig/real.h>
#include <synfig/time.h>
#include <synfig/canvasbase.h>
#include <synfig/canvas.h>
#include <synfig/rect.h>
#include <synfig/transformation.h>

/* === M A C R O S ========================================================= */

/* === T Y P E D E F S ===================================================== */

/* === C L A S S E S & S T R U C T S ======================================= */

namespace synfig {
class Layer_PasteCanvas : public Layer_Composite, public Layer_NoDeform
{
private:
    ValueBase param_origin;
    ValueBase param_transformation;
    etl::loose_handle<synfig::Canvas> canvas;
    ValueBase param_time_dilation;
    ValueBase param_time_offset;
    ValueBase param_outline_grow;
    ValueBase param_children_lock;
    mutable ValueBase param_curr_time;

    bool muck_with_time_;
    mutable int depth;

    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_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);
    Real get_time_dilation()const { return param_time_dilation.get(Real()); }
    Time get_time_offset()const { return param_time_offset.get(Time()); }

    Point get_origin()const { return param_origin.get(Point()); }
    Transformation get_transformation()const { return param_transformation.get(Transformation()); }
    Transformation get_summary_transformation()const
    {
        return get_transformation().transform( Transformation(-get_origin()) );
    }

    Layer_PasteCanvas();
    virtual ~Layer_PasteCanvas();
    virtual String get_local_name()const;
    virtual bool set_param(const String & param, const synfig::ValueBase &value);
    virtual ValueBase get_param(const String & param)const;
    virtual void apply_z_range_to_params(ContextParams &cp)const;
    virtual Color get_color(Context context, const Point &pos)const;
    virtual void set_time(IndependentContext context, Time time)const;
    virtual bool accelerated_render(Context context,Surface *surface,int quality, const RendDesc &renddesc, ProgressCallback *cb)const;
    virtual bool accelerated_cairorender(Context context, cairo_t *cr, int quality, const RendDesc &renddesc, ProgressCallback *cb)const;
    Rect get_bounding_rect_context_dependent(const ContextParams &context_params)const;
    virtual Rect get_full_bounding_rect(Context context)const;
    virtual Vocab get_param_vocab()const;
    virtual synfig::Layer::Handle hit_check(synfig::Context context, const synfig::Point &point)const;
    virtual void set_render_method(Context context, RenderMethod x);

    virtual void fill_sound_processor(SoundProcessor &soundProcessor) const;

protected:
    virtual void get_times_vfunc(Node::time_set &set) const;

}; // END of class Layer_PasteCanvas

}; // END of namespace synfig

/* === E N D =============================================================== */

#endif