Remove .gitignore do nothing is ignored.
[synfig.git] / synfig-core / trunk / src / synfig / layer_pastecanvas.cpp
index b4b8538..3fafb8e 100644 (file)
@@ -6,7 +6,7 @@
 **
 **     \legal
 **     Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
-**     Copyright (c) 2007 Chris Moore
+**     Copyright (c) 2007, 2008 Chris Moore
 **
 **     This package is free software; you can redistribute it and/or
 **     modify it under the terms of the GNU General Public License as
@@ -53,6 +53,7 @@ using namespace synfig;
 
 #define MAX_DEPTH 10
 
+// if this isn't defined, the 'dead heads' in examples/pirates.sifz don't render properly
 #define SYNFIG_CLIP_PASTECANVAS
 
 //#ifdef __APPLE__
@@ -82,9 +83,11 @@ SYNFIG_LAYER_SET_CVS_ID(Layer_PasteCanvas,"$Id$");
 
 Layer_PasteCanvas::Layer_PasteCanvas():
        origin(0,0),
+       focus(0,0),
        depth(0),
        zoom(0),
-       time_offset(0)
+       time_offset(0),
+       extra_reference(false)
 {
        children_lock=false;
        muck_with_time_=true;
@@ -102,6 +105,7 @@ Layer_PasteCanvas::~Layer_PasteCanvas()
        set_sub_canvas(0);
 
        //if(canvas && (canvas->is_inline() || !get_canvas() || get_canvas()->get_root()!=canvas->get_root()))
+       //if(extra_reference)
        //      canvas->unref();
 }
 
@@ -141,6 +145,26 @@ Layer_PasteCanvas::get_param_vocab()const
                .set_local_name(_("Children Lock"))
        );
 
+       ret.push_back(ParamDesc("focus")
+               .set_local_name(_("Focus Point"))
+               .set_origin("origin")
+               .set_connect("origin")
+               .set_description(_("Point to remain fixed when zooming"))
+       //      .set_invisible_duck()
+       );
+
+       // optimize_layers() in canvas.cpp makes a new PasteCanvas layer
+       // and copies over the parameters of the old layer.  the
+       // 'curr_time' member wasn't being copied, so I've added it as a
+       // hidden, non critical parameter, and now it will be.  this
+       // allows a single exported subcanvas to be used more than once at
+       // a time, with different time offets in each.  see bug #1896557.
+       ret.push_back(ParamDesc("curr_time")
+               .set_local_name(_("Current Time"))
+               .not_critical()
+               .hidden()
+       );
+
        return ret;
 }
 
@@ -148,6 +172,7 @@ bool
 Layer_PasteCanvas::set_param(const String & param, const ValueBase &value)
 {
        IMPORT(origin);
+       IMPORT(focus);
 
        // IMPORT(canvas);
        if(param=="canvas" && value.same_type_as(Canvas::Handle()))
@@ -156,7 +181,12 @@ Layer_PasteCanvas::set_param(const String & param, const ValueBase &value)
                return true;
        }
 
-       //! \todo this introduces bug 1844764 if enabled; it was introduced in r954, but I can't see if it's useful
+       //! \todo this introduces bug 1844764 if enabled; it was introduced in r954.
+       // http://synfig.org/images/3/3d/Moving-waypoints.sifz is an
+       // example of an animation that has its waypoints displayed
+       // incorrectly without this fix; select the outer layer and drag
+       // the time slider.  The linear waypoints don't take effect until
+       // 5s, but the time slider appears to pass the first one at 3s.
 #if 0
        if (param=="time_offset" && value.same_type_as(time_offset))
        {
@@ -175,6 +205,7 @@ Layer_PasteCanvas::set_param(const String & param, const ValueBase &value)
 
        IMPORT(children_lock);
        IMPORT(zoom);
+       IMPORT(curr_time);
 
        return Layer_Composite::set_param(param,value);
 }
@@ -185,11 +216,14 @@ Layer_PasteCanvas::set_sub_canvas(etl::handle<synfig::Canvas> x)
        if(canvas && muck_with_time_)
                remove_child(canvas.get());
 
-       if(canvas && (canvas->is_inline() || !get_canvas() || get_canvas()->get_root()!=canvas->get_root()))
+       // if(canvas && (canvas->is_inline() || !get_canvas() || get_canvas()->get_root()!=canvas->get_root()))
+       if (extra_reference)
                canvas->unref();
 
        child_changed_connection.disconnect();
 
