Allow Real values to be converted to "BLine Tangent". The ValueNode returns the...
[synfig.git] / synfig-core / trunk / src / synfig / valuenode_blinecalctangent.cpp
1 /* === S Y N F I G ========================================================= */
2 /*!     \file valuenode_blinecalctangent.cpp
3 **      \brief Implementation of the "BLine Tangent" 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 #ifdef USING_PCH
27 #       include "pch.h"
28 #else
29 #ifdef HAVE_CONFIG_H
30 #       include <config.h>
31 #endif
32
33 #include "valuenode_blinecalctangent.h"
34 #include "valuenode_bline.h"
35 #include "valuenode_const.h"
36 #include "valuenode_composite.h"
37 #include "general.h"
38 #include "exception.h"
39 #include <ETL/hermite>
40 #include <ETL/calculus>
41
42 #endif
43
44 /* === U S I N G =========================================================== */
45
46 using namespace std;
47 using namespace etl;
48 using namespace synfig;
49
50 /* === M A C R O S ========================================================= */
51
52 /* === G L O B A L S ======================================================= */
53
54 /* === P R O C E D U R E S ================================================= */
55
56 /* === M E T H O D S ======================================================= */
57
58 ValueNode_BLineCalcTangent::ValueNode_BLineCalcTangent(const ValueBase::Type &x):
59         LinkableValueNode(x)
60 {
61         if(x!=ValueBase::TYPE_ANGLE && x!=ValueBase::TYPE_REAL && x!=ValueBase::TYPE_VECTOR)
62                 throw Exception::BadType(ValueBase::type_local_name(x));
63
64         ValueNode_BLine* value_node(new ValueNode_BLine());
65         set_link("bline",value_node);
66         set_link("loop",ValueNode_Const::create(bool(false)));
67         set_link("amount",ValueNode_Const::create(Real(0.5)));
68 }
69
70 LinkableValueNode*
71 ValueNode_BLineCalcTangent::create_new()const
72 {
73         return new ValueNode_BLineCalcTangent(get_type());
74 }
75
76 ValueNode_BLineCalcTangent*
77 ValueNode_BLineCalcTangent::create(const ValueBase &x)
78 {
79         return new ValueNode_BLineCalcTangent(x.get_type());
80 }
81
82 ValueNode_BLineCalcTangent::~ValueNode_BLineCalcTangent()
83 {
84         unlink_all();
85 }
86
87 ValueBase
88 ValueNode_BLineCalcTangent::operator()(Time t)const
89 {
90         const std::vector<ValueBase> bline((*bline_)(t));
91         handle<ValueNode_BLine> bline_value_node(bline_);
92         const bool looped(bline_value_node->get_loop());
93         int size = bline.size(), from_vertex;
94         bool loop((*loop_)(t).get(bool()));
95         Real amount((*amount_)(t).get(Real()));
96         BLinePoint blinepoint0, blinepoint1;
97
98         if (!looped) size--;
99         if (size < 1)
100                 switch (get_type())
101                 {
102                         case ValueBase::TYPE_ANGLE:  return Angle();
103                         case ValueBase::TYPE_REAL:   return Real();
104                         case ValueBase::TYPE_VECTOR: return Vector();
105                         default: assert(0); return ValueBase();
106                 }
107         if (loop)
108         {
109                 amount = amount - int(amount);
110                 if (amount < 0) amount++;
111         }
112         else
113         {
114                 if (amount < 0) amount = 0;
115                 if (amount > 1) amount = 1;
116         }
117
118         vector<ValueBase>::const_iterator iter, next(bline.begin());
119
120         iter = looped ? --bline.end() : next++;
121         amount = amount * size;
122         from_vertex = int(amount);
123         if (from_vertex > size-1) from_vertex = size-1;
124         blinepoint0 = from_vertex ? *(next+from_vertex-1) : *iter;
125         blinepoint1 = *(next+from_vertex);
126
127         etl::hermite<Vector> curve(blinepoint0.get_vertex(),   blinepoint1.get_vertex(),
128                                                            blinepoint0.get_tangent2(), blinepoint1.get_tangent1());
129         etl::derivative< etl::hermite<Vector> > deriv(curve);
130
131         switch (get_type())
132         {
133                 case ValueBase::TYPE_ANGLE:  return deriv(amount-from_vertex).angle();
134                 case ValueBase::TYPE_REAL:   return deriv(amount-from_vertex).mag();
135                 case ValueBase::TYPE_VECTOR: return deriv(amount-from_vertex);
136                 default: assert(0); return ValueBase();
137         }
138 }
139
140 String
141 ValueNode_BLineCalcTangent::get_name()const
142 {
143         return "blinecalctangent";
144 }
145
146 String
147 ValueNode_BLineCalcTangent::get_local_name()const
148 {
149         return _("BLine Tangent");
150 }
151
152 bool
153 ValueNode_BLineCalcTangent::set_link_vfunc(int i,ValueNode::Handle value)
154 {
155         assert(i>=0 && i<link_count());
156
157         switch(i)
158         {
159         case 0: CHECK_TYPE_AND_SET_VALUE(bline_,  ValueBase::TYPE_LIST);
160         case 1: CHECK_TYPE_AND_SET_VALUE(loop_,   ValueBase::TYPE_BOOL);
161         case 2: CHECK_TYPE_AND_SET_VALUE(amount_, ValueBase::TYPE_REAL);
162         }
163         return false;
164 }
165
166 ValueNode::LooseHandle
167 ValueNode_BLineCalcTangent::get_link_vfunc(int i)const
168 {
169         assert(i>=0 && i<link_count());
170
171         switch(i)
172         {
173                 case 0: return bline_;
174                 case 1: return loop_;
175                 case 2: return amount_;
176         }
177
178         return 0;
179 }
180
181 int
182 ValueNode_BLineCalcTangent::link_count()const
183 {
184         return 3;
185 }
186
187 String
188 ValueNode_BLineCalcTangent::link_name(int i)const
189 {
190         assert(i>=0 && i<link_count());
191
192         switch(i)
193         {
194                 case 0: return "bline";
195                 case 1: return "loop";
196                 case 2: return "amount";
197         }
198         return String();
199 }
200
201 String
202 ValueNode_BLineCalcTangent::link_local_name(int i)const
203 {
204         assert(i>=0 && i<link_count());
205
206         switch(i)
207         {
208                 case 0: return _("BLine");
209                 case 1: return _("Loop");
210                 case 2: return _("Amount");
211         }
212         return String();
213 }
214
215 int
216 ValueNode_BLineCalcTangent::get_link_index_from_name(const String &name)const
217 {
218         if(name=="bline")  return 0;
219         if(name=="loop")   return 1;
220         if(name=="amount") return 2;
221         throw Exception::BadLinkName(name);
222 }
223
224 bool
225 ValueNode_BLineCalcTangent::check_type(ValueBase::Type type)
226 {
227         return (type==ValueBase::TYPE_ANGLE ||
228                         type==ValueBase::TYPE_REAL  ||
229                         type==ValueBase::TYPE_VECTOR);
230 }