1 /* === S Y N F I G ========================================================= */
2 /*! \file valuenode.cpp
3 ** \brief Implementation of the "Placeholder" valuenode conversion.
8 ** Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
9 ** Copyright (c) 2007, 2008 Chris Moore
10 ** Copyright (c) 2008 Carlos López
12 ** This package is free software; you can redistribute it and/or
13 ** modify it under the terms of the GNU General Public License as
14 ** published by the Free Software Foundation; either version 2 of
15 ** the License, or (at your option) any later version.
17 ** This package is distributed in the hope that it will be useful,
18 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 ** General Public License for more details.
23 /* ========================================================================= */
25 /* === H E A D E R S ======================================================= */
27 #define SYNFIG_NO_ANGLE
29 //#define HAS_HASH_MAP 1
38 #include "valuenode.h"
41 #include "paramdesc.h"
44 #include "valuenode_const.h"
45 #include "valuenode_linear.h"
46 #include "valuenode_composite.h"
47 #include "valuenode_reference.h"
48 #include "valuenode_scale.h"
49 #include "valuenode_blinecalctangent.h"
50 #include "valuenode_blinecalcvertex.h"
51 #include "valuenode_blinecalcwidth.h"
52 #include "valuenode_blinereversetangent.h"
53 #include "valuenode_segcalctangent.h"
54 #include "valuenode_segcalcvertex.h"
55 #include "valuenode_repeat_gradient.h"
56 #include "valuenode_stripes.h"
57 #include "valuenode_range.h"
58 #include "valuenode_add.h"
59 #include "valuenode_subtract.h"
60 #include "valuenode_timedswap.h"
61 #include "valuenode_twotone.h"
62 #include "valuenode_bline.h"
63 #include "valuenode_dynamiclist.h"
64 #include "valuenode_radialcomposite.h"
65 #include "valuenode_gradientrotate.h"
66 #include "valuenode_sine.h"
67 #include "valuenode_cos.h"
68 #include "valuenode_atan2.h"
69 #include "valuenode_exp.h"
70 #include "valuenode_switch.h"
71 #include "valuenode_timeloop.h"
72 #include "valuenode_reciprocal.h"
73 #include "valuenode_duplicate.h"
74 #include "valuenode_integer.h"
75 #include "valuenode_step.h"
76 #include "valuenode_vectorangle.h"
77 #include "valuenode_vectorlength.h"
78 #include "valuenode_vectorx.h"
79 #include "valuenode_vectory.h"
80 #include "valuenode_gradientcolor.h"
81 #include "valuenode_dotproduct.h"
82 #include "valuenode_timestring.h"
83 #include "valuenode_realstring.h"
84 #include "valuenode_join.h"
85 #include "valuenode_anglestring.h"
86 #include "valuenode_intstring.h"
87 #include "valuenode_log.h"
93 /* === U S I N G =========================================================== */
97 using namespace synfig;
99 /* === M A C R O S ========================================================= */
101 /* === G L O B A L S ======================================================= */
103 static int value_node_count(0);
105 static LinkableValueNode::Book *book_;
108 ValueNode::LooseHandle
109 synfig::find_value_node(const GUID& guid)
111 return guid_cast<ValueNode>(guid);
114 /* === P R O C E D U R E S ================================================= */
116 /* === M E T H O D S ======================================================= */
119 ValueNode::subsys_init()
121 book_=new LinkableValueNode::Book();
123 #define ADD_VALUENODE(class,name,local,version) \
124 (*book_)[name].factory=reinterpret_cast<LinkableValueNode::Factory>(&class::create); \
125 (*book_)[name].check_type=&class::check_type; \
126 (*book_)[name].local_name=local; \
127 (*book_)[name].release_version=version
129 #define ADD_VALUENODE2(class,name,local,version) \
130 (*book_)[name].factory=reinterpret_cast<LinkableValueNode::Factory>(&class::create_from); \
131 (*book_)[name].check_type=&class::check_type; \
132 (*book_)[name].local_name=local; \
133 (*book_)[name].release_version=version
135 ADD_VALUENODE(ValueNode_Linear, "linear", _("Linear"), RELEASE_VERSION_0_61_06);
136 ADD_VALUENODE(ValueNode_Composite, "composite", _("Composite"), RELEASE_VERSION_0_61_06);
137 ADD_VALUENODE(ValueNode_RadialComposite, "radial_composite", _("Radial Composite"), RELEASE_VERSION_0_61_06);
138 ADD_VALUENODE(ValueNode_Reference, "reference", _("Reference"), RELEASE_VERSION_0_61_06);
139 ADD_VALUENODE(ValueNode_Scale, "scale", _("Scale"), RELEASE_VERSION_0_61_06);
140 ADD_VALUENODE(ValueNode_SegCalcTangent, "segcalctangent", _("Segment Tangent"), RELEASE_VERSION_0_61_06);
141 ADD_VALUENODE(ValueNode_SegCalcVertex, "segcalcvertex", _("Segment Vertex"), RELEASE_VERSION_0_61_06);
142 ADD_VALUENODE(ValueNode_Stripes, "stripes", _("Stripes"), RELEASE_VERSION_0_61_06);
143 ADD_VALUENODE(ValueNode_Subtract, "subtract", _("Subtract"), RELEASE_VERSION_0_61_06);
144 ADD_VALUENODE(ValueNode_TwoTone, "twotone", _("Two-Tone"), RELEASE_VERSION_0_61_06);
145 ADD_VALUENODE(ValueNode_BLine, "bline", _("BLine"), RELEASE_VERSION_0_61_06);
146 ADD_VALUENODE2(ValueNode_DynamicList, "dynamic_list", _("Dynamic List"), RELEASE_VERSION_0_61_06);
147 ADD_VALUENODE(ValueNode_GradientRotate, "gradient_rotate", _("Gradient Rotate"), RELEASE_VERSION_0_61_06);
148 ADD_VALUENODE(ValueNode_Sine, "sine", _("Sine"), RELEASE_VERSION_0_61_06);
150 ADD_VALUENODE(ValueNode_TimedSwap, "timed_swap", _("Timed Swap"), RELEASE_VERSION_0_61_07); // SVN r610
151 ADD_VALUENODE(ValueNode_Repeat_Gradient, "repeat_gradient", _("Repeat Gradient"), RELEASE_VERSION_0_61_07); // SVN r666
152 ADD_VALUENODE(ValueNode_Exp, "exp", _("Exponential"), RELEASE_VERSION_0_61_07); // SVN r739
153 ADD_VALUENODE(ValueNode_Add, "add", _("Add"), RELEASE_VERSION_0_61_07); // SVN r742
154 ADD_VALUENODE(ValueNode_BLineCalcTangent, "blinecalctangent", _("BLine Tangent"), RELEASE_VERSION_0_61_07); // SVN r744
155 ADD_VALUENODE(ValueNode_BLineCalcVertex, "blinecalcvertex", _("BLine Vertex"), RELEASE_VERSION_0_61_07); // SVN r744
156 ADD_VALUENODE(ValueNode_Range, "range", _("Range"), RELEASE_VERSION_0_61_07); // SVN r776
158 ADD_VALUENODE(ValueNode_Switch, "switch", _("Switch"), RELEASE_VERSION_0_61_08); // SVN r923
159 ADD_VALUENODE(ValueNode_Cos, "cos", _("Cos"), RELEASE_VERSION_0_61_08); // SVN r1111
160 ADD_VALUENODE(ValueNode_Atan2, "atan2", _("aTan2"), RELEASE_VERSION_0_61_08); // SVN r1132
161 ADD_VALUENODE(ValueNode_BLineRevTangent, "blinerevtangent", _("Reverse Tangent"), RELEASE_VERSION_0_61_08); // SVN r1162
162 ADD_VALUENODE(ValueNode_TimeLoop, "timeloop", _("Time Loop"), RELEASE_VERSION_0_61_08); // SVN r1226
163 ADD_VALUENODE(ValueNode_Reciprocal, "reciprocal", _("Reciprocal"), RELEASE_VERSION_0_61_08); // SVN r1238
164 ADD_VALUENODE(ValueNode_Duplicate, "duplicate", _("Duplicate"), RELEASE_VERSION_0_61_08); // SVN r1267
165 ADD_VALUENODE(ValueNode_Integer, "fromint", _("From Integer"), RELEASE_VERSION_0_61_08); // SVN r1267
166 ADD_VALUENODE(ValueNode_Step, "step", _("Step"), RELEASE_VERSION_0_61_08); // SVN r1691
167 ADD_VALUENODE(ValueNode_BLineCalcWidth, "blinecalcwidth", _("BLine Width"), RELEASE_VERSION_0_61_08); // SVN r1694
169 ADD_VALUENODE(ValueNode_VectorAngle, "vectorangle", _("Vector Angle"), RELEASE_VERSION_0_61_09); // SVN r1880
170 ADD_VALUENODE(ValueNode_VectorLength, "vectorlength", _("Vector Length"), RELEASE_VERSION_0_61_09); // SVN r1881
171 ADD_VALUENODE(ValueNode_VectorX, "vectorx", _("Vector X"), RELEASE_VERSION_0_61_09); // SVN r1882
172 ADD_VALUENODE(ValueNode_VectorY, "vectory", _("Vector Y"), RELEASE_VERSION_0_61_09); // SVN r1882
173 ADD_VALUENODE(ValueNode_GradientColor, "gradientcolor", _("Gradient Color"), RELEASE_VERSION_0_61_09); // SVN r1885
174 ADD_VALUENODE(ValueNode_DotProduct, "dotproduct", _("Dot Product"), RELEASE_VERSION_0_61_09); // SVN r1891
175 ADD_VALUENODE(ValueNode_TimeString, "timestring", _("Time String"), RELEASE_VERSION_0_61_09); // SVN r2000
176 ADD_VALUENODE(ValueNode_RealString, "realstring", _("Real String"), RELEASE_VERSION_0_61_09); // SVN r2003
177 ADD_VALUENODE(ValueNode_Join, "join", _("Joined List"), RELEASE_VERSION_0_61_09); // SVN r2007
178 ADD_VALUENODE(ValueNode_AngleString, "anglestring", _("Angle String"), RELEASE_VERSION_0_61_09); // SVN r2010
179 ADD_VALUENODE(ValueNode_IntString, "intstring", _("Int String"), RELEASE_VERSION_0_61_09); // SVN r2010
180 ADD_VALUENODE(ValueNode_Logarithm, "logarithm", _("Logarithm"), RELEASE_VERSION_0_61_09); // SVN r2034
183 #undef ADD_VALUENODE2
189 ValueNode::subsys_stop()
192 /* if(global_value_node_map.size() || value_node_count)
195 synfig::error("%d ValueNodes haven't been destroyed yet!",value_node_count);
197 if(global_value_node_map.size()!=value_node_count)
198 synfig::error("value node count mismatch! map.size()!=value_node_count (%d!=%d)",global_value_node_map.size(),value_node_count);
200 GlobalValueNodeMap::iterator iter;
201 for(iter=global_value_node_map.begin();iter!=global_value_node_map.end();++iter)
203 if(!iter->second->is_exported())
204 synfig::info(_("%s: count:%d name:%s type:%s"),
205 iter->first.get_string().c_str(),
206 iter->second->count(),
207 iter->second->get_name().c_str(),
208 ValueBase::type_local_name(iter->second->get_type()).c_str()
211 synfig::info(_("%s: id:%s count:%d name:%s type:%s"),
212 iter->first.get_string().c_str(),
213 iter->second->get_id().c_str(),
214 iter->second->count(),
215 iter->second->get_name().c_str(),
216 ValueBase::type_local_name(iter->second->get_type()).c_str()
224 ValueNode::ValueNode(ValueBase::Type type):type(type)
229 LinkableValueNode::Book&
230 LinkableValueNode::book()
235 LinkableValueNode::Handle
236 LinkableValueNode::create(const String &name, const ValueBase& x)
238 if(!book().count(name))
241 if (!check_type(name, x.get_type()) &&
242 // the Duplicate ValueNode is an exception - we don't want the
243 // user creating it for themselves, so check_type() fails for
244 // it even when it is valid
245 !(name == "duplicate" && x.get_type() == ValueBase::TYPE_REAL))
247 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());
251 return book()[name].factory(x);
255 LinkableValueNode::check_type(const String &name, ValueBase::Type x)
257 if(!book().count(name) || !book()[name].check_type)
259 return book()[name].check_type(x);
263 LinkableValueNode::set_link(int i,ValueNode::Handle x)
265 ValueNode::Handle previous(get_link(i));
267 if(set_link_vfunc(i,x))
270 remove_child(previous.get());
273 if(!x->is_exported() && get_parent_canvas())
275 x->set_parent_canvas(get_parent_canvas());
283 ValueNode::LooseHandle
284 LinkableValueNode::get_link(int i)const
286 return get_link_vfunc(i);
290 LinkableValueNode::unlink_all()
292 for(int i=0;i<link_count();i++)
294 ValueNode::LooseHandle value_node(get_link(i));
296 value_node->parent_set.erase(this);
300 ValueNode::~ValueNode()
308 ValueNode::on_changed()
310 etl::loose_handle<Canvas> parent_canvas = get_parent_canvas();
312 do // signal to all the ancestor canvases
313 parent_canvas->signal_value_node_changed()(this);
314 while (parent_canvas = parent_canvas->parent());
315 else if(get_root_canvas())
316 get_root_canvas()->signal_value_node_changed()(this);
322 ValueNode::replace(etl::handle<ValueNode> x)
327 while(parent_set.size())
329 (*parent_set.begin())->add_child(x.get());
330 (*parent_set.begin())->remove_child(this);
331 //x->parent_set.insert(*parent_set.begin());
332 //parent_set.erase(parent_set.begin());
334 int r(RHandle(this).replace(x));
340 ValueNode::set_id(const String &x)
345 signal_id_changed_();
350 ValueNode::get_description(bool show_exported_name)const
352 String ret(_("ValueNode"));
354 if (dynamic_cast<const LinkableValueNode*>(this))
355 return (dynamic_cast<const LinkableValueNode*>(this))->get_description(-1, show_exported_name);
357 if (show_exported_name && !is_exported())
358 show_exported_name = false;
360 if (show_exported_name)
361 ret += strprintf(" (%s)", get_id().c_str());
366 ValueNodeList::ValueNodeList():
367 placeholder_count_(0)
372 ValueNodeList::count(const String &id)const
379 for(iter=begin();iter!=end() && id!=(*iter)->get_id();++iter)
389 ValueNodeList::find(const String &id)
394 throw Exception::IDNotFound("Empty ID");
396 for(iter=begin();iter!=end() && id!=(*iter)->get_id();++iter)
400 throw Exception::IDNotFound("ValueNode in ValueNodeList: "+id);
405 ValueNode::ConstHandle
406 ValueNodeList::find(const String &id)const
411 throw Exception::IDNotFound("Empty ID");
413 for(iter=begin();iter!=end() && id!=(*iter)->get_id();++iter)
417 throw Exception::IDNotFound("ValueNode in ValueNodeList: "+id);
423 ValueNodeList::surefind(const String &id)
426 throw Exception::IDNotFound("Empty ID");
428 ValueNode::Handle value_node;
434 catch(Exception::IDNotFound)
436 value_node=PlaceholderValueNode::create();
437 value_node->set_id(id);
438 push_back(value_node);
439 placeholder_count_++;
446 ValueNodeList::erase(ValueNode::Handle value_node)
452 for(iter=begin();iter!=end();++iter)
453 if(value_node.get()==iter->get())
455 std::list<ValueNode::RHandle>::erase(iter);
456 if(PlaceholderValueNode::Handle::cast_dynamic(value_node))
457 placeholder_count_--;
464 ValueNodeList::add(ValueNode::Handle value_node)
468 if(value_node->get_id().empty())
473 ValueNode::RHandle other_value_node=find(value_node->get_id());
474 if(PlaceholderValueNode::Handle::cast_dynamic(other_value_node))
476 other_value_node->replace(value_node);
477 placeholder_count_--;
483 catch(Exception::IDNotFound)
485 push_back(value_node);
493 ValueNodeList::audit()
497 for(next=begin(),iter=next++;iter!=end();iter=next++)
499 std::list<ValueNode::RHandle>::erase(iter);
504 PlaceholderValueNode::get_name()const
506 return "placeholder";
510 PlaceholderValueNode::get_local_name()const
512 return _("Placeholder");
516 PlaceholderValueNode::clone(const GUID& deriv_guid)const
518 ValueNode* ret(new PlaceholderValueNode());
519 ret->set_guid(get_guid()^deriv_guid);
523 PlaceholderValueNode::Handle
524 PlaceholderValueNode::create(ValueBase::Type type)
526 return new PlaceholderValueNode(type);
530 PlaceholderValueNode::operator()(Time /*t*/)const
536 PlaceholderValueNode::PlaceholderValueNode(ValueBase::Type type):
542 LinkableValueNode::clone(const GUID& deriv_guid)const
545 ValueNode* x(find_value_node(get_guid()^deriv_guid).get());
551 LinkableValueNode *ret=create_new();
552 ret->set_guid(get_guid()^deriv_guid);
554 for(i=0;i<link_count();i++)
556 ValueNode::Handle link=get_link_vfunc(i);
557 if(!link->is_exported())
559 ValueNode::LooseHandle value_node(find_value_node(link->get_guid()^deriv_guid));
561 value_node=link->clone(deriv_guid);
562 ret->set_link(i,value_node);
565 ret->set_link(i,link);
572 ValueNode::get_relative_id(etl::loose_handle<const Canvas> x)const
574 assert(is_exported());
577 if(x.get()==canvas_.get())
580 return canvas_->_get_relative_id(x)+':'+get_id();
584 ValueNode::set_parent_canvas(etl::loose_handle<Canvas> x)
586 canvas_=x; if(x) root_canvas_=x->get_root();
590 ValueNode::set_root_canvas(etl::loose_handle<Canvas> x)
592 root_canvas_=x->get_root();
595 void LinkableValueNode::get_times_vfunc(Node::time_set &set) const
597 ValueNode::LooseHandle h;
599 int size = link_count();
601 //just add it to the set...
602 for(int i=0; i < size; ++i)
608 const Node::time_set &tset = h->get_times();
609 set.insert(tset.begin(),tset.end());
615 LinkableValueNode::get_description(int index, bool show_exported_name)const
621 if (show_exported_name && is_exported())
622 description += strprintf(" (%s)", get_id().c_str());
626 description = String(":") + link_local_name(index);
628 if (show_exported_name)
630 ValueNode::LooseHandle link(get_link(index));
631 if (link->is_exported())
632 description += strprintf(" (%s)", link->get_id().c_str());
636 const synfig::Node* node = this;
637 LinkableValueNode::ConstHandle parent_linkable_vn = 0;
639 // walk up through the valuenodes trying to find the layer at the top
640 while (!node->parent_set.empty() && !dynamic_cast<const Layer*>(node))
642 LinkableValueNode::ConstHandle linkable_value_node(dynamic_cast<const LinkableValueNode*>(node));
643 if (linkable_value_node)
646 int cnt = linkable_value_node->link_count();
647 for (int i = 0; i < cnt; i++)
648 if (linkable_value_node->get_link(i) == parent_linkable_vn)
650 link = String(":") + linkable_value_node->link_local_name(i);
654 description = linkable_value_node->get_local_name() + link + (parent_linkable_vn?">":"") + description;
656 node = *node->parent_set.begin();
657 parent_linkable_vn = linkable_value_node;
660 Layer::ConstHandle parent_layer(dynamic_cast<const Layer*>(node));
664 const Layer::DynamicParamList &dynamic_param_list(parent_layer->dynamic_param_list());
665 // loop to find the parameter in the dynamic parameter list - this gives us its name
666 for (Layer::DynamicParamList::const_iterator iter = dynamic_param_list.begin(); iter != dynamic_param_list.end(); iter++)
667 if (iter->second == parent_linkable_vn)
668 param = String(":") + parent_layer->get_param_local_name(iter->first);
669 description = strprintf("(%s)%s>%s",
670 parent_layer->get_non_empty_description().c_str(),
672 description.c_str());