Add new ValueNode "Vector Angle" for calculating an angle from a vector.
[synfig.git] / 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, 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 //#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 #include "paramdesc.h"
41 #include "releases.h"
42
43 #include "valuenode_const.h"
44 #include "valuenode_linear.h"
45 #include "valuenode_composite.h"
46 #include "valuenode_reference.h"
47 #include "valuenode_scale.h"
48 #include "valuenode_blinecalctangent.h"
49 #include "valuenode_blinecalcvertex.h"
50 #include "valuenode_blinecalcwidth.h"
51 #include "valuenode_blinereversetangent.h"
52 #include "valuenode_segcalctangent.h"
53 #include "valuenode_segcalcvertex.h"
54 #include "valuenode_repeat_gradient.h"
55 #include "valuenode_stripes.h"
56 #include "valuenode_range.h"
57 #include "valuenode_add.h"
58 #include "valuenode_subtract.h"
59 #include "valuenode_timedswap.h"
60 #include "valuenode_twotone.h"
61 #include "valuenode_bline.h"
62 #include "valuenode_dynamiclist.h"
63 #include "valuenode_radialcomposite.h"
64 #include "valuenode_gradientrotate.h"
65 #include "valuenode_sine.h"
66 #include "valuenode_cos.h"
67 #include "valuenode_atan2.h"
68 #include "valuenode_exp.h"
69 #include "valuenode_switch.h"
70 #include "valuenode_timeloop.h"
71 #include "valuenode_reciprocal.h"
72 #include "valuenode_duplicate.h"
73 #include "valuenode_integer.h"
74 #include "valuenode_step.h"
75 #include "valuenode_vectorangle.h"
76
77 #include "layer.h"
78
79 #endif
80
81 /* === U S I N G =========================================================== */
82
83 using namespace std;
84 using namespace etl;
85 using namespace synfig;
86
87 /* === M A C R O S ========================================================= */
88
89 /* === G L O B A L S ======================================================= */
90
91 static int value_node_count(0);
92
93 static LinkableValueNode::Book *book_;
94
95
96 ValueNode::LooseHandle
97 synfig::find_value_node(const GUID& guid)
98 {
99         return guid_cast<ValueNode>(guid);
100 }
101
102 /* === P R O C E D U R E S ================================================= */
103
104 /* === M E T H O D S ======================================================= */
105
106 bool
107 ValueNode::subsys_init()
108 {
109         book_=new LinkableValueNode::Book();
110
111 #define ADD_VALUENODE(class,name,local,version)                                                                                                 \
112         (*book_)[name].factory=reinterpret_cast<LinkableValueNode::Factory>(&class::create);            \
113         (*book_)[name].check_type=&class::check_type;                                                                                           \
114         (*book_)[name].local_name=local;                                                                                                                        \
115         (*book_)[name].release_version=version
116
117 #define ADD_VALUENODE2(class,name,local,version)                                                                                                \
118         (*book_)[name].factory=reinterpret_cast<LinkableValueNode::Factory>(&class::create_from);       \
119         (*book_)[name].check_type=&class::check_type;                                                                                           \
120         (*book_)[name].local_name=local;                                                                                                                        \
121         (*book_)[name].release_version=version
122
123         ADD_VALUENODE(ValueNode_Linear,                   "linear",                       _("Linear"),                   RELEASE_VERSION_0_61_06);
124         ADD_VALUENODE(ValueNode_Composite,                "composite",            _("Composite"),                RELEASE_VERSION_0_61_06);
125         ADD_VALUENODE(ValueNode_RadialComposite,  "radial_composite", _("Radial Composite"), RELEASE_VERSION_0_61_06);
126         ADD_VALUENODE(ValueNode_Reference,                "reference",            _("Reference"),                RELEASE_VERSION_0_61_06);
127         ADD_VALUENODE(ValueNode_Scale,                    "scale",                        _("Scale"),                    RELEASE_VERSION_0_61_06);
128         ADD_VALUENODE(ValueNode_SegCalcTangent,   "segcalctangent",       _("Segment Tangent"),  RELEASE_VERSION_0_61_06);
129         ADD_VALUENODE(ValueNode_SegCalcVertex,    "segcalcvertex",        _("Segment Vertex"),   RELEASE_VERSION_0_61_06);
130         ADD_VALUENODE(ValueNode_Stripes,                  "stripes",              _("Stripes"),                  RELEASE_VERSION_0_61_06);
131         ADD_VALUENODE(ValueNode_Subtract,                 "subtract",             _("Subtract"),                 RELEASE_VERSION_0_61_06);
132         ADD_VALUENODE(ValueNode_TwoTone,                  "twotone",              _("Two-Tone"),                 RELEASE_VERSION_0_61_06);
133         ADD_VALUENODE(ValueNode_BLine,                    "bline",                        _("BLine"),                    RELEASE_VERSION_0_61_06);
134         ADD_VALUENODE2(ValueNode_DynamicList,     "dynamic_list",         _("Dynamic List"),     RELEASE_VERSION_0_61_06);
135         ADD_VALUENODE(ValueNode_GradientRotate,   "gradient_rotate",  _("Gradient Rotate"),      RELEASE_VERSION_0_61_06);
136         ADD_VALUENODE(ValueNode_Sine,                     "sine",                         _("Sine"),                     RELEASE_VERSION_0_61_06);
137
138         ADD_VALUENODE(ValueNode_TimedSwap,                "timed_swap",           _("Timed Swap"),               RELEASE_VERSION_0_61_07); // SVN r610
139         ADD_VALUENODE(ValueNode_Repeat_Gradient,  "repeat_gradient",  _("Repeat Gradient"),      RELEASE_VERSION_0_61_07); // SVN r666
140         ADD_VALUENODE(ValueNode_Exp,                      "exp",                          _("Exponential"),              RELEASE_VERSION_0_61_07); // SVN r739
141         ADD_VALUENODE(ValueNode_Add,                      "add",                          _("Add"),                              RELEASE_VERSION_0_61_07); // SVN r742
142         ADD_VALUENODE(ValueNode_BLineCalcTangent, "blinecalctangent", _("BLine Tangent"),        RELEASE_VERSION_0_61_07); // SVN r744
143         ADD_VALUENODE(ValueNode_BLineCalcVertex,  "blinecalcvertex",  _("BLine Vertex"),         RELEASE_VERSION_0_61_07); // SVN r744
144         ADD_VALUENODE(ValueNode_Range,                    "range",                        _("Range"),                    RELEASE_VERSION_0_61_07); // SVN r776
145
146         ADD_VALUENODE(ValueNode_Switch,                   "switch",                       _("Switch"),                   RELEASE_VERSION_0_61_08); // SVN r923
147         ADD_VALUENODE(ValueNode_Cos,                      "cos",                          _("Cos"),                              RELEASE_VERSION_0_61_08); // SVN r1111
148         ADD_VALUENODE(ValueNode_Atan2,                    "atan2",                        _("aTan2"),                    RELEASE_VERSION_0_61_08); // SVN r1132
149         ADD_VALUENODE(ValueNode_BLineRevTangent,  "blinerevtangent",  _("Reverse Tangent"),      RELEASE_VERSION_0_61_08); // SVN r1162
150         ADD_VALUENODE(ValueNode_TimeLoop,                 "timeloop",             _("Time Loop"),                RELEASE_VERSION_0_61_08); // SVN r1226
151         ADD_VALUENODE(ValueNode_Reciprocal,               "reciprocal",           _("Reciprocal"),               RELEASE_VERSION_0_61_08); // SVN r1238
152         ADD_VALUENODE(ValueNode_Duplicate,                "duplicate",            _("Duplicate"),                RELEASE_VERSION_0_61_08); // SVN r1267
153         ADD_VALUENODE(ValueNode_Integer,                  "fromint",              _("From Integer"),     RELEASE_VERSION_0_61_08); // SVN r1267
154         ADD_VALUENODE(ValueNode_Step,                     "step",                         _("Step"),                     RELEASE_VERSION_0_61_08); // SVN r1691
155         ADD_VALUENODE(ValueNode_BLineCalcWidth,   "blinecalcwidth",       _("BLine Width"),              RELEASE_VERSION_0_61_08); // SVN r1694
156
157         ADD_VALUENODE(ValueNode_VectorAngle,      "vectorangle",          _("Vector Angle"),     RELEASE_VERSION_0_61_09); // SVN r????
158
159 #undef ADD_VALUENODE
160 #undef ADD_VALUENODE2
161
162         return true;
163 }
164
165 bool
166 ValueNode::subsys_stop()
167 {
168         delete book_;
169 /*      if(global_value_node_map.size() || value_node_count)
170         {
171                 if(value_node_count)
172                         synfig::error("%d ValueNodes haven't been destroyed yet!",value_node_count);
173
174                 if(global_value_node_map.size()!=value_node_count)
175                         synfig::error("value node count mismatch! map.size()!=value_node_count (%d!=%d)",global_value_node_map.size(),value_node_count);
176
177                 GlobalValueNodeMap::iterator iter;
178                 for(iter=global_value_node_map.begin();iter!=global_value_node_map.end();++iter)
179                 {
180                         if(!iter->second->is_exported())
181                                 synfig::info(_("%s: count:%d name:%s type:%s"),
182                                         iter->first.get_string().c_str(),
183                                         iter->second->count(),
184                                         iter->second->get_name().c_str(),
185                                         ValueBase::type_local_name(iter->second->get_type()).c_str()
186                                 );
187                         else
188                                 synfig::info(_("%s: id:%s count:%d name:%s type:%s"),
189                                         iter->first.get_string().c_str(),
190                                         iter->second->get_id().c_str(),
191                                         iter->second->count(),
192                                         iter->second->get_name().c_str(),
193                                         ValueBase::type_local_name(iter->second->get_type()).c_str()
194                                 );
195                 }
196         }
197 */
198         return true;
199 }
200
201 ValueNode::ValueNode(ValueBase::Type type):type(type)
202 {
203         value_node_count++;
204 }
205
206 LinkableValueNode::Book&
207 LinkableValueNode::book()
208 {
209         return *book_;
210 }
211
212 LinkableValueNode::Handle
213 LinkableValueNode::create(const String &name, const ValueBase& x)
214 {
215         if(!book().count(name))
216                 return 0;
217
218         if (!check_type(name, x.get_type()) &&
219                 // the Duplicate ValueNode is an exception - we don't want the
220                 // user creating it for themselves, so check_type() fails for
221                 // it even when it is valid
222                 !(name == "duplicate" && x.get_type() == ValueBase::TYPE_REAL))
223         {
224                 error(_("Bad type: ValueNode '%s' doesn't accept type '%s'"), book()[name].local_name.c_str(), ValueBase::type_local_name(x.get_type()).c_str());
225                 return 0;
226         }
227
228         return book()[name].factory(x);
229 }
230
231 bool
232 LinkableValueNode::check_type(const String &name, ValueBase::Type x)
233 {
234         if(!book().count(name) || !book()[name].check_type)
235                 return false;
236         return book()[name].check_type(x);
237 }
238
239 bool
240 LinkableValueNode::set_link(int i,ValueNode::Handle x)
241 {
242         ValueNode::Handle previous(get_link(i));
243
244         if(set_link_vfunc(i,x))
245         {
246                 if(previous)
247                         remove_child(previous.get());
248                 add_child(x.get());
249
250                 if(!x->is_exported() && get_parent_canvas())
251                 {
252                         x->set_parent_canvas(get_parent_canvas());
253                 }
254                 changed();
255                 return true;
256         }
257         return false;
258 }
259
260 ValueNode::LooseHandle
261 LinkableValueNode::get_link(int i)const
262 {
263         return get_link_vfunc(i);
264 }
265
266 void
267 LinkableValueNode::unlink_all()
268 {
269         for(int i=0;i<link_count();i++)
270         {
271                 ValueNode::LooseHandle value_node(get_link(i));
272                 if(value_node)
273                         value_node->parent_set.erase(this);
274         }
275 }
276
277 ValueNode::~ValueNode()
278 {
279         value_node_count--;
280
281         begin_delete();
282 }
283
284 void
285 ValueNode::on_changed()
286 {
287         etl::loose_handle<Canvas> parent_canvas = get_parent_canvas();
288         if(parent_canvas)
289                 do                                              // signal to all the ancestor canvases
290                         parent_canvas->signal_value_node_changed()(this);
291                 while (parent_canvas = parent_canvas->parent());
292         else if(get_root_canvas())
293                 get_root_canvas()->signal_value_node_changed()(this);
294
295         Node::on_changed();
296 }
297
298 int
299 ValueNode::replace(etl::handle<ValueNode> x)
300 {
301         if(x.get()==this)
302                 return 0;
303
304         while(parent_set.size())
305         {
306                 (*parent_set.begin())->add_child(x.get());
307                 (*parent_set.begin())->remove_child(this);
308                 //x->parent_set.insert(*parent_set.begin());
309                 //parent_set.erase(parent_set.begin());
310         }
311         int r(RHandle(this).replace(x));
312         x->changed();
313         return r;
314 }
315
316 void
317 ValueNode::set_id(const String &x)
318 {
319         if(name!=x)
320         {
321                 name=x;
322                 signal_id_changed_();
323         }
324 }
325
326 String
327 ValueNode::get_description(bool show_exported_name)const
328 {
329         String ret(_("ValueNode"));
330
331         if (dynamic_cast<const LinkableValueNode*>(this))
332                 return (dynamic_cast<const LinkableValueNode*>(this))->get_description(-1, show_exported_name);
333
334         if (show_exported_name && !is_exported())
335                 show_exported_name = false;
336
337         if (show_exported_name)
338                 ret += strprintf(" (%s)", get_id().c_str());
339
340         return ret;
341 }
342
343 ValueNodeList::ValueNodeList():
344         placeholder_count_(0)
345 {
346 }
347
348 bool
349 ValueNodeList::count(const String &id)const
350 {
351         const_iterator iter;
352
353         if(id.empty())
354                 return false;
355
356         for(iter=begin();iter!=end() && id!=(*iter)->get_id();++iter)
357                 ;
358
359         if(iter==end())
360                 return false;
361
362         return true;
363 }
364
365 ValueNode::Handle
366 ValueNodeList::find(const String &id)
367 {
368         iterator iter;
369
370         if(id.empty())
371                 throw Exception::IDNotFound("Empty ID");
372
373         for(iter=begin();iter!=end() && id!=(*iter)->get_id();++iter)
374                 ;
375
376         if(iter==end())
377                 throw Exception::IDNotFound("ValueNode in ValueNodeList: "+id);
378
379         return *iter;
380 }
381
382 ValueNode::ConstHandle
383 ValueNodeList::find(const String &id)const
384 {
385         const_iterator iter;
386
387         if(id.empty())
388                 throw Exception::IDNotFound("Empty ID");
389
390         for(iter=begin();iter!=end() && id!=(*iter)->get_id();++iter)
391                 ;
392
393         if(iter==end())
394                 throw Exception::IDNotFound("ValueNode in ValueNodeList: "+id);
395
396         return *iter;
397 }
398
399 ValueNode::Handle
400 ValueNodeList::surefind(const String &id)
401 {
402         if(id.empty())
403                 throw Exception::IDNotFound("Empty ID");
404
405         ValueNode::Handle value_node;
406
407         try
408         {
409                 value_node=find(id);
410         }
411         catch(Exception::IDNotFound)
412         {
413                 value_node=PlaceholderValueNode::create();
414                 value_node->set_id(id);
415                 push_back(value_node);
416                 placeholder_count_++;
417         }
418
419         return value_node;
420 }
421
422 bool
423 ValueNodeList::erase(ValueNode::Handle value_node)
424 {
425         assert(value_node);
426
427         iterator iter;
428
429         for(iter=begin();iter!=end();++iter)
430                 if(value_node.get()==iter->get())
431                 {
432                         std::list<ValueNode::RHandle>::erase(iter);
433                         if(PlaceholderValueNode::Handle::cast_dynamic(value_node))
434                                 placeholder_count_--;
435                         return true;
436                 }
437         return false;
438 }
439
440 bool
441 ValueNodeList::add(ValueNode::Handle value_node)
442 {
443         if(!value_node)
444                 return false;
445         if(value_node->get_id().empty())
446                 return false;
447
448         try
449         {
450                 ValueNode::RHandle other_value_node=find(value_node->get_id());
451                 if(PlaceholderValueNode::Handle::cast_dynamic(other_value_node))
452                 {
453                         other_value_node->replace(value_node);
454                         placeholder_count_--;
455                         return true;
456                 }
457
458                 return false;
459         }
460         catch(Exception::IDNotFound)
461         {
462                 push_back(value_node);
463                 return true;
464         }
465
466         return false;
467 }
468
469 void
470 ValueNodeList::audit()
471 {
472         iterator iter,next;
473
474         for(next=begin(),iter=next++;iter!=end();iter=next++)
475                 if(iter->count()==1)
476                         std::list<ValueNode::RHandle>::erase(iter);
477 }
478
479
480 String
481 PlaceholderValueNode::get_name()const
482 {
483         return "placeholder";
484 }
485
486 String
487 PlaceholderValueNode::get_local_name()const
488 {
489         return _("Placeholder");
490 }
491
492 ValueNode*
493 PlaceholderValueNode::clone(const GUID& deriv_guid)const
494 {
495         ValueNode* ret(new PlaceholderValueNode());
496         ret->set_guid(get_guid()^deriv_guid);
497         return ret;
498 }
499
500 PlaceholderValueNode::Handle
501 PlaceholderValueNode::create(ValueBase::Type type)
502 {
503         return new PlaceholderValueNode(type);
504 }
505
506 ValueBase
507 PlaceholderValueNode::operator()(Time /*t*/)const
508 {
509         assert(0);
510         return ValueBase();
511 }
512
513 PlaceholderValueNode::PlaceholderValueNode(ValueBase::Type type):
514         ValueNode(type)
515 {
516 }
517
518 ValueNode*
519 LinkableValueNode::clone(const GUID& deriv_guid)const
520 {
521         {
522                 ValueNode* x(find_value_node(get_guid()^deriv_guid).get());
523                 if(x)
524                         return x;
525         }
526
527         int i;
528         LinkableValueNode *ret=create_new();
529         ret->set_guid(get_guid()^deriv_guid);
530
531         for(i=0;i<link_count();i++)
532         {
533                 ValueNode::Handle link=get_link_vfunc(i);
534                 if(!link->is_exported())
535                 {
536                         ValueNode::LooseHandle value_node(find_value_node(link->get_guid()^deriv_guid));
537                         if(!value_node)
538                                 value_node=link->clone(deriv_guid);
539                         ret->set_link(i,value_node);
540                 }
541                 else
542                         ret->set_link(i,link);
543         }
544
545         return ret;
546 }
547
548 String
549 ValueNode::get_relative_id(etl::loose_handle<const Canvas> x)const
550 {
551         assert(is_exported());
552         assert(canvas_);
553
554         if(x.get()==canvas_.get())
555                 return get_id();
556
557         return canvas_->_get_relative_id(x)+':'+get_id();
558 }
559
560 void
561 ValueNode::set_parent_canvas(etl::loose_handle<Canvas> x)
562 {
563         canvas_=x; if(x) root_canvas_=x->get_root();
564 }
565
566 void
567 ValueNode::set_root_canvas(etl::loose_handle<Canvas> x)
568 {
569         root_canvas_=x->get_root();
570 }
571
572 void LinkableValueNode::get_times_vfunc(Node::time_set &set) const
573 {
574         ValueNode::LooseHandle  h;
575
576         int size = link_count();
577
578         //just add it to the set...
579         for(int i=0; i < size; ++i)
580         {
581                 h = get_link(i);
582
583                 if(h)
584                 {
585                         const Node::time_set &tset = h->get_times();
586                         set.insert(tset.begin(),tset.end());
587                 }
588         }
589 }
590
591 String
592 LinkableValueNode::get_description(int index, bool show_exported_name)const
593 {
594         String description;
595
596         if (index == -1)
597         {
598                 if (show_exported_name && is_exported())
599                         description += strprintf(" (%s)", get_id().c_str());
600         }
601         else
602         {
603                 description = String(":") + link_local_name(index);
604
605                 if (show_exported_name)
606                 {
607                         ValueNode::LooseHandle link(get_link(index));
608                         if (link->is_exported())
609                                 description += strprintf(" (%s)", link->get_id().c_str());
610                 }
611         }
612
613         const synfig::Node* node = this;
614         LinkableValueNode::ConstHandle parent_linkable_vn = 0;
615
616         // walk up through the valuenodes trying to find the layer at the top
617         while (!node->parent_set.empty() && !dynamic_cast<const Layer*>(node))
618         {
619                 LinkableValueNode::ConstHandle linkable_value_node(dynamic_cast<const LinkableValueNode*>(node));
620                 if (linkable_value_node)
621                 {
622                         String link;
623                         int cnt = linkable_value_node->link_count();
624                         for (int i = 0; i < cnt; i++)
625                                 if (linkable_value_node->get_link(i) == parent_linkable_vn)
626                                 {
627                                         link = String(":") + linkable_value_node->link_local_name(i);
628                                         break;
629                                 }
630
631                         description = linkable_value_node->get_local_name() + link + (parent_linkable_vn?">":"") + description;
632                 }
633                 node = *node->parent_set.begin();
634                 parent_linkable_vn = linkable_value_node;
635         }
636
637         Layer::ConstHandle parent_layer(dynamic_cast<const Layer*>(node));
638         if(parent_layer)
639         {
640                 String param;
641                 const Layer::DynamicParamList &dynamic_param_list(parent_layer->dynamic_param_list());
642                 // loop to find the parameter in the dynamic parameter list - this gives us its name
643                 for (Layer::DynamicParamList::const_iterator iter = dynamic_param_list.begin(); iter != dynamic_param_list.end(); iter++)
644                         if (iter->second == parent_linkable_vn)
645                                 param = String(":") + parent_layer->get_param_local_name(iter->first);
646                 description = strprintf("(%s)%s>%s",
647                                                                 parent_layer->get_non_empty_description().c_str(),
648                                                                 param.c_str(),
649                                                                 description.c_str());
650         }
651
652         return description;
653 }