Fixing warnings from doxygen:
[synfig.git] / synfig-core / trunk / src / modules / mod_gradient / lineargradient.h
1 /* === S Y N F I G ========================================================= */
2 /*!     \file lineargradient.h
3 **      \brief Template Header
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_INTERPOLATION_LINEARGRADIENT_H
26 #define __SYNFIG_INTERPOLATION_LINEARGRADIENT_H
27
28 /* === H E A D E R S ======================================================= */
29
30 #include <synfig/vector.h>
31 #include <synfig/layer_composite.h>
32 #include <synfig/gradient.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 using namespace synfig;
41 using namespace std;
42 using namespace etl;
43
44 class LinearGradient : public Layer_Composite, public Layer_NoDeform
45 {
46         SYNFIG_LAYER_MODULE_EXT
47
48 private:
49
50         Point p1,p2;
51         Vector diff;
52         Gradient gradient;
53
54         bool loop;
55         bool zigzag;
56
57         void sync();
58
59         synfig::Color color_func(const synfig::Point &x, float supersample=0)const;
60
61         float calc_supersample(const synfig::Point &x, float pw,float ph)const;
62
63 public:
64         LinearGradient();
65
66         virtual bool set_param(const String &param, const ValueBase &value);
67         virtual ValueBase get_param(const String &param)const;
68         virtual Color get_color(Context context, const Point &pos)const;
69         virtual bool accelerated_render(Context context,Surface *surface,int quality, const RendDesc &renddesc, ProgressCallback *cb)const;
70         synfig::Layer::Handle hit_check(synfig::Context context, const synfig::Point &point)const;
71
72         virtual Vocab get_param_vocab()const;
73 };
74
75 /* === E N D =============================================================== */
76
77 #endif