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();
95 Layer::Vocab voc(get_param_vocab());
96 Layer::fill_static(voc);
97 set_param_static("children_lock", true);
100 Layer_PasteCanvas::~Layer_PasteCanvas()
103 canvas->parent_set.erase(this);
106 //if(canvas)DEBUGINFO(strprintf("%d",canvas->count()));
110 //if(canvas && (canvas->is_inline() || !get_canvas() || get_canvas()->get_root()!=canvas->get_root()))
111 //if(extra_reference)
116 Layer_PasteCanvas::get_local_name()const
118 if(!canvas) return _("Pasted Canvas");
119 if(canvas->is_inline()) return _("Inline Canvas");
120 if(canvas->get_root()==get_canvas()->get_root()) return '[' + canvas->get_id() + ']';
122 return '[' + canvas->get_file_name() + ']';
126 Layer_PasteCanvas::get_param_vocab()const
128 Layer::Vocab ret(Layer_Composite::get_param_vocab());
130 ret.push_back(ParamDesc("origin")
131 .set_local_name(_("Origin"))
132 .set_description(_("Point where you want the origin to be"))
134 ret.push_back(ParamDesc("canvas")
135 .set_local_name(_("Canvas"))
136 .set_description(_("Canvas to paste"))
138 ret.push_back(ParamDesc("zoom")
139 .set_local_name(_("Zoom"))
140 .set_description(_("Size of canvas"))
143 ret.push_back(ParamDesc("time_offset")
144 .set_local_name(_("Time Offset"))
147 ret.push_back(ParamDesc("children_lock")
148 .set_local_name(_("Children Lock"))
151 ret.push_back(ParamDesc("focus")
152 .set_local_name(_("Focus Point"))
153 .set_origin("origin")
154 .set_connect("origin")
155 .set_description(_("Point to remain fixed when zooming"))
156 // .set_invisible_duck()
159 // optimize_layers() in canvas.cpp makes a new PasteCanvas layer
160 // and copies over the parameters of the old layer. the
161 // 'curr_time' member wasn't being copied, so I've added it as a
162 // hidden, non critical parameter, and now it will be. this
163 // allows a single exported subcanvas to be used more than once at
164 // a time, with different time offets in each. see bug #1896557.
165 ret.push_back(ParamDesc("curr_time")
166 .set_local_name(_("Current Time"))
175 Layer_PasteCanvas::set_param(const String & param, const ValueBase &value)
181 if(param=="canvas" && value.same_type_as(Canvas::Handle()))
183 set_sub_canvas(value.get(Canvas::Handle()));
184 set_param_static(param, value.get_static());
187 //! \todo this introduces bug 1844764 if enabled; it was introduced in r954.
188 // http://synfig.org/images/3/3d/Moving-waypoints.sifz is an
189 // example of an animation that has its waypoints displayed
190 // incorrectly without this fix; select the outer layer and drag
191 // the time slider. The linear waypoints don't take effect until
192 // 5s, but the time slider appears to pass the first one at 3s.
194 if (param=="time_offset" && value.same_type_as(time_offset))
196 if (time_offset != value.get(Time()))
198 value.put(&time_offset);
199 // notify that the time_offset has changed so we can update the
200 // waypoint positions in parent layers
209 IMPORT(children_lock);
213 return Layer_Composite::set_param(param,value);
217 Layer_PasteCanvas::set_sub_canvas(etl::handle<synfig::Canvas> x)
219 if(canvas && muck_with_time_)
220 remove_child(canvas.get());
222 // if(canvas && (canvas->is_inline() || !get_canvas() || get_canvas()->get_root()!=canvas->get_root()))
226 child_changed_connection.disconnect();
228 if (canvas != x) signal_subcanvas_changed()();
233 child_changed_connection=canvas->signal_changed().connect(
236 &Layer_PasteCanvas::changed
241 bounds = ((canvas->get_context().get_full_bounding_rect() - focus) * exp(zoom) + origin + focus);
243 if(canvas && muck_with_time_)
244 add_child(canvas.get());
246 if(canvas && (canvas->is_inline() || !get_canvas() || get_canvas()->get_root()!=canvas->get_root()))
249 extra_reference = true;
252 extra_reference = false;
258 // when a pastecanvas that contains another pastecanvas is copy/pasted
259 // from one document to another, only the outermost pastecanvas was
260 // getting its renddesc set to match that of its new parent. this
261 // function is used to recurse through the pastecanvas copying its
262 // renddesc to any pastecanvases it contains (bug #2116947, svn r2200)
264 Layer_PasteCanvas::update_renddesc()
266 if(!get_canvas() || !canvas || !canvas->is_inline()) return;
268 canvas->rend_desc()=get_canvas()->rend_desc();
269 for (Context context = canvas->get_context(); !context->empty(); context++)
271 etl::handle<Layer_PasteCanvas> paste = etl::handle<Layer_PasteCanvas>::cast_dynamic(*context);
272 if (paste) paste->update_renddesc();
276 // This is called whenever the parent canvas gets set/changed
278 Layer_PasteCanvas::on_canvas_set()
280 if(get_canvas() && canvas && canvas->is_inline() && canvas->parent()!=get_canvas())
282 canvas->set_inline(get_canvas());
287 Layer_PasteCanvas::get_param(const String& param)const
294 EXPORT(children_lock);
300 return Layer_Composite::get_param(param);
304 Layer_PasteCanvas::set_time(Context context, Time time)const
306 if(depth==MAX_DEPTH)return;depth_counter counter(depth);
309 context.set_time(time);
312 canvas->set_time(time+time_offset);
314 bounds=(canvas->get_context().get_full_bounding_rect()-focus)*exp(zoom)+origin+focus;
320 synfig::Layer::Handle
321 Layer_PasteCanvas::hit_check(synfig::Context context, const synfig::Point &pos)const
323 if(depth==MAX_DEPTH)return 0;depth_counter counter(depth);
326 Point target_pos=(pos-focus-origin)/exp(zoom)+focus;
328 if(canvas && get_amount() && canvas->get_context().get_color(target_pos).get_a()>=0.25)
332 return canvas->get_context().hit_check(target_pos);
334 return const_cast<Layer_PasteCanvas*>(this);
337 return context.hit_check(pos);
341 Layer_PasteCanvas::get_color(Context context, const Point &pos)const
343 if(!canvas || !get_amount())
344 return context.get_color(pos);
346 if(depth==MAX_DEPTH)return Color::alpha();depth_counter counter(depth);
348 Point target_pos=(pos-focus-origin)/exp(zoom)+focus;
350 return Color::blend(canvas->get_context().get_color(target_pos),context.get_color(pos),get_amount(),get_blend_method());
355 Layer_PasteCanvas::accelerated_render(Context context,Surface *surface,int quality, const RendDesc &renddesc, ProgressCallback *cb)const
357 if(cb && !cb->amount_complete(0,10000)) return false;
360 // if we are at the extent of our depth,
361 // then we should just return whatever is under us.
362 return context.accelerated_render(surface,quality,renddesc,cb);
364 depth_counter counter(depth);
366 if(!canvas || !get_amount())
367 return context.accelerated_render(surface,quality,renddesc,cb);
369 SuperCallback stageone(cb,0,4500,10000);
370 SuperCallback stagetwo(cb,4500,9000,10000);
371 SuperCallback stagethree(cb,9000,9999,10000);
373 RendDesc desc(renddesc);
374 Vector::value_type zoomfactor=1.0/exp(zoom);
376 desc.set_tl((desc.get_tl()-focus-origin)*zoomfactor+focus);
377 desc.set_br((desc.get_br()-focus-origin)*zoomfactor+focus);
378 desc.set_flags(RendDesc::PX_ASPECT);
380 if (is_solid_color() || context->empty())
382 surface->set_wh(renddesc.get_w(),renddesc.get_h());
385 else if (!context.accelerated_render(surface,quality,renddesc,&stageone))
388 if(muck_with_time_ && curr_time!=Time::begin() /*&& canvas->get_time()!=curr_time+time_offset*/)
389 canvas->set_time(curr_time+time_offset);
391 Color::BlendMethod blend_method(get_blend_method());
392 const Rect full_bounding_rect(canvas->get_context().get_full_bounding_rect());
394 bool blend_using_straight = false; // use 'straight' just for the central blit
396 // sometimes the user changes the parameters while we're
397 // rendering, causing our pasted canvas' bounding box to shrink
398 // and no longer overlap with our tile. if that has happened,
399 // let's just stop now - we'll be refreshing soon anyway
400 //! \todo shouldn't a mutex ensure this isn't needed?
401 // http://synfig.org/images/d/d2/Bbox-change.sifz is an example
402 // that shows this happening - open the encapsulation, select the
403 // 'shade', and toggle the 'invert' parameter quickly.
404 // Occasionally you'll see:
405 // error: Context::accelerated_render(): Layer "shade" threw a bad_alloc exception!
406 // where the shade layer tries to allocate itself a canvas of
407 // negative proportions, due to changing bounding boxes.
408 if (!etl::intersect(desc.get_rect(), full_bounding_rect))
410 warning("%s:%d bounding box shrank while rendering?", __FILE__, __LINE__);
414 // we have rendered what's under us, if necessary
417 // if there's nothing under us, and we're blending 'onto', then we've finished
418 if (Color::is_onto(blend_method)) return true;
420 // there's nothing under us, so using straight blending is
421 // faster than and equivalent to using composite, but we don't
422 // want to blank the surrounding areas
423 if (blend_method==Color::BLEND_COMPOSITE) blend_using_straight = true;
426 if (!etl::intersect(context.get_full_bounding_rect(),(full_bounding_rect-focus)*exp(zoom)+origin+focus))
428 // if there's no intersection between the context and our
429 // surface, and we're rendering 'onto', then we're done
430 if (Color::is_onto(blend_method) && !Color::is_straight(blend_method))
433 /* 'straight' is faster than 'composite' and has the same
434 * effect if the affected area of the lower layer is
435 * transparent; however, if we're not clipping the blit to
436 * just the bounding rectangle, the affected area is the whole
437 * tile, so we can't use this optimisation. if we are
438 * clipping, then we can use 'straight' to blit the clipped
439 * rectangle, but we shouldn't set blend_method to 'straight',
440 * or the surrounding areas will be blanked, which we don't
443 #ifdef SYNFIG_CLIP_PASTECANVAS
444 if (blend_method==Color::BLEND_COMPOSITE) blend_using_straight = true;
445 #endif // SYNFIG_CLIP_PASTECANVAS
448 #ifdef SYNFIG_CLIP_PASTECANVAS
449 Rect area(desc.get_rect() & full_bounding_rect);
451 Point min(area.get_min());
452 Point max(area.get_max());
454 if (desc.get_tl()[0] > desc.get_br()[0]) swap(min[0], max[0]);
455 if (desc.get_tl()[1] > desc.get_br()[1]) swap(min[1], max[1]);
457 const int x(floor_to_int((min[0] - desc.get_tl()[0]) / desc.get_pw()));
458 const int y(floor_to_int((min[1] - desc.get_tl()[1]) / desc.get_ph()));
459 const int w( ceil_to_int((max[0] - desc.get_tl()[0]) / desc.get_pw()) - x);
460 const int h( ceil_to_int((max[1] - desc.get_tl()[1]) / desc.get_ph()) - y);
462 const int tw = desc.get_w();
463 const int th = desc.get_h();
465 desc.set_subwindow(x,y,w,h);
467 // \todo this used to also have "area.area()<=0.000001 || " - is it useful?
468 // it was causing bug #1809480 (Zoom in beyond 8.75 in nested canvases fails)
469 if(desc.get_w()==0 || desc.get_h()==0)
471 if(cb && !cb->amount_complete(10000,10000)) return false;
475 // SYNFIG_CLIP_PASTECANVAS is defined, so we are only touching the
476 // pixels within the affected rectangle. If the blend method is
477 // 'straight', then we need to blend transparent pixels with the
478 // clipped areas of this tile, because with the 'straight' blend
479 // method, even transparent pixels have an effect on the layers below
480 if (Color::is_straight(blend_method))
482 Surface clearsurface;
484 Surface::alpha_pen apen(surface->begin());
485 apen.set_alpha(get_amount());
487 // the area we're about to blit is transparent, so it doesn't
488 // matter whether we use 'straight' or 'straight onto' here
489 if (blend_method == Color::BLEND_ALPHA_BRIGHTEN)
490 apen.set_blend_method(blend_method);
492 apen.set_blend_method(Color::BLEND_STRAIGHT);
494 /* This represents the area we're pasting into the tile,
495 * within the tile as a whole. Areas (A), (B), (C) and (D)
496 * need blending with the underlying context if they're not
500 * 0 +------------------------+
504 * y | - - +----------+ - - - |
506 * | (C) | w by h | (D) |
508 * y+h | - - +----------+ - - - |
512 * tw +------------------------+
515 if (y > 0) // draw the full-width strip above the rectangle (A)
516 { apen.move_to(0,0); clearsurface.set_wh(tw,y); clearsurface.clear(); clearsurface.blit_to(apen); }
517 if (y+h < th) // draw the full-width strip below the rectangle (B)
518 { apen.move_to(0,y+h); clearsurface.set_wh(tw,th-(y+h)); clearsurface.clear(); clearsurface.blit_to(apen); }
519 if (x > 0) // draw the box directly left of the rectangle (C)
520 { apen.move_to(0,y); clearsurface.set_wh(x,h); clearsurface.clear(); clearsurface.blit_to(apen); }
521 if (x+w < tw) // draw the box directly right of the rectangle (D)
522 { apen.move_to(x+w,y); clearsurface.set_wh(tw-(x+w),h); clearsurface.clear(); clearsurface.blit_to(apen); }
524 #endif // SYNFIG_CLIP_PASTECANVAS
526 // render the canvas to be pasted onto pastesurface
527 Surface pastesurface;
528 if(!canvas->get_context().accelerated_render(&pastesurface,quality,desc,&stagetwo))
531 #ifdef SYNFIG_CLIP_PASTECANVAS
532 Surface::alpha_pen apen(surface->get_pen(x,y));
533 #else // SYNFIG_CLIP_PASTECANVAS
534 Surface::alpha_pen apen(surface->begin());
535 #endif // SYNFIG_CLIP_PASTECANVAS
537 apen.set_alpha(get_amount());
538 apen.set_blend_method(blend_using_straight ? Color::BLEND_STRAIGHT : blend_method);
539 pastesurface.blit_to(apen);
541 if(cb && !cb->amount_complete(10000,10000)) return false;
547 Layer_PasteCanvas::get_bounding_rect()const
552 void Layer_PasteCanvas::get_times_vfunc(Node::time_set &set) const
555 if(canvas) tset = canvas->get_times();
557 Node::time_set::iterator i = tset.begin(), end = tset.end();
559 //Make sure we offset the time...
560 //! \todo: SOMETHING STILL HAS TO BE DONE WITH THE OTHER DIRECTION
561 // (recursing down the tree needs to take this into account too...)
564 #ifdef ADJUST_WAYPOINTS_FOR_TIME_OFFSET // see node.h
569 Layer::get_times_vfunc(set);
574 Layer_PasteCanvas::set_param_static(const String ¶m, const bool x)
576 return Layer_Composite::set_param_static(param, x);
581 Layer_PasteCanvas::get_param_static(const String ¶m) const
583 return Layer_Composite::get_param_static(param);