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