+       if (canvas != x) signal_subcanvas_changed()();
+
        canvas=x;
 
        /*if(canvas)
@@ -201,18 +235,41 @@ Layer_PasteCanvas::set_sub_canvas(etl::handle<synfig::Canvas> x)
                );
        */
        if(canvas)
-               bounds=(canvas->get_context().get_full_bounding_rect()-canvas->rend_desc().get_focus())*exp(zoom)+origin+canvas->rend_desc().get_focus();
+               bounds = ((canvas->get_context().get_full_bounding_rect() - focus) * exp(zoom) + origin + focus);
 
        if(canvas && muck_with_time_)
                add_child(canvas.get());
 
        if(canvas && (canvas->is_inline() || !get_canvas() || get_canvas()->get_root()!=canvas->get_root()))
+       {
                canvas->ref();
+               extra_reference = true;
+       }
+       else
+               extra_reference = false;
 
        if(canvas)
                on_canvas_set();
 }
 
+// when a pastecanvas that contains another pastecanvas is copy/pasted
+// from one document to another, only the outermost pastecanvas was
+// getting its renddesc set to match that of its new parent.  this
+// function is used to recurse through the pastecanvas copying its
+// renddesc to any pastecanvases it contains (bug #2116947, svn r2200)
+void
+Layer_PasteCanvas::update_renddesc()
+{
+       if(!get_canvas() || !canvas || !canvas->is_inline()) return;
+
+       canvas->rend_desc()=get_canvas()->rend_desc();
+       for (Context context = canvas->get_context(); !context->empty(); context++)
+       {
+               etl::handle<Layer_PasteCanvas> paste = etl::handle<Layer_PasteCanvas>::cast_dynamic(*context);
+               if (paste) paste->update_renddesc();
+       }
+}
+
 // This is called whenever the parent canvas gets set/changed
 void
 Layer_PasteCanvas::on_canvas_set()
@@ -230,10 +287,12 @@ ValueBase
 Layer_PasteCanvas::get_param(const String& param)const
 {
        EXPORT(origin);
+       EXPORT(focus);
        EXPORT(canvas);
        EXPORT(zoom);
        EXPORT(time_offset);
        EXPORT(children_lock);
+       EXPORT(curr_time);
 
        EXPORT_NAME();
        EXPORT_VERSION();
@@ -252,7 +311,7 @@ Layer_PasteCanvas::set_time(Context context, Time time)const
        {
                canvas->set_time(time+time_offset);
 
-               bounds=(canvas->get_context().get_full_bounding_rect()-canvas->rend_desc().get_focus())*exp(zoom)+origin+canvas->rend_desc().get_focus();
+               bounds=(canvas->get_context().get_full_bounding_rect()-focus)*exp(zoom)+origin+focus;
        }
        else
                bounds=Rect::zero();
@@ -264,7 +323,7 @@ Layer_PasteCanvas::hit_check(synfig::Context context, const synfig::Point &pos)c
        if(depth==MAX_DEPTH)return 0;depth_counter counter(depth);
 
        if (canvas) {
-               Point target_pos=(pos-canvas->rend_desc().get_focus()-origin)/exp(zoom)+canvas->rend_desc().get_focus();
+               Point target_pos=(pos-focus-origin)/exp(zoom)+focus;
 
                if(canvas && get_amount() && canvas->get_context().get_color(target_pos).get_a()>=0.25)
                {
@@ -286,7 +345,7 @@ Layer_PasteCanvas::get_color(Context context, const Point &pos)const
 
        if(depth==MAX_DEPTH)return Color::alpha();depth_counter counter(depth);
 
-       Point target_pos=(pos-canvas->rend_desc().get_focus()-origin)/exp(zoom)+canvas->rend_desc().get_focus();
+       Point target_pos=(pos-focus-origin)/exp(zoom)+focus;
 
        return Color::blend(canvas->get_context().get_color(target_pos),context.get_color(pos),get_amount(),get_blend_method());
 }
@@ -307,9 +366,6 @@ Layer_PasteCanvas::accelerated_render(Context context,Surface *surface,int quali
        if(!canvas || !get_amount())
                return context.accelerated_render(surface,quality,renddesc,cb);
 
-       if(muck_with_time_ && curr_time!=Time::begin() && canvas->get_time()!=curr_time+time_offset)
-               canvas->set_time(curr_time+time_offset);
-
        SuperCallback stageone(cb,0,4500,10000);
        SuperCallback stagetwo(cb,4500,9000,10000);
        SuperCallback stagethree(cb,9000,9999,10000);
@@ -317,8 +373,8 @@ Layer_PasteCanvas::accelerated_render(Context context,Surface *surface,int quali
        RendDesc desc(renddesc);
        Vector::value_type zoomfactor=1.0/exp(zoom);
        desc.clear_flags();
-       desc.set_tl((desc.get_tl()-canvas->rend_desc().get_focus()-origin)*zoomfactor+canvas->rend_desc().get_focus());
-       desc.set_br((desc.get_br()-canvas->rend_desc().get_focus()-origin)*zoomfactor+canvas->rend_desc().get_focus());
+       desc.set_tl((desc.get_tl()-focus-origin)*zoomfactor+focus);
+       desc.set_br((desc.get_br()-focus-origin)*zoomfactor+focus);
        desc.set_flags(RendDesc::PX_ASPECT);
 
        if (is_solid_color() || context->empty())
@@ -329,14 +385,64 @@ Layer_PasteCanvas::accelerated_render(Context context,Surface *surface,int quali
        else if (!context.accelerated_render(surface,quality,renddesc,&stageone))
                return false;
 
+       if(muck_with_time_ && curr_time!=Time::begin() && canvas->get_time()!=curr_time+time_offset)
+               canvas->set_time(curr_time+time_offset);
+
        Color::BlendMethod blend_method(get_blend_method());
        const Rect full_bounding_rect(canvas->get_context().get_full_bounding_rect());
 
-       if(context->empty() ||
-          !etl::intersect(context.get_full_bounding_rect(),full_bounding_rect+origin))
+       bool blend_using_straight = false; // use 'straight' just for the central blit
+
+       // sometimes the user changes the parameters while we're
+       // rendering, causing our pasted canvas' bounding box to shrink
+       // and no longer overlap with our tile.  if that has happened,
+       // let's just stop now - we'll be refreshing soon anyway
+       //! \todo shouldn't a mutex ensure this isn't needed?
+       // http://synfig.org/images/d/d2/Bbox-change.sifz is an example
+       // that shows this happening - open the encapsulation, select the
+       // 'shade', and toggle the 'invert' parameter quickly.
+       // Occasionally you'll see:
+       //   error: Context::accelerated_render(): Layer "shade" threw a bad_alloc exception!
+       // where the shade layer tries to allocate itself a canvas of
+       // negative proportions, due to changing bounding boxes.
+       if (!etl::intersect(desc.get_rect(), full_bounding_rect))
        {
+               warning("%s:%d bounding box shrank while rendering?", __FILE__, __LINE__);
+               return true;
+       }
+
+       // we have rendered what's under us, if necessary
+       if(context->empty())
+       {
+               // if there's nothing under us, and we're blending 'onto', then we've finished
                if (Color::is_onto(blend_method)) return true;
-               if (blend_method==Color::BLEND_COMPOSITE) blend_method=Color::BLEND_STRAIGHT;
+
+               // there's nothing under us, so using straight blending is
+               // faster than and equivalent to using composite, but we don't
+               // want to blank the surrounding areas
+               if (blend_method==Color::BLEND_COMPOSITE) blend_using_straight = true;
+       }
+
+       if (!etl::intersect(context.get_full_bounding_rect(),(full_bounding_rect-focus)*exp(zoom)+origin+focus))
+       {
+               // if there's no intersection between the context and our
+               // surface, and we're rendering 'onto', then we're done
+               if (Color::is_onto(blend_method) && !Color::is_straight(blend_method))
+                       return true;
+
+               /* 'straight' is faster than 'composite' and has the same
+                * effect if the affected area of the lower layer is
+                * transparent;  however, if we're not clipping the blit to
+                * just the bounding rectangle, the affected area is the whole
+                * tile, so we can't use this optimisation.  if we are
+                * clipping, then we can use 'straight' to blit the clipped
+                * rectangle, but we shouldn't set blend_method to 'straight',
+                * or the surrounding areas will be blanked, which we don't
+                * want.
+                */
+#ifdef SYNFIG_CLIP_PASTECANVAS
+               if (blend_method==Color::BLEND_COMPOSITE) blend_using_straight = true;
+#endif // SYNFIG_CLIP_PASTECANVAS
        }
 
 #ifdef SYNFIG_CLIP_PASTECANVAS
@@ -353,6 +459,9 @@ Layer_PasteCanvas::accelerated_render(Context context,Surface *surface,int quali
        const int w( ceil_to_int((max[0] - desc.get_tl()[0]) / desc.get_pw()) - x);
        const int h( ceil_to_int((max[1] - desc.get_tl()[1]) / desc.get_ph()) - y);
 
+       const int tw = desc.get_w();
+       const int th = desc.get_h();
+
        desc.set_subwindow(x,y,w,h);
 
        // \todo this used to also have "area.area()<=0.000001 || " - is it useful?
@@ -362,6 +471,56 @@ Layer_PasteCanvas::accelerated_render(Context context,Surface *surface,int quali
                if(cb && !cb->amount_complete(10000,10000)) return false;
                return true;
        }
+
+       // SYNFIG_CLIP_PASTECANVAS is defined, so we are only touching the
+       // pixels within the affected rectangle.  If the blend method is
+       // 'straight', then we need to blend transparent pixels with the
+       // clipped areas of this tile, because with the 'straight' blend
+       // method, even transparent pixels have an effect on the layers below
+       if (Color::is_straight(blend_method))
+       {
+               Surface clearsurface;
+
+               Surface::alpha_pen apen(surface->begin());
+               apen.set_alpha(get_amount());
+
+               // the area we're about to blit is transparent, so it doesn't
+               // matter whether we use 'straight' or 'straight onto' here
+               if (blend_method == Color::BLEND_ALPHA_BRIGHTEN)
+                       apen.set_blend_method(blend_method);
+               else
+                       apen.set_blend_method(Color::BLEND_STRAIGHT);
+
+               /* This represents the area we're pasting into the tile,
+                * within the tile as a whole.  Areas (A), (B), (C) and (D)
+                * need blending with the underlying context if they're not
+                * zero-sized:
+                *
+                *               0         x             x+w      tw
+                *       0       +------------------------+
+                *               |                                                |
+                *               |                      (A)                       |
+                *               |                                                |
+                *       y       | - - +----------+ - - - |
+                *               |         |              |               |
+                *               | (C) |  w by h  |      (D)  |
+                *               |         |              |               |
+                *       y+h | - - +----------+ - - - |
+                *               |                                                |
+                *               |                      (B)                       |
+                *               |                                                |
+                *       tw      +------------------------+
+                */
+
+               if (y > 0)                              // draw the full-width strip above the rectangle (A)
+               { apen.move_to(0,0);   clearsurface.set_wh(tw,y);        clearsurface.clear(); clearsurface.blit_to(apen); }
+               if (y+h < th)                   // draw the full-width strip below the rectangle (B)
+               { apen.move_to(0,y+h); clearsurface.set_wh(tw,th-(y+h)); clearsurface.clear(); clearsurface.blit_to(apen); }
+               if (x > 0)                              // draw the box directly left of the rectangle (C)
+               { apen.move_to(0,y);   clearsurface.set_wh(x,h);         clearsurface.clear(); clearsurface.blit_to(apen); }
+               if (x+w < tw)                   // draw the box directly right of the rectangle (D)
+               { apen.move_to(x+w,y); clearsurface.set_wh(tw-(x+w),h);  clearsurface.clear(); clearsurface.blit_to(apen); }
+       }
 #endif // SYNFIG_CLIP_PASTECANVAS
 
        // render the canvas to be pasted onto pastesurface
@@ -376,7 +535,7 @@ Layer_PasteCanvas::accelerated_render(Context context,Surface *surface,int quali
 #endif // SYNFIG_CLIP_PASTECANVAS
 
        apen.set_alpha(get_amount());
-       apen.set_blend_method(blend_method);
+       apen.set_blend_method(blend_using_straight ? Color::BLEND_STRAIGHT : blend_method);
        pastesurface.blit_to(apen);
 
        if(cb && !cb->amount_complete(10000,10000)) return false;