synfig-core/src/modules/mod_gradient/radialgradient.cpp

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file mod_gradient/radialgradient.cpp
   3 **      \brief Implementation of the "Radial Gradient" layer
   4 **
   5 **      $Id$
   6 **
   7 **      \legal
   8 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
   9 **      Copyright (c) 2007 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 <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>
  41
  42 #include "radialgradient.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(RadialGradient);
  55 SYNFIG_LAYER_SET_NAME(RadialGradient,"radial_gradient");
  56 SYNFIG_LAYER_SET_LOCAL_NAME(RadialGradient,N_("Radial Gradient"));
  57 SYNFIG_LAYER_SET_CATEGORY(RadialGradient,N_("Gradients"));
  58 SYNFIG_LAYER_SET_VERSION(RadialGradient,"0.1");
  59 SYNFIG_LAYER_SET_CVS_ID(RadialGradient,"$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 RadialGradient::RadialGradient():
  68         Layer_Composite(1.0,Color::BLEND_COMPOSITE),
  69         gradient(Color::black(),Color::white()),
  70         center(0,0),
  71         radius(0.5),
  72         loop(false),
  73         zigzag(false)
  74 {
  75         Layer::Vocab voc(get_param_vocab());
  76         Layer::fill_static(voc);
  77 }
  78
  79 bool
  80 RadialGradient::set_param(const String & param, const ValueBase &value)
  81 {
  82         IMPORT(gradient);
  83         IMPORT(center);
  84         IMPORT(radius);
  85         IMPORT(loop);
  86         IMPORT(zigzag);
  87
  88         return Layer_Composite::set_param(param,value);
  89 }
  90
  91 ValueBase
  92 RadialGradient::get_param(const String &param)const
  93 {
  94         EXPORT(gradient);
  95         EXPORT(center);
  96         EXPORT(radius);
  97         EXPORT(loop);
  98         EXPORT(zigzag);
  99
 100         EXPORT_NAME();
 101         EXPORT_VERSION();
 102
 103         return Layer_Composite::get_param(param);
 104 }
 105
 106 Layer::Vocab
 107 RadialGradient::get_param_vocab()const
 108 {
 109         Layer::Vocab ret(Layer_Composite::get_param_vocab());
 110
 111         ret.push_back(ParamDesc("gradient")
 112                 .set_local_name(_("Gradient"))
 113                 .set_description(_("Gradient to apply"))
 114         );
 115
 116         ret.push_back(ParamDesc("center")
 117                 .set_local_name(_("Center"))
 118                 .set_description(_("Center of the gradient"))
 119         );
 120
 121         ret.push_back(ParamDesc("radius")
 122                 .set_local_name(_("Radius"))
 123                 .set_description(_("This is the radius of the circle"))
 124                 .set_is_distance()
 125                 .set_origin("center")
 126         );
 127
 128         ret.push_back(ParamDesc("loop")
 129                 .set_local_name(_("Loop"))
 130                 .set_description(_("When checked the gradient is looped"))
 131         );
 132
 133         ret.push_back(ParamDesc("zigzag")
 134                 .set_local_name(_("ZigZag"))
 135                 .set_description(_("When checked the gradient is summetrical at the center"))
 136         );
 137
 138         return ret;
 139 }
 140
 141 inline Color
 142 RadialGradient::color_func(const Point &point, float supersample)const
 143 {
 144         Real dist((point-center).mag()/radius);
 145
 146         if(zigzag)
 147         {
 148                 dist*=2.0;
 149                 supersample*=2.0;
 150                 if(dist>1)dist=2.0-dist;
 151         }
 152
 153         if(loop)
 154         {
 155                 dist-=floor(dist);
 156
 157                 if(dist+supersample*0.5>1.0)
 158                 {
 159                         float  left(supersample*0.5-(dist-1.0));
 160                         float right(supersample*0.5+(dist-1.0));
 161                         Color pool(gradient(1.0-(left*0.5),left).premult_alpha()*left/supersample);
 162                         if (zigzag) pool+=gradient(1.0-right*0.5,right).premult_alpha()*right/supersample;
 163                         else            pool+=gradient(right*0.5,right).premult_alpha()*right/supersample;
 164                         return pool.demult_alpha();
 165                 }
 166                 if(dist-supersample*0.5<0.0)
 167                 {
 168                         float  left(supersample*0.5-dist);
 169                         float right(supersample*0.5+dist);
 170                         Color pool(gradient(right*0.5,right).premult_alpha()*right/supersample);
 171                         if (zigzag) pool+=gradient(left*0.5,left).premult_alpha()*left/supersample;
 172                         else            pool+=gradient(1.0-left*0.5,left).premult_alpha()*left/supersample;
 173                         return pool.demult_alpha();
 174                 }
 175         }
 176
 177         return gradient(dist,supersample);
 178 }
 179
 180
 181 float
 182 RadialGradient::calc_supersample(const synfig::Point &/*x*/, float pw,float /*ph*/)const
 183 {
 184 //      return sqrt(pw*pw+ph*ph)/radius;
 185         return 1.2*pw/radius;
 186 }
 187
 188 synfig::Layer::Handle
 189 RadialGradient::hit_check(synfig::Context context, const synfig::Point &point)const
 190 {
 191         if(get_blend_method()==Color::BLEND_STRAIGHT && get_amount()>=0.5)
 192                 return const_cast<RadialGradient*>(this);
 193         if(get_amount()==0.0)
 194                 return context.hit_check(point);
 195         if((get_blend_method()==Color::BLEND_STRAIGHT || get_blend_method()==Color::BLEND_COMPOSITE) && color_func(point).get_a()>0.5)
 196                 return const_cast<RadialGradient*>(this);
 197         return context.hit_check(point);
 198 }
 199
 200 Color
 201 RadialGradient::get_color(Context context, const Point &pos)const
 202 {
 203         const Color color(color_func(pos));
 204
 205         if(get_amount()==1.0 && get_blend_method()==Color::BLEND_STRAIGHT)
 206                 return color;
 207         else
 208                 return Color::blend(color,context.get_color(pos),get_amount(),get_blend_method());
 209 }
 210
 211 bool
 212 RadialGradient::accelerated_render(Context context,Surface *surface,int quality, const RendDesc &renddesc, ProgressCallback *cb)const
 213 {
 214         SuperCallback supercb(cb,0,9500,10000);
 215
 216         if(get_amount()==1.0 && get_blend_method()==Color::BLEND_STRAIGHT)
 217         {
 218                 surface->set_wh(renddesc.get_w(),renddesc.get_h());
 219         }
 220         else
 221         {
 222                 if(!context.accelerated_render(surface,quality,renddesc,&supercb))
 223                         return false;
 224                 if(get_amount()==0)
 225                         return true;
 226         }
 227
 228
 229         int x,y;
 230
 231         Surface::pen pen(surface->begin());
 232         const Real pw(renddesc.get_pw()),ph(renddesc.get_ph());
 233         Point pos;
 234         Point tl(renddesc.get_tl());
 235         const int w(surface->get_w());
 236         const int h(surface->get_h());
 237
 238         if(get_amount()==1.0 && get_blend_method()==Color::BLEND_STRAIGHT)
 239         {
 240                 for(y=0,pos[1]=tl[1];y<h;y++,pen.inc_y(),pen.dec_x(x),pos[1]+=ph)
 241                         for(x=0,pos[0]=tl[0];x<w;x++,pen.inc_x(),pos[0]+=pw)
 242                                 pen.put_value(color_func(pos,calc_supersample(pos,pw,ph)));
 243         }
 244         else
 245         {
 246                 for(y=0,pos[1]=tl[1];y<h;y++,pen.inc_y(),pen.dec_x(x),pos[1]+=ph)
 247                         for(x=0,pos[0]=tl[0];x<w;x++,pen.inc_x(),pos[0]+=pw)
 248                                 pen.put_value(Color::blend(color_func(pos,calc_supersample(pos,pw,ph)),pen.get_value(),get_amount(),get_blend_method()));
 249         }
 250
 251         // Mark our progress as finished
 252         if(cb && !cb->amount_complete(10000,10000))
 253                 return false;
 254
 255         return true;
 256 }