diff options
author | Xavi Artigas <xavierartigas@yahoo.es> | 2019-10-30 15:26:08 +0100 |
---|---|---|
committer | Xavi Artigas <xavierartigas@yahoo.es> | 2019-11-04 13:51:21 +0100 |
commit | 0e71e0e286d97c4aaee76f1c079e2f00fc616cbf (patch) | |
tree | 0c814991b41d16d504febd787e554873ffab4037 | |
parent | 56d541fbdb1cdc980dcdee644be24d52255af3fb (diff) | |
download | efl-0e71e0e286d97c4aaee76f1c079e2f00fc616cbf.tar.gz |
docs: Polish Efl.Canvas.Animation_Group and sons
Summary: These docs were almost empty.
Reviewers: bu5hm4n, zmike, cedric, Jaehyun_Cho
Reviewed By: cedric
Subscribers: #reviewers, #committers
Tags: #efl
Differential Revision: https://phab.enlightenment.org/D10564
3 files changed, 29 insertions, 9 deletions
diff --git a/src/lib/evas/canvas/efl_canvas_animation_group.eo b/src/lib/evas/canvas/efl_canvas_animation_group.eo index fdf42e2d88..f9cada25a7 100644 --- a/src/lib/evas/canvas/efl_canvas_animation_group.eo +++ b/src/lib/evas/canvas/efl_canvas_animation_group.eo @@ -1,24 +1,29 @@ abstract @beta Efl.Canvas.Animation_Group extends Efl.Canvas.Animation { - [[Efl group animation abstract class]] + [[Base class for combined animations (groups of animations that are played together). + + This class provides methods to add, remove and retrieve individual animations from the group. + + See for example @Efl.Canvas.Animation_Group_Parallel and @Efl.Canvas.Animation_Group_Sequential. + ]] c_prefix: efl_animation_group; data: Efl_Canvas_Animation_Group_Data; methods { animation_add { - [[Add the given animation to the animation group.]] + [[Adds the given animation to the animation group.]] params { - @in animation: Efl.Canvas.Animation; [[The animation which needs to be added to the animation group]] + @in animation: Efl.Canvas.Animation; [[Animation to add to the group.]] } } animation_del { - [[Delete the given animation from the animation group.]] + [[Removes the given animation from the animation group.]] params { - @in animation: Efl.Canvas.Animation; [[The animation which needs to be deleted from the animation group]] + @in animation: Efl.Canvas.Animation; [[Animation to remove from the group.]] } } animations_get @const { - [[Get the animations of the animation group.]] - return: list<Efl.Canvas.Animation>; [[The animations of the animation group]] + [[Gets the list of animations currently in the animation group.]] + return: list<Efl.Canvas.Animation>; [[List of animations in the group.]] } } implements { diff --git a/src/lib/evas/canvas/efl_canvas_animation_group_parallel.eo b/src/lib/evas/canvas/efl_canvas_animation_group_parallel.eo index 63773ddac3..e0434e7ad4 100644 --- a/src/lib/evas/canvas/efl_canvas_animation_group_parallel.eo +++ b/src/lib/evas/canvas/efl_canvas_animation_group_parallel.eo @@ -1,6 +1,13 @@ class @beta Efl.Canvas.Animation_Group_Parallel extends Efl.Canvas.Animation_Group { - [[Efl group parallel animation class]] + [[Combined animation which plays its individual animations in parallel + (all of them simultaneously). + + For instance, this could be used to move an @Efl.Canvas.Object from one position to another + while rotating it along the way. + + Use @Efl.Canvas.Animation_Group.animation_add to append individual animations. + ]] c_prefix: efl_animation_group_parallel; data: null; methods { diff --git a/src/lib/evas/canvas/efl_canvas_animation_group_sequential.eo b/src/lib/evas/canvas/efl_canvas_animation_group_sequential.eo index 415a87f999..aebd70ede5 100644 --- a/src/lib/evas/canvas/efl_canvas_animation_group_sequential.eo +++ b/src/lib/evas/canvas/efl_canvas_animation_group_sequential.eo @@ -1,6 +1,14 @@ class @beta Efl.Canvas.Animation_Group_Sequential extends Efl.Canvas.Animation_Group { - [[Efl group sequential animation class]] + [[Combined animation which plays its individual animations in a sequential order + (one after the other). + + For instance, this could be used to move an @Efl.Canvas.Object from one position to another + and then start rotating it once it reaches its destination. + + Use @Efl.Canvas.Animation_Group.animation_add to append individual animations. + Animations are played in the order in which they are added. + ]] data: null; methods { } |