1 /* === S Y N F I G ========================================================= */
2 /*! \file layer_composite.h
3 ** \brief Composite Layer Class Implementation
8 ** Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
9 ** Copyright (c) 2007, 2008 Chris Moore
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.
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.
22 /* ========================================================================= */
24 /* === S T A R T =========================================================== */
26 #ifndef __SYNFIG_LAYER_COMPOSITE_H
27 #define __SYNFIG_LAYER_COMPOSITE_H
29 /* === H E A D E R S ======================================================= */
34 /* === M A C R O S ========================================================= */
36 /* === T Y P E D E F S ===================================================== */
38 /* === C L A S S E S & S T R U C T S ======================================= */
42 class Layer_NoDeform {};
45 /*! \class Layer_Composite
46 ** \brief Base class for layers that put stuff on top of lower layers
48 class Layer_Composite : public Layer
51 //! The amount of composite
53 //! The blend method for the composition
54 Color::BlendMethod blend_method;
57 //! Default constructor. Not used directly.
58 Layer_Composite(float amount=1.0, Color::BlendMethod blend_method=Color::BLEND_COMPOSITE);
60 //! Converted blend is used to check if an old version of canvas
61 //! is used in the composition. Old Straight was used as new Composite
63 bool converted_blend_;
64 //! Transparent color is used for old canvas versions.
65 //!Old Straight plus transparent color seems to be the same new than alpha over.
66 bool transparent_color_;
69 //! Gets the amount of the layer
70 float get_amount()const { return amount; }
71 //! Sets the amount of the layer and returns this layer
72 Layer_Composite& set_amount(float x) { amount=x; return *this; }
73 //! Gets the blend method of the layer
74 Color::BlendMethod get_blend_method()const { return blend_method; }
75 //! Sets the blend method of the layer and returns this layer
76 Layer_Composite& set_blend_method(Color::BlendMethod x) { blend_method=x; return *this; }
77 //! Returns true is amount is 1 and blend method is straight
78 virtual bool is_solid_color()const { return amount==1.0f && blend_method==Color::BLEND_STRAIGHT; }
79 //! Returns true if the amount is zero.
80 bool is_disabled()const { return amount==0.0f; }
81 //! Gets the parameter vocabulary. To be overrided by the derived.
82 virtual Vocab get_param_vocab()const;
83 //! Sets the value for the given parameter.
84 virtual bool set_param(const String ¶m, const ValueBase &value);
85 //! Gets the value of the given parameter
86 virtual ValueBase get_param(const String ¶m)const;
87 //!Returns the rectangle that includes the context of the layer and
88 //! the intersection of the layer in case it is active and not onto
89 virtual Rect get_full_bounding_rect(Context context)const;
90 //! Renders the layer composited on the context and puts it on the target surface.
91 virtual bool accelerated_render(Context context,Surface *surface,int quality, const RendDesc &renddesc, ProgressCallback *cb)const;
92 }; // END of class Layer_Composite
94 }; // END of namespace synfig
96 /* === E N D =============================================================== */