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

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file valuenode.cpp
   3 **      \brief Implementation of the "Placeholder" valuenode conversion.
   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 #define SYNFIG_NO_ANGLE
  27
  28 //#define HAS_HASH_MAP 1
  29
  30 #ifdef USING_PCH
  31 #       include "pch.h"
  32 #else
  33 #ifdef HAVE_CONFIG_H
  34 #       include <config.h>
  35 #endif
  36
  37 #include "valuenode.h"
  38 #include "general.h"
  39 #include "canvas.h"
  40
  41 #include "valuenode_const.h"
  42 #include "valuenode_linear.h"
  43 #include "valuenode_composite.h"
  44 #include "valuenode_reference.h"
  45 #include "valuenode_scale.h"
  46 #include "valuenode_blinecalctangent.h"
  47 #include "valuenode_blinecalcvertex.h"
  48 #include "valuenode_blinereversetangent.h"
  49 #include "valuenode_segcalctangent.h"
  50 #include "valuenode_segcalcvertex.h"
  51 #include "valuenode_repeat_gradient.h"
  52 #include "valuenode_stripes.h"
  53 #include "valuenode_range.h"
  54 #include "valuenode_add.h"
  55 #include "valuenode_subtract.h"
  56 #include "valuenode_timedswap.h"
  57 #include "valuenode_twotone.h"
  58 #include "valuenode_bline.h"
  59 #include "valuenode_dynamiclist.h"
  60 #include "valuenode_radialcomposite.h"
  61 #include "valuenode_gradientrotate.h"
  62 #include "valuenode_sine.h"
  63 #include "valuenode_cos.h"
  64 #include "valuenode_atan2.h"
  65 #include "valuenode_exp.h"
  66 #include "valuenode_switch.h"
  67 #include "valuenode_timeloop.h"
  68 #include "valuenode_reciprocal.h"
  69 #include "valuenode_duplicate.h"
  70 #include "valuenode_integer.h"
  71
  72 #include "layer.h"
  73
  74 #endif
  75
  76 /* === U S I N G =========================================================== */
  77
  78 using namespace std;
  79 using namespace etl;
  80 using namespace synfig;
  81
  82 /* === M A C R O S ========================================================= */
  83
  84 /* === G L O B A L S ======================================================= */
  85
  86 static int value_node_count(0);
  87
  88 static LinkableValueNode::Book *book_;
  89
  90
  91 ValueNode::LooseHandle
  92 synfig::find_value_node(const GUID& guid)
  93 {
  94         return guid_cast<ValueNode>(guid);
  95 }
  96
  97 /* === P R O C E D U R E S ================================================= */
  98
  99 /* === M E T H O D S ======================================================= */
 100
 101 bool
 102 ValueNode::subsys_init()
 103 {
 104         book_=new LinkableValueNode::Book();
 105
 106 #define ADD_VALUENODE(class,name,local)                                                                                                                 \
 107         (*book_)[name].factory=reinterpret_cast<LinkableValueNode::Factory>(&class::create);            \
 108         (*book_)[name].check_type=&class::check_type;                                                                                           \
 109         (*book_)[name].local_name=local
 110
 111 #define ADD_VALUENODE2(class,name,local)                                                                                                                \
 112         (*book_)[name].factory=reinterpret_cast<LinkableValueNode::Factory>(&class::create_from);       \
 113         (*book_)[name].check_type=&class::check_type;                                                                                           \
 114         (*book_)[name].local_name=local
 115
 116         ADD_VALUENODE(ValueNode_Linear,                 "linear",                       _("Linear")                             );
 117         ADD_VALUENODE(ValueNode_Composite,              "composite",            _("Composite")                  );
 118         ADD_VALUENODE(ValueNode_RadialComposite,"radial_composite",     _("Radial Composite")   );
 119         ADD_VALUENODE(ValueNode_Reference,              "reference",            _("Reference")                  );
 120         ADD_VALUENODE(ValueNode_Repeat_Gradient,"repeat_gradient",      _("Repeat Gradient")    );
 121         ADD_VALUENODE(ValueNode_Scale,                  "scale",                        _("Scale")                              );
 122         ADD_VALUENODE(ValueNode_BLineCalcTangent,"blinecalctangent",_("BLine Tangent")          );
 123         ADD_VALUENODE(ValueNode_BLineCalcVertex,"blinecalcvertex",      _("BLine Vertex")               );
 124         ADD_VALUENODE(ValueNode_BLineRevTangent,"blinerevtangent",      _("Reverse Tangent")    );
 125         ADD_VALUENODE(ValueNode_SegCalcTangent, "segcalctangent",       _("Segment Tangent")    );
 126         ADD_VALUENODE(ValueNode_SegCalcVertex,  "segcalcvertex",        _("Segment Vertex")             );
 127         ADD_VALUENODE(ValueNode_Stripes,                "stripes",                      _("Stripes")                    );
 128         ADD_VALUENODE(ValueNode_Range,                  "range",                        _("Range")                              );
 129         ADD_VALUENODE(ValueNode_Add,                    "add",                          _("Add")                                );
 130         ADD_VALUENODE(ValueNode_Subtract,               "subtract",                     _("Subtract")                   );
 131         ADD_VALUENODE(ValueNode_TimedSwap,              "timed_swap",           _("Timed Swap")                 );
 132         ADD_VALUENODE(ValueNode_TwoTone,                "twotone",                      _("Two-Tone")                   );
 133         ADD_VALUENODE(ValueNode_BLine,                  "bline",                        _("BLine")                              );
 134         ADD_VALUENODE2(ValueNode_DynamicList,   "dynamic_list",         _("Dynamic List")               );
 135         ADD_VALUENODE(ValueNode_GradientRotate, "gradient_rotate",      _("Gradient Rotate")    );
 136         ADD_VALUENODE(ValueNode_Sine,                   "sine",                         _("Sine")                               );
 137         ADD_VALUENODE(ValueNode_Cos,                    "cos",                          _("Cos")                                );
 138         ADD_VALUENODE(ValueNode_Atan2,                  "atan2",                        _("aTan2")                              );
 139         ADD_VALUENODE(ValueNode_Exp,                    "exp",                          _("Exponential")                );
 140         ADD_VALUENODE(ValueNode_Switch,                 "switch",                       _("Switch")                             );
 141         ADD_VALUENODE(ValueNode_TimeLoop,               "timeloop",                     _("Time Loop")                  );
 142         ADD_VALUENODE(ValueNode_Reciprocal,             "reciprocal",           _("Reciprocal")                 );
 143         ADD_VALUENODE(ValueNode_Duplicate,              "duplicate",            _("Duplicate")                  );
 144         ADD_VALUENODE(ValueNode_Integer,                "fromint",                      _("From Integer")               );
 145
 146 #undef ADD_VALUENODE
 147 #undef ADD_VALUENODE2
 148
 149         return true;
 150 }
 151
 152 bool
 153 ValueNode::subsys_stop()
 154 {
 155         delete book_;
 156 /*      if(global_value_node_map.size() || value_node_count)
 157         {
 158                 if(value_node_count)
 159                         synfig::error("%d ValueNodes haven't been destroyed yet!",value_node_count);
 160
 161                 if(global_value_node_map.size()!=value_node_count)
 162                         synfig::error("value node count mismatch! map.size()!=value_node_count (%d!=%d)",global_value_node_map.size(),value_node_count);
 163
 164                 GlobalValueNodeMap::iterator iter;
 165                 for(iter=global_value_node_map.begin();iter!=global_value_node_map.end();++iter)
 166                 {
 167                         if(!iter->second->is_exported())
 168                                 synfig::info(_("%s: count:%d name:%s type:%s"),
 169                                         iter->first.get_string().c_str(),
 170                                         iter->second->count(),
 171                                         iter->second->get_name().c_str(),
 172                                         ValueBase::type_local_name(iter->second->get_type()).c_str()
 173                                 );
 174                         else
 175                                 synfig::info(_("%s: id:%s count:%d name:%s type:%s"),
 176                                         iter->first.get_string().c_str(),
 177                                         iter->second->get_id().c_str(),
 178                                         iter->second->count(),
 179                                         iter->second->get_name().c_str(),
 180                                         ValueBase::type_local_name(iter->second->get_type()).c_str()
 181                                 );
 182                 }
 183         }
 184 */
 185         return true;
 186 }
 187
 188 ValueNode::ValueNode(ValueBase::Type type):type(type)
 189 {
 190         value_node_count++;
 191 }
 192
 193 LinkableValueNode::Book&
 194 LinkableValueNode::book()
 195 {
 196         return *book_;
 197 }
 198
 199 LinkableValueNode::Handle
 200 LinkableValueNode::create(const String &name, const ValueBase& x)
 201 {
 202         if(!book().count(name))
 203                 return 0;
 204         return book()[name].factory(x);
 205 }
 206
 207 bool
 208 LinkableValueNode::check_type(const String &name, ValueBase::Type x)
 209 {
 210         if(!book().count(name) || !book()[name].check_type)
 211                 return false;
 212         return book()[name].check_type(x);
 213 }
 214
 215 bool
 216 LinkableValueNode::set_link(int i,ValueNode::Handle x)
 217 {
 218         ValueNode::Handle previous(get_link(i));
 219
 220         if(set_link_vfunc(i,x))
 221         {
 222                 if(previous)
 223                         remove_child(previous.get());
 224                 add_child(x.get());
 225
 226                 if(!x->is_exported() && get_parent_canvas())
 227                 {
 228                         x->set_parent_canvas(get_parent_canvas());
 229                 }
 230                 changed();
 231                 return true;
 232         }
 233         return false;
 234 }
 235
 236 ValueNode::LooseHandle
 237 LinkableValueNode::get_link(int i)const
 238 {
 239         return get_link_vfunc(i);
 240 }
 241
 242 void
 243 LinkableValueNode::unlink_all()
 244 {
 245         for(int i=0;i<link_count();i++)
 246         {
 247                 ValueNode::LooseHandle value_node(get_link(i));
 248                 if(value_node)
 249                         value_node->parent_set.erase(this);
 250         }
 251 }
 252
 253 ValueNode::~ValueNode()
 254 {
 255         value_node_count--;
 256
 257         begin_delete();
 258 }
 259
 260 void
 261 ValueNode::on_changed()
 262 {
 263         etl::loose_handle<Canvas> parent_canvas = get_parent_canvas();
 264         if(parent_canvas)
 265                 do                                              // signal to all the ancestor canvases
 266                         parent_canvas->signal_value_node_changed()(this);
 267                 while (parent_canvas = parent_canvas->parent());
 268         else if(get_root_canvas())
 269                 get_root_canvas()->signal_value_node_changed()(this);
 270
 271         Node::on_changed();
 272 }
 273
 274 int
 275 ValueNode::replace(etl::handle<ValueNode> x)
 276 {
 277         if(x.get()==this)
 278                 return 0;
 279
 280         while(parent_set.size())
 281         {
 282                 (*parent_set.begin())->add_child(x.get());
 283                 (*parent_set.begin())->remove_child(this);
 284                 //x->parent_set.insert(*parent_set.begin());
 285                 //parent_set.erase(parent_set.begin());
 286         }
 287         int r(RHandle(this).replace(x));
 288         x->changed();
 289         return r;
 290 }
 291
 292 void
 293 ValueNode::set_id(const String &x)
 294 {
 295         if(name!=x)
 296         {
 297                 name=x;
 298                 signal_id_changed_();
 299         }
 300 }
 301
 302 ValueNodeList::ValueNodeList():
 303         placeholder_count_(0)
 304 {
 305 }
 306
 307 bool
 308 ValueNodeList::count(const String &id)const
 309 {
 310         const_iterator iter;
 311
 312         if(id.empty())
 313                 return false;
 314
 315         for(iter=begin();iter!=end() && id!=(*iter)->get_id();++iter);
 316
 317         if(iter==end())
 318                 return false;
 319
 320         return true;
 321 }
 322
 323 ValueNode::Handle
 324 ValueNodeList::find(const String &id)
 325 {
 326         iterator iter;
 327
 328         if(id.empty())
 329                 throw Exception::IDNotFound("Empty ID");
 330
 331         for(iter=begin();iter!=end() && id!=(*iter)->get_id();++iter);
 332
 333         if(iter==end())
 334                 throw Exception::IDNotFound("ValueNode in ValueNodeList: "+id);
 335
 336         return *iter;
 337 }
 338
 339 ValueNode::ConstHandle
 340 ValueNodeList::find(const String &id)const
 341 {
 342         const_iterator iter;
 343
 344         if(id.empty())
 345                 throw Exception::IDNotFound("Empty ID");
 346
 347         for(iter=begin();iter!=end() && id!=(*iter)->get_id();++iter);
 348
 349         if(iter==end())
 350                 throw Exception::IDNotFound("ValueNode in ValueNodeList: "+id);
 351
 352         return *iter;
 353 }
 354
 355 ValueNode::Handle
 356 ValueNodeList::surefind(const String &id)
 357 {
 358         if(id.empty())
 359                 throw Exception::IDNotFound("Empty ID");
 360
 361         ValueNode::Handle value_node;
 362
 363         try
 364         {
 365                 value_node=find(id);
 366         }
 367         catch(Exception::IDNotFound)
 368         {
 369                 value_node=PlaceholderValueNode::create();
 370                 value_node->set_id(id);
 371                 push_back(value_node);
 372                 placeholder_count_++;
 373         }
 374
 375         return value_node;
 376 }
 377
 378 bool
 379 ValueNodeList::erase(ValueNode::Handle value_node)
 380 {
 381         assert(value_node);
 382
 383         iterator iter;
 384
 385         for(iter=begin();iter!=end();++iter)
 386                 if(value_node.get()==iter->get())
 387                 {
 388                         std::list<ValueNode::RHandle>::erase(iter);
 389                         if(PlaceholderValueNode::Handle::cast_dynamic(value_node))
 390                                 placeholder_count_--;
 391                         return true;
 392                 }
 393         return false;
 394 }
 395
 396 bool
 397 ValueNodeList::add(ValueNode::Handle value_node)
 398 {
 399         if(!value_node)
 400                 return false;
 401         if(value_node->get_id().empty())
 402                 return false;
 403
 404         try
 405         {
 406                 ValueNode::RHandle other_value_node=find(value_node->get_id());
 407                 if(PlaceholderValueNode::Handle::cast_dynamic(other_value_node))
 408                 {
 409                         other_value_node->replace(value_node);
 410                         placeholder_count_--;
 411                         return true;
 412                 }
 413
 414                 return false;
 415         }
 416         catch(Exception::IDNotFound)
 417         {
 418                 push_back(value_node);
 419                 return true;
 420         }
 421
 422         return false;
 423 }
 424
 425 void
 426 ValueNodeList::audit()
 427 {
 428         iterator iter,next;
 429
 430         for(next=begin(),iter=next++;iter!=end();iter=next++)
 431                 if(iter->count()==1)
 432                         std::list<ValueNode::RHandle>::erase(iter);
 433 }
 434
 435
 436 String
 437 PlaceholderValueNode::get_name()const
 438 {
 439         return "placeholder";
 440 }
 441
 442 String
 443 PlaceholderValueNode::get_local_name()const
 444 {
 445         return _("Placeholder");
 446 }
 447
 448 ValueNode*
 449 PlaceholderValueNode::clone(const GUID& deriv_guid)const
 450 {
 451         ValueNode* ret(new PlaceholderValueNode());
 452         ret->set_guid(get_guid()^deriv_guid);
 453         return ret;
 454 }
 455
 456 PlaceholderValueNode::Handle
 457 PlaceholderValueNode::create(ValueBase::Type type)
 458 {
 459         return new PlaceholderValueNode(type);
 460 }
 461
 462 ValueBase
 463 PlaceholderValueNode::operator()(Time /*t*/)const
 464 {
 465         assert(0);
 466         return ValueBase();
 467 }
 468
 469 PlaceholderValueNode::PlaceholderValueNode(ValueBase::Type type):
 470         ValueNode(type)
 471 {
 472 }
 473
 474 ValueNode*
 475 LinkableValueNode::clone(const GUID& deriv_guid)const
 476 {
 477         // printf("%s:%d clone()\n", __FILE__, __LINE__);
 478         { ValueNode* x(find_value_node(get_guid()^deriv_guid).get()); if(x)
 479                                                                                                                                   {
 480                                                                                                                                           printf("VALUENODE FOUND VALUENODE\n");
 481                                                                                                                                           return x;
 482                                                                                                                                   }}
 483
 484         int i;
 485         LinkableValueNode *ret=create_new();
 486         ret->set_guid(get_guid()^deriv_guid);
 487
 488         for(i=0;i<link_count();i++)
 489         {
 490                 ValueNode::Handle link=get_link_vfunc(i);
 491                 if(!link->is_exported())
 492                 {
 493                         ValueNode::LooseHandle value_node(find_value_node(link->get_guid()^deriv_guid));
 494                         if(!value_node)
 495                                 value_node=link->clone(deriv_guid);
 496                         ret->set_link(i,value_node);
 497                 }
 498                 else
 499                         ret->set_link(i,link);
 500         }
 501
 502         return ret;
 503 }
 504
 505 String
 506 ValueNode::get_relative_id(etl::loose_handle<const Canvas> x)const
 507 {
 508         assert(is_exported());
 509         assert(canvas_);
 510
 511         if(x.get()==canvas_.get())
 512                 return get_id();
 513
 514         return canvas_->_get_relative_id(x)+':'+get_id();
 515 }
 516
 517 void
 518 ValueNode::set_parent_canvas(etl::loose_handle<Canvas> x)
 519 {
 520         canvas_=x; if(x) root_canvas_=x->get_root();
 521 }
 522
 523 void
 524 ValueNode::set_root_canvas(etl::loose_handle<Canvas> x)
 525 {
 526         root_canvas_=x->get_root();
 527 }
 528
 529 void LinkableValueNode::get_times_vfunc(Node::time_set &set) const
 530 {
 531         ValueNode::LooseHandle  h;
 532
 533         int size = link_count();
 534
 535         //just add it to the set...
 536         for(int i=0; i < size; ++i)
 537         {
 538                 h = get_link(i);
 539
 540                 if(h)
 541                 {
 542                         const Node::time_set &tset = h->get_times();
 543                         set.insert(tset.begin(),tset.end());
 544                 }
 545         }
 546 }