db1d3efec9d3c13494556d9a9b0492079f29cc65
[synfig.git] / synfig-core / trunk / src / modules / lyr_std / twirl.h
1 /* === S Y N F I G ========================================================= */
2 /*!     \file twirl.h
3 **      \brief Header file for implementation of the "Twirl" layer
4 **
5 **      $Id$
6 **
7 **      \legal
8 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
9 **
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.
14 **
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.
19 **      \endlegal
20 */
21 /* ========================================================================= */
22
23 /* === S T A R T =========================================================== */
24
25 #ifndef __SYNFIG_TWIRL_H
26 #define __SYNFIG_TWIRL_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 #include <synfig/value.h>
34 #include <synfig/gradient.h>
35 #include <synfig/angle.h>
36
37 /* === M A C R O S ========================================================= */
38
39 /* === T Y P E D E F S ===================================================== */
40
41 /* === C L A S S E S & S T R U C T S ======================================= */
42 class Twirl_Trans;
43
44 class Twirl : public synfig::Layer_Composite
45 {
46         SYNFIG_LAYER_MODULE_EXT
47         friend class Twirl_Trans;
48
49 private:
50
51         synfig::Point center;
52
53         synfig::Real radius;
54
55         synfig::Angle rotations;
56
57         bool distort_inside;
58
59         bool distort_outside;
60
61         synfig::Point distort(const synfig::Point &pos, bool reverse=false)const;
62 public:
63
64         Twirl();
65
66         virtual bool set_param(const synfig::String & param, const synfig::ValueBase &value);
67
68         virtual synfig::ValueBase get_param(const synfig::String & param)const;
69
70         virtual synfig::Color get_color(synfig::Context context, const synfig::Point &pos)const;
71
72         //virtual bool accelerated_render(synfig::Context context,synfig::Surface *surface,int quality, const synfig::RendDesc &renddesc, synfig::ProgressCallback *cb)const;
73
74         synfig::Layer::Handle hit_check(synfig::Context context, const synfig::Point &point)const;
75
76         virtual Vocab get_param_vocab()const;
77         virtual etl::handle<synfig::Transform> get_transform()const;
78         virtual bool reads_context()const { return true; }
79 }; // END of class Twirl
80
81 /* === E N D =============================================================== */
82
83 #endif