Rename get_param_vocab to get_children_vocab and use a wrapper for the pure virtual...
[synfig.git] / synfig-core / src / synfig / valuenode_reciprocal.cpp
1 /* === S Y N F I G ========================================================= */
2 /*!     \file valuenode_reciprocal.cpp
3 **      \brief Implementation of the "Reciprocal" 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_reciprocal.h"
34 #include "valuenode_const.h"
35 #include "general.h"
36
37 #endif
38
39 /* === U S I N G =========================================================== */
40
41 using namespace std;
42 using namespace etl;
43 using namespace synfig;
44
45 /* === M A C R O S ========================================================= */
46
47 /* === G L O B A L S ======================================================= */
48
49 /* === P R O C E D U R E S ================================================= */
50
51 /* === M E T H O D S ======================================================= */
52
53 ValueNode_Reciprocal::ValueNode_Reciprocal(const ValueBase &x):
54         LinkableValueNode(x.get_type())
55 {
56         Real value(x.get(Real()));
57         Real infinity(999999.0);
58         Real epsilon(0.000001);
59
60         if (value == 0)
61                 value = infinity;
62         else
63                 value = 1.0/value;
64
65         set_link("link",     ValueNode_Const::create(Real(value)));
66         set_link("epsilon",  ValueNode_Const::create(Real(epsilon)));
67         set_link("infinite", ValueNode_Const::create(Real(infinity)));
68 }
69
70 ValueNode_Reciprocal*
71 ValueNode_Reciprocal::create(const ValueBase &x)
72 {
73         return new ValueNode_Reciprocal(x);
74 }
75
76 LinkableValueNode*
77 ValueNode_Reciprocal::create_new()const
78 {
79         return new ValueNode_Reciprocal(get_type());
80 }
81
82 ValueNode_Reciprocal::~ValueNode_Reciprocal()
83 {
84         unlink_all();
85 }
86
87 bool
88 ValueNode_Reciprocal::set_link_vfunc(int i,ValueNode::Handle value)
89 {
90         assert(i>=0 && i<link_count());
91
92         switch(i)
93         {
94         case 0: CHECK_TYPE_AND_SET_VALUE(link_,     ValueBase::TYPE_REAL);
95         case 1: CHECK_TYPE_AND_SET_VALUE(epsilon_,  ValueBase::TYPE_REAL);
96         case 2: CHECK_TYPE_AND_SET_VALUE(infinite_, ValueBase::TYPE_REAL);
97         }
98         return false;
99 }
100
101 ValueNode::LooseHandle
102 ValueNode_Reciprocal::get_link_vfunc(int i)const
103 {
104         assert(i>=0 && i<link_count());
105
106         if(i==0) return link_;
107         if(i==1) return epsilon_;
108         if(i==2) return infinite_;
109
110         return 0;
111 }
112
113 int
114 ValueNode_Reciprocal::link_count()const
115 {
116         return 3;
117 }
118
119 String
120 ValueNode_Reciprocal::link_local_name(int i)const
121 {
122         assert(i>=0 && i<link_count());
123
124         if(i==0) return _("Link");
125         if(i==1) return _("Epsilon");
126         if(i==2) return _("Infinite");
127         return String();
128 }
129
130 String
131 ValueNode_Reciprocal::link_name(int i)const
132 {
133         assert(i>=0 && i<link_count());
134
135         if(i==0) return "link";
136         if(i==1) return "epsilon";
137         if(i==2) return "infinite";
138         return String();
139 }
140
141 int
142 ValueNode_Reciprocal::get_link_index_from_name(const String &name)const
143 {
144         if(name=="link")     return 0;
145         if(name=="epsilon")  return 1;
146         if(name=="infinite") return 2;
147
148         throw Exception::BadLinkName(name);
149 }
150
151 ValueBase
152 ValueNode_Reciprocal::operator()(Time t)const
153 {
154         if (getenv("SYNFIG_DEBUG_VALUENODE_OPERATORS"))
155                 printf("%s:%d operator()\n", __FILE__, __LINE__);
156
157         Real link     = (*link_)    (t).get(Real());
158         Real epsilon  = (*epsilon_) (t).get(Real());
159         Real infinite = (*infinite_)(t).get(Real());
160
161         if (epsilon < 0.00000001)
162                 epsilon = 0.00000001;
163
164         if (abs(link) < epsilon)
165                 if (link < 0)
166                         return -infinite;
167                 else
168                         return infinite;
169         else
170                 return 1.0f / link;
171 }
172
173 String
174 ValueNode_Reciprocal::get_name()const
175 {
176         return "reciprocal";
177 }
178
179 String
180 ValueNode_Reciprocal::get_local_name()const
181 {
182         return _("Reciprocal");
183 }
184
185 bool
186 ValueNode_Reciprocal::check_type(ValueBase::Type type)
187 {
188         return type==ValueBase::TYPE_REAL;
189 }
190
191 LinkableValueNode::Vocab
192 ValueNode_Reciprocal::get_children_vocab_vfunc()const
193 {
194         LinkableValueNode::Vocab ret;
195
196         ret.push_back(ParamDesc(ValueBase(),"link")
197                 .set_local_name(_("Link"))
198                 .set_description(_("The value node used to calculate its reciprocal"))
199         );
200
201         ret.push_back(ParamDesc(ValueBase(),"epsilon")
202                 .set_local_name(_("Epsilon"))
203                 .set_description(_("The value used to decide whether 'Link' is too small to obtain its reciprocal"))
204         );
205
206                 ret.push_back(ParamDesc(ValueBase(),"infinite")
207                 .set_local_name(_("Infinite"))
208                 .set_description(_("The resulting value when 'Link' < 'Epsilon'"))
209         );
210
211         return ret;
212 }