be7155a06d2d761dbb785985e37ac5b673d8c52f
[synfig.git] /
1 /* === S Y N F I G ========================================================= */
2 /*!     \file lineargradient.cpp
3 **      \brief Implementation of the "Linear Gradient" 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 ** === N O T E S ===========================================================
22 **
23 ** ========================================================================= */
24
25 /* === H E A D E R S ======================================================= */
26
27 #ifdef USING_PCH
28 #       include "pch.h"
29 #else
30 #ifdef HAVE_CONFIG_H
31 #       include <config.h>
32 #endif
33
34 #include "lineargradient.h"
35
36 #include <synfig/string.h>
37 #include <synfig/time.h>
38 #include <synfig/context.h>
39 #include <synfig/paramdesc.h>
40 #include <synfig/renddesc.h>
41 #include <synfig/surface.h>
42 #include <synfig/value.h>
43 #include <synfig/valuenode.h>
44
45 #endif
46
47 /* === M A C R O S ========================================================= */
48
49 /* === G L O B A L S ======================================================= */
50
51 SYNFIG_LAYER_INIT(LinearGradient);
52 SYNFIG_LAYER_SET_NAME(LinearGradient,"linear_gradient");
53 SYNFIG_LAYER_SET_LOCAL_NAME(LinearGradient,N_("Linear Gradient"));
54 SYNFIG_LAYER_SET_CATEGORY(LinearGradient,N_("Gradients"));
55 SYNFIG_LAYER_SET_VERSION(LinearGradient,"0.0");
56 SYNFIG_LAYER_SET_CVS_ID(LinearGradient,"$Id$");
57
58 /* === P R O C E D U R E S ================================================= */
59
60 /* === M E T H O D S ======================================================= */
61
62 inline void
63 LinearGradient::sync()
64 {
65         diff=(p2-p1);
66         const Real mag(diff.inv_mag());
67         diff*=mag*mag;
68 }
69
70
71 LinearGradient::LinearGradient():
72         p1(1,1),
73         p2(-1,-1),
74         gradient(Color::black(), Color::white()),
75         loop(false),
76         zigzag(false)
77 {
78         sync();
79 }
80
81 inline Color
82 LinearGradient::color_func(const Point &point, float supersample)const
83 {
84         Real dist(point*diff-p1*diff);
85
86         if(loop)
87                 dist-=floor(dist);
88
89         if(zigzag)
90         {
91                 dist*=2.0;
92                 supersample*=2.0;
93                 if(dist>1)dist=2.0-dist;
94         }
95
96         if(loop)
97         {
98                 if(dist+supersample*0.5>1.0)
99                 {
100                         float  left(supersample*0.5-(dist-1.0));
101                         float right(supersample*0.5+(dist-1.0));
102                         Color pool(gradient(1.0-(left*0.5),left).premult_alpha()*left/supersample);
103                         if (zigzag) pool+=gradient(1.0-right*0.5,right).premult_alpha()*right/supersample;
104                         else            pool+=gradient(right*0.5,right).premult_alpha()*right/supersample;
105                         return pool.demult_alpha();
106                 }
107                 if(dist-supersample*0.5<0.0)
108                 {
109                         float  left(supersample*0.5-dist);
110                         float right(supersample*0.5+dist);
111                         Color pool(gradient(right*0.5,right).premult_alpha()*right/supersample);
112                         if (zigzag) pool+=gradient(left*0.5,left).premult_alpha()*left/supersample;
113                         else            pool+=gradient(1.0-left*0.5,left).premult_alpha()*left/supersample;
114                         return pool.demult_alpha();
115                 }
116         }
117         return gradient(dist,supersample);
118 }
119
120 float
121 LinearGradient::calc_supersample(const synfig::Point &/*x*/, float pw,float /*ph*/)const
122 {
123         return pw/(p2-p1).mag();
124 }
125
126 synfig::Layer::Handle
127 LinearGradient::hit_check(synfig::Context context, const synfig::Point &point)const
128 {
129         if(get_blend_method()==Color::BLEND_STRAIGHT && get_amount()>=0.5)
130                 return const_cast<LinearGradient*>(this);
131         if(get_amount()==0.0)
132                 return context.hit_check(point);
133         if((get_blend_method()==Color::BLEND_STRAIGHT || get_blend_method()==Color::BLEND_COMPOSITE) && color_func(point).get_a()>0.5)
134                 return const_cast<LinearGradient*>(this);
135         return context.hit_check(point);
136 }
137
138 bool
139 LinearGradient::set_param(const String & param, const ValueBase &value)
140 {
141         if(param=="p1" && value.same_type_as(p1))
142         {
143                 p1=value.get(p1);
144                 sync();
145                 return true;
146         }
147         if(param=="p2" && value.same_type_as(p2))
148         {
149                 p2=value.get(p2);
150                 sync();
151                 return true;
152         }
153         //IMPORT(p1);
154         //IMPORT(p2);
155
156
157         IMPORT(gradient);
158         IMPORT(loop);
159         IMPORT(zigzag);
160         return Layer_Composite::set_param(param,value);
161 }
162
163 ValueBase
164 LinearGradient::get_param(const String & param)const
165 {
166         EXPORT(p1);
167         EXPORT(p2);
168         EXPORT(gradient);
169         EXPORT(loop);
170         EXPORT(zigzag);
171
172         EXPORT_NAME();
173         EXPORT_VERSION();
174
175         return Layer_Composite::get_param(param);
176 }
177
178 Layer::Vocab
179 LinearGradient::get_param_vocab()const
180 {
181         Layer::Vocab ret(Layer_Composite::get_param_vocab());
182
183         ret.push_back(ParamDesc("p1")
184                 .set_local_name(_("Point 1"))
185                 .set_connect("p2")
186         );
187         ret.push_back(ParamDesc("p2")
188                 .set_local_name(_("Point 2"))
189         );
190         ret.push_back(ParamDesc("gradient")
191                 .set_local_name(_("Gradient"))
192         );
193         ret.push_back(ParamDesc("loop")
194                 .set_local_name(_("Loop"))
195         );
196         ret.push_back(ParamDesc("zigzag")
197                 .set_local_name(_("ZigZag"))
198         );
199
200         return ret;
201 }
202
203 Color
204 LinearGradient::get_color(Context context, const Point &point)const
205 {
206         const Color color(color_func(point));
207
208         if(get_amount()==1.0 && get_blend_method()==Color::BLEND_STRAIGHT)
209                 return color;
210         else
211                 return Color::blend(color,context.get_color(point),get_amount(),get_blend_method());
212 }
213
214 bool
215 LinearGradient::accelerated_render(Context context,Surface *surface,int quality, const RendDesc &renddesc, ProgressCallback *cb)const
216 {
217         SuperCallback supercb(cb,0,9500,10000);
218
219         if(get_amount()==1.0 && get_blend_method()==Color::BLEND_STRAIGHT)
220         {
221                 surface->set_wh(renddesc.get_w(),renddesc.get_h());
222         }
223         else
224         {
225                 if(!context.accelerated_render(surface,quality,renddesc,&supercb))
226                         return false;
227                 if(get_amount()==0)
228                         return true;
229         }
230
231
232         int x,y;
233
234         Surface::pen pen(surface->begin());
235         const Real pw(renddesc.get_pw()),ph(renddesc.get_ph());
236         Point pos;
237         Point tl(renddesc.get_tl());
238         const int w(surface->get_w());
239         const int h(surface->get_h());
240
241         if(get_amount()==1.0 && get_blend_method()==Color::BLEND_STRAIGHT)
242         {
243                 for(y=0,pos[1]=tl[1];y<h;y++,pen.inc_y(),pen.dec_x(x),pos[1]+=ph)
244                         for(x=0,pos[0]=tl[0];x<w;x++,pen.inc_x(),pos[0]+=pw)
245                                 pen.put_value(color_func(pos,calc_supersample(pos,pw,ph)));
246         }
247         else
248         {
249                 for(y=0,pos[1]=tl[1];y<h;y++,pen.inc_y(),pen.dec_x(x),pos[1]+=ph)
250                         for(x=0,pos[0]=tl[0];x<w;x++,pen.inc_x(),pos[0]+=pw)
251                                 pen.put_value(Color::blend(color_func(pos,calc_supersample(pos,pw,ph)),pen.get_value(),get_amount(),get_blend_method()));
252         }
253
254         // Mark our progress as finished
255         if(cb && !cb->amount_complete(10000,10000))
256                 return false;
257
258         return true;
259 }