1 /* === S Y N F I G ========================================================= */
3 ** \brief Implementation of the "Circle" layer
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 /* ========================================================================= */
23 /* === H E A D E R S ======================================================= */
33 #include <synfig/string.h>
34 #include <synfig/time.h>
35 #include <synfig/context.h>
36 #include <synfig/paramdesc.h>
37 #include <synfig/renddesc.h>
38 #include <synfig/surface.h>
39 #include <synfig/value.h>
40 #include <synfig/valuenode.h>
46 using namespace synfig;
50 /* -- G L O B A L S --------------------------------------------------------- */
52 SYNFIG_LAYER_INIT(Circle);
53 SYNFIG_LAYER_SET_NAME(Circle,"circle");
54 SYNFIG_LAYER_SET_LOCAL_NAME(Circle,N_("Circle"));
55 SYNFIG_LAYER_SET_CATEGORY(Circle,N_("Geometry"));
56 SYNFIG_LAYER_SET_VERSION(Circle,"0.1");
57 SYNFIG_LAYER_SET_CVS_ID(Circle,"$Id$");
59 /* -- F U N C T I O N S ----------------------------------------------------- */
62 Layer_Composite (1.0,Color::BLEND_STRAIGHT),
63 color (Color::black()),
68 falloff (FALLOFF_INTERPOLATION_LINEAR)
74 Circle::ImportParameters(const String ¶m, const ValueBase &value)
76 IMPORT_PLUS(color, { if (color.get_a() == 0) { if (converted_blend_) {
77 set_blend_method(Color::BLEND_ALPHA_OVER);
78 color.set_a(1); } else transparent_color_ = true; } });
85 return Layer_Composite::set_param(param,value);
89 Circle::set_param(const String ¶m, const ValueBase &value)
91 if(ImportParameters(param,value))
101 Circle::get_param(const String ¶m)const
113 return Layer_Composite::get_param(param);
117 Circle::get_param_vocab()const
119 Layer::Vocab ret(Layer_Composite::get_param_vocab());
121 ret.push_back(ParamDesc("color")
122 .set_local_name(_("Color"))
124 ret.push_back(ParamDesc("radius")
125 .set_local_name(_("Radius"))
129 ret.push_back(ParamDesc("feather")
130 .set_local_name(_("Feather"))
133 ret.push_back(ParamDesc("pos")
134 .set_local_name(_("Center"))
136 ret.push_back(ParamDesc("invert")
137 .set_local_name(_("Invert"))
138 .set_description(_("Invert the circle"))
141 ret.push_back(ParamDesc("falloff")
142 .set_local_name(_("Falloff"))
143 .set_description(_("Determines the falloff function for the feather"))
145 .add_enum_value(FALLOFF_INTERPOLATION_LINEAR,"linear",_("Linear"))
146 .add_enum_value(FALLOFF_SQUARED,"squared",_("Squared"))
147 .add_enum_value(FALLOFF_SQRT,"sqrt",_("Square Root"))
148 .add_enum_value(FALLOFF_SIGMOND,"sigmond",_("Sigmond"))
149 .add_enum_value(FALLOFF_COSINE,"cosine",_("Cosine"))
155 synfig::Layer::Handle
156 Circle::hit_check(synfig::Context context, const synfig::Point &point)const
158 Point temp=pos-point;
161 return context.hit_check(point);
163 bool in_circle(temp.mag_squared() <= radius*radius);
167 in_circle=!in_circle;
168 if(in_circle && get_amount()-(feather/radius)<=0.1 && get_blend_method()!=Color::BLEND_STRAIGHT)
173 if(get_amount()-(feather/radius)<=0.0)
179 synfig::Layer::Handle tmp;
180 if(get_blend_method()==Color::BLEND_BEHIND && (tmp=context.hit_check(point)))
182 if(Color::is_onto(get_blend_method()) && !(tmp=context.hit_check(point)))
184 return const_cast<Circle*>(this);
187 return context.hit_check(point);
191 Real Circle::SqdFalloff(const Circle::CircleDataCache &c, const Real &mag_sqd)
193 //squared proportional falloff
194 return (c.outer_radius_sqd - mag_sqd) / c.diff_sqd;
197 Real Circle::InvSqdFalloff(const Circle::CircleDataCache &c, const Real &mag_sqd)
199 //squared proportional falloff
200 return 1.0 - (c.outer_radius_sqd - mag_sqd) / c.diff_sqd;
204 Real Circle::SqrtFalloff(const Circle::CircleDataCache &c, const Real &mag_sqd)
206 //linear distance falloff
207 Real ret = ( c.outer_radius - sqrt(mag_sqd) ) / c.double_feather;
208 //then take the square root of it
213 Real Circle::InvSqrtFalloff(const Circle::CircleDataCache &c, const Real &mag_sqd)
215 //linear distance falloff
216 Real ret = ( c.outer_radius - sqrt(mag_sqd) ) / c.double_feather;
217 //then take the square root of it
218 ret = 1.0 - sqrt(ret);
222 Real Circle::LinearFalloff(const Circle::CircleDataCache &c, const Real &mag_sqd)
224 //linear distance falloff
225 return ( c.outer_radius - sqrt(mag_sqd) ) / c.double_feather;
228 Real Circle::InvLinearFalloff(const Circle::CircleDataCache &c, const Real &mag_sqd)
230 return 1.0 - ( c.outer_radius - sqrt(mag_sqd) ) / c.double_feather;
231 //linear distance falloff
234 Real Circle::SigmondFalloff(const Circle::CircleDataCache &c, const Real &mag_sqd)
236 //linear distance falloff
237 Real ret = ( c.outer_radius - sqrt(mag_sqd) ) / c.double_feather;
238 // inverse exponential of the linear falloff (asymptotes at 0 and 1)
239 // \frac{1.0}{ 1 + e^{- \( a*10-5 \)}}
240 ret = 1.0 / (1 + exp(-(ret*10-5)) );
244 Real Circle::InvSigmondFalloff(const Circle::CircleDataCache &c, const Real &mag_sqd)
246 //linear distance falloff
247 Real ret = ( c.outer_radius - sqrt(mag_sqd) ) / c.double_feather;
248 // inverse exponential of the linear falloff (asymptotes at 0 and 1)
249 // \frac{1.0}{ 1 + e^{- \( a*10-5 \)}}
250 ret = 1.0 - 1.0 / (1 + exp(-(ret*10-5)) );
256 Circle::CosineFalloff(const Circle::CircleDataCache &c, const Real &mag_sqd)
258 //Cosine distance falloff
259 return (1.0f-cos((( c.outer_radius - sqrt(mag_sqd) ) / c.double_feather)*3.1415927))*0.5f;
263 Circle::InvCosineFalloff(const Circle::CircleDataCache &c, const Real &mag_sqd)
265 return 1.0f-(1.0f-cos((( c.outer_radius - sqrt(mag_sqd) ) / c.double_feather)*3.1415927))*0.5f;
266 //Cosine distance falloff
269 void Circle::constructcache()
271 cache.inner_radius = radius - feather;
272 if(cache.inner_radius < 0)
273 cache.inner_radius = 0;
275 cache.outer_radius = radius + feather;
277 cache.inner_radius_sqd = cache.inner_radius > 0 ? (radius-feather)*(radius-feather) : 0;
278 cache.outer_radius_sqd = (radius+feather)*(radius+feather);
280 cache.diff_sqd = feather*feather*4.0;
281 cache.double_feather = feather*2.0;
283 falloff_func = GetFalloffFunc();
286 Circle::FALLOFF_FUNC *Circle::GetFalloffFunc()const
290 case FALLOFF_SQUARED: return invert?InvSqdFalloff:SqdFalloff;
292 case FALLOFF_SQRT: return invert?InvSqrtFalloff:SqrtFalloff;
294 case FALLOFF_INTERPOLATION_LINEAR: return invert?InvLinearFalloff:LinearFalloff;
296 case FALLOFF_SIGMOND: return invert?InvSigmondFalloff:SigmondFalloff;
299 default: return invert?InvCosineFalloff:CosineFalloff;
304 Circle::get_color(Context context, const Point &point)const
306 if(radius==0 || is_disabled())
307 return context.get_color(point);
310 Point temp=pos-point;
312 /*const Real inner_radius = radius-feather;
313 const Real outer_radius = radius+feather;
315 const Real inner_radius_sqd = inner_radius > 0 ? (radius-feather)*(radius-feather) : 0;
316 const Real outer_radius_sqd = (radius+feather)*(radius+feather);
318 const Real diff_radii_sqd = outer_radius_sqd - inner_radius_sqd;
319 const Real double_feather = feather*2.0;*/
321 /*const Real &inner_radius = cache.inner_radius;
322 const Real &outer_radius = cache.outer_radius;*/
324 const Real &inner_radius_sqd = cache.inner_radius_sqd;
325 const Real &outer_radius_sqd = cache.outer_radius_sqd;
327 /*const Real &diff_radii_sqd = cache.diff_radii_sqd;
328 const Real &double_feather = cache.double_feather;*/
330 const Vector::value_type mag_squared = temp.mag_squared();
332 //Outside the circle, with feathering enabled
333 if( mag_squared > outer_radius_sqd )
335 // inverted -> outside == colored in
338 if(get_amount() == 1 && get_blend_method() == Color::BLEND_STRAIGHT)
341 return Color::blend(color,context.get_color(point),get_amount(),get_blend_method());
344 return context.get_color(point);
347 //inside the circle's solid area (with feathering)
348 else if(mag_squared <= inner_radius_sqd)
350 // !invert -> solid area
352 if(get_amount() == 1 && get_blend_method() == Color::BLEND_STRAIGHT)
355 return Color::blend(color,context.get_color(point),get_amount(),get_blend_method());
357 return context.get_color(point);
360 //If we get here, the pixel is within the feathering area, and is thus subject to falloff
363 Color::value_type alpha;
368 case FALLOFF_SQUARED:
369 //squared proportional falloff
370 alpha = (outer_radius_sqd - mag_squared) / diff_radii_sqd;
374 //linear distance falloff
375 alpha = ( outer_radius - sqrt(mag_squared) ) / double_feather;
376 //then take the square root of it
380 case FALLOFF_INTERPOLATION_LINEAR:
381 //linear distance falloff
382 alpha = ( outer_radius - sqrt(mag_squared) ) / double_feather;
385 case FALLOFF_SIGMOND:
387 //linear distance falloff
388 alpha = ( outer_radius - sqrt(mag_squared) ) / double_feather;
389 // inverse exponential of the linear falloff (asymptotes at 0 and 1)
390 // \frac{1.0}{ 1 + e^{- \( a*10-5 \)}}
391 alpha = 1.0 / (1 + exp(-(alpha*10-5)) );
395 //If we're inverted, we need to invert the falloff value
399 alpha = falloff_func(cache,mag_squared);
401 //Compose falloff value with amount from the composite layer, and that is the blend value
402 alpha *= get_amount();
404 return Color::blend(color,context.get_color(point),alpha,get_blend_method());
408 Color NormalBlend(Color a, Color b, float amount)
410 return (b-a)*amount+a;
415 Circle::accelerated_render(Context context,Surface *surface,int quality, const RendDesc &renddesc, ProgressCallback *cb)const
418 if(is_disabled() || (radius==0 && invert==false))
419 return context.accelerated_render(surface,quality, renddesc, cb);
421 // Another trivial case
422 if(invert && radius==0 && is_solid_color())
424 surface->set_wh(renddesc.get_w(),renddesc.get_h());
425 surface->fill(color);
426 if(cb && !cb->amount_complete(10000,10000))
432 const Point tl(renddesc.get_tl());
433 const Point br(renddesc.get_br());
434 const int w(renddesc.get_w());
435 const int h(renddesc.get_h());
437 const Real x_neg = tl[0] > br[0] ? -1 : 1;
438 const Real y_neg = tl[1] > br[1] ? -1 : 1;
440 // Width and Height of a pixel
441 const Real pw = (br[0] - tl[0]) / w;
442 const Real ph = (br[1] - tl[1]) / h;
444 // Increasing the feather amount by the size of
445 // a pixel will create an anti-aliased appearance
446 // don't render feathering at all when quality is 10
447 const Real newfeather = (quality == 10) ? 0 : feather + (abs(ph)+abs(pw))/4.0;
450 int left = (int) floor( (pos[0] - x_neg*(radius+newfeather) - tl[0]) / pw );
451 int right = (int) ceil( (pos[0] + x_neg*(radius+newfeather) - tl[0]) / pw );
452 int top = (int) floor( (pos[1] - y_neg*(radius+newfeather) - tl[1]) / ph );
453 int bottom = (int) ceil( (pos[1] + y_neg*(radius+newfeather) - tl[1]) / ph );
455 //clip the rectangle bounds
465 const Real inner_radius = radius-newfeather>0 ? radius-newfeather : 0;
466 const Real outer_radius = radius+newfeather;
468 const Real inner_radius_sqd = inner_radius*inner_radius;
469 const Real outer_radius_sqd = outer_radius*outer_radius;
471 const Real diff_radii_sqd = 4*newfeather*std::max(newfeather,radius);//4.0*radius*newfeather;
472 const Real double_feather = newfeather * 2.0;
474 //Compile the temporary cache for the falloff calculations
475 FALLOFF_FUNC *func = GetFalloffFunc();
477 const CircleDataCache cache =
479 inner_radius,outer_radius,
480 inner_radius_sqd,outer_radius_sqd,
481 diff_radii_sqd,double_feather
484 //info("Circle: Initialized everything");
486 //let the rendering begin
487 SuperCallback supercb(cb,0,9000,10000);
489 //if it's a degenerate circle, do what we need to do, and then leave
490 if(left >= right || top >= bottom)
494 if(get_amount() == 1 && get_blend_method() == Color::BLEND_STRAIGHT)
496 surface->set_wh(w,h);
497 surface->fill(color);
501 // Render what is behind us
502 if(!context.accelerated_render(surface,quality,renddesc,&supercb))
504 if(cb)cb->error(strprintf(__FILE__"%d: Accelerated Renderer Failure",__LINE__));
508 Surface::alpha_pen p(surface->begin(),get_amount(),_BlendFunc(get_blend_method()));
516 // Render what is behind us
517 if(!context.accelerated_render(surface,quality,renddesc,&supercb))
519 if(cb)cb->error(strprintf(__FILE__"%d: Accelerated Renderer Failure",__LINE__));
526 if( (pos[0] - tl[0])*(pos[0] - tl[0]) + (pos[1] - tl[1])*(pos[1] - tl[1]) < inner_radius_sqd
527 && (pos[0] - br[0])*(pos[0] - br[0]) + (pos[1] - br[1])*(pos[1] - br[1]) < inner_radius_sqd
528 && (pos[0] - tl[0])*(pos[0] - tl[0]) + (pos[1] - br[1])*(pos[1] - br[1]) < inner_radius_sqd
529 && (pos[0] - br[0])*(pos[0] - br[0]) + (pos[1] - tl[1])*(pos[1] - tl[1]) < inner_radius_sqd )
533 // Render what is behind us
534 if(!context.accelerated_render(surface,quality,renddesc,&supercb))
536 if(cb)cb->error(strprintf(__FILE__"%d: Accelerated Renderer Failure",__LINE__));
541 if(get_amount() == 1 && get_blend_method() == Color::BLEND_STRAIGHT)
543 surface->set_wh(w,h);
544 surface->fill(color);
550 //info("Circle: Non degenerate, rasterize %c", invert);
552 //we start in the middle of the left-top pixel
553 Real leftf = (left + 0.5)*pw + tl[0];
554 Real topf = (top + 0.5)*ph + tl[1];
556 //the looping variables
560 //Loop normally, since we are not inverted
563 // Render what is behind us
564 if(!context.accelerated_render(surface,quality,renddesc,&supercb))
566 if(cb)cb->error(strprintf(__FILE__"%d: Accelerated Renderer Failure",__LINE__));
570 //make topf and leftf relative to the center of the circle
577 //Loop over the valid y-values in the bounding square
578 for(;j <= bottom; j++, y += ph)
583 //for each y-value, Loop over the bounding x-values in the bounding square
584 for(;i <= right; i++, x += pw)
586 //for each pixel, figure out the distance and blend
589 //if in the inner circle then the full color shows through
590 if(r <= inner_radius_sqd)
592 if(get_amount() == 1 && get_blend_method() == Color::BLEND_STRAIGHT)
593 (*surface)[j][i]=color;
595 (*surface)[j][i]=Color::blend(color,(*surface)[j][i],get_amount(),get_blend_method());
597 //if it's within the outer circle then it's in the feathering range
598 else if(r <= outer_radius_sqd)
604 case FALLOFF_SQUARED:
605 myamount = (outer_radius_sqd - r) / diff_radii_sqd;
609 myamount = (outer_radius - sqrt(r)) / double_feather;
610 myamount = sqrt(myamount);
613 case FALLOFF_INTERPOLATION_LINEAR:
614 myamount = (outer_radius - sqrt(r)) / double_feather;
617 case FALLOFF_SIGMOND:
619 myamount = (outer_radius - sqrt(r)) / double_feather;
620 myamount = 1.0 / ( 1 + exp(-(myamount*10 - 5)) );
624 Real myamount = func(cache,r);
626 //if(myamount<0.0)myamount=0.0;
627 //if(myamount>1.0)myamount=1.0;
628 myamount *= get_amount();
629 (*surface)[j][i] = Color::blend(color,(*surface)[j][i],myamount,get_blend_method());
637 RendDesc desc(renddesc);
640 int offset_x=0,offset_y=0;
642 //fill the surface with the background color initially
643 surface->set_wh(w,h);
644 surface->fill(color);
646 //then render the background to an alternate surface
647 if(get_amount() == 1 && get_blend_method() == Color::BLEND_STRAIGHT)
652 //if there is no background showing through we are done
653 if(right < left || bottom < top)
656 desc.set_subwindow(left,top,right-left+1,bottom-top+1);
658 // Render what is behind us
659 if(!context.accelerated_render(&background,quality,desc,&supercb))
661 if(cb)cb->error(strprintf(__FILE__"%d: Accelerated Renderer Failure",__LINE__));
672 leftf = /*0.5*pw +*/ tl[0];
673 topf = /*0.5*ph +*/ tl[1];
675 // Render what is behind us
676 if(!context.accelerated_render(&background,quality,renddesc,&supercb))
678 if(cb)cb->error(strprintf(__FILE__"%d: Accelerated Renderer Failure",__LINE__));
689 for(;j <= bottom; j++, y+=ph)
694 for(;i <= right; i++, x+=pw)
696 Vector::value_type r = x*x + y*y;
698 if(r < inner_radius_sqd)
700 (*surface)[j][i] = background[j-offset_y][i-offset_x];
702 else if(r < outer_radius_sqd)
708 case FALLOFF_SQUARED:
709 amount = (r - inner_radius_sqd) / diff_radii_sqd;
711 case FALLOFF_INTERPOLATION_LINEAR:
712 amount = (sqrt(r) - inner_radius) / double_feather;
715 amount = (outer_radius - sqrt(r)) / double_feather;
716 amount = 1.0 - sqrt(amount);
718 case FALLOFF_SIGMOND:
720 amount = (outer_radius - sqrt(r)) / double_feather;
721 amount = 1.0 - ( 1.0/( 1 + exp(-(amount*10-5)) ) );
725 Real amount = func(cache,r);
727 if(amount<0.0)amount=0.0;
728 if(amount>1.0)amount=1.0;
730 amount*=get_amount();
732 (*surface)[j][i]=Color::blend(color,background[j-offset_y][i-offset_x],amount,get_blend_method());
733 }else if(get_amount() != 1 || get_blend_method() != Color::BLEND_STRAIGHT)
735 (*surface)[j][i]=Color::blend(color,background[j][i],get_amount(),get_blend_method());
741 // Mark our progress as finished
742 if(cb && !cb->amount_complete(10000,10000))
749 Circle::get_bounding_rect()const
752 return Rect::full_plane();
755 pos[0]+(radius+feather),
756 pos[1]+(radius+feather),
757 pos[0]-(radius+feather),
758 pos[1]-(radius+feather)
765 Circle::get_full_bounding_rect(Context context)const
769 if(is_solid_color() && color.get_a()==0)
772 pos[0]+(radius+feather),
773 pos[1]+(radius+feather),
774 pos[0]-(radius+feather),
775 pos[1]-(radius+feather)
777 return bounds & context.get_full_bounding_rect();
779 return Rect::full_plane();
782 return Layer_Composite::get_full_bounding_rect(context);