cedric pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=ea811a917428935c4e733213b26f4295c610f3a3
commit ea811a917428935c4e733213b26f4295c610f3a3
Author: Bryce Harrington <br...@osg.samsung.com>
Date: Mon Sep 18 10:41:40 2017 -0700
efl interface: add Eo API documentation for path and shape interpolation
Subscribers: cedric, jpeg
Differential Revision: https://phab.enlightenment.org/D5202
Signed-off-by: Cedric BAIL <ced...@osg.samsung.com>
---
src/lib/efl/interfaces/efl_gfx_path.eo | 18 ++++++++++++++----
src/lib/efl/interfaces/efl_gfx_shape.eo | 16 ++++++++++++----
2 files changed, 26 insertions(+), 8 deletions(-)
diff --git a/src/lib/efl/interfaces/efl_gfx_path.eo
b/src/lib/efl/interfaces/efl_gfx_path.eo
index c4d15d8f63..1862a34b82 100644
--- a/src/lib/efl/interfaces/efl_gfx_path.eo
+++ b/src/lib/efl/interfaces/efl_gfx_path.eo
@@ -256,12 +256,22 @@ mixin Efl.Gfx.Path
}
}
interpolate {
- [[Interpolate object]]
+ [[Creates intermediary path part-way between two paths
+
+ Sets the points of the $obj as the linear interpolation of the points
+ in the $from and to $paths. The path's x,y position and control
+ point coordinates are likewise interpolated.
+
+ The $from and $to paths must not already have equivalent points,
+ and $to must contain at least as many points as $from, else the
+ function returns $false with no interpolation performed. If $to
+ has more points than $from, the excess points are ignored.
+ ]]
return: bool; [[$true on success, $false otherwise]]
params {
- @in from: const(Efl.Object); [[Source object]]
- @in to: const(Efl.Object); [[Destination object]]
- @in pos_map: double; [[Position map]]
+ @in from: const(Efl.Object); [[Source path]]
+ @in to: const(Efl.Object); [[Destination path]]
+ @in pos_map: double; [[Position map in range 0.0 to 1.0]]
}
}
equal_commands {
diff --git a/src/lib/efl/interfaces/efl_gfx_shape.eo
b/src/lib/efl/interfaces/efl_gfx_shape.eo
index 48531cdbf5..14964b2fa6 100644
--- a/src/lib/efl/interfaces/efl_gfx_shape.eo
+++ b/src/lib/efl/interfaces/efl_gfx_shape.eo
@@ -118,12 +118,20 @@ mixin Efl.Gfx.Shape (Efl.Gfx.Path)
}
}
interpolate {
- [[Interpolate object]]
+ [[Creates intermediary shape part-way between two shapes
+
+ Sets the data properties of $obj as the linear interpolation
+ of the $from and $to objects by $pos_map. In addition to
+ interpolating the path data, the two shapes' dash length, fill
+ color, and stroke style are also interpolated.
+
+ See also @Efl.Gfx.Path.interpolate.
+ ]]
return: bool; [[$true on success, $false otherwise]]
params {
- @in from: const(Efl.Object); [[Source object]]
- @in to: const(Efl.Object); [[Destination object]]
- @in pos_map: double; [[Position map]]
+ @in from: const(Efl.Object); [[Source shape]]
+ @in to: const(Efl.Object); [[Destination shape]]
+ @in pos_map: double; [[Position map in range 0.0 to 1.0]]
}
}
dup {
--
