summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2019-11-04 13:06:41 +0100
committerXavi Artigas <xavierartigas@yahoo.es>2019-11-04 13:06:53 +0100
commitdc5ffbb8660db8f93ebf698802a56b31daeaf8b9 (patch)
tree4446b567663ed2178ae966bfc576ceb931a29356
parenta1a77f5590a27ba6bb70ce9d2f5343f3cddc96dc (diff)
docs: Polish Efl.Canvas.Animation_*
Summary: These docs were lacking a lot of detail. Depends on D10562 Reviewers: bu5hm4n, cedric, zmike, Jaehyun_Cho Reviewed By: cedric Subscribers: #reviewers, #committers Tags: #efl Differential Revision: https://phab.enlightenment.org/D10565
-rw-r--r--src/lib/evas/canvas/efl_canvas_animation_alpha.eo15
-rw-r--r--src/lib/evas/canvas/efl_canvas_animation_rotate.eo40
-rw-r--r--src/lib/evas/canvas/efl_canvas_animation_scale.eo41
-rw-r--r--src/lib/evas/canvas/efl_canvas_animation_translate.eo28
4 files changed, 91 insertions, 33 deletions
diff --git a/src/lib/evas/canvas/efl_canvas_animation_alpha.eo b/src/lib/evas/canvas/efl_canvas_animation_alpha.eo
index 1ff9720c3e..d76a80c1a0 100644
--- a/src/lib/evas/canvas/efl_canvas_animation_alpha.eo
+++ b/src/lib/evas/canvas/efl_canvas_animation_alpha.eo
@@ -1,18 +1,25 @@
1class @beta Efl.Canvas.Animation_Alpha extends Efl.Canvas.Animation 1class @beta Efl.Canvas.Animation_Alpha extends Efl.Canvas.Animation
2{ 2{
3 [[Efl alpha animation class]] 3 [[Animated alpha blending effect.
4
5 The @Efl.Canvas.Object will have its alpha (transparency) value multiplied by
6 this animation.
7 This can be used to create fade-in and fade-out transitions, for example.
8 ]]
4 c_prefix: efl_animation_alpha; 9 c_prefix: efl_animation_alpha;
5 data: Efl_Canvas_Animation_Alpha_Data; 10 data: Efl_Canvas_Animation_Alpha_Data;
6 methods { 11 methods {
7 @property alpha { 12 @property alpha {
8 [[Alpha property]] 13 [[Alpha range to animate. $[0.0] means the object is transparent and $[1.0] means
14 the object is opaque.
15 ]]
9 set { 16 set {
10 } 17 }
11 get { 18 get {
12 } 19 }
13 values { 20 values {
14 from_alpha: double; [[Alpha value when animation starts]] 21 from_alpha: double; [[Initial alpha value.]]
15 to_alpha: double; [[Alpha value when animation ends]] 22 to_alpha: double; [[Ending alpha value.]]
16 } 23 }
17 } 24 }
18 } 25 }
diff --git a/src/lib/evas/canvas/efl_canvas_animation_rotate.eo b/src/lib/evas/canvas/efl_canvas_animation_rotate.eo
index 3c1d8af086..c7463f8824 100644
--- a/src/lib/evas/canvas/efl_canvas_animation_rotate.eo
+++ b/src/lib/evas/canvas/efl_canvas_animation_rotate.eo
@@ -1,33 +1,51 @@
1class @beta Efl.Canvas.Animation_Rotate extends Efl.Canvas.Animation 1class @beta Efl.Canvas.Animation_Rotate extends Efl.Canvas.Animation
2{ 2{
3 [[Efl rotate animation class]] 3 [[Animated rotation effect.
4
5 The @Efl.Canvas.Object will rotate around a pivot point from one degree to another.
6 Coordinates for the pivot point can be relative to another object or absolute
7 (relative to the containing canvas).
8
9 Note: Changing an object's position using @Efl.Gfx.Entity.position while this
10 animation is running might lead to unexpected results.
11 ]]
4 c_prefix: efl_animation_rotate; 12 c_prefix: efl_animation_rotate;
5 data: Efl_Canvas_Animation_Rotate_Data; 13 data: Efl_Canvas_Animation_Rotate_Data;
6 methods { 14 methods {
7 @property rotate { 15 @property rotate {
8 [[Rotate property]] 16 [[Degree range to animate and pivot object.
17 The object will rotate from $from_degree to $to_degree around the pivot point.
18 All of the object's vertices (i.e. the corners, if it's a rectangular object)
19 will be rotated by these degrees, relative to the pivot point inside the pivot object.
20 The pivot point is another object $pivot plus an additional offset $center_point.
21 ]]
9 set { 22 set {
10 } 23 }
11 get { 24 get {
12 } 25 }
13 values { 26 values {
14 from_degree: double; [[Rotation degree when animation starts]] 27 from_degree: double; [[Initial rotation (from 0 to 360). 0 means no rotation.]]
15 to_degree: double; [[Rotation degree when animation ends]] 28 to_degree: double; [[Ending rotation (from 0 to 360). 0 means no rotation.]]
16 pivot: Efl.Canvas.Object; [[Pivot object for the center point. 29 pivot: Efl.Canvas.Object; [[Object to use as pivot. $NULL means the animated object itself.]]
17 If the pivot object is $NULL, then the object is rotated on itself.]] 30 center_point: Eina.Vector2; [[Position in pixels of the pivot point inside the pivot object.
18 center_point : Eina.Vector2; [[Relative coordinate of the center point.]] 31 $[(0,0)] means the upper-left corner.]]
19 } 32 }
20 } 33 }
21 @property rotate_absolute { 34 @property rotate_absolute {
22 [[Rotate absolute property]] 35 [[Degree range to animate and absolute pivot point.
36 The object will rotate from $from_degree to $to_degree around the pivot point.
37 All of the object's vertices (i.e. the corners, if it's a rectangular object)
38 will be rotated by these degrees, relative to an absolute pivot point.
39 The pivot point is relative to the canvas.
40 ]]
23 set { 41 set {
24 } 42 }
25 get { 43 get {
26 } 44 }
27 values { 45 values {
28 from_degree: double; [[Rotation degree when animation starts]] 46 from_degree: double; [[Initial rotation (from 0 to 360). 0 means no rotation.]]
29 to_degree: double; [[Rotation degree when animation ends]] 47 to_degree: double; [[Ending rotation (from 0 to 360). 0 means no rotation.]]
30 center_pointer : Eina.Position2D; [[absolute coordinate of the center point.]] 48 pivot_point : Eina.Position2D; [[Position of the pivot point relative to the canvas.]]
31 } 49 }
32 } 50 }
33 } 51 }
diff --git a/src/lib/evas/canvas/efl_canvas_animation_scale.eo b/src/lib/evas/canvas/efl_canvas_animation_scale.eo
index b35c5d819b..23f9dea0b0 100644
--- a/src/lib/evas/canvas/efl_canvas_animation_scale.eo
+++ b/src/lib/evas/canvas/efl_canvas_animation_scale.eo
@@ -1,33 +1,52 @@
1class @beta Efl.Canvas.Animation_Scale extends Efl.Canvas.Animation 1class @beta Efl.Canvas.Animation_Scale extends Efl.Canvas.Animation
2{ 2{
3 [[Efl scale animation class]] 3 [[Animated scaling effect.
4
5 The @Efl.Canvas.Object will have its size and position changed due to a scaling
6 operation around a specified pivot point.
7 Coordinates for the pivot point can be relative to the object or absolute
8 (relative to the containing canvas).
9
10 Note: Changing an object's geometry using @Efl.Gfx.Entity.position or @Efl.Gfx.Entity.size
11 while this animation is running might lead to unexpected results.
12 ]]
4 c_prefix: efl_animation_scale; 13 c_prefix: efl_animation_scale;
5 data: Efl_Canvas_Animation_Scale_Data; 14 data: Efl_Canvas_Animation_Scale_Data;
6 methods { 15 methods {
7 @property scale { 16 @property scale {
8 [[Scale property]] 17 [[Scale range and pivot object.
18 The object's scale will change from $from_scale to $to_scale.
19 All of the object's vertices (i.e. the corners, if it's a rectangular object)
20 will be multiplied by this scale, relative to the pivot point inside the pivot object.
21 The pivot point is another object $pivot plus an additional offset $center_point.
22 ]]
9 set { 23 set {
10 } 24 }
11 get { 25 get {
12 } 26 }
13 values { 27 values {
14 from_scale : Eina.Vector2; [[Scale factor when animation starts]] 28 from_scale: Eina.Vector2; [[Initial scale value.]]
15 to_scale : Eina.Vector2; [[Scale factor when animation ends]] 29 to_scale: Eina.Vector2; [[Ending scale value.]]
16 pivot: Efl.Canvas.Object; [[Pivot object for the center point. If the pivot object is $NULL, then the object 30 pivot: Efl.Canvas.Object; [[Object to use as pivot. $NULL means the animated object itself.]]
17 is scaled on itself.]] 31 center_point: Eina.Vector2; [[Position in pixels of the pivot point inside the pivot object.
18 pivot_pos : Eina.Vector2; [[Relative coordinates of the center point. 0.0,0.0 is upper left.]] 32 $[(0,0)] means the upper-left corner.]]
19 } 33 }
20 } 34 }
21 @property scale_absolute { 35 @property scale_absolute {
22 [[Scale absolute property]] 36 [[Scale range and pivot position, relative to the canvas.
37 The object's scale will change from $from_scale to $to_scale.
38 All of the object's vertices (i.e. the corners, if it's a rectangular object)
39 will be multiplied by this scale, relative to the pivot point.
40 The pivot point is relative to the canvas.
41 ]]
23 set { 42 set {
24 } 43 }
25 get { 44 get {
26 } 45 }
27 values { 46 values {
28 from_scale : Eina.Vector2; [[Scale factor when animation starts]] 47 from_scale: Eina.Vector2; [[Initial scale value.]]
29 to_scale : Eina.Vector2; [[Scale factor when animation ends]] 48 to_scale: Eina.Vector2; [[Ending scale value.]]
30 pos : Eina.Position2D; [[Absolut coordinates in canvas space]] 49 pivot_point: Eina.Position2D; [[Position of the pivot point relative to the canvas.]]
31 } 50 }
32 } 51 }
33 } 52 }
diff --git a/src/lib/evas/canvas/efl_canvas_animation_translate.eo b/src/lib/evas/canvas/efl_canvas_animation_translate.eo
index e4b2678679..ed06dd567c 100644
--- a/src/lib/evas/canvas/efl_canvas_animation_translate.eo
+++ b/src/lib/evas/canvas/efl_canvas_animation_translate.eo
@@ -1,29 +1,43 @@
1class @beta Efl.Canvas.Animation_Translate extends Efl.Canvas.Animation 1class @beta Efl.Canvas.Animation_Translate extends Efl.Canvas.Animation
2{ 2{
3 [[Efl translate animation class]] 3 [[Animated translation effect.
4
5 The @Efl.Canvas.Object will move from one point to another.
6 Coordinates for the origin and destination points can be relative to the object
7 or absolute (relative to the containing canvas).
8
9 Note: Changing an object's position using @Efl.Gfx.Entity.position while this
10 animation is running might lead to unexpected results.
11 ]]
4 c_prefix: efl_animation_translate; 12 c_prefix: efl_animation_translate;
5 data: Efl_Canvas_Animation_Translate_Data; 13 data: Efl_Canvas_Animation_Translate_Data;
6 methods { 14 methods {
7 @property translate { 15 @property translate {
8 [[Translate property]] 16 [[Translation vector, relative to the starting position of the object.
17 So, for example, if $from is $[(0,0)], the object will move from its
18 current position to $to.
19 ]]
9 set { 20 set {
10 } 21 }
11 get { 22 get {
12 } 23 }
13 values { 24 values {
14 from : Eina.Position2D; [[Position moved when animation starts.]] 25 from : Eina.Position2D; [[Relative initial position.]]
15 to : Eina.Position2D; [[Position moved when animation ends.]] 26 to : Eina.Position2D; [[Relative ending position.]]
16 } 27 }
17 } 28 }
18 @property translate_absolute { 29 @property translate_absolute {
19 [[Translate absolute property]] 30 [[Translation vector, relative to the canvas.
31 So, for example, if $from is $[(0,0)], the object will always start from the
32 origin of the canvas, regardless of the current object position.
33 ]]
20 set { 34 set {
21 } 35 }
22 get { 36 get {
23 } 37 }
24 values { 38 values {
25 from : Eina.Position2D; [[The position where the animation starts.]] 39 from : Eina.Position2D; [[Absolute initial position.]]
26 to : Eina.Position2D; [[The position where the animation stops.]] 40 to : Eina.Position2D; [[Absolute ending position.]]
27 } 41 }
28 } 42 }
29 } 43 }