1 /* === S Y N F I G ========================================================= */
2 /*! \file layer_pastecanvas.cpp
3 ** \brief 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 /* === H E A D E R S ======================================================= */
33 #include "layer_pastecanvas.h"
37 #include "paramdesc.h"
41 #include "valuenode.h"
46 /* === U S I N G =========================================================== */
50 using namespace synfig;
52 /* === M A C R O S ========================================================= */
56 // if this isn't defined, the 'dead heads' in examples/pirates.sifz don't render properly
57 #define SYNFIG_CLIP_PASTECANVAS
60 //#undef SYNFIG_CLIP_PASTECANVAS
63 /* === C L A S S E S ======================================================= */
65 class depth_counter // Makes our recursive depth counter exception-safe
69 depth_counter(int &x):depth(&x) { (*depth)++; }
70 ~depth_counter() { (*depth)--; }
73 /* === G L O B A L S ======================================================= */
75 SYNFIG_LAYER_INIT(Layer_PasteCanvas);
76 SYNFIG_LAYER_SET_NAME(Layer_PasteCanvas,"PasteCanvas"); // todo: use paste_canvas
77 SYNFIG_LAYER_SET_LOCAL_NAME(Layer_PasteCanvas,N_("Paste Canvas"));
78 SYNFIG_LAYER_SET_CATEGORY(Layer_PasteCanvas,N_("Other"));
79 SYNFIG_LAYER_SET_VERSION(Layer_PasteCanvas,"0.1");
80 SYNFIG_LAYER_SET_CVS_ID(Layer_PasteCanvas,"$Id$");
82 /* === M E T H O D S ======================================================= */
84 Layer_PasteCanvas::Layer_PasteCanvas():
90 extra_reference(false)
94 curr_time=Time::begin();
97 Layer_PasteCanvas::~Layer_PasteCanvas()
100 canvas->parent_set.erase(this);
103 //if(canvas)DEBUGINFO(strprintf("%d",canvas->count()));
107 //if(canvas && (canvas->is_inline() || !get_canvas() || get_canvas()->get_root()!=canvas->get_root()))
108 //if(extra_reference)
113 Layer_PasteCanvas::get_local_name()const
115 if(!canvas) return _("Pasted Canvas");
116 if(canvas->is_inline()) return _("Inline Canvas");
117 if(canvas->get_root()==get_canvas()->get_root()) return '[' + canvas->get_id() + ']';
119 return '[' + canvas->get_file_name() + ']';
123 Layer_PasteCanvas::get_param_vocab()const
125 Layer::Vocab ret(Layer_Composite::get_param_vocab());
127 ret.push_back(ParamDesc("origin")
128 .set_local_name(_("Origin"))
129 .set_description(_("Point where you want the origin to be"))
131 ret.push_back(ParamDesc("canvas")
132 .set_local_name(_("Canvas"))
133 .set_description(_("Canvas to paste"))
135 ret.push_back(ParamDesc("zoom")
136 .set_local_name(_("Zoom"))
137 .set_description(_("Size of canvas"))
140 ret.push_back(ParamDesc("time_offset")
141 .set_local_name(_("Time Offset"))
144 ret.push_back(ParamDesc("children_lock")
145 .set_local_name(_("Children Lock"))
148 ret.push_back(ParamDesc("focus")
149 .set_local_name(_("Focus Point"))
150 .set_origin("origin")
151 .set_connect("origin")
152 .set_description(_("Point to remain fixed when zooming"))
153 // .set_invisible_duck()
156 // optimize_layers() in canvas.cpp makes a new PasteCanvas layer
157 // and copies over the parameters of the old layer. the
158 // 'curr_time' member wasn't being copied, so I've added it as a
159 // hidden, non critical parameter, and now it will be. this
160 // allows a single exported subcanvas to be used more than once at
161 // a time, with different time offets in each. see bug #1896557.
162 ret.push_back(ParamDesc("curr_time")
163 .set_local_name(_("Current Time"))
172 Layer_PasteCanvas::set_param(const String & param, const ValueBase &value)
178 if(param=="canvas" && value.same_type_as(Canvas::Handle()))
180 set_sub_canvas(value.get(Canvas::Handle()));
184 //! \todo this introduces bug 1844764 if enabled; it was introduced in r954.
185 // http://synfig.org/images/3/3d/Moving-waypoints.sifz is an
186 // example of an animation that has its waypoints displayed
187 // incorrectly without this fix; select the outer layer and drag
188 // the time slider. The linear waypoints don't take effect until
189 // 5s, but the time slider appears to pass the first one at 3s.
191 if (param=="time_offset" && value.same_type_as(time_offset))
193 if (time_offset != value.get(Time()))
195 value.put(&time_offset);
196 // notify that the time_offset has changed so we can update the
197 // waypoint positions in parent layers
206 IMPORT(children_lock);
210 return Layer_Composite::set_param(param,value);
214 Layer_PasteCanvas::set_sub_canvas(etl::handle<synfig::Canvas> x)
216 if(canvas && muck_with_time_)
217 remove_child(canvas.get());
219 // if(canvas && (canvas->is_inline() || !get_canvas() || get_canvas()->get_root()!=canvas->get_root()))
223 child_changed_connection.disconnect();
225 if (canvas != x) signal_subcanvas_changed()();
230 child_changed_connection=canvas->signal_changed().connect(
233 &Layer_PasteCanvas::changed
238 bounds = ((canvas->get_context().get_full_bounding_rect() - focus) * exp(zoom) + origin + focus);
240 if(canvas && muck_with_time_)
241 add_child(canvas.get());
243 if(canvas && (canvas->is_inline() || !get_canvas() || get_canvas()->get_root()!=canvas->get_root()))
246 extra_reference = true;
249 extra_reference = false;
255 // when a pastecanvas that contains another pastecanvas is copy/pasted
256 // from one document to another, only the outermost pastecanvas was
257 // getting its renddesc set to match that of its new parent. this
258 // function is used to recurse through the pastecanvas copying its
259 // renddesc to any pastecanvases it contains (bug #2116947, svn r2200)
261 Layer_PasteCanvas::update_renddesc()
263 if(!get_canvas() || !canvas || !canvas->is_inline()) return;
265 canvas->rend_desc()=get_canvas()->rend_desc();
266 for (Context context = canvas->get_context(); !context->empty(); context++)
268 etl::handle<Layer_PasteCanvas> paste = etl::handle<Layer_PasteCanvas>::cast_dynamic(*context);
269 if (paste) paste->update_renddesc();
273 // This is called whenever the parent canvas gets set/changed
275 Layer_PasteCanvas::on_canvas_set()
277 if(get_canvas() && canvas && canvas->is_inline() && canvas->parent()!=get_canvas())
279 canvas->set_inline(get_canvas());
284 Layer_PasteCanvas::get_param(const String& param)const
291 EXPORT(children_lock);
297 return Layer_Composite::get_param(param);
301 Layer_PasteCanvas::set_time(Context context, Time time)const
303 if(depth==MAX_DEPTH)return;depth_counter counter(depth);
306 context.set_time(time);
309 canvas->set_time(time+time_offset);
311 bounds=(canvas->get_context().get_full_bounding_rect()-focus)*exp(zoom)+origin+focus;
317 synfig::Layer::Handle
318 Layer_PasteCanvas::hit_check(synfig::Context context, const synfig::Point &pos)const
320 if(depth==MAX_DEPTH)return 0;depth_counter counter(depth);
323 Point target_pos=(pos-focus-origin)/exp(zoom)+focus;
325 if(canvas && get_amount() && canvas->get_context().get_color(target_pos).get_a()>=0.25)
329 return canvas->get_context().hit_check(target_pos);
331 return const_cast<Layer_PasteCanvas*>(this);
334 return context.hit_check(pos);
338 Layer_PasteCanvas::get_color(Context context, const Point &pos)const
340 if(!canvas || !get_amount())
341 return context.get_color(pos);
343 if(depth==MAX_DEPTH)return Color::alpha();depth_counter counter(depth);
345 Point target_pos=(pos-focus-origin)/exp(zoom)+focus;
347 return Color::blend(canvas->get_context().get_color(target_pos),context.get_color(pos),get_amount(),get_blend_method());
352 Layer_PasteCanvas::accelerated_render(Context context,Surface *surface,int quality, const RendDesc &renddesc, ProgressCallback *cb)const
354 if(cb && !cb->amount_complete(0,10000)) return false;
357 // if we are at the extent of our depth,
358 // then we should just return whatever is under us.
359 return context.accelerated_render(surface,quality,renddesc,cb);
361 depth_counter counter(depth);
363 if(!canvas || !get_amount())
364 return context.accelerated_render(surface,quality,renddesc,cb);
366 SuperCallback stageone(cb,0,4500,10000);
367 SuperCallback stagetwo(cb,4500,9000,10000);
368 SuperCallback stagethree(cb,9000,9999,10000);
370 RendDesc desc(renddesc);
371 Vector::value_type zoomfactor=1.0/exp(zoom);
373 desc.set_tl((desc.get_tl()-focus-origin)*zoomfactor+focus);
374 desc.set_br((desc.get_br()-focus-origin)*zoomfactor+focus);
375 desc.set_flags(RendDesc::PX_ASPECT);
377 if (is_solid_color() || context->empty())
379 surface->set_wh(renddesc.get_w(),renddesc.get_h());
382 else if (!context.accelerated_render(surface,quality,renddesc,&stageone))
385 if(muck_with_time_ && curr_time!=Time::begin() /*&& canvas->get_time()!=curr_time+time_offset*/)
386 canvas->set_time(curr_time+time_offset);
388 Color::BlendMethod blend_method(get_blend_method());
389 const Rect full_bounding_rect(canvas->get_context().get_full_bounding_rect());
391 bool blend_using_straight = false; // use 'straight' just for the central blit
393 // sometimes the user changes the parameters while we're
394 // rendering, causing our pasted canvas' bounding box to shrink
395 // and no longer overlap with our tile. if that has happened,
396 // let's just stop now - we'll be refreshing soon anyway
397 //! \todo shouldn't a mutex ensure this isn't needed?
398 // http://synfig.org/images/d/d2/Bbox-change.sifz is an example
399 // that shows this happening - open the encapsulation, select the
400 // 'shade', and toggle the 'invert' parameter quickly.
401 // Occasionally you'll see:
402 // error: Context::accelerated_render(): Layer "shade" threw a bad_alloc exception!
403 // where the shade layer tries to allocate itself a canvas of
404 // negative proportions, due to changing bounding boxes.
405 if (!etl::intersect(desc.get_rect(), full_bounding_rect))
407 warning("%s:%d bounding box shrank while rendering?", __FILE__, __LINE__);
411 // we have rendered what's under us, if necessary
414 // if there's nothing under us, and we're blending 'onto', then we've finished
415 if (Color::is_onto(blend_method)) return true;
417 // there's nothing under us, so using straight blending is
418 // faster than and equivalent to using composite, but we don't
419 // want to blank the surrounding areas
420 if (blend_method==Color::BLEND_COMPOSITE) blend_using_straight = true;
423 if (!etl::intersect(context.get_full_bounding_rect(),(full_bounding_rect-focus)*exp(zoom)+origin+focus))
425 // if there's no intersection between the context and our
426 // surface, and we're rendering 'onto', then we're done
427 if (Color::is_onto(blend_method) && !Color::is_straight(blend_method))
430 /* 'straight' is faster than 'composite' and has the same
431 * effect if the affected area of the lower layer is
432 * transparent; however, if we're not clipping the blit to
433 * just the bounding rectangle, the affected area is the whole
434 * tile, so we can't use this optimisation. if we are
435 * clipping, then we can use 'straight' to blit the clipped
436 * rectangle, but we shouldn't set blend_method to 'straight',
437 * or the surrounding areas will be blanked, which we don't
440 #ifdef SYNFIG_CLIP_PASTECANVAS
441 if (blend_method==Color::BLEND_COMPOSITE) blend_using_straight = true;
442 #endif // SYNFIG_CLIP_PASTECANVAS
445 #ifdef SYNFIG_CLIP_PASTECANVAS
446 Rect area(desc.get_rect() & full_bounding_rect);
448 Point min(area.get_min());
449 Point max(area.get_max());
451 if (desc.get_tl()[0] > desc.get_br()[0]) swap(min[0], max[0]);
452 if (desc.get_tl()[1] > desc.get_br()[1]) swap(min[1], max[1]);
454 const int x(floor_to_int((min[0] - desc.get_tl()[0]) / desc.get_pw()));
455 const int y(floor_to_int((min[1] - desc.get_tl()[1]) / desc.get_ph()));
456 const int w( ceil_to_int((max[0] - desc.get_tl()[0]) / desc.get_pw()) - x);
457 const int h( ceil_to_int((max[1] - desc.get_tl()[1]) / desc.get_ph()) - y);
459 const int tw = desc.get_w();
460 const int th = desc.get_h();
462 desc.set_subwindow(x,y,w,h);
464 // \todo this used to also have "area.area()<=0.000001 || " - is it useful?
465 // it was causing bug #1809480 (Zoom in beyond 8.75 in nested canvases fails)
466 if(desc.get_w()==0 || desc.get_h()==0)
468 if(cb && !cb->amount_complete(10000,10000)) return false;
472 // SYNFIG_CLIP_PASTECANVAS is defined, so we are only touching the
473 // pixels within the affected rectangle. If the blend method is
474 // 'straight', then we need to blend transparent pixels with the
475 // clipped areas of this tile, because with the 'straight' blend
476 // method, even transparent pixels have an effect on the layers below
477 if (Color::is_straight(blend_method))
479 Surface clearsurface;
481 Surface::alpha_pen apen(surface->begin());
482 apen.set_alpha(get_amount());
484 // the area we're about to blit is transparent, so it doesn't
485 // matter whether we use 'straight' or 'straight onto' here
486 if (blend_method == Color::BLEND_ALPHA_BRIGHTEN)
487 apen.set_blend_method(blend_method);
489 apen.set_blend_method(Color::BLEND_STRAIGHT);
491 /* This represents the area we're pasting into the tile,
492 * within the tile as a whole. Areas (A), (B), (C) and (D)
493 * need blending with the underlying context if they're not
497 * 0 +------------------------+
501 * y | - - +----------+ - - - |
503 * | (C) | w by h | (D) |
505 * y+h | - - +----------+ - - - |
509 * tw +------------------------+
512 if (y > 0) // draw the full-width strip above the rectangle (A)
513 { apen.move_to(0,0); clearsurface.set_wh(tw,y); clearsurface.clear(); clearsurface.blit_to(apen); }
514 if (y+h < th) // draw the full-width strip below the rectangle (B)
515 { apen.move_to(0,y+h); clearsurface.set_wh(tw,th-(y+h)); clearsurface.clear(); clearsurface.blit_to(apen); }
516 if (x > 0) // draw the box directly left of the rectangle (C)
517 { apen.move_to(0,y); clearsurface.set_wh(x,h); clearsurface.clear(); clearsurface.blit_to(apen); }
518 if (x+w < tw) // draw the box directly right of the rectangle (D)
519 { apen.move_to(x+w,y); clearsurface.set_wh(tw-(x+w),h); clearsurface.clear(); clearsurface.blit_to(apen); }
521 #endif // SYNFIG_CLIP_PASTECANVAS
523 // render the canvas to be pasted onto pastesurface
524 Surface pastesurface;
525 if(!canvas->get_context().accelerated_render(&pastesurface,quality,desc,&stagetwo))
528 #ifdef SYNFIG_CLIP_PASTECANVAS
529 Surface::alpha_pen apen(surface->get_pen(x,y));
530 #else // SYNFIG_CLIP_PASTECANVAS
531 Surface::alpha_pen apen(surface->begin());
532 #endif // SYNFIG_CLIP_PASTECANVAS
534 apen.set_alpha(get_amount());
535 apen.set_blend_method(blend_using_straight ? Color::BLEND_STRAIGHT : blend_method);
536 pastesurface.blit_to(apen);
538 if(cb && !cb->amount_complete(10000,10000)) return false;
544 Layer_PasteCanvas::get_bounding_rect()const
549 void Layer_PasteCanvas::get_times_vfunc(Node::time_set &set) const
552 if(canvas) tset = canvas->get_times();
554 Node::time_set::iterator i = tset.begin(), end = tset.end();
556 //Make sure we offset the time...
557 //! \todo: SOMETHING STILL HAS TO BE DONE WITH THE OTHER DIRECTION
558 // (recursing down the tree needs to take this into account too...)
561 #ifdef ADJUST_WAYPOINTS_FOR_TIME_OFFSET // see node.h
566 Layer::get_times_vfunc(set);