Update Mirror Tool
[synfig.git] / synfig-core / src / modules / example / metaballs.cpp
1 /* === S Y N F I G ========================================================= */
2 /*!     \file metaballs.cpp
3 **      \brief Implementation of the "Metaballs" layer
4 **
5 **      $Id$
6 **
7 **      \legal
8 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
9 **
10 **      This package is free software; you can redistribute it and/or
11 **      modify it under the terms of the GNU General Public License as
12 **      published by the Free Software Foundation; either version 2 of
13 **      the License, or (at your option) any later version.
14 **
15 **      This package is distributed in the hope that it will be useful,
16 **      but WITHOUT ANY WARRANTY; without even the implied warranty of
17 **      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 **      General Public License for more details.
19 **      \endlegal
20 */
21 /* ========================================================================= */
22
23 /* === H E A D E R S ======================================================= */
24
25 #ifdef USING_PCH
26 #       include "pch.h"
27 #else
28 #ifdef HAVE_CONFIG_H
29 #       include <config.h>
30 #endif
31
32 #include <synfig/string.h>
33 #include <synfig/time.h>
34 #include <synfig/context.h>
35 #include <synfig/paramdesc.h>
36 #include <synfig/renddesc.h>
37 #include <synfig/surface.h>
38 #include <synfig/value.h>
39 #include <synfig/valuenode.h>
40 #include <ETL/pen>
41
42 #include "metaballs.h"
43
44 #endif
45
46 /* === U S I N G =========================================================== */
47
48 using namespace etl;
49 using namespace std;
50 using namespace synfig;
51
52 /* === G L O B A L S ======================================================= */
53
54 SYNFIG_LAYER_INIT(Metaballs);
55 SYNFIG_LAYER_SET_NAME(Metaballs,"metaballs");
56 SYNFIG_LAYER_SET_LOCAL_NAME(Metaballs,N_("Metaballs"));
57 SYNFIG_LAYER_SET_CATEGORY(Metaballs,N_("Example"));
58 SYNFIG_LAYER_SET_VERSION(Metaballs,"0.1");
59 SYNFIG_LAYER_SET_CVS_ID(Metaballs,"$Id$");
60
61 /* === P R O C E D U R E S ================================================= */
62
63 /* === M E T H O D S ======================================================= */
64
65 /* === E N T R Y P O I N T ================================================= */
66
67 Metaballs::Metaballs():
68         Layer_Composite(1.0,Color::BLEND_STRAIGHT),
69         gradient(Color::black(), Color::white()),
70         threshold(0),
71         threshold2(1),
72         positive(false)
73 {
74         centers.push_back(Point( 0, -1.5));     radii.push_back(2.5);   weights.push_back(1);
75         centers.push_back(Point(-2,  1));       radii.push_back(2.5);   weights.push_back(1);
76         centers.push_back(Point( 2,  1));       radii.push_back(2.5);   weights.push_back(1);
77 }
78
79 bool
80 Metaballs::set_param(const String & param, const ValueBase &value)
81 {
82         if(     param=="centers" && value.same_type_as(centers))
83         {
84                 centers = value;
85                 return true;
86         }
87
88         if(     param=="weights" && value.same_type_as(weights))
89         {
90                 weights = value;
91                 return true;
92         }
93
94         if(     param=="radii" && value.same_type_as(radii))
95         {
96                 radii = value;
97                 return true;
98         }
99
100         IMPORT(gradient);
101         IMPORT(threshold);
102         IMPORT(threshold2);
103         IMPORT(positive);
104
105         return Layer_Composite::set_param(param,value);
106 }
107
108 ValueBase
109 Metaballs::get_param(const String &param)const
110 {
111         EXPORT(gradient);
112
113         EXPORT(radii);
114         EXPORT(weights);
115         EXPORT(centers);
116         EXPORT(threshold);
117         EXPORT(threshold2);
118         EXPORT(positive);
119
120         EXPORT_NAME();
121         EXPORT_VERSION();
122
123         return Layer_Composite::get_param(param);
124 }
125
126 Layer::Vocab
127 Metaballs::get_param_vocab()const
128 {
129         Layer::Vocab ret(Layer_Composite::get_param_vocab());
130
131         ret.push_back(ParamDesc("gradient")
132                 .set_local_name(_("Gradient"))
133         );
134
135         ret.push_back(ParamDesc("centers")
136                 .set_local_name(_("Points"))
137         );
138
139         ret.push_back(ParamDesc("radii")
140                 .set_local_name(_("Radii"))
141         );
142
143         ret.push_back(ParamDesc("weights")
144                 .set_local_name(_("Weights"))
145         );
146
147         ret.push_back(ParamDesc("threshold")
148                 .set_local_name(_("Gradient Left"))
149         );
150
151         ret.push_back(ParamDesc("threshold2")
152                 .set_local_name(_("Gradient Right"))
153         );
154
155         ret.push_back(ParamDesc("positive")
156                 .set_local_name(_("Positive Only"))
157         );
158
159         return ret;
160 }
161
162 synfig::Layer::Handle
163 Metaballs::hit_check(synfig::Context context, const synfig::Point &point)const
164 {
165         Real density(totaldensity(point));
166
167         if (density <= 0 || density > 1 || get_amount() == 0)
168                 return context.hit_check(point);
169
170         synfig::Layer::Handle tmp;
171
172         if (get_blend_method()==Color::BLEND_BEHIND && (tmp=context.hit_check(point)))
173                 return tmp;
174
175         if (Color::is_onto(get_blend_method()) && !(context.hit_check(point)))
176                 return 0;
177
178         return const_cast<Metaballs*>(this);
179 }
180
181 Real
182 Metaballs::densityfunc(const synfig::Point &p, const synfig::Point &c, Real R)const
183 {
184         const Real dx = p[0] - c[0];
185         const Real dy = p[1] - c[1];
186
187         const Real n = (1 - (dx*dx + dy*dy)/(R*R));
188         if (positive && n < 0) return 0;
189         return (n*n*n);
190
191         /*
192         f(d) = (1 - d^2)^3
193         f'(d) = -6d * (1 - d^2)^2
194
195         could use this too...
196         f(d) = (1 - d^2)^2
197         f'(d) = -6d * (1 - d^2)
198         */
199 }
200
201 Real
202 Metaballs::totaldensity(const Point &pos)const
203 {
204         Real density = 0;
205
206         //sum up weighted functions
207         for(unsigned int i=0;i<centers.size();i++)
208                 density += weights[i] * densityfunc(pos,centers[i], radii[i]);
209
210         return (density - threshold) / (threshold2 - threshold);
211 }
212
213 Color
214 Metaballs::get_color(Context context, const Point &pos)const
215 {
216         if(get_amount()==1.0 && get_blend_method()==Color::BLEND_STRAIGHT)
217                 return gradient(totaldensity(pos));
218         else
219                 return Color::blend(gradient(totaldensity(pos)),context.get_color(pos),get_amount(),get_blend_method());
220 }
221
222 bool
223 Metaballs::accelerated_render(Context context,Surface *surface,int quality, const RendDesc &renddesc, ProgressCallback *cb)const
224 {
225         // Width and Height of a pixel
226         const Point br(renddesc.get_br()), tl(renddesc.get_tl());
227         const int        w(renddesc.get_w()),   h(renddesc.get_h());
228         const Real      pw(renddesc.get_pw()), ph(renddesc.get_ph());
229
230         SuperCallback supercb(cb,0,9000,10000);
231
232         Point pos(tl[0],tl[1]);
233
234         if(!context.accelerated_render(surface,quality,renddesc,&supercb))
235         {
236                 if(cb)cb->error(strprintf(__FILE__"%d: Accelerated Renderer Failure",__LINE__));
237                 return false;
238         }
239
240         for(int y = 0; y < h; y++, pos[1] += ph)
241         {
242                 pos[0] = tl[0];
243                 for(int x = 0; x < w; x++, pos[0] += pw)
244                         (*surface)[y][x] = Color::blend(gradient(totaldensity(pos)),(*surface)[y][x],get_amount(),get_blend_method());
245         }
246
247         // Mark our progress as finished
248         if(cb && !cb->amount_complete(10000,10000))
249                 return false;
250
251         return true;
252 }