Set the description of some parameters

[synfig.git] / synfig-core / src / synfig / layer_composite.cpp

diff --git a/synfig-core/src/synfig/layer_composite.cpp b/synfig-core/src/synfig/layer_composite.cpp
index 6a25efc..2dda09f 100644 (file)
--- a/synfig-core/src/synfig/layer_composite.cpp
+++ b/synfig-core/src/synfig/layer_composite.cpp
@@ -59,13 +59,22 @@ using namespace synfig;
 /* === P R O C E D U R E S ================================================= */
 
 /* === M E T H O D S ======================================================= */
+Layer_Composite::Layer_Composite(float         a, Color::BlendMethod   bm):
+               amount                          (a),
+               blend_method            (bm),
+               converted_blend_        (false),
+               transparent_color_      (false)
+       {
+               Layer::Vocab voc(get_param_vocab());
+               Layer::fill_static(voc);
+       }
 
 bool
 Layer_Composite::accelerated_render(Context context,Surface *surface,int quality, const RendDesc &renddesc_, ProgressCallback *cb)  const
 {
        RendDesc renddesc(renddesc_);
 
-       if(!amount_)
+       if(!amount)
                return context.accelerated_render(surface,quality,renddesc,cb);
 
        CanvasBase image;
@@ -92,18 +101,22 @@ Layer_Composite::accelerated_render(Context context,Surface *surface,int quality
 
        image.push_back(0);     // Alpha black
 
-       // Render the backdrop
+       // Render the backdrop on the surface layer's surface.
        if(!context.accelerated_render(&surfacelayer->surface,quality,renddesc,&stageone))
                return false;
-
+       // Sets up the interpolation of the context (now the surface layer is the first one)
+       // depending on the quality
        if(quality<=4)surfacelayer->c=3;else
        if(quality<=5)surfacelayer->c=2;
        else if(quality<=6)surfacelayer->c=1;
        else surfacelayer->c=0;
        surfacelayer->tl=renddesc.get_tl();
        surfacelayer->br=renddesc.get_br();
+       // Sets the blend method to straight. See below
        surfacelayer->set_blend_method(Color::BLEND_STRAIGHT);
-
+       // Push this layer on the image. The blending result is only this layer
+       // adn the surface layer. The rest of the context is ignored by the straight
+       // blend method of surface layer
        image.push_front(const_cast<synfig::Layer_Composite*>(this));
 
        // Set up a surface target
@@ -136,13 +149,16 @@ Layer_Composite::get_full_bounding_rect(Context context)const
 Layer::Vocab
 Layer_Composite::get_param_vocab()const
 {
+       //! First fills the returning vocabulary with the ancestor class
        Layer::Vocab ret(Layer::get_param_vocab());
-
-       ret.push_back(ParamDesc(amount_,"amount")
+       //! Now inserts the two parameters that this layer knows.
+       ret.push_back(ParamDesc(amount,"amount")
                .set_local_name(_("Amount"))
+               .set_description(_("Alpha channel of the layer"))
        );
-       ret.push_back(ParamDesc(blend_method_,"blend_method")
+       ret.push_back(ParamDesc(blend_method,"blend_method")
                .set_local_name(_("Blend Method"))
+               .set_description(_("The blending method used to composite on the layers below"))
        );
 
        return ret;
@@ -151,21 +167,25 @@ Layer_Composite::get_param_vocab()const
 bool
 Layer_Composite::set_param(const String & param, const ValueBase &value)
 {
-       if(param=="amount" && value.same_type_as(amount_))
-               amount_=value.get(amount_);
+       if(param=="amount" && value.same_type_as(amount))
+       {
+               amount=value.get(amount);
+               set_param_static(param,value.get_static());
+       }
        else
        if(param=="blend_method" && value.same_type_as(int()))
        {
-               blend_method_ = static_cast<Color::BlendMethod>(value.get(int()));
+               blend_method = static_cast<Color::BlendMethod>(value.get(int()));
+               set_param_static(param,value.get_static());
 
-               if (blend_method_ < 0 || blend_method_ >= Color::BLEND_END)
+               if (blend_method < 0 || blend_method >= Color::BLEND_END)
                {
-                       warning("illegal value (%d) for blend_method - using Composite instead", blend_method_);
-                       blend_method_ = Color::BLEND_COMPOSITE;
+                       warning("illegal value (%d) for blend_method - using Composite instead", blend_method);
+                       blend_method = Color::BLEND_COMPOSITE;
                        return false;
                }
 
-               if (blend_method_ == Color::BLEND_STRAIGHT && !reads_context())
+               if (blend_method == Color::BLEND_STRAIGHT && !reads_context())
                {
                        Canvas::Handle canvas(get_canvas());
                        if (canvas)
@@ -179,7 +199,7 @@ Layer_Composite::set_param(const String & param, const ValueBase &value)
                                                                version.c_str(), get_non_empty_description().c_str());
                                        else
                                        {
-                                               blend_method_ = Color::BLEND_COMPOSITE;
+                                               blend_method = Color::BLEND_COMPOSITE;
                                                converted_blend_ = true;
 
                                                // if this layer has a transparent color, go back and set the color again
@@ -200,9 +220,21 @@ Layer_Composite::set_param(const String & param, const ValueBase &value)
 ValueBase
 Layer_Composite::get_param(const String & param)const
 {
+
+       //! First check if the parameter's string is known.
        if(param=="amount")
-               return get_amount();
+       {
+               synfig::ValueBase ret(get_amount());
+               ret.set_static(get_param_static(param));
+               return ret;
+       }
        if(param=="blend_method")
-               return static_cast<int>(get_blend_method());
+       {
+               synfig::ValueBase ret(static_cast<int>(get_blend_method()));
+               ret.set_static(get_param_static(param));
+               return ret;
+       }
+       //! If it is unknown then call the ancestor's get param member
+       //! to see if it can handle that parameter's string.
        return Layer::get_param(param);
 }