summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2019-12-17 13:53:25 +0100
committerXavi Artigas <xavierartigas@yahoo.es>2019-12-17 14:07:20 +0100
commit3bfc73a95ae2b0eeb473ace10eacafa5802eca93 (patch)
tree65bf5c8b570eaeea803027e3acedc9e1cd14c1af
parentbfc095104cf286485672ea78049ca2677e6e5fea (diff)
docs: Add missing docs for Efl.Canvas.Object_Animation
-rw-r--r--src/lib/evas/canvas/efl_canvas_object_animation.eo35
1 files changed, 23 insertions, 12 deletions
diff --git a/src/lib/evas/canvas/efl_canvas_object_animation.eo b/src/lib/evas/canvas/efl_canvas_object_animation.eo
index 49146a6b81..3a4aa87a0a 100644
--- a/src/lib/evas/canvas/efl_canvas_object_animation.eo
+++ b/src/lib/evas/canvas/efl_canvas_object_animation.eo
@@ -1,5 +1,9 @@
1mixin @beta Efl.Canvas.Object_Animation requires Efl.Object 1mixin @beta Efl.Canvas.Object_Animation requires Efl.Object
2{ 2{
3 [[A mixin that provides animation capabilities to @Efl.Canvas.Object.
4
5 By including this mixin canvas objects can be animated just by calling @.animation_start.
6 ]]
3 methods { 7 methods {
4 @property animation { 8 @property animation {
5 [[The animation that is currently played on the canvas object. 9 [[The animation that is currently played on the canvas object.
@@ -13,43 +17,50 @@ mixin @beta Efl.Canvas.Object_Animation requires Efl.Object
13 } 17 }
14 } 18 }
15 @property animation_progress { 19 @property animation_progress {
16 [[The current progress of the animation, between 0.0 and 1.0. 20 [[The current progress of the animation, between $[0.0] and $[1.0].
17 21
18 Even if the animation is going backwards (speed < 0.0). the progress will still go from 0.0 to 1.0. 22 Even if the animation is going backwards (speed < 0.0) the progress will still go from $[0.0] to $[1.0].
19 23
20 If there is no animation going on, this will return -1.0. 24 If there is no animation going on, this will return $[-1.0].
21 ]] 25 ]]
22 get { 26 get {
23 27
24 } 28 }
25 values { 29 values {
26 progress : double; [[The progress the animation applying is currently in.]] 30 progress : double; [[Current progress of the animation.]]
27 } 31 }
28 } 32 }
29 @property animation_pause { 33 @property animation_pause {
30 [[Pause the animation 34 [[Pause the animation.
31 35
32 The animation will not be unset. When $pause is unset, the animation will be resumed at the same progress it has right now. 36 @.animation will not be unset. When $pause is $false, the animation will be resumed at the same progress it
37 was when it was paused.
33 ]] 38 ]]
34 values { 39 values {
35 pause : bool; 40 pause : bool; [[Paused state.]]
36 } 41 }
37 } 42 }
38 animation_start { 43 animation_start {
39 [[Start a new animation. 44 [[Start a new animation.
40 45
41 If there is a animation going on, this is stopped. The previous @.animation object will be replaced. The lifetime is adjusted accordingly. 46 If there is an animation going on, it is stopped and the previous @.animation object is replaced.
47 Its lifetime is adjusted accordingly.
42 ]] 48 ]]
43 params { 49 params {
44 animation : Efl.Canvas.Animation @move; [[The animation to start. When not needed anymore, the reference that was passed is given up.]] 50 animation : Efl.Canvas.Animation @move; [[The animation to start. When not needed anymore,
45 speed : double; [[The speed of the playback. `1.0` is normal playback. Negative values mean backward playback.]] 51 the reference that was passed is given up.]]
46 starting_progress : double; [[The progress to start, must be between 0.0 and 1.0.]] 52 speed : double; [[The speed of the playback. $[1.0] is normal playback. Negative values mean reverse playback.
53 ]]
54 starting_progress : double; [[The progress point where to start. Must be between $[0.0] and $[1.0].
55 Useful to revert an animation which has already started.
56 ]]
47 } 57 }
48 } 58 }
49 animation_stop { 59 animation_stop {
50 [[Stop the animation. 60 [[Stop the animation.
51 61
52 After this call, @.animation will return $null. The reference that was taken during @.animation_start will be given up on. 62 After this call, @.animation will return $null.
63 The reference that was taken during @.animation_start will be given up.
53 ]] 64 ]]
54 } 65 }
55 } 66 }