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
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.
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.
22 /* ========================================================================= */
24 /* === H E A D E R S ======================================================= */
26 #define SYNFIG_NO_ANGLE
28 //#define HAS_HASH_MAP 1
37 #include "valuenode.h"
40 #include "paramdesc.h"
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 #include "valuenode_vectorlength.h"
82 /* === U S I N G =========================================================== */
86 using namespace synfig;
88 /* === M A C R O S ========================================================= */
90 /* === G L O B A L S ======================================================= */
92 static int value_node_count(0);
94 static LinkableValueNode::Book *book_;
97 ValueNode::LooseHandle
98 synfig::find_value_node(const GUID& guid)
100 return guid_cast<ValueNode>(guid);
103 /* === P R O C E D U R E S ================================================= */
105 /* === M E T H O D S ======================================================= */
108 ValueNode::subsys_init()
110 book_=new LinkableValueNode::Book();
112 #define ADD_VALUENODE(class,name,local,version) \
113 (*book_)[name].factory=reinterpret_cast<LinkableValueNode::Factory>(&class::create); \
114 (*book_)[name].check_type=&class::check_type; \
115 (*book_)[name].local_name=local; \
116 (*book_)[name].release_version=version
118 #define ADD_VALUENODE2(class,name,local,version) \
119 (*book_)[name].factory=reinterpret_cast<LinkableValueNode::Factory>(&class::create_from); \
120 (*book_)[name].check_type=&class::check_type; \
121 (*book_)[name].local_name=local; \
122 (*book_)[name].release_version=version
124 ADD_VALUENODE(ValueNode_Linear, "linear", _("Linear"), RELEASE_VERSION_0_61_06);
125 ADD_VALUENODE(ValueNode_Composite, "composite", _("Composite"), RELEASE_VERSION_0_61_06);
126 ADD_VALUENODE(ValueNode_RadialComposite, "radial_composite", _("Radial Composite"), RELEASE_VERSION_0_61_06);
127 ADD_VALUENODE(ValueNode_Reference, "reference", _("Reference"), RELEASE_VERSION_0_61_06);
128 ADD_VALUENODE(ValueNode_Scale, "scale", _("Scale"), RELEASE_VERSION_0_61_06);
129 ADD_VALUENODE(ValueNode_SegCalcTangent, "segcalctangent", _("Segment Tangent"), RELEASE_VERSION_0_61_06);
130 ADD_VALUENODE(ValueNode_SegCalcVertex, "segcalcvertex", _("Segment Vertex"), RELEASE_VERSION_0_61_06);
131 ADD_VALUENODE(ValueNode_Stripes, "stripes", _("Stripes"), RELEASE_VERSION_0_61_06);
132 ADD_VALUENODE(ValueNode_Subtract, "subtract", _("Subtract"), RELEASE_VERSION_0_61_06);
133 ADD_VALUENODE(ValueNode_TwoTone, "twotone", _("Two-Tone"), RELEASE_VERSION_0_61_06);
134 ADD_VALUENODE(ValueNode_BLine, "bline", _("BLine"), RELEASE_VERSION_0_61_06);
135 ADD_VALUENODE2(ValueNode_DynamicList, "dynamic_list", _("Dynamic List"), RELEASE_VERSION_0_61_06);
136 ADD_VALUENODE(ValueNode_GradientRotate, "gradient_rotate", _("Gradient Rotate"), RELEASE_VERSION_0_61_06);
137 ADD_VALUENODE(ValueNode_Sine, "sine", _("Sine"), RELEASE_VERSION_0_61_06);
139 ADD_VALUENODE(ValueNode_TimedSwap, "timed_swap", _("Timed Swap"), RELEASE_VERSION_0_61_07); // SVN r610
140 ADD_VALUENODE(ValueNode_Repeat_Gradient, "repeat_gradient", _("Repeat Gradient"), RELEASE_VERSION_0_61_07); // SVN r666
141 ADD_VALUENODE(ValueNode_Exp, "exp", _("Exponential"), RELEASE_VERSION_0_61_07); // SVN r739
142 ADD_VALUENODE(ValueNode_Add, "add", _("Add"), RELEASE_VERSION_0_61_07); // SVN r742
143 ADD_VALUENODE(ValueNode_BLineCalcTangent, "blinecalctangent", _("BLine Tangent"), RELEASE_VERSION_0_61_07); // SVN r744
144 ADD_VALUENODE(ValueNode_BLineCalcVertex, "blinecalcvertex", _("BLine Vertex"), RELEASE_VERSION_0_61_07); // SVN r744
145 ADD_VALUENODE(ValueNode_Range, "range", _("Range"), RELEASE_VERSION_0_61_07); // SVN r776
147 ADD_VALUENODE(ValueNode_Switch, "switch", _("Switch"), RELEASE_VERSION_0_61_08); // SVN r923
148 ADD_VALUENODE(ValueNode_Cos, "cos", _("Cos"), RELEASE_VERSION_0_61_08); // SVN r1111
149 ADD_VALUENODE(ValueNode_Atan2, "atan2", _("aTan2"), RELEASE_VERSION_0_61_08); // SVN r1132
150 ADD_VALUENODE(ValueNode_BLineRevTangent, "blinerevtangent", _("Reverse Tangent"), RELEASE_VERSION_0_61_08); // SVN r1162
151 ADD_VALUENODE(ValueNode_TimeLoop, "timeloop", _("Time Loop"), RELEASE_VERSION_0_61_08); // SVN r1226
152 ADD_VALUENODE(ValueNode_Reciprocal, "reciprocal", _("Reciprocal"), RELEASE_VERSION_0_61_08); // SVN r1238
153 ADD_VALUENODE(ValueNode_Duplicate, "duplicate", _("Duplicate"), RELEASE_VERSION_0_61_08); // SVN r1267
154 ADD_VALUENODE(ValueNode_Integer, "fromint", _("From Integer"), RELEASE_VERSION_0_61_08); // SVN r1267
155 ADD_VALUENODE(ValueNode_Step, "step", _("Step"), RELEASE_VERSION_0_61_08); // SVN r1691
156 ADD_VALUENODE(ValueNode_BLineCalcWidth, "blinecalcwidth", _("BLine Width"), RELEASE_VERSION_0_61_08); // SVN r1694
158 ADD_VALUENODE(ValueNode_VectorAngle, "vectorangle", _("Vector Angle"), RELEASE_VERSION_0_61_09); // SVN r1880
159 ADD_VALUENODE(ValueNode_VectorLength, "vectorlength", _("Vector Length"), RELEASE_VERSION_0_61_09); // SVN r1881
162 #undef ADD_VALUENODE2
168 ValueNode::subsys_stop()
171 /* if(global_value_node_map.size() || value_node_count)
174 synfig::error("%d ValueNodes haven't been destroyed yet!",value_node_count);
176 if(global_value_node_map.size()!=value_node_count)
177 synfig::error("value node count mismatch! map.size()!=value_node_count (%d!=%d)",global_value_node_map.size(),value_node_count);
179 GlobalValueNodeMap::iterator iter;
180 for(iter=global_value_node_map.begin();iter!=global_value_node_map.end();++iter)
182 if(!iter->second->is_exported())
183 synfig::info(_("%s: count:%d name:%s type:%s"),
184 iter->first.get_string().c_str(),
185 iter->second->count(),
186 iter->second->get_name().c_str(),
187 ValueBase::type_local_name(iter->second->get_type()).c_str()
190 synfig::info(_("%s: id:%s count:%d name:%s type:%s"),
191 iter->first.get_string().c_str(),
192 iter->second->get_id().c_str(),
193 iter->second->count(),
194 iter->second->get_name().c_str(),
195 ValueBase::type_local_name(iter->second->get_type()).c_str()
203 ValueNode::ValueNode(ValueBase::Type type):type(type)
208 LinkableValueNode::Book&
209 LinkableValueNode::book()
214 LinkableValueNode::Handle
215 LinkableValueNode::create(const String &name, const ValueBase& x)
217 if(!book().count(name))
220 if (!check_type(name, x.get_type()) &&
221 // the Duplicate ValueNode is an exception - we don't want the
222 // user creating it for themselves, so check_type() fails for
223 // it even when it is valid
224 !(name == "duplicate" && x.get_type() == ValueBase::TYPE_REAL))
226 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());
230 return book()[name].factory(x);
234 LinkableValueNode::check_type(const String &name, ValueBase::Type x)
236 if(!book().count(name) || !book()[name].check_type)
238 return book()[name].check_type(x);
242 LinkableValueNode::set_link(int i,ValueNode::Handle x)
244 ValueNode::Handle previous(get_link(i));
246 if(set_link_vfunc(i,x))
249 remove_child(previous.get());
252 if(!x->is_exported() && get_parent_canvas())
254 x->set_parent_canvas(get_parent_canvas());
262 ValueNode::LooseHandle
263 LinkableValueNode::get_link(int i)const
265 return get_link_vfunc(i);
269 LinkableValueNode::unlink_all()
271 for(int i=0;i<link_count();i++)
273 ValueNode::LooseHandle value_node(get_link(i));
275 value_node->parent_set.erase(this);
279 ValueNode::~ValueNode()
287 ValueNode::on_changed()
289 etl::loose_handle<Canvas> parent_canvas = get_parent_canvas();
291 do // signal to all the ancestor canvases
292 parent_canvas->signal_value_node_changed()(this);
293 while (parent_canvas = parent_canvas->parent());
294 else if(get_root_canvas())
295 get_root_canvas()->signal_value_node_changed()(this);
301 ValueNode::replace(etl::handle<ValueNode> x)
306 while(parent_set.size())
308 (*parent_set.begin())->add_child(x.get());
309 (*parent_set.begin())->remove_child(this);
310 //x->parent_set.insert(*parent_set.begin());
311 //parent_set.erase(parent_set.begin());
313 int r(RHandle(this).replace(x));
319 ValueNode::set_id(const String &x)
324 signal_id_changed_();
329 ValueNode::get_description(bool show_exported_name)const
331 String ret(_("ValueNode"));
333 if (dynamic_cast<const LinkableValueNode*>(this))
334 return (dynamic_cast<const LinkableValueNode*>(this))->get_description(-1, show_exported_name);
336 if (show_exported_name && !is_exported())
337 show_exported_name = false;
339 if (show_exported_name)
340 ret += strprintf(" (%s)", get_id().c_str());
345 ValueNodeList::ValueNodeList():
346 placeholder_count_(0)
351 ValueNodeList::count(const String &id)const
358 for(iter=begin();iter!=end() && id!=(*iter)->get_id();++iter)
368 ValueNodeList::find(const String &id)
373 throw Exception::IDNotFound("Empty ID");
375 for(iter=begin();iter!=end() && id!=(*iter)->get_id();++iter)
379 throw Exception::IDNotFound("ValueNode in ValueNodeList: "+id);
384 ValueNode::ConstHandle
385 ValueNodeList::find(const String &id)const
390 throw Exception::IDNotFound("Empty ID");
392 for(iter=begin();iter!=end() && id!=(*iter)->get_id();++iter)
396 throw Exception::IDNotFound("ValueNode in ValueNodeList: "+id);
402 ValueNodeList::surefind(const String &id)
405 throw Exception::IDNotFound("Empty ID");
407 ValueNode::Handle value_node;
413 catch(Exception::IDNotFound)
415 value_node=PlaceholderValueNode::create();
416 value_node->set_id(id);
417 push_back(value_node);
418 placeholder_count_++;
425 ValueNodeList::erase(ValueNode::Handle value_node)
431 for(iter=begin();iter!=end();++iter)
432 if(value_node.get()==iter->get())
434 std::list<ValueNode::RHandle>::erase(iter);
435 if(PlaceholderValueNode::Handle::cast_dynamic(value_node))
436 placeholder_count_--;
443 ValueNodeList::add(ValueNode::Handle value_node)
447 if(value_node->get_id().empty())
452 ValueNode::RHandle other_value_node=find(value_node->get_id());
453 if(PlaceholderValueNode::Handle::cast_dynamic(other_value_node))
455 other_value_node->replace(value_node);
456 placeholder_count_--;
462 catch(Exception::IDNotFound)
464 push_back(value_node);
472 ValueNodeList::audit()
476 for(next=begin(),iter=next++;iter!=end();iter=next++)
478 std::list<ValueNode::RHandle>::erase(iter);
483 PlaceholderValueNode::get_name()const
485 return "placeholder";
489 PlaceholderValueNode::get_local_name()const
491 return _("Placeholder");
495 PlaceholderValueNode::clone(const GUID& deriv_guid)const
497 ValueNode* ret(new PlaceholderValueNode());
498 ret->set_guid(get_guid()^deriv_guid);
502 PlaceholderValueNode::Handle
503 PlaceholderValueNode::create(ValueBase::Type type)
505 return new PlaceholderValueNode(type);
509 PlaceholderValueNode::operator()(Time /*t*/)const
515 PlaceholderValueNode::PlaceholderValueNode(ValueBase::Type type):
521 LinkableValueNode::clone(const GUID& deriv_guid)const
524 ValueNode* x(find_value_node(get_guid()^deriv_guid).get());
530 LinkableValueNode *ret=create_new();
531 ret->set_guid(get_guid()^deriv_guid);
533 for(i=0;i<link_count();i++)
535 ValueNode::Handle link=get_link_vfunc(i);
536 if(!link->is_exported())
538 ValueNode::LooseHandle value_node(find_value_node(link->get_guid()^deriv_guid));
540 value_node=link->clone(deriv_guid);
541 ret->set_link(i,value_node);
544 ret->set_link(i,link);
551 ValueNode::get_relative_id(etl::loose_handle<const Canvas> x)const
553 assert(is_exported());
556 if(x.get()==canvas_.get())
559 return canvas_->_get_relative_id(x)+':'+get_id();
563 ValueNode::set_parent_canvas(etl::loose_handle<Canvas> x)
565 canvas_=x; if(x) root_canvas_=x->get_root();
569 ValueNode::set_root_canvas(etl::loose_handle<Canvas> x)
571 root_canvas_=x->get_root();
574 void LinkableValueNode::get_times_vfunc(Node::time_set &set) const
576 ValueNode::LooseHandle h;
578 int size = link_count();
580 //just add it to the set...
581 for(int i=0; i < size; ++i)
587 const Node::time_set &tset = h->get_times();
588 set.insert(tset.begin(),tset.end());
594 LinkableValueNode::get_description(int index, bool show_exported_name)const
600 if (show_exported_name && is_exported())
601 description += strprintf(" (%s)", get_id().c_str());
605 description = String(":") + link_local_name(index);
607 if (show_exported_name)
609 ValueNode::LooseHandle link(get_link(index));
610 if (link->is_exported())
611 description += strprintf(" (%s)", link->get_id().c_str());
615 const synfig::Node* node = this;
616 LinkableValueNode::ConstHandle parent_linkable_vn = 0;
618 // walk up through the valuenodes trying to find the layer at the top
619 while (!node->parent_set.empty() && !dynamic_cast<const Layer*>(node))
621 LinkableValueNode::ConstHandle linkable_value_node(dynamic_cast<const LinkableValueNode*>(node));
622 if (linkable_value_node)
625 int cnt = linkable_value_node->link_count();
626 for (int i = 0; i < cnt; i++)
627 if (linkable_value_node->get_link(i) == parent_linkable_vn)
629 link = String(":") + linkable_value_node->link_local_name(i);
633 description = linkable_value_node->get_local_name() + link + (parent_linkable_vn?">":"") + description;
635 node = *node->parent_set.begin();
636 parent_linkable_vn = linkable_value_node;
639 Layer::ConstHandle parent_layer(dynamic_cast<const Layer*>(node));
643 const Layer::DynamicParamList &dynamic_param_list(parent_layer->dynamic_param_list());
644 // loop to find the parameter in the dynamic parameter list - this gives us its name
645 for (Layer::DynamicParamList::const_iterator iter = dynamic_param_list.begin(); iter != dynamic_param_list.end(); iter++)
646 if (iter->second == parent_linkable_vn)
647 param = String(":") + parent_layer->get_param_local_name(iter->first);
648 description = strprintf("(%s)%s>%s",
649 parent_layer->get_non_empty_description().c_str(),
651 description.c_str());