summaryrefslogtreecommitdiff
path: root/src/lib
diff options
context:
space:
mode:
authorBryce Harrington <bryce@osg.samsung.com>2017-09-18 10:41:40 -0700
committerCedric BAIL <cedric@osg.samsung.com>2017-09-18 11:18:43 -0700
commitea811a917428935c4e733213b26f4295c610f3a3 (patch)
tree38e73ed33c4836085c110737d6be1091a703e3e0 /src/lib
parent93d339b5ed3fa46aa073db703ac666b85c764bd8 (diff)
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 <cedric@osg.samsung.com>
Diffstat (limited to 'src/lib')
-rw-r--r--src/lib/efl/interfaces/efl_gfx_path.eo18
-rw-r--r--src/lib/efl/interfaces/efl_gfx_shape.eo16
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 c4d15d8..1862a34 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
256 } 256 }
257 } 257 }
258 interpolate { 258 interpolate {
259 [[Interpolate object]] 259 [[Creates intermediary path part-way between two paths
260
261 Sets the points of the $obj as the linear interpolation of the points
262 in the $from and to $paths. The path's x,y position and control
263 point coordinates are likewise interpolated.
264
265 The $from and $to paths must not already have equivalent points,
266 and $to must contain at least as many points as $from, else the
267 function returns $false with no interpolation performed. If $to
268 has more points than $from, the excess points are ignored.
269 ]]
260 return: bool; [[$true on success, $false otherwise]] 270 return: bool; [[$true on success, $false otherwise]]
261 params { 271 params {
262 @in from: const(Efl.Object); [[Source object]] 272 @in from: const(Efl.Object); [[Source path]]
263 @in to: const(Efl.Object); [[Destination object]] 273 @in to: const(Efl.Object); [[Destination path]]
264 @in pos_map: double; [[Position map]] 274 @in pos_map: double; [[Position map in range 0.0 to 1.0]]
265 } 275 }
266 } 276 }
267 equal_commands { 277 equal_commands {
diff --git a/src/lib/efl/interfaces/efl_gfx_shape.eo b/src/lib/efl/interfaces/efl_gfx_shape.eo
index 48531cd..14964b2 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)
118 } 118 }
119 } 119 }
120 interpolate { 120 interpolate {
121 [[Interpolate object]] 121 [[Creates intermediary shape part-way between two shapes
122
123 Sets the data properties of $obj as the linear interpolation
124 of the $from and $to objects by $pos_map. In addition to
125 interpolating the path data, the two shapes' dash length, fill
126 color, and stroke style are also interpolated.
127
128 See also @Efl.Gfx.Path.interpolate.
129 ]]
122 return: bool; [[$true on success, $false otherwise]] 130 return: bool; [[$true on success, $false otherwise]]
123 params { 131 params {
124 @in from: const(Efl.Object); [[Source object]] 132 @in from: const(Efl.Object); [[Source shape]]
125 @in to: const(Efl.Object); [[Destination object]] 133 @in to: const(Efl.Object); [[Destination shape]]
126 @in pos_map: double; [[Position map]] 134 @in pos_map: double; [[Position map in range 0.0 to 1.0]]
127 } 135 }
128 } 136 }
129 dup { 137 dup {