From 42e8f249832b9ca81691bbf76a6668aa4612117f Mon Sep 17 00:00:00 2001 From: Carlos Lopez Date: Tue, 7 Dec 2010 20:04:10 +0100 Subject: [PATCH] Set the description of some parameters --- synfig-core/src/modules/lyr_std/clamp.cpp | 3 ++ synfig-core/src/modules/lyr_std/curvewarp.cpp | 29 +++++++++++-------- synfig-core/src/modules/lyr_std/sphere_distort.cpp | 4 +++ synfig-core/src/modules/lyr_std/stretch.cpp | 2 ++ synfig-core/src/modules/lyr_std/supersample.cpp | 1 + synfig-core/src/modules/lyr_std/timeloop.cpp | 5 ++++ synfig-core/src/modules/lyr_std/warp.cpp | 7 +++++ synfig-core/src/modules/mod_example/filledrect.cpp | 3 ++ .../src/modules/mod_geometry/checkerboard.cpp | 1 + synfig-core/src/modules/mod_geometry/circle.cpp | 4 +++ .../src/modules/mod_gradient/conicalgradient.cpp | 4 +++ .../src/modules/mod_gradient/curvegradient.cpp | 33 ++++++++++++++-------- .../src/modules/mod_gradient/lineargradient.cpp | 5 ++++ synfig-core/src/modules/mod_noise/distort.cpp | 6 ++++ synfig-core/src/modules/mod_noise/noise.cpp | 8 ++++++ synfig-core/src/synfig/layer.cpp | 1 + synfig-core/src/synfig/layer_composite.cpp | 2 ++ 17 files changed, 95 insertions(+), 23 deletions(-) diff --git a/synfig-core/src/modules/lyr_std/clamp.cpp b/synfig-core/src/modules/lyr_std/clamp.cpp index eafb048..7866ffe 100644 --- a/synfig-core/src/modules/lyr_std/clamp.cpp +++ b/synfig-core/src/modules/lyr_std/clamp.cpp @@ -159,14 +159,17 @@ Layer_Clamp::get_param_vocab()const ret.push_back(ParamDesc("clamp_ceiling") .set_local_name(_("Clamp Ceiling")) + .set_description(_("When checked the Ceiling value is used")) ); ret.push_back(ParamDesc("ceiling") .set_local_name(_("Ceiling")) + .set_description(_("Upper boundary of the clamping")) ); ret.push_back(ParamDesc("floor") .set_local_name(_("Floor")) + .set_description(_("Lower boundary of the clamping")) ); return ret; diff --git a/synfig-core/src/modules/lyr_std/curvewarp.cpp b/synfig-core/src/modules/lyr_std/curvewarp.cpp index 131cef0..4d8c769 100644 --- a/synfig-core/src/modules/lyr_std/curvewarp.cpp +++ b/synfig-core/src/modules/lyr_std/curvewarp.cpp @@ -385,28 +385,33 @@ CurveWarp::get_param_vocab()const Layer::Vocab ret; ret.push_back(ParamDesc("origin") - .set_local_name(_("Origin"))); - + .set_local_name(_("Origin")) + .set_description(_("Position of the source line")) + ); ret.push_back(ParamDesc("perp_width") .set_local_name(_("Width")) - .set_origin("start_point")); - + .set_origin("start_point") + .set_description(_("How much is expanded the result perpendicular to the source line")) + ); ret.push_back(ParamDesc("start_point") .set_local_name(_("Start Point")) - .set_connect("end_point")); - + .set_connect("end_point") + .set_description(_("First point of the source line")) + ); ret.push_back(ParamDesc("end_point") - .set_local_name(_("End Point"))); - + .set_local_name(_("End Point")) + .set_description(_("Final point of the source line")) + ); ret.push_back(ParamDesc("bline") .set_local_name(_("Vertices")) .set_origin("origin") .set_hint("width") - .set_description(_("A list of BLine Points"))); - + .set_description(_("List of BLine Points where the source line is curved to")) + ); ret.push_back(ParamDesc("fast") - .set_local_name(_("Fast"))); - + .set_local_name(_("Fast")) + .set_description(_("When checked, renders quickly but with artifacts")) + ); return ret; } diff --git a/synfig-core/src/modules/lyr_std/sphere_distort.cpp b/synfig-core/src/modules/lyr_std/sphere_distort.cpp index 5786a46..f4fa700 100644 --- a/synfig-core/src/modules/lyr_std/sphere_distort.cpp +++ b/synfig-core/src/modules/lyr_std/sphere_distort.cpp @@ -143,21 +143,25 @@ Layer_SphereDistort::get_param_vocab()const ret.push_back(ParamDesc("center") .set_local_name(_("Position")) + .set_description(_("Where the sphere distortion is centered")) ); ret.push_back(ParamDesc("radius") .set_local_name(_("Radius")) .set_origin("center") .set_is_distance() + .set_description(_("The size of the sphere distortion")) ); ret.push_back(ParamDesc("amount") .set_local_name(_("Amount")) .set_is_distance(false) + .set_description(_("The distortion intensity (negative values inverts effect)")) ); ret.push_back(ParamDesc("clip") .set_local_name(_("Clip")) + .set_description(_("When cheked, the area outside the Radius are not distorted")) ); ret.push_back(ParamDesc("type") diff --git a/synfig-core/src/modules/lyr_std/stretch.cpp b/synfig-core/src/modules/lyr_std/stretch.cpp index 65ae87f..e0fdb04 100644 --- a/synfig-core/src/modules/lyr_std/stretch.cpp +++ b/synfig-core/src/modules/lyr_std/stretch.cpp @@ -102,10 +102,12 @@ Layer_Stretch::get_param_vocab()const ret.push_back(ParamDesc("amount") .set_local_name(_("Amount")) .set_origin("center") + .set_description(_("Size of the stretch relative to its Center")) ); ret.push_back(ParamDesc("center") .set_local_name(_("Center")) + .set_description(_("Where the stretch distortion is centered")) ); return ret; diff --git a/synfig-core/src/modules/lyr_std/supersample.cpp b/synfig-core/src/modules/lyr_std/supersample.cpp index 27c8c13..e6d9a7d 100644 --- a/synfig-core/src/modules/lyr_std/supersample.cpp +++ b/synfig-core/src/modules/lyr_std/supersample.cpp @@ -227,6 +227,7 @@ SuperSample::get_param_vocab(void)const ); ret.push_back(ParamDesc("alpha_aware") .set_local_name(_("Be Alpha Safe")) + .set_description(_("Avoid alpha artifacts when checked")) ); return ret; diff --git a/synfig-core/src/modules/lyr_std/timeloop.cpp b/synfig-core/src/modules/lyr_std/timeloop.cpp index f896af0..9cd8340 100644 --- a/synfig-core/src/modules/lyr_std/timeloop.cpp +++ b/synfig-core/src/modules/lyr_std/timeloop.cpp @@ -120,22 +120,27 @@ Layer_TimeLoop::get_param_vocab()const ret.push_back(ParamDesc("link_time") .set_local_name(_("Link Time")) + .set_description(_("Start time of the loop for the cycled context")) ); ret.push_back(ParamDesc("local_time") .set_local_name(_("Local Time")) + .set_description(_("The time when the resulted loop starts")) ); ret.push_back(ParamDesc("duration") .set_local_name(_("Duration")) + .set_description(_("Lenght of the loop")) ); ret.push_back(ParamDesc("only_for_positive_duration") .set_local_name(_("Only For Positive Duration")) + .set_description(_("When checked will loop only positive durations")) ); ret.push_back(ParamDesc("symmetrical") .set_local_name(_("Symmetrical")) + .set_description(_("When checked, loops are mirrored centered at Local Time")) ); return ret; diff --git a/synfig-core/src/modules/lyr_std/warp.cpp b/synfig-core/src/modules/lyr_std/warp.cpp index 729272e..6d31033 100644 --- a/synfig-core/src/modules/lyr_std/warp.cpp +++ b/synfig-core/src/modules/lyr_std/warp.cpp @@ -372,30 +372,36 @@ Warp::get_param_vocab()const ret.push_back(ParamDesc("src_tl") .set_local_name(_("Source TL")) .set_box("src_br") + .set_description(_("Top Left corner of the source to warp")) ); ret.push_back(ParamDesc("src_br") .set_local_name(_("Source BR")) + .set_description(_("Bottom Right corner of the source to warp")) ); ret.push_back(ParamDesc("dest_tl") .set_local_name(_("Dest TL")) .set_connect("dest_tr") + .set_description(_("Top Left corner of the destination")) ); ret.push_back(ParamDesc("dest_tr") .set_local_name(_("Dest TR")) .set_connect("dest_br") + .set_description(_("Top Right corner of the destination")) ); ret.push_back(ParamDesc("dest_br") .set_local_name(_("Dest BR")) .set_connect("dest_bl") + .set_description(_("Bottom Right corner of the destination")) ); ret.push_back(ParamDesc("dest_bl") .set_local_name(_("Dest BL")) .set_connect("dest_tl") + .set_description(_("Bottom Left corner of the destination")) ); ret.push_back(ParamDesc("clip") @@ -404,6 +410,7 @@ Warp::get_param_vocab()const ret.push_back(ParamDesc("horizon") .set_local_name(_("Horizon")) + .set_description(_("Height that determines the horizon in perspectives")) ); return ret; diff --git a/synfig-core/src/modules/mod_example/filledrect.cpp b/synfig-core/src/modules/mod_example/filledrect.cpp index d78f45e..20baf14 100644 --- a/synfig-core/src/modules/mod_example/filledrect.cpp +++ b/synfig-core/src/modules/mod_example/filledrect.cpp @@ -117,6 +117,7 @@ FilledRect::get_param_vocab()const ret.push_back(ParamDesc("color") .set_local_name(_("Color")) + .set_description(_("Fill color of the layer")) ); ret.push_back(ParamDesc("point1") @@ -138,10 +139,12 @@ FilledRect::get_param_vocab()const ret.push_back(ParamDesc("bevel") .set_local_name(_("Bevel")) + .set_description(_("Use Bevel for the corners")) ); ret.push_back(ParamDesc("bevCircle") .set_local_name(_("Keep Bevel Circular")) + .set_description(_("When checked the bevel is circular")) ); return ret; diff --git a/synfig-core/src/modules/mod_geometry/checkerboard.cpp b/synfig-core/src/modules/mod_geometry/checkerboard.cpp index 2389e01..24ed8cd 100644 --- a/synfig-core/src/modules/mod_geometry/checkerboard.cpp +++ b/synfig-core/src/modules/mod_geometry/checkerboard.cpp @@ -123,6 +123,7 @@ CheckerBoard::get_param_vocab()const ); ret.push_back(ParamDesc("origin") .set_local_name(_("Origin")) + .set_description(_("Center of the checkers")) ); ret.push_back(ParamDesc("size") .set_local_name(_("Size")) diff --git a/synfig-core/src/modules/mod_geometry/circle.cpp b/synfig-core/src/modules/mod_geometry/circle.cpp index 5c8d059..6346eb5 100644 --- a/synfig-core/src/modules/mod_geometry/circle.cpp +++ b/synfig-core/src/modules/mod_geometry/circle.cpp @@ -125,18 +125,22 @@ Circle::get_param_vocab()const ret.push_back(ParamDesc("color") .set_local_name(_("Color")) + .set_description(_("Fill color of the layer")) ); ret.push_back(ParamDesc("radius") .set_local_name(_("Radius")) .set_origin("origin") + .set_description(_("Radius of the circle")) .set_is_distance() ); ret.push_back(ParamDesc("feather") .set_local_name(_("Feather")) .set_is_distance() + .set_description(_("Amount of feather of the circle")) ); ret.push_back(ParamDesc("origin") .set_local_name(_("Origin")) + .set_description(_("Center of the circle")) ); ret.push_back(ParamDesc("invert") .set_local_name(_("Invert")) diff --git a/synfig-core/src/modules/mod_gradient/conicalgradient.cpp b/synfig-core/src/modules/mod_gradient/conicalgradient.cpp index 4916d0f..c697de2 100644 --- a/synfig-core/src/modules/mod_gradient/conicalgradient.cpp +++ b/synfig-core/src/modules/mod_gradient/conicalgradient.cpp @@ -106,19 +106,23 @@ ConicalGradient::get_param_vocab()const ret.push_back(ParamDesc("gradient") .set_local_name(_("Gradient")) + .set_description(_("Gradient to apply")) ); ret.push_back(ParamDesc("center") .set_local_name(_("Center")) + .set_description(_("Center of the cone")) ); ret.push_back(ParamDesc("angle") .set_local_name(_("Angle")) .set_origin("center") + .set_description(_("Rotation of the gradient around the center")) ); ret.push_back(ParamDesc("symmetric") .set_local_name(_("Symmetric")) + .set_description(_("When checked the gradient is looped")) ); return ret; diff --git a/synfig-core/src/modules/mod_gradient/curvegradient.cpp b/synfig-core/src/modules/mod_gradient/curvegradient.cpp index ec376ba..691b0e5 100644 --- a/synfig-core/src/modules/mod_gradient/curvegradient.cpp +++ b/synfig-core/src/modules/mod_gradient/curvegradient.cpp @@ -533,28 +533,39 @@ CurveGradient::get_param_vocab()const Layer::Vocab ret(Layer_Composite::get_param_vocab()); ret.push_back(ParamDesc("origin") - .set_local_name(_("Origin"))); - + .set_local_name(_("Origin")) + .set_description(_("Offset for the Vertices List")) + ); ret.push_back(ParamDesc("width") .set_is_distance() - .set_local_name(_("Width"))); - + .set_local_name(_("Width")) + .set_description(_("Global width of the gradient")) + ); ret.push_back(ParamDesc("bline") .set_local_name(_("Vertices")) .set_origin("origin") .set_hint("width") - .set_description(_("A list of BLine Points"))); - + .set_description(_("A list of BLine Points")) + ); ret.push_back(ParamDesc("gradient") - .set_local_name(_("Gradient"))); + .set_local_name(_("Gradient")) + .set_description(_("Gradient to apply")) + ); ret.push_back(ParamDesc("loop") - .set_local_name(_("Loop"))); + .set_local_name(_("Loop")) + .set_description(_("When checked the gradient is looped")) + ); ret.push_back(ParamDesc("zigzag") - .set_local_name(_("ZigZag"))); + .set_local_name(_("ZigZag")) + .set_description(_("When checked the gradient is summetrical at the center")) + ); ret.push_back(ParamDesc("perpendicular") - .set_local_name(_("Perpendicular"))); + .set_local_name(_("Perpendicular")) + ); ret.push_back(ParamDesc("fast") - .set_local_name(_("Fast"))); + .set_local_name(_("Fast")) + .set_description(_("When checked, renders quickly but with artifacts")) + ); return ret; } diff --git a/synfig-core/src/modules/mod_gradient/lineargradient.cpp b/synfig-core/src/modules/mod_gradient/lineargradient.cpp index c47ffad..8811226 100644 --- a/synfig-core/src/modules/mod_gradient/lineargradient.cpp +++ b/synfig-core/src/modules/mod_gradient/lineargradient.cpp @@ -188,18 +188,23 @@ LinearGradient::get_param_vocab()const ret.push_back(ParamDesc("p1") .set_local_name(_("Point 1")) .set_connect("p2") + .set_description(_("Start point of the gradient")) ); ret.push_back(ParamDesc("p2") .set_local_name(_("Point 2")) + .set_description(_("End point of the gradient")) ); ret.push_back(ParamDesc("gradient") .set_local_name(_("Gradient")) + .set_description(_("Gradient to apply")) ); ret.push_back(ParamDesc("loop") .set_local_name(_("Loop")) + .set_description(_("When checked the gradient is looped")) ); ret.push_back(ParamDesc("zigzag") .set_local_name(_("ZigZag")) + .set_description(_("When checked the gradient is summetrical at the center")) ); return ret; diff --git a/synfig-core/src/modules/mod_noise/distort.cpp b/synfig-core/src/modules/mod_noise/distort.cpp index c946440..e12eae7 100644 --- a/synfig-core/src/modules/mod_noise/distort.cpp +++ b/synfig-core/src/modules/mod_noise/distort.cpp @@ -202,13 +202,16 @@ NoiseDistort::get_param_vocab()const ret.push_back(ParamDesc("displacement") .set_local_name(_("Displacement")) + .set_description(_("How big the distortion displaces the context")) ); ret.push_back(ParamDesc("size") .set_local_name(_("Size")) + .set_description(_("The distance between distortions")) ); ret.push_back(ParamDesc("seed") .set_local_name(_("RandomNoise Seed")) + .set_description(_("Change to modify the random seed of the noise")) ); ret.push_back(ParamDesc("smooth") .set_local_name(_("Interpolation")) @@ -222,12 +225,15 @@ NoiseDistort::get_param_vocab()const ); ret.push_back(ParamDesc("detail") .set_local_name(_("Detail")) + .set_description(_("Increase to obtain fine details of the noise")) ); ret.push_back(ParamDesc("speed") .set_local_name(_("Animation Speed")) + .set_description(_("In cycles per second")) ); ret.push_back(ParamDesc("turbulent") .set_local_name(_("Turbulent")) + .set_description(_("When checked produces turbulent noise")) ); return ret; diff --git a/synfig-core/src/modules/mod_noise/noise.cpp b/synfig-core/src/modules/mod_noise/noise.cpp index e4d5c3b..b433d1f 100644 --- a/synfig-core/src/modules/mod_noise/noise.cpp +++ b/synfig-core/src/modules/mod_noise/noise.cpp @@ -256,12 +256,15 @@ Noise::get_param_vocab()const ret.push_back(ParamDesc("gradient") .set_local_name(_("Gradient")) + .set_description(_("Gradient to apply")) ); ret.push_back(ParamDesc("seed") .set_local_name(_("RandomNoise Seed")) + .set_description(_("Change to modify the random seed of the noise")) ); ret.push_back(ParamDesc("size") .set_local_name(_("Size")) + .set_description(_("Size of the noise")) ); ret.push_back(ParamDesc("smooth") .set_local_name(_("Interpolation")) @@ -275,18 +278,23 @@ Noise::get_param_vocab()const ); ret.push_back(ParamDesc("detail") .set_local_name(_("Detail")) + .set_description(_("Increase to obtain fine details of the noise")) ); ret.push_back(ParamDesc("speed") .set_local_name(_("Animation Speed")) + .set_description(_("In cycles per second")) ); ret.push_back(ParamDesc("turbulent") .set_local_name(_("Turbulent")) + .set_description(_("When checked produces turbulent noise")) ); ret.push_back(ParamDesc("do_alpha") .set_local_name(_("Do Alpha")) + .set_description(_("Uses transparency")) ); ret.push_back(ParamDesc("super_sample") .set_local_name(_("Super Sampling")) + .set_description(_("When checked the gradient is supersampled")) ); return ret; diff --git a/synfig-core/src/synfig/layer.cpp b/synfig-core/src/synfig/layer.cpp index 3569a5a..ae25ab4 100644 --- a/synfig-core/src/synfig/layer.cpp +++ b/synfig-core/src/synfig/layer.cpp @@ -584,6 +584,7 @@ Layer::get_param_vocab()const ret.push_back(ParamDesc(z_depth,"z_depth") .set_local_name(_("Z Depth")) .set_animation_only(true) + .set_description(_("Modifies the position of the layer in the layer stack")) ); return ret; diff --git a/synfig-core/src/synfig/layer_composite.cpp b/synfig-core/src/synfig/layer_composite.cpp index 70d4430..2dda09f 100644 --- a/synfig-core/src/synfig/layer_composite.cpp +++ b/synfig-core/src/synfig/layer_composite.cpp @@ -154,9 +154,11 @@ Layer_Composite::get_param_vocab()const //! 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") .set_local_name(_("Blend Method")) + .set_description(_("The blending method used to composite on the layers below")) ); return ret; -- 2.7.4