1 /* === S Y N F I G ========================================================= */
2 /*! \file valuenode_range.cpp
3 ** \brief Implementation of the "Range" 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 ======================================================= */
34 #include "valuenode_range.h"
35 #include "valuenode_const.h"
43 /* === U S I N G =========================================================== */
47 using namespace synfig;
49 /* === M A C R O S ========================================================= */
51 /* === G L O B A L S ======================================================= */
53 /* === P R O C E D U R E S ================================================= */
55 /* === M E T H O D S ======================================================= */
57 synfig::ValueNode_Range::ValueNode_Range(const ValueBase &value):
58 LinkableValueNode(value.get_type())
60 Vocab ret(get_children_vocab());
61 set_children_vocab(ret);
62 ValueBase::Type id(value.get_type());
66 case ValueBase::TYPE_ANGLE:
67 set_link("min",ValueNode_Const::create(value.get(Angle())));
68 set_link("max",ValueNode_Const::create(value.get(Angle())));
69 set_link("link",ValueNode_Const::create(value.get(Angle())));
71 case ValueBase::TYPE_INTEGER:
72 set_link("min",ValueNode_Const::create(value.get(int())));
73 set_link("max",ValueNode_Const::create(value.get(int())));
74 set_link("link",ValueNode_Const::create(value.get(int())));
76 case ValueBase::TYPE_REAL:
77 set_link("min",ValueNode_Const::create(value.get(Real())));
78 set_link("max",ValueNode_Const::create(value.get(Real())));
79 set_link("link",ValueNode_Const::create(value.get(Real())));
81 case ValueBase::TYPE_TIME:
82 set_link("min",ValueNode_Const::create(value.get(Time())));
83 set_link("max",ValueNode_Const::create(value.get(Time())));
84 set_link("link",ValueNode_Const::create(value.get(Time())));
88 throw runtime_error(get_local_name()+_(":Bad type ")+ValueBase::type_local_name(id));
91 assert(min_->get_type()==id);
92 assert(max_->get_type()==id);
93 assert(link_->get_type()==id);
94 assert(get_type()==id);
98 ValueNode_Range::create_new()const
100 return new ValueNode_Range(get_type());
104 ValueNode_Range::create(const ValueBase& value)
106 return new ValueNode_Range(value);
109 synfig::ValueNode_Range::~ValueNode_Range()
115 synfig::ValueNode_Range::operator()(Time t)const
117 if (getenv("SYNFIG_DEBUG_VALUENODE_OPERATORS"))
118 printf("%s:%d operator()\n", __FILE__, __LINE__);
120 if(!min_ || !max_ || !link_)
121 throw runtime_error(strprintf("ValueNode_Range: %s",_("Some of my parameters aren't set!")));
125 case ValueBase::TYPE_ANGLE:
127 Angle minimum = (* min_)(t).get(Angle());
128 Angle maximum = (* max_)(t).get(Angle());
129 Angle link = (*link_)(t).get(Angle());
130 // This code was removed because it didn't work with link < minimum
131 // It is sane to completely delete it if the replacement code is fine.
132 /* ***********************************************
133 // if link is between min and max, use it
134 if (Angle::deg((link-minimum).mod()).get() < Angle::deg((maximum-minimum).mod()).get())
136 // otherwise use whichever of min and max is closest to link
137 else if (link.dist(minimum).abs() < link.dist(maximum).abs())
141 *********************************************** */
142 if(Angle::rad(maximum).get()>=Angle::rad(link).get() && Angle::rad(link).get()>=Angle::rad(minimum).get())
144 else if (Angle::rad(minimum).get()>Angle::rad(link).get())
149 case ValueBase::TYPE_INTEGER:
150 return std::max((*min_)(t).get(int()), std::min((*max_)(t).get(int()), (*link_)(t).get(int())));
151 case ValueBase::TYPE_REAL:
152 return std::max((*min_)(t).get(Real()), std::min((*max_)(t).get(Real()), (*link_)(t).get(Real())));
153 case ValueBase::TYPE_TIME:
154 return std::max((*min_)(t).get(Time()), std::min((*max_)(t).get(Time()), (*link_)(t).get(Time())));
163 synfig::ValueNode_Range::get_inverse(Time t, const synfig::Vector &target_value) const
167 case ValueBase::TYPE_INTEGER:
169 int max_value((*max_)(t).get(int()));
170 int min_value((*min_)(t).get(int()));
171 return std::max(min_value, std::min(max_value, int(target_value.mag())));
173 case ValueBase::TYPE_REAL:
175 Real max_value((*max_)(t).get(Real()));
176 Real min_value((*min_)(t).get(Real()));
177 return std::max(min_value, std::min(max_value, target_value.mag()));
179 case ValueBase::TYPE_ANGLE:
181 Angle max_value((*max_)(t).get(Angle()));
182 Angle min_value((*min_)(t).get(Angle()));
183 Angle target_angle(Angle::tan(target_value[1],target_value[0]));
184 return target_angle>max_value?max_value:target_angle<min_value?min_value:target_angle;
186 case ValueBase::TYPE_TIME:
188 Real max_value((*max_)(t).get(Time()));
189 Real min_value((*min_)(t).get(Time()));
190 return std::max(min_value, std::min(max_value, target_value.mag()));
199 synfig::ValueNode_Range::get_inverse(Time t, const synfig::Angle &target_value) const
201 Angle minimum = (* min_)(t).get(Angle());
202 Angle maximum = (* max_)(t).get(Angle());
203 Angle link = (*link_)(t).get(Angle());
208 if(Angle::rad(maximum).get()>=Angle::rad(target_value).get() && Angle::rad(target_value).get()>=Angle::rad(minimum).get())
210 else if (Angle::rad(minimum).get()>Angle::rad(target_value).get())
220 ValueNode_Range::set_link_vfunc(int i,ValueNode::Handle value)
222 assert(i>=0 && i<link_count());
226 case 0: CHECK_TYPE_AND_SET_VALUE(min_, get_type());
227 case 1: CHECK_TYPE_AND_SET_VALUE(max_, get_type());
228 case 2: CHECK_TYPE_AND_SET_VALUE(link_, get_type());
233 ValueNode::LooseHandle
234 ValueNode_Range::get_link_vfunc(int i)const
236 assert(i>=0 && i<link_count());
242 case 2: return link_;
248 ValueNode_Range::link_count()const
254 ValueNode_Range::link_local_name(int i)const
256 assert(i>=0 && i<link_count());
260 case 0: return _("Min");
261 case 1: return _("Max");
262 case 2: return _("Link");
263 default: return String();
268 ValueNode_Range::link_name(int i)const
270 assert(i>=0 && i<link_count());
274 case 0: return "min";
275 case 1: return "max";
276 case 2: return "link";
277 default: return String();
282 ValueNode_Range::get_link_index_from_name(const String &name)const
284 if(name=="min") return 0;
285 if(name=="max") return 1;
286 if(name=="link") return 2;
287 throw Exception::BadLinkName(name);
291 ValueNode_Range::get_name()const
297 ValueNode_Range::get_local_name()const
303 ValueNode_Range::check_type(ValueBase::Type type)
305 return type==ValueBase::TYPE_ANGLE
306 || type==ValueBase::TYPE_INTEGER
307 || type==ValueBase::TYPE_REAL
308 || type==ValueBase::TYPE_TIME;
311 LinkableValueNode::Vocab
312 ValueNode_Range::get_children_vocab_vfunc()const
314 if(children_vocab.size())
315 return children_vocab;
317 LinkableValueNode::Vocab ret;
319 ret.push_back(ParamDesc(ValueBase(),"min")
320 .set_local_name(_("Min"))
321 .set_description(_("Returned value when 'Link' is smaller"))
324 ret.push_back(ParamDesc(ValueBase(),"max")
325 .set_local_name(_("Max"))
326 .set_description(_("Returned value when 'Link' is greater"))
329 ret.push_back(ParamDesc(ValueBase(),"link")
330 .set_local_name(_("Link"))
331 .set_description(_("The value node to limit its range"))