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

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