summaryrefslogtreecommitdiff
path: root/src/lib/efl/interfaces/efl_gfx_shape.eo
blob: 9cf053cf695000a39ebb36d4f8403dec92f9bc8f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
import eina_types;
import efl_gfx_types;

mixin Efl.Gfx.Shape
{
   [[EFL graphics shape object interface]]
   methods {
      @property stroke_scale {
         [[The stroke scale to be used for stroking the path. Will be used along
           with stroke width property.

           @since 1.14
         ]]
         set {
         }
         get {
         }
         values {
            s: double; [[Stroke scale value]]
         }
      }
      @property stroke_color {
         [[The color to be used for stroking the path.

           @since 1.14
         ]]
         set {
         }
         get {
         }
         values {
            r: int; [[The red component of the given color.]]
            g: int; [[The green component of the given color.]]
            b: int; [[The blue component of the given color.]]
            a: int; [[The alpha component of the given color.]]
         }
      }
      @property stroke_width {
         [[The stroke width to be used for stroking the path.

           @since 1.14
         ]]
         set {
         }
         get {
         }
         values {
            w: double; [[Stroke width to be used]]
         }
      }
      @property stroke_location {
         [[Not implemented]]
         set {
         }
         get {
         }
         values {
            centered: double;
         }
      }
      @property stroke_dash {
         [[Not implemented]]
         set {
         }
         get {
         }
         values {
            dash: const(Efl.Gfx.Dash) *;
            length: uint;
         }
      }
      @property stroke_cap {
         [[The cap style to be used for stroking the path.
           The cap will be used for capping the end point of a
           open subpath.

           See also \@ref Efl_Gfx_Cap.

           @since 1.14
         ]]
         set {
         }
         get {
         }
         values {
            c: Efl.Gfx.Cap; [[Cap style to use, default is EFL_GFX_CAP_BUTT]]
         }
      }
      @property stroke_join {
         [[The join style to be used for stroking the path.
           The join style will be used for joining the two line segment
           while stroking the path.

           See also \@ref Efl_Gfx_Join.

           @since 1.14
         ]]
         set {
         }
         get {
         }
         values {
            j: Efl.Gfx.Join; [[Join style to use, default is EFL_GFX_JOIN_MITER]]
         }
      }
      @property fill_rule {
         [[The fill rule of the given shape object.
           $EFL_GFX_FILL_RULE_WINDING, or $EFL_GFX_FILL_RULE_ODD_EVEN.

           @since 1.14
         ]]
         set {
         }
         get {
         }
         values {
            fill_rule: Efl.Gfx.Fill.Rule; [[The current fill rule of the shape object.
                                           One of $EFL_GFX_FILL_RULE_WINDING, $EFL_GFX_FILL_RULE_ODD_EVEN]]
         }
      }
      @property path {
         [[Set the list of commands and points to be used to create the
           content of shape.

           See \@ref efl_gfx_path interface for how to create a command list.

           @since 1.14
         ]]
         set {
         }
         get {
         }
         values {
            op: const(Efl.Gfx.Path.Command_Type) *; [[Command list]]
            points: const(double) *; [[Point list]]
         }
      }
      @property path_length {
        get {
        }
        values {
          commands: uint;
          points: uint;
        }
      }
      @property current {
        [[Current point coordinates]]
        get {
        }
        values {
          x: double; [[X co-ordinate of the current point.]]
          y: double; [[Y co-ordinate of the current point.]]
        }
      }
      @property current_ctrl {
        [[Current control point coordinates]]
        get {
        }
        values {
          x: double; [[X co-ordinate of control point.]]
          y: double; [[Y co-ordinate of control point.]]
        }
      }
      dup {
        [[Copy the shape data from the object specified.

          @since 1.14
        ]]
        params {
          @in dup_from: const(Efl.Object); [[Shape object from where data will be copied.]]
        }
      }
      bounds_get {
        [[Compute and return the bounding box of the currently set path

          @since 1.14
        ]]
        params {
          @out r: Eina.Rectangle; [[Contain the bounding box of the currently set path]]
        }
      }
      reset {
        [[Reset the shape data of the shape object.

          @since 1.14
        ]]
      }
      append_move_to {
        [[Moves the current point to the given point, 
          implicitly starting a new subpath and closing the previous one.

          See also @.append_close.

          @since 1.14
        ]]
        params {
          @in x: double; [[X co-ordinate of the current point.]]
          @in y: double; [[Y co-ordinate of the current point.]]
        }
      }
      append_line_to {
        [[Adds a straight line from the current position to the given end point.
          After the line is drawn, the current position is updated to be at the
          end point of the line.

          If no current position present, it draws a line to itself, basically
          a point.

          See also @.append_move_to.

          @since 1.14
        ]]
        params {
          @in x: double; [[X co-ordinate of end point of the line.]]
          @in y: double; [[Y co-ordinate of end point of the line.]]
        }
      }
      append_quadratic_to {
        [[Adds a quadratic Bezier curve between the current position and the
          given end point (x,y) using the control points specified by (ctrl_x,
          ctrl_y). After the path is drawn, the current position is updated to
          be at the end point of the path.

          @since 1.14
        ]]
        params {
          @in x: double; [[X co-ordinate of end point of the line.]]
          @in y: double; [[Y co-ordinate of end point of the line.]]
          @in ctrl_x: double; [[X co-ordinate of control point.]]
          @in ctrl_y: double; [[Y co-ordinate of control point.]]
        }
      }
      append_squadratic_to {
        [[Same as efl_gfx_path_append_quadratic_to() api only difference is
          that it uses the current control point to draw the bezier.

          See also @.append_quadratic_to.

          @since 1.14
        ]]
        params {
          @in x: double; [[X co-ordinate of end point of the line.]]
          @in y: double; [[Y co-ordinate of end point of the line.]]
        }
      }
      append_cubic_to {
        [[Adds a cubic Bezier curve between the current position and the
          given end point (x,y) using the control points specified by
          (ctrl_x0, ctrl_y0), and (ctrl_x1, ctrl_y1). After the path is drawn,
          the current position is updated to be at the end point of the path.

          @since 1.14
        ]]
        params {
          @in ctrl_x0: double; [[X co-ordinate of 1st control point.]]
          @in ctrl_y0: double; [[Y co-ordinate of 1st control point.]]
          @in ctrl_x1: double; [[X co-ordinate of 2nd control point.]]
          @in ctrl_y1: double; [[Y co-ordinate of 2nd control point.]]
          @in x: double; [[X co-ordinate of end point of the line.]]
          @in y: double; [[Y co-ordinate of end point of the line.]]
        }
      }
      append_scubic_to {
        [[Same as efl_gfx_path_append_cubic_to() api only difference is that it
          uses the current control point to draw the bezier.

         See also @.append_cubic_to.

          @since 1.14
        ]]
        params {
          @in x: double; [[X co-ordinate of end point of the line.]]
          @in y: double; [[Y co-ordinate of end point of the line.]]
          @in ctrl_x: double; [[X co-ordinate of 2nd control point.]]
          @in ctrl_y: double; [[Y co-ordinate of 2nd control point.]]
        }
      }
      append_arc_to {
        [[Append an arc that connects from the current point int the point list
          to the given point (x,y). The arc is defined by the given radius in 
          x-direction (rx) and radius in y direction (ry).

          Use this api if you know the end point's of the arc otherwise use
          more convenient function @.append_arc.

          @since 1.14
        ]]
        params {
          @in x: double; [[X co-ordinate of end point of the arc.]]
          @in y: double; [[Y co-ordinate of end point of the arc.]]
          @in rx: double; [[radius of arc in x direction.]]
          @in ry: double; [[radius of arc in y direction.]]
          @in angle: double; [[x-axis rotation , normally 0.]]
          @in large_arc: bool; [[Defines whether to draw the larger arc or
                                 smaller arc joining two point.]]
          @in sweep: bool; [[Defines whether the arc will be drawn
                             counter-clockwise or clockwise from current point
                             to the end point taking into account the large_arc
                             property.]]
        }
      }
      append_arc {
        [[Append an arc that enclosed in the given rectangle (x, y, w, h).
          The angle is defined in counter clock wise , use -ve angle for clockwise arc.

          @since 1.18
        ]]
        params {
          @in x: double; [[X co-ordinate of the rect.]]
          @in y: double; [[Y co-ordinate of the rect.]]
          @in w: double; [[width of the rect.]]
          @in h: double; [[height of the rect.]]
          @in start_angle: double; [[Angle at which the arc will start]]
          @in sweep_length: double; [[@ Length of the arc.]]
        }
      }
      append_close {
        [[Closes the current subpath by drawing a line to the beginning of the
          subpath, automatically starting a new path. The current point of the
          new path is (0, 0).

          If the subpath does not contain any points, this function does nothing.

          @since 1.14
        ]]
      }
      append_circle {
        [[Append a circle with given center and radius.

          @since 1.14
        ]]
        params {
          @in x: double; [[X co-ordinate of the center of the circle.]]
          @in y: double; [[Y co-ordinate of the center of the circle.]]
          @in radius: double; [[radius of the circle.]]
        }
      }
      append_rect {
        [[Append the given rectangle with rounded corner to the path.

          The xr and yr arguments specify the radii of the ellipses defining the
          corners of the rounded rectangle.

          xr and yr are specified in terms of width and height respectively.

          If xr and yr are 0, then it will draw a rectangle without rounded
          corner.

          @since 1.14
        ]]
        params {
            @in x: double; [[X co-ordinate of the rectangle.]]
            @in y: double; [[Y co-ordinate of the rectangle.]]
            @in w: double; [[Width of the rectangle.]]
            @in h: double; [[Height of the rectangle.]]
            @in rx: double; [[The x radius of the rounded corner and should be
                              in range [ 0 to w/2 ]
                            ]]
            @in ry: double; [[The y radius of the rounded corner and should be
                              in range [ 0 to h/2 ]
                            ]]
        }
      }
      append_svg_path {
        params {
          @in svg_path_data: string;
        }
      }
      interpolate {
        return: bool;
        params {
          @in from: const(Efl.Object);
          @in to: const(Efl.Object);
          @in pos_map: double;
        }
      }
      equal_commands {
        return: bool;
        params {
          @in with: const(Efl.Object);
        }
      }
   }
}