cb008d5a94a916b6c9490f6997140df51890d95c
[synfig.git] / lumakey.h
1 /* === S Y N F I G ========================================================= */
2 /*!     \file lumakey.h
3 **      \brief Header file for implementation of the "Luma Key" layer
4 **
5 **      $Id$
6 **
7 **      \legal
8 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
9 **      Copyright (c) 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 ** === N O T E S ===========================================================
23 **
24 ** ========================================================================= */
25
26 /* === S T A R T =========================================================== */
27
28 #ifndef __SYNFIG_LUMAKEY_H
29 #define __SYNFIG_LUMAKEY_H
30
31 /* === H E A D E R S ======================================================= */
32
33 #include <synfig/layer_composite.h>
34 #include <synfig/color.h>
35 #include <synfig/vector.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
43 class LumaKey : public synfig::Layer_Composite, public synfig::Layer_NoDeform
44 {
45         SYNFIG_LAYER_MODULE_EXT
46 private:
47
48 public:
49         LumaKey();
50
51         virtual bool set_param(const synfig::String & param, const synfig::ValueBase &value);
52
53         virtual synfig::ValueBase get_param(const synfig::String & param)const;
54
55         virtual synfig::Color get_color(synfig::Context context, const synfig::Point &pos)const;
56
57         virtual Vocab get_param_vocab()const;
58
59         synfig::Layer::Handle hit_check(synfig::Context context, const synfig::Point &point)const;
60         virtual synfig::Rect get_bounding_rect(synfig::Context context)const;
61
62         virtual bool accelerated_render(synfig::Context context,synfig::Surface *surface,int quality, const synfig::RendDesc &renddesc, synfig::ProgressCallback *cb)const;
63         virtual bool reads_context()const { return true; }
64 }; // END of class LumaKey
65
66 /* === E N D =============================================================== */
67
68 #endif