1 /* === S Y N F I G ========================================================= */
2 /*! \file curvegradient.cpp
3 ** \brief Template Header
8 ** Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
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.
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.
21 ** === N O T E S ===========================================================
23 ** ========================================================================= */
25 /* === H E A D E R S ======================================================= */
34 #include "curvegradient.h"
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>
45 #include <ETL/hermite>
46 #include <ETL/calculus>
50 /* === M A C R O S ========================================================= */
52 /* === G L O B A L S ======================================================= */
54 SYNFIG_LAYER_INIT(CurveGradient);
55 SYNFIG_LAYER_SET_NAME(CurveGradient,"curve_gradient");
56 SYNFIG_LAYER_SET_LOCAL_NAME(CurveGradient,_("Curve Gradient"));
57 SYNFIG_LAYER_SET_CATEGORY(CurveGradient,_("Gradients"));
58 SYNFIG_LAYER_SET_VERSION(CurveGradient,"0.0");
59 SYNFIG_LAYER_SET_CVS_ID(CurveGradient,"$Id$");
61 /* === P R O C E D U R E S ================================================= */
63 inline float calculate_distance(const synfig::BLinePoint& a,const synfig::BLinePoint& b)
66 const Point& c1(a.get_vertex());
67 const Point c2(a.get_vertex()+a.get_tangent2()/3);
68 const Point c3(b.get_vertex()-b.get_tangent1()/3);
69 const Point& c4(b.get_vertex());
70 return (c1-c2).mag()+(c2-c3).mag()+(c3-c4).mag();
75 inline float calculate_distance(const std::vector<synfig::BLinePoint>& bline, bool bline_loop)
77 std::vector<synfig::BLinePoint>::const_iterator iter,next,ret;
78 std::vector<synfig::BLinePoint>::const_iterator end(bline.end());
82 if (bline.empty()) return dist;
91 for(;next!=end;iter=next++)
94 etl::hermite<Vector> curve(
98 next->get_tangent1());
100 // dist+=calculate_distance(*iter,*next);
101 dist+=curve.length();
107 std::vector<synfig::BLinePoint>::const_iterator
108 find_closest(bool fast, const std::vector<synfig::BLinePoint>& bline,const Point& p,float& t,bool loop=false,float *bline_dist_ret=0)
110 std::vector<synfig::BLinePoint>::const_iterator iter,next,ret;
111 std::vector<synfig::BLinePoint>::const_iterator end(bline.end());
114 float dist(100000000000.0);
118 float best_bline_dist(0);
119 float best_bline_len(0);
120 float total_bline_dist(0);
122 etl::hermite<Vector> best_curve;
131 for(;next!=end;iter=next++)
134 etl::hermite<Vector> curve(
137 iter->get_tangent2(),
138 next->get_tangent1());
141 const float t(curve.find_closest(p,6,0.01,0.99));
142 bp=curve(t);if((bp-p).mag_squared()<dist) { ret=iter; dist=(bp-p).mag_squared(); ret_t=t; }
149 //len=calculate_distance(*iter,*next);
155 #define POINT_CHECK(x) bp=curve(x); thisdist=(bp-p).mag_squared(); if(thisdist<dist) { ret=iter; dist=thisdist; best_bline_dist=total_bline_dist; best_bline_len=len; best_curve=curve; }
157 POINT_CHECK((1.0/6.0));
158 POINT_CHECK((2.0/6.0));
159 POINT_CHECK((3.0/6.0));
160 POINT_CHECK((4.0/6.0));
161 POINT_CHECK((5.0/6.0));
166 float pos = curve.find_closest(fast, p);
167 thisdist=(curve(pos)-p).mag_squared();
172 best_bline_dist=total_bline_dist;
179 total_bline_dist+=len;
186 //! \todo is this a redundant call to find_closest()?
187 // note bline_dist_ret is null except when 'perpendicular' is true
188 *bline_dist_ret=best_bline_dist+best_curve.find_distance(0,best_curve.find_closest(fast, p));
189 // *bline_dist_ret=best_bline_dist+best_curve.find_closest(fast, p)*best_bline_len;
195 /* === M E T H O D S ======================================================= */
198 CurveGradient::sync()
200 curve_length_=calculate_distance(bline, bline_loop);
204 CurveGradient::CurveGradient():
207 gradient(Color::black(), Color::white()),
210 perpendicular(false),
213 bline.push_back(BLinePoint());
214 bline.push_back(BLinePoint());
215 bline.push_back(BLinePoint());
216 bline[0].set_vertex(Point(0,1));
217 bline[1].set_vertex(Point(0,-1));
218 bline[2].set_vertex(Point(1,0));
219 bline[0].set_tangent(bline[1].get_vertex()-bline[2].get_vertex()*0.5f);
220 bline[1].set_tangent(bline[2].get_vertex()-bline[0].get_vertex()*0.5f);
221 bline[2].set_tangent(bline[0].get_vertex()-bline[1].get_vertex()*0.5f);
222 bline[0].set_width(1.0f);
223 bline[1].set_width(1.0f);
224 bline[2].set_width(1.0f);
231 CurveGradient::color_func(const Point &point_, int quality, float supersample)const
240 bool edge_case = false;
243 return Color::alpha();
244 else if(bline.size()==1)
246 tangent=bline.front().get_tangent1();
247 p1=bline.front().get_vertex();
248 thickness=bline.front().get_width();
253 Point point(point_-offset);
255 std::vector<synfig::BLinePoint>::const_iterator iter,next;
257 // Figure out the BLinePoints we will be using,
258 // Taking into account looping.
261 next=find_closest(fast,bline,point,t,bline_loop,&perp_dist);
262 perp_dist/=curve_length_;
264 else // not perpendicular
266 next=find_closest(fast,bline,point,t,bline_loop);
270 if(next==bline.end()) next=bline.begin();
273 etl::hermite<Vector> curve(
276 iter->get_tangent2(),
280 // Setup the derivative function
281 etl::derivative<etl::hermite<Vector> > deriv(curve);
283 int search_iterations(7);
285 /*if(quality==0)search_iterations=8;
286 else if(quality<=2)search_iterations=10;
287 else if(quality<=4)search_iterations=8;
294 else // not perpendicular
296 if(quality<=6)search_iterations=7;
297 else if(quality<=7)search_iterations=6;
298 else if(quality<=8)search_iterations=5;
299 else search_iterations=4;
302 // Figure out the closest point on the curve
304 t = curve.find_closest(fast, point,search_iterations);
306 // Calculate our values
307 p1=curve(t); // the closest point on the curve
308 tangent=deriv(t).norm(); // the unit tangent at that point
310 // if the point we're nearest to is at either end of the
311 // bline, our distance from the curve is the distance from the
312 // point on the curve. we need to know which side of the
313 // curve we're on, so find the average of the two tangents at
315 if (t<0.00001 || t>0.99999)
319 if (iter->get_split_tangent_flag())
321 tangent=(iter->get_tangent1().norm()+tangent).norm();
327 if (next->get_split_tangent_flag())
329 tangent=(next->get_tangent2().norm()+tangent).norm();
337 tangent*=curve_length_;
338 p1-=tangent*perp_dist;
339 tangent=-tangent.perp();
341 else // not perpendicular
342 // the width of the bline at the closest point on the curve
343 thickness=(next->get_width()-iter->get_width())*t+iter->get_width();
351 /* diff=tangent.perp();
352 const Real mag(diff.inv_mag());
353 supersample=supersample*mag;
361 const Real mag(diff.inv_mag());
362 supersample=supersample*mag;
364 dist=((point_-offset)*diff-p1*diff);
367 else // not perpendicular
371 diff=(p1-(point_-offset));
372 if(diff*tangent.perp()<0) diff=-diff;
373 diff=diff.norm()*thickness*width;
376 diff=tangent.perp()*thickness*width;
379 const Real mag(diff.inv_mag());
380 supersample=supersample*mag;
382 dist=((point_-offset)*diff-p1*diff);
392 if(dist>1)dist=2.0-dist;
397 if(dist+supersample*0.5>1.0)
399 float left(supersample*0.5-(dist-1.0));
400 float right(supersample*0.5+(dist-1.0));
401 Color pool(gradient(1.0-(left*0.5),left).premult_alpha()*left/supersample);
402 if (zigzag) pool+=gradient(1.0-right*0.5,right).premult_alpha()*right/supersample;
403 else pool+=gradient(right*0.5,right).premult_alpha()*right/supersample;
404 return pool.demult_alpha();
406 if(dist-supersample*0.5<0.0)
408 float left(supersample*0.5-dist);
409 float right(supersample*0.5+dist);
410 Color pool(gradient(right*0.5,right).premult_alpha()*right/supersample);
411 if (zigzag) pool+=gradient(left*0.5,left).premult_alpha()*left/supersample;
412 else pool+=gradient(1.0-left*0.5,left).premult_alpha()*left/supersample;
413 return pool.demult_alpha();
416 return gradient(dist,supersample);
420 CurveGradient::calc_supersample(const synfig::Point &/*x*/, float pw,float /*ph*/)const
425 synfig::Layer::Handle
426 CurveGradient::hit_check(synfig::Context context, const synfig::Point &point)const
428 if(get_blend_method()==Color::BLEND_STRAIGHT && get_amount()>=0.5)
429 return const_cast<CurveGradient*>(this);
430 if(get_amount()==0.0)
431 return context.hit_check(point);
432 if((get_blend_method()==Color::BLEND_STRAIGHT || get_blend_method()==Color::BLEND_COMPOSITE|| get_blend_method()==Color::BLEND_ONTO) && color_func(point).get_a()>0.5)
433 return const_cast<CurveGradient*>(this);
434 return context.hit_check(point);
438 CurveGradient::set_param(const String & param, const ValueBase &value)
443 IMPORT(perpendicular);
446 if(param=="bline" && value.get_type()==ValueBase::TYPE_LIST)
449 bline_loop=value.get_loop();
459 return Layer_Composite::set_param(param,value);
463 CurveGradient::get_param(const String & param)const
471 EXPORT(perpendicular);
477 return Layer_Composite::get_param(param);
481 CurveGradient::get_param_vocab()const
483 Layer::Vocab ret(Layer_Composite::get_param_vocab());
485 ret.push_back(ParamDesc("offset")
486 .set_local_name(_("Offset")));
488 ret.push_back(ParamDesc("width")
490 .set_local_name(_("Width")));
492 ret.push_back(ParamDesc("bline")
493 .set_local_name(_("Vertices"))
494 .set_origin("offset")
496 .set_description(_("A list of BLine Points")));
498 ret.push_back(ParamDesc("gradient")
499 .set_local_name(_("Gradient")));
500 ret.push_back(ParamDesc("loop")
501 .set_local_name(_("Loop")));
502 ret.push_back(ParamDesc("zigzag")
503 .set_local_name(_("ZigZag")));
504 ret.push_back(ParamDesc("perpendicular")
505 .set_local_name(_("Perpendicular")));
506 ret.push_back(ParamDesc("fast")
507 .set_local_name(_("Fast")));
513 CurveGradient::get_color(Context context, const Point &point)const
515 const Color color(color_func(point,0));
517 if(get_amount()==1.0 && get_blend_method()==Color::BLEND_STRAIGHT)
520 return Color::blend(color,context.get_color(point),get_amount(),get_blend_method());
524 CurveGradient::accelerated_render(Context context,Surface *surface,int quality, const RendDesc &renddesc, ProgressCallback *cb)const
526 SuperCallback supercb(cb,0,9500,10000);
528 if(get_amount()==1.0 && get_blend_method()==Color::BLEND_STRAIGHT)
530 surface->set_wh(renddesc.get_w(),renddesc.get_h());
534 if(!context.accelerated_render(surface,quality,renddesc,&supercb))
543 Surface::pen pen(surface->begin());
544 const Real pw(renddesc.get_pw()),ph(renddesc.get_ph());
546 Point tl(renddesc.get_tl());
547 const int w(surface->get_w());
548 const int h(surface->get_h());
550 if(get_amount()==1.0 && get_blend_method()==Color::BLEND_STRAIGHT)
552 for(y=0,pos[1]=tl[1];y<h;y++,pen.inc_y(),pen.dec_x(x),pos[1]+=ph)
553 for(x=0,pos[0]=tl[0];x<w;x++,pen.inc_x(),pos[0]+=pw)
554 pen.put_value(color_func(pos,quality,calc_supersample(pos,pw,ph)));
558 for(y=0,pos[1]=tl[1];y<h;y++,pen.inc_y(),pen.dec_x(x),pos[1]+=ph)
559 for(x=0,pos[0]=tl[0];x<w;x++,pen.inc_x(),pos[0]+=pw)
560 pen.put_value(Color::blend(color_func(pos,quality,calc_supersample(pos,pw,ph)),pen.get_value(),get_amount(),get_blend_method()));
563 // Mark our progress as finished
564 if(cb && !cb->amount_complete(10000,10000))