synfig-core/src/synfig/layer.cpp

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file layer.cpp
   3 **      \brief Layer class implementation
   4 **
   5 **      $Id$
   6 **
   7 **      \legal
   8 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
   9 **      Copyright (c) 2007, 2008 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 "canvas.h"
  34 #include "layer.h"
  35 #include "render.h"
  36 #include "value.h"
  37 #include "layer_bitmap.h"
  38 #include "layer_mime.h"
  39 #include "context.h"
  40 #include "paramdesc.h"
  41
  42 #include "layer_solidcolor.h"
  43 #include "layer_polygon.h"
  44 #include "layer_pastecanvas.h"
  45 #include "layer_motionblur.h"
  46 #include "layer_duplicate.h"
  47
  48 #include "valuenode_const.h"
  49
  50 #include "transform.h"
  51 #include "rect.h"
  52 #include "guid.h"
  53
  54 #include <sigc++/adaptors/bind.h>
  55 #endif
  56
  57 /* === U S I N G =========================================================== */
  58
  59 using namespace etl;
  60 using namespace std;
  61 using namespace synfig;
  62
  63 /* === G L O B A L S ======================================================= */
  64
  65 static Layer::Book* _layer_book;
  66
  67 struct _LayerCounter
  68 {
  69         static int counter;
  70         ~_LayerCounter()
  71         {
  72                 if(counter)
  73                         synfig::error("%d layers not yet deleted!",counter);
  74         }
  75 } _layer_counter;
  76
  77 int _LayerCounter::counter(0);
  78
  79 /* === P R O C E D U R E S ================================================= */
  80
  81 Layer::Book&
  82 Layer::book()
  83 {
  84         return *_layer_book;
  85 }
  86
  87 void
  88 Layer::register_in_book(const BookEntry &entry)
  89 {
  90         book()[entry.name]=entry;
  91 }
  92
  93 bool
  94 Layer::subsys_init()
  95 {
  96         _layer_book=new Book();
  97
  98 #define INCLUDE_LAYER(class)                                                                    \
  99         synfig::Layer::book() [synfig::String(class::name__)] =         \
 100                 BookEntry(class::create,                                                                \
 101                                   class::name__,                                                                \
 102                                   dgettext("synfig", class::local_name__),              \
 103                                   class::category__,                                                    \
 104                                   class::cvs_id__,                                                              \
 105                                   class::version__)
 106
 107 #define LAYER_ALIAS(class,alias)                                                                \
 108         synfig::Layer::book()[synfig::String(alias)] =                          \
 109                 BookEntry(class::create,                                                                \
 110                                   alias,                                                                                \
 111                                   alias,                                                                                \
 112                                   CATEGORY_DO_NOT_USE,                                                  \
 113                                   class::cvs_id__,                                                              \
 114                                   class::version__)
 115
 116         INCLUDE_LAYER(Layer_SolidColor);        LAYER_ALIAS(Layer_SolidColor,   "solid_color");
 117         INCLUDE_LAYER(Layer_PasteCanvas);       LAYER_ALIAS(Layer_PasteCanvas,  "paste_canvas");
 118         INCLUDE_LAYER(Layer_Polygon);           LAYER_ALIAS(Layer_Polygon,              "Polygon");
 119         INCLUDE_LAYER(Layer_MotionBlur);        LAYER_ALIAS(Layer_MotionBlur,   "motion_blur");
 120         INCLUDE_LAYER(Layer_Duplicate);
 121
 122 #undef INCLUDE_LAYER
 123
 124         return true;
 125 }
 126
 127 bool
 128 Layer::subsys_stop()
 129 {
 130         delete _layer_book;
 131         return true;
 132 }
 133
 134 /* === M E T H O D S ======================================================= */
 135
 136 Layer::Layer():
 137         active_(true),
 138         z_depth_(0.0f),
 139         dirty_time_(Time::end())
 140 {
 141         _LayerCounter::counter++;
 142 }
 143
 144 Layer::LooseHandle
 145 synfig::Layer::create(const String &name)
 146 {
 147         if(!book().count(name))
 148         {
 149                 return Layer::LooseHandle(new Layer_Mime(name));
 150         }
 151
 152         Layer* layer(book()[name].factory());
 153         return Layer::LooseHandle(layer);
 154 }
 155
 156 synfig::Layer::~Layer()
 157 {
 158         _LayerCounter::counter--;
 159         while(!dynamic_param_list_.empty())
 160         {
 161                 remove_child(dynamic_param_list_.begin()->second.get());
 162                 dynamic_param_list_.erase(dynamic_param_list_.begin());
 163         }
 164
 165         remove_from_all_groups();
 166
 167         parent_death_connect_.disconnect();
 168         begin_delete();
 169 }
 170
 171 void
 172 synfig::Layer::set_canvas(etl::loose_handle<Canvas> x)
 173 {
 174         if(canvas_!=x)
 175         {
 176                 parent_death_connect_.disconnect();
 177                 canvas_=x;
 178                 if(x)
 179                 {
 180                         parent_death_connect_=x->signal_deleted().connect(
 181                                 sigc::bind(
 182                                         sigc::mem_fun(
 183                                                 *this,
 184                                                 &Layer::set_canvas
 185                                         ),
 186                                         etl::loose_handle<synfig::Canvas>(0)
 187                                 )
 188                         );
 189                 }
 190                 on_canvas_set();
 191         }
 192 }
 193
 194 void
 195 synfig::Layer::on_canvas_set()
 196 {
 197 }
 198
 199 etl::loose_handle<synfig::Canvas>
 200 synfig::Layer::get_canvas()const
 201 {
 202         return canvas_;
 203 }
 204
 205 int
 206 Layer::get_depth()const
 207 {
 208         if(!get_canvas())
 209                 return -1;
 210         return get_canvas()->get_depth(const_cast<synfig::Layer*>(this));
 211 }
 212
 213 void
 214 Layer::set_active(bool x)
 215 {
 216         if(active_!=x)
 217         {
 218                 active_=x;
 219
 220                 Node::on_changed();
 221                 signal_status_changed_();
 222         }
 223 }
 224
 225 void
 226 Layer::set_description(const String& x)
 227 {
 228         if(description_!=x)
 229         {
 230                 description_=x;
 231                 signal_description_changed_();
 232         }
 233 }
 234
 235 bool
 236 Layer::connect_dynamic_param(const String& param, etl::loose_handle<ValueNode> value_node)
 237 {
 238         ValueNode::Handle previous(dynamic_param_list_[param]);
 239
 240         if(previous==value_node)
 241                 return true;
 242
 243         dynamic_param_list_[param]=ValueNode::Handle(value_node);
 244
 245         if(previous)
 246                 remove_child(previous.get());
 247
 248         add_child(value_node.get());
 249
 250         if(!value_node->is_exported() && get_canvas())
 251         {
 252                 value_node->set_parent_canvas(get_canvas());
 253         }
 254
 255         changed();
 256         return true;
 257 }
 258
 259 bool
 260 Layer::disconnect_dynamic_param(const String& param)
 261 {
 262         ValueNode::Handle previous(dynamic_param_list_[param]);
 263
 264         if(previous)
 265         {
 266                 dynamic_param_list_.erase(param);
 267
 268                 // fix 2353284: if two parameters in the same layer are
 269                 // connected to the same valuenode and we disconnect one of
 270                 // them, the parent-child relationship for the remaining
 271                 // connection was being deleted.  now we search the parameter
 272                 // list to see if another parameter uses the same valuenode
 273                 DynamicParamList::const_iterator iter;
 274                 for (iter = dynamic_param_list().begin(); iter != dynamic_param_list().end(); iter++)
 275                         if (iter->second == previous)
 276                                 break;
 277                 if (iter == dynamic_param_list().end())
 278                         remove_child(previous.get());
 279
 280                 changed();
 281         }
 282         return true;
 283 }
 284
 285 void
 286 Layer::on_changed()
 287 {
 288         dirty_time_=Time::end();
 289         Node::on_changed();
 290 }
 291
 292 bool
 293 Layer::set_param(const String &param, const ValueBase &value)
 294 {
 295         if(param=="z_depth" && value.same_type_as(z_depth_))
 296         {
 297                 z_depth_=value.get(z_depth_);
 298                 return true;
 299         }
 300         return false;
 301 }
 302
 303 etl::handle<Transform>
 304 Layer::get_transform()const
 305 {
 306         return 0;
 307 }
 308
 309 float
 310 Layer::get_z_depth(const synfig::Time& t)const
 311 {
 312         if(!dynamic_param_list().count("z_depth"))
 313                 return z_depth_;
 314         return (*dynamic_param_list().find("z_depth")->second)(t).get(Real());
 315 }
 316
 317 Layer::Handle
 318 Layer::simple_clone()const
 319 {
 320         if(!book().count(get_name())) return 0;
 321         Handle ret = create(get_name()).get();
 322         ret->group_=group_;
 323         //ret->set_canvas(get_canvas());
 324         ret->set_description(get_description());
 325         ret->set_active(active());
 326         ret->set_param_list(get_param_list());
 327         for(DynamicParamList::const_iterator iter=dynamic_param_list().begin();iter!=dynamic_param_list().end();++iter)
 328                 ret->connect_dynamic_param(iter->first, iter->second);
 329         return ret;
 330 }
 331
 332 Layer::Handle
 333 Layer::clone(const GUID& deriv_guid) const
 334 {
 335         if(!book().count(get_name())) return 0;
 336
 337         //Layer *ret = book()[get_name()].factory();//create(get_name()).get();
 338         Handle ret = create(get_name()).get();
 339
 340         ret->group_=group_;
 341         //ret->set_canvas(get_canvas());
 342         ret->set_description(get_description());
 343         ret->set_active(active());
 344         ret->set_guid(get_guid()^deriv_guid);
 345
 346         //ret->set_param_list(get_param_list());
 347         // Process the parameter list so that
 348         // we can duplicate any inline canvases
 349         ParamList param_list(get_param_list());
 350         for(ParamList::const_iterator iter(param_list.begin()); iter != param_list.end(); ++iter)
 351         {
 352                 if(dynamic_param_list().count(iter->first)==0 && iter->second.get_type()==ValueBase::TYPE_CANVAS)
 353                 {
 354                         // This parameter is a canvas.  We need a close look.
 355                         Canvas::Handle canvas(iter->second.get(Canvas::Handle()));
 356                         if(canvas && canvas->is_inline())
 357                         {
 358                                 // This parameter is an inline canvas! we need to clone it
 359                                 // before we set it as a parameter.
 360                                 Canvas::Handle new_canvas(canvas->clone(deriv_guid));
 361                                 ValueBase value(new_canvas);
 362                                 ret->set_param(iter->first, value);
 363                                 continue;
 364                         }
 365                 }
 366
 367                 // This is a normal parameter,go ahead and set it.
 368                 ret->set_param(iter->first, iter->second);
 369         }
 370
 371         // Duplicate the dynamic paramlist, but only the exported data nodes
 372         DynamicParamList::const_iterator iter;
 373         for(iter=dynamic_param_list().begin();iter!=dynamic_param_list().end();++iter)
 374         {
 375                 // Make sure we clone inline canvases
 376                 if(iter->second->get_type()==ValueBase::TYPE_CANVAS)
 377                 {
 378                         Canvas::Handle canvas((*iter->second)(0).get(Canvas::Handle()));
 379                         if(canvas->is_inline())
 380                         {
 381                                 Canvas::Handle new_canvas(canvas->clone(deriv_guid));
 382                                 ValueBase value(new_canvas);
 383                                 ret->connect_dynamic_param(iter->first,ValueNode_Const::create(value));
 384                                 continue;
 385                         }
 386                 }
 387
 388                 if(iter->second->is_exported())
 389                         ret->connect_dynamic_param(iter->first,iter->second);
 390                 else
 391                         ret->connect_dynamic_param(iter->first,iter->second->clone(deriv_guid));
 392         }
 393
 394         //ret->set_canvas(0);
 395
 396         return ret;
 397 }
 398
 399 bool
 400 Layer::reads_context() const
 401 {
 402         return false;
 403 }
 404
 405 Rect
 406 Layer::get_full_bounding_rect(Context context)const
 407 {
 408         if(active())
 409                 return context.get_full_bounding_rect()|get_bounding_rect();
 410         return context.get_full_bounding_rect();
 411 }
 412
 413 Rect
 414 Layer::get_bounding_rect()const
 415 {
 416         return Rect::full_plane();
 417 }
 418
 419 bool
 420 Layer::set_param_list(const ParamList &list)
 421 {
 422         bool ret=true;
 423         if(!list.size())
 424                 return false;
 425         ParamList::const_iterator iter(list.begin());
 426         for(;iter!=list.end();++iter)
 427         {
 428                 if(!set_param(iter->first, iter->second))ret=false;
 429         }
 430         return ret;
 431 }
 432
 433 Layer::ParamList
 434 Layer::get_param_list()const
 435 {
 436         ParamList ret;
 437
 438         Vocab vocab(get_param_vocab());
 439
 440         Vocab::const_iterator iter=vocab.begin();
 441         for(;iter!=vocab.end();++iter)
 442         {
 443                 ret[iter->get_name()]=get_param(iter->get_name());
 444         }
 445         return ret;
 446 }
 447
 448 ValueBase
 449 Layer::get_param(const String & param)const
 450 {
 451         if(param=="z_depth")
 452                 return get_z_depth();
 453
 454         return ValueBase();
 455 }
 456
 457 String
 458 Layer::get_version()const
 459 {
 460         return get_param("version__").get(String());
 461 }
 462
 463 bool
 464 Layer::set_version(const String &/*ver*/)
 465 {
 466         return false;
 467 }
 468
 469 void
 470 Layer::reset_version()
 471 {
 472 }
 473
 474
 475 void
 476 Layer::set_time(Context context, Time time)const
 477 {
 478         context.set_time(time);
 479         dirty_time_=time;
 480 }
 481
 482 void
 483 Layer::set_time(Context context, Time time, const Point &pos)const
 484 {
 485         context.set_time(time,pos);
 486         dirty_time_=time;
 487 }
 488
 489 Color
 490 Layer::get_color(Context context, const Point &pos)const
 491 {
 492         return context.get_color(pos);
 493 }
 494
 495 synfig::Layer::Handle
 496 Layer::hit_check(synfig::Context context, const synfig::Point &pos)const
 497 {
 498         return context.hit_check(pos);
 499 }
 500
 501 /*      The default accelerated renderer
 502 **      is anything but accelerated...
 503 */
 504 bool
 505 Layer::accelerated_render(Context context,Surface *surface,int /*quality*/, const RendDesc &renddesc, ProgressCallback *cb)  const
 506 {
 507         handle<Target> target=surface_target(surface);
 508         if(!target)
 509         {
 510                 if(cb)cb->error(_("Unable to create surface target"));
 511                 return false;
 512         }
 513         RendDesc desc=renddesc;
 514         target->set_rend_desc(&desc);
 515
 516         // When we render, we want to
 517         // make sure that we are rendered too...
 518         // Since the context iterator is for
 519         // the layer after us, we need to back up.
 520         // This could be considered a hack, as
 521         // it is a possibility that we are indeed
 522         // not the previous layer.
 523         --context;
 524
 525         return render(context,target,desc,cb);
 526         //return render_threaded(context,target,desc,cb,2);
 527 }
 528
 529 String
 530 Layer::get_name()const
 531 {
 532         return get_param("name__").get(String());
 533 }
 534
 535 String
 536 Layer::get_local_name()const
 537 {
 538         return get_param("local_name__").get(String());
 539 }
 540
 541
 542 Layer::Vocab
 543 Layer::get_param_vocab()const
 544 {
 545         Layer::Vocab ret;
 546
 547         ret.push_back(ParamDesc(z_depth_,"z_depth")
 548                 .set_local_name(_("Z Depth"))
 549                 .set_animation_only(true)
 550         );
 551
 552         return ret;
 553 }
 554
 555 void
 556 Layer::get_times_vfunc(Node::time_set &set) const
 557 {
 558         DynamicParamList::const_iterator        i = dynamic_param_list_.begin(),
 559                                                                                 end = dynamic_param_list_.end();
 560
 561         for(; i != end; ++i)
 562         {
 563                 const Node::time_set &tset = i->second->get_times();
 564                 set.insert(tset.begin(),tset.end());
 565         }
 566 }
 567
 568
 569 void
 570 Layer::add_to_group(const String&x)
 571 {
 572         if(x==group_)
 573                 return;
 574         if(!group_.empty())
 575                 remove_from_all_groups();
 576         group_=x;
 577         signal_added_to_group()(group_);
 578 }
 579
 580 void
 581 Layer::remove_from_group(const String&x)
 582 {
 583         if(group_==x)
 584                 remove_from_all_groups();
 585 }
 586
 587 void
 588 Layer::remove_from_all_groups()
 589 {
 590         if(group_.empty())
 591                 return;
 592         signal_removed_from_group()(group_);
 593         group_.clear();
 594 }
 595
 596 String
 597 Layer::get_group()const
 598 {
 599         return group_;
 600 }
 601
 602 const String
 603 Layer::get_param_local_name(const String &param_name)const
 604 {
 605         ParamVocab vocab = get_param_vocab();
 606         // loop to find the parameter in the parameter vocab - this gives us its local name
 607         for (ParamVocab::iterator iter = vocab.begin(); iter != vocab.end(); iter++)
 608                 if (iter->get_name() == param_name)
 609                         return iter->get_local_name();
 610         return String();
 611 }