Fixing warnings from doxygen:
[synfig.git] / synfig-core / trunk / src / modules / mod_geometry / checkerboard.h
1 /* === S Y N F I G ========================================================= */
2 /*!     \file checkerboard.h
3 **      \brief Checkerboard Layer
4 **
5 **      \legal
6 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
7 **
8 **      This package is free software; you can redistribute it and/or
9 **      modify it under the terms of the GNU General Public License as
10 **      published by the Free Software Foundation; either version 2 of
11 **      the License, or (at your option) any later version.
12 **
13 **      This package is distributed in the hope that it will be useful,
14 **      but WITHOUT ANY WARRANTY; without even the implied warranty of
15 **      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 **      General Public License for more details.
17 **      \endlegal
18 **
19 ** === N O T E S ===========================================================
20 **
21 ** ========================================================================= */
22
23 /* === S T A R T =========================================================== */
24
25 #ifndef __SYNFIG_CHECKERBOARD_H
26 #define __SYNFIG_CHECKERBOARD_H
27
28 /* === H E A D E R S ======================================================= */
29
30 #include <synfig/layer_composite.h>
31 #include <synfig/color.h>
32 #include <synfig/vector.h>
33
34 /* === M A C R O S ========================================================= */
35
36 /* === T Y P E D E F S ===================================================== */
37
38 /* === C L A S S E S & S T R U C T S ======================================= */
39
40 class CheckerBoard : public synfig::Layer_Composite, public synfig::Layer_NoDeform
41 {
42         SYNFIG_LAYER_MODULE_EXT
43 private:
44         synfig::Color color;
45         synfig::Point pos;
46         synfig::Point size;
47
48         bool point_test(const synfig::Point& x)const;
49
50 public:
51         CheckerBoard();
52
53         virtual bool set_param(const synfig::String & param, const synfig::ValueBase &value);
54
55         virtual synfig::ValueBase get_param(const synfig::String & param)const;
56
57         virtual synfig::Color get_color(synfig::Context context, const synfig::Point &pos)const;
58
59         virtual Vocab get_param_vocab()const;
60
61         synfig::Layer::Handle hit_check(synfig::Context context, const synfig::Point &point)const;
62
63         virtual bool accelerated_render(synfig::Context context,synfig::Surface *surface,int quality, const synfig::RendDesc &renddesc, synfig::ProgressCallback *cb)const;
64 };
65
66 /* === E N D =============================================================== */
67
68 #endif