Merge branch 'master' into genete_core_review
[synfig.git] / synfig-core / src / modules / mod_geometry / checkerboard.cpp
1 /* === S Y N F I G ========================================================= */
2 /*!     \file checkerboard.cpp
3 **      \brief Implementation of the "Checkerboard" layer
4 **
5 **      $Id$
6 **
7 **      \legal
8 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
9 **      Copyright (c) 2007, 2008 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 "checkerboard.h"
34
35 #include <synfig/string.h>
36 #include <synfig/time.h>
37 #include <synfig/context.h>
38 #include <synfig/paramdesc.h>
39 #include <synfig/renddesc.h>
40 #include <synfig/surface.h>
41 #include <synfig/value.h>
42 #include <synfig/valuenode.h>
43 #include <synfig/segment.h>
44
45 #endif
46
47 using namespace synfig;
48 using namespace std;
49 using namespace etl;
50
51 /* === M A C R O S ========================================================= */
52
53 /* === G L O B A L S ======================================================= */
54
55 SYNFIG_LAYER_INIT(CheckerBoard);
56 SYNFIG_LAYER_SET_NAME(CheckerBoard,"checker_board");
57 SYNFIG_LAYER_SET_LOCAL_NAME(CheckerBoard,N_("Checkerboard"));
58 SYNFIG_LAYER_SET_CATEGORY(CheckerBoard,N_("Geometry"));
59 SYNFIG_LAYER_SET_VERSION(CheckerBoard,"0.1");
60 SYNFIG_LAYER_SET_CVS_ID(CheckerBoard,"$Id$");
61
62 /* === P R O C E D U R E S ================================================= */
63
64 /* === M E T H O D S ======================================================= */
65
66 CheckerBoard::CheckerBoard():
67         Layer_Composite (1.0,Color::BLEND_COMPOSITE),
68         color                   (Color::black()),
69         origin                  (Point(0.125,0.125)),
70         size                    (Point(0.25,0.25))
71 {}
72
73 inline bool
74 CheckerBoard::point_test(const synfig::Point& getpos)const
75 {
76         int val=((int)((getpos[0]-origin[0])/size[0])+(int)((getpos[1]-origin[1])/size[1]));
77         if(getpos[0]-origin[0] < 0.0)
78                 val++;
79         if(getpos[1]-origin[1] < 0.0)
80                 val++;
81         return val&1;
82 }
83
84 bool
85 CheckerBoard::set_param(const String &param, const ValueBase &value)
86 {
87         IMPORT_PLUS(color, { if (color.get_a() == 0) { if (converted_blend_) {
88                                         set_blend_method(Color::BLEND_ALPHA_OVER);
89                                         color.set_a(1); } else transparent_color_ = true; } });
90         IMPORT(origin);
91         IMPORT(size);
92
93         IMPORT_AS(origin,"pos");
94         IMPORT_AS(origin[0],"pos[0]");
95         IMPORT_AS(origin[1],"pos[1]");
96
97         return Layer_Composite::set_param(param,value);
98 }
99
100 ValueBase
101 CheckerBoard::get_param(const String &param)const
102 {
103         EXPORT(color);
104         EXPORT(origin);
105         EXPORT(size);
106         EXPORT_NAME();
107         EXPORT_VERSION();
108
109         return Layer_Composite::get_param(param);
110 }
111
112 Layer::Vocab
113 CheckerBoard::get_param_vocab()const
114 {
115         Layer::Vocab ret(Layer_Composite::get_param_vocab());
116
117         ret.push_back(ParamDesc("color")
118                 .set_local_name(_("Color"))
119                 .set_description(_("Color of checkers"))
120         );
121         ret.push_back(ParamDesc("origin")
122                 .set_local_name(_("Origin"))
123         );
124         ret.push_back(ParamDesc("size")
125                 .set_local_name(_("Size"))
126                 .set_description(_("Size of checkers"))
127                 .set_origin("origin")
128         );
129
130         return ret;
131 }
132
133 synfig::Layer::Handle
134 CheckerBoard::hit_check(synfig::Context context, const synfig::Point &getpos)const
135 {
136         if(get_amount()!=0.0 && point_test(getpos))
137         {
138                 synfig::Layer::Handle tmp;
139                 if(get_blend_method()==Color::BLEND_BEHIND && (tmp=context.hit_check(getpos)))
140                         return tmp;
141                 if(Color::is_onto(get_blend_method()) && !(tmp=context.hit_check(getpos)))
142                         return 0;
143                 return const_cast<CheckerBoard*>(this);
144         }
145         else
146                 return context.hit_check(getpos);
147 }
148
149 Color
150 CheckerBoard::get_color(Context context, const Point &getpos)const
151 {
152         if(get_amount()!=0.0 && point_test(getpos))
153         {
154                 if(get_amount()==1.0 && get_blend_method()==Color::BLEND_STRAIGHT)
155                         return color;
156                 else
157                         return Color::blend(color,context.get_color(getpos),get_amount(),get_blend_method());
158         }
159         else
160                 return Color::blend(Color::alpha(),context.get_color(getpos),get_amount(),get_blend_method());
161 }
162
163 bool
164 CheckerBoard::accelerated_render(Context context,Surface *surface,int quality, const RendDesc &renddesc, ProgressCallback *cb)const
165 {
166         SuperCallback supercb(cb,0,9500,10000);
167
168         if(!context.accelerated_render(surface,quality,renddesc,&supercb))
169                 return false;
170         if(get_amount()==0)
171                 return true;
172
173         int x,y;
174
175         const Point tl(renddesc.get_tl());
176         Point pos;
177         const int w(surface->get_w());
178         const int h(surface->get_h());
179         const Real pw(renddesc.get_pw()),ph(renddesc.get_ph());
180
181         Surface::alpha_pen apen(surface->begin());
182
183         apen.set_alpha(get_amount());
184         apen.set_blend_method(get_blend_method());
185         apen.set_value(color);
186
187         for(y=0,pos[1]=tl[1];y<h;y++,apen.inc_y(),apen.dec_x(x),pos[1]+=ph)
188                 for(x=0,pos[0]=tl[0];x<w;x++,apen.inc_x(),pos[0]+=pw)
189                         if(point_test(pos))
190                                 apen.put_value();
191
192         // Mark our progress as finished
193         if(cb && !cb->amount_complete(10000,10000))
194                 return false;
195
196         return true;
197 }