synfig-core/trunk/src/synfig/layer_pastecanvas.cpp

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file layer_pastecanvas.cpp
   3 **      \brief Implementation of the "Paste Canvas" layer
   4 **
   5 **      $Id$
   6 **
   7 **      \legal
   8 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
   9 **      Copyright (c) 2007 Chris Moore
  10 **
  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.
  15 **
  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.
  20 **      \endlegal
  21 */
  22 /* ========================================================================= */
  23
  24 /* === H E A D E R S ======================================================= */
  25
  26 #ifdef USING_PCH
  27 #       include "pch.h"
  28 #else
  29 #ifdef HAVE_CONFIG_H
  30 #       include <config.h>
  31 #endif
  32
  33 #include "layer_pastecanvas.h"
  34 #include "string.h"
  35 #include "time.h"
  36 #include "context.h"
  37 #include "paramdesc.h"
  38 #include "renddesc.h"
  39 #include "surface.h"
  40 #include "value.h"
  41 #include "valuenode.h"
  42 #include "canvas.h"
  43
  44 #endif
  45
  46 /* === U S I N G =========================================================== */
  47
  48 using namespace etl;
  49 using namespace std;
  50 using namespace synfig;
  51
  52 /* === M A C R O S ========================================================= */
  53
  54 #define MAX_DEPTH 10
  55
  56 //#ifdef __APPLE__
  57 //#define SYNFIG_NO_CLIP
  58 //#endif
  59
  60 /* === C L A S S E S ======================================================= */
  61
  62 class depth_counter     // Makes our recursive depth counter exception-safe
  63 {
  64         int *depth;
  65 public:
  66         depth_counter(int &x):depth(&x) { (*depth)++; }
  67         ~depth_counter() { (*depth)--; }
  68 };
  69
  70 /* === G L O B A L S ======================================================= */
  71
  72 SYNFIG_LAYER_INIT(Layer_PasteCanvas);
  73 SYNFIG_LAYER_SET_NAME(Layer_PasteCanvas,"PasteCanvas"); // todo: use paste_canvas
  74 SYNFIG_LAYER_SET_LOCAL_NAME(Layer_PasteCanvas,N_("Paste Canvas"));
  75 SYNFIG_LAYER_SET_CATEGORY(Layer_PasteCanvas,N_("Other"));
  76 SYNFIG_LAYER_SET_VERSION(Layer_PasteCanvas,"0.1");
  77 SYNFIG_LAYER_SET_CVS_ID(Layer_PasteCanvas,"$Id$");
  78
  79 /* === M E T H O D S ======================================================= */
  80
  81 Layer_PasteCanvas::Layer_PasteCanvas():
  82         origin(0,0),
  83         depth(0),
  84         zoom(0),
  85         time_offset(0)
  86 {
  87         children_lock=false;
  88         muck_with_time_=true;
  89         curr_time=Time::begin();
  90 }
  91
  92 Layer_PasteCanvas::~Layer_PasteCanvas()
  93 {
  94 /*      if(canvas)
  95                 canvas->parent_set.erase(this);
  96 */
  97
  98         //if(canvas)DEBUGINFO(strprintf("%d",canvas->count()));
  99
 100         set_sub_canvas(0);
 101
 102         //if(canvas && (canvas->is_inline() || !get_canvas() || get_canvas()->get_root()!=canvas->get_root()))
 103         //      canvas->unref();
 104 }
 105
 106 String
 107 Layer_PasteCanvas::get_local_name()const
 108 {
 109         if(!canvas)     return _("Pasted Canvas");
 110         if(canvas->is_inline()) return _("Inline Canvas");
 111         if(canvas->get_root()==get_canvas()->get_root()) return '[' + canvas->get_id() + ']';
 112
 113         return '[' + canvas->get_file_name() + ']';
 114 }
 115
 116 Layer::Vocab
 117 Layer_PasteCanvas::get_param_vocab()const
 118 {
 119         Layer::Vocab ret(Layer_Composite::get_param_vocab());
 120
 121         ret.push_back(ParamDesc("origin")
 122                 .set_local_name(_("Origin"))
 123                 .set_description(_("Point where you want the origin to be"))
 124         );
 125         ret.push_back(ParamDesc("canvas")
 126                 .set_local_name(_("Canvas"))
 127                 .set_description(_("Canvas to paste"))
 128         );
 129         ret.push_back(ParamDesc("zoom")
 130                 .set_local_name(_("Zoom"))
 131                 .set_description(_("Size of canvas"))
 132         );
 133
 134         ret.push_back(ParamDesc("time_offset")
 135                 .set_local_name(_("Time Offset"))
 136         );
 137
 138         ret.push_back(ParamDesc("children_lock")
 139                 .set_local_name(_("Children Lock"))
 140         );
 141
 142         return ret;
 143 }
 144
 145 bool
 146 Layer_PasteCanvas::set_param(const String & param, const ValueBase &value)
 147 {
 148         IMPORT(origin);
 149
 150         // IMPORT(canvas);
 151         if(param=="canvas" && value.same_type_as(Canvas::Handle()))
 152         {
 153                 set_sub_canvas(value.get(Canvas::Handle()));
 154                 return true;
 155         }
 156
 157         // IMPORT(time_offset);
 158         if (param=="time_offset" && value.same_type_as(time_offset))
 159         {
 160                 if (time_offset != value.get(Time()))
 161                 {
 162                         value.put(&time_offset);
 163                         // notify that the time_offset has changed so we can update the
 164                         // waypoint positions in parent layers
 165                         changed();
 166                 }
 167                 return true;
 168         }
 169
 170         IMPORT(children_lock);
 171         IMPORT(zoom);
 172
 173         return Layer_Composite::set_param(param,value);
 174 }
 175
 176 void
 177 Layer_PasteCanvas::set_sub_canvas(etl::handle<synfig::Canvas> x)
 178 {
 179         if(canvas && muck_with_time_)
 180                 remove_child(canvas.get());
 181
 182         if(canvas && (canvas->is_inline() || !get_canvas() || get_canvas()->get_root()!=canvas->get_root()))
 183                 canvas->unref();
 184
 185         child_changed_connection.disconnect();
 186
 187         canvas=x;
 188
 189         /*if(canvas)
 190                 child_changed_connection=canvas->signal_changed().connect(
 191                         sigc::mem_fun(
 192                                 *this,
 193                                 &Layer_PasteCanvas::changed
 194                         )
 195                 );
 196         */
 197         if(canvas)
 198                 bounds=(canvas->get_context().get_full_bounding_rect()-canvas->rend_desc().get_focus())*exp(zoom)+origin+canvas->rend_desc().get_focus();
 199
 200         if(canvas && muck_with_time_)
 201                 add_child(canvas.get());
 202
 203         if(canvas && (canvas->is_inline() || !get_canvas() || get_canvas()->get_root()!=canvas->get_root()))
 204                 canvas->ref();
 205
 206         if(canvas)
 207                 on_canvas_set();
 208 }
 209
 210 // This is called whenever the parent canvas gets set/changed
 211 void
 212 Layer_PasteCanvas::on_canvas_set()
 213 {
 214         //synfig::info("before count()=%d",count());
 215         if(get_canvas() && canvas && canvas->is_inline() && canvas->parent()!=get_canvas())
 216         {
 217                 //synfig::info("during count()=%d",count());
 218                 canvas->set_inline(get_canvas());
 219         }
 220         //synfig::info("after count()=%d",count());
 221 }
 222
 223 ValueBase
 224 Layer_PasteCanvas::get_param(const String& param)const
 225 {
 226         EXPORT(origin);
 227         EXPORT(canvas);
 228         EXPORT(zoom);
 229         EXPORT(time_offset);
 230         EXPORT(children_lock);
 231
 232         EXPORT_NAME();
 233         EXPORT_VERSION();
 234
 235         return Layer_Composite::get_param(param);
 236 }
 237
 238 void
 239 Layer_PasteCanvas::set_time(Context context, Time time)const
 240 {
 241         if(depth==MAX_DEPTH)return;depth_counter counter(depth);
 242         curr_time=time;
 243
 244         context.set_time(time);
 245         if(canvas)
 246         {
 247                 canvas->set_time(time+time_offset);
 248
 249                 bounds=(canvas->get_context().get_full_bounding_rect()-canvas->rend_desc().get_focus())*exp(zoom)+origin+canvas->rend_desc().get_focus();
 250         }
 251         else
 252                 bounds=Rect::zero();
 253 }
 254
 255 synfig::Layer::Handle
 256 Layer_PasteCanvas::hit_check(synfig::Context context, const synfig::Point &pos)const
 257 {
 258         if(depth==MAX_DEPTH)return 0;depth_counter counter(depth);
 259
 260         if (canvas) {
 261                 Point target_pos=(pos-canvas->rend_desc().get_focus()-origin)/exp(zoom)+canvas->rend_desc().get_focus();
 262
 263                 if(canvas && get_amount() && canvas->get_context().get_color(target_pos).get_a()>=0.25)
 264                 {
 265                         if(!children_lock)
 266                         {
 267                                 return canvas->get_context().hit_check(target_pos);
 268                         }
 269                         return const_cast<Layer_PasteCanvas*>(this);
 270                 }
 271         }
 272         return context.hit_check(pos);
 273 }
 274
 275 Color
 276 Layer_PasteCanvas::get_color(Context context, const Point &pos)const
 277 {
 278         if(!canvas || !get_amount())
 279                 return context.get_color(pos);
 280
 281         if(depth==MAX_DEPTH)return Color::alpha();depth_counter counter(depth);
 282
 283         Point target_pos=(pos-canvas->rend_desc().get_focus()-origin)/exp(zoom)+canvas->rend_desc().get_focus();
 284
 285         return Color::blend(canvas->get_context().get_color(target_pos),context.get_color(pos),get_amount(),get_blend_method());
 286 }
 287
 288
 289 bool
 290 Layer_PasteCanvas::accelerated_render(Context context,Surface *surface,int quality, const RendDesc &renddesc, ProgressCallback *cb)const
 291 {
 292         if(cb && !cb->amount_complete(0,10000)) return false;
 293
 294         if(depth==MAX_DEPTH)
 295         {
 296                 DEBUGPOINT();
 297                 // if we are at the extent of our depth,
 298                 // then we should just return whatever is under us.
 299                 return context.accelerated_render(surface,quality,renddesc,cb);
 300         }
 301         depth_counter counter(depth);
 302
 303         if(!canvas || !get_amount())
 304                 return context.accelerated_render(surface,quality,renddesc,cb);
 305
 306         if(muck_with_time_ && curr_time!=Time::begin() && canvas->get_time()!=curr_time+time_offset)
 307         {
 308                 canvas->set_time(curr_time+time_offset);
 309         }
 310
 311         SuperCallback stageone(cb,0,4500,10000);
 312         SuperCallback stagetwo(cb,4500,9000,10000);
 313         SuperCallback stagethree(cb,9000,9999,10000);
 314
 315         RendDesc desc(renddesc);
 316         Vector::value_type zoomfactor=1.0/exp(zoom);
 317         desc.clear_flags();
 318         desc.set_tl((desc.get_tl()-canvas->rend_desc().get_focus()-origin)*zoomfactor+canvas->rend_desc().get_focus());
 319         desc.set_br((desc.get_br()-canvas->rend_desc().get_focus()-origin)*zoomfactor+canvas->rend_desc().get_focus());
 320         desc.set_flags(RendDesc::PX_ASPECT);
 321
 322         if(is_solid_color() || context->empty())
 323         {
 324                 surface->set_wh(renddesc.get_w(),renddesc.get_h());
 325                 surface->clear();
 326         }
 327         else if(!context.accelerated_render(surface,quality,renddesc,&stageone))
 328                 return false;
 329         Color::BlendMethod blend_method(get_blend_method());
 330
 331         const Rect full_bounding_rect(canvas->get_context().get_full_bounding_rect());
 332
 333         if(context->empty())
 334         {
 335                 if(Color::is_onto(blend_method))
 336                         return true;
 337
 338                 if(blend_method==Color::BLEND_COMPOSITE)
 339                         blend_method=Color::BLEND_STRAIGHT;
 340         }
 341         else
 342         if(!etl::intersect(context.get_full_bounding_rect(),full_bounding_rect+origin))
 343         {
 344                 if(Color::is_onto(blend_method))
 345                         return true;
 346
 347                 if(blend_method==Color::BLEND_COMPOSITE)
 348                         blend_method=Color::BLEND_STRAIGHT;
 349         }
 350
 351 #ifndef SYNFIG_NO_CLIP
 352         {
 353                 //synfig::info("PasteCanv Clip");
 354                 Rect area(desc.get_rect()&full_bounding_rect);
 355
 356                 Point min(area.get_min());
 357                 Point max(area.get_max());
 358
 359                 if(desc.get_tl()[0]>desc.get_br()[0])
 360                         swap(min[0],max[0]);
 361                 if(desc.get_tl()[1]>desc.get_br()[1])
 362                         swap(min[1],max[1]);
 363
 364                 const int
 365                         x(floor_to_int((min[0]-desc.get_tl()[0])/desc.get_pw())),
 366                         y(floor_to_int((min[1]-desc.get_tl()[1])/desc.get_ph())),
 367                         w(ceil_to_int((max[0]-desc.get_tl()[0])/desc.get_pw())-x),
 368                         h(ceil_to_int((max[1]-desc.get_tl()[1])/desc.get_ph())-y);
 369
 370                 desc.set_subwindow(x,y,w,h);
 371
 372                 Surface pastesurface;
 373
 374                 // \todo this used to also have "area.area()<=0.000001 || " - is it useful?
 375                 //               it was causing bug #1809480 (Zoom in beyond 8.75 in nested canvases fails)
 376                 if(desc.get_w()==0 || desc.get_h()==0)
 377                 {
 378                         if(cb && !cb->amount_complete(10000,10000)) return false;
 379
 380                         return true;
 381                 }
 382
 383                 if(!canvas->get_context().accelerated_render(&pastesurface,quality,desc,&stagetwo))
 384                         return false;
 385
 386                 Surface::alpha_pen apen(surface->get_pen(x,y));
 387
 388                 apen.set_alpha(get_amount());
 389                 apen.set_blend_method(blend_method);
 390
 391                 pastesurface.blit_to(apen);
 392         }
 393 #else
 394         {
 395                 Surface pastesurface;
 396
 397                 if(!canvas->get_context().accelerated_render(&pastesurface,quality,desc,&stagetwo))
 398                         return false;
 399
 400                 Surface::alpha_pen apen(surface->begin());
 401
 402                 apen.set_alpha(get_amount());
 403                 apen.set_blend_method(blend_method);
 404
 405                 pastesurface.blit_to(apen);
 406         }
 407 #endif
 408
 409         if(cb && !cb->amount_complete(10000,10000)) return false;
 410
 411         return true;
 412 }
 413
 414 Rect
 415 Layer_PasteCanvas::get_bounding_rect()const
 416 {
 417         return bounds;
 418 }
 419
 420 void Layer_PasteCanvas::get_times_vfunc(Node::time_set &set) const
 421 {
 422         Node::time_set tset;
 423         if(canvas) tset = canvas->get_times();
 424
 425         Node::time_set::iterator i = tset.begin(), end = tset.end();
 426
 427         //Make sure we offset the time...
 428         //! \todo: SOMETHING STILL HAS TO BE DONE WITH THE OTHER DIRECTION
 429         //                 (recursing down the tree needs to take this into account too...)
 430         for(; i != end; ++i)
 431                 set.insert(*i
 432 #ifdef ADJUST_WAYPOINTS_FOR_TIME_OFFSET // see node.h
 433                                    - time_offset
 434 #endif
 435                         );
 436
 437         Layer::get_times_vfunc(set);
 438 }