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
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimppaths</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimp-image.html" title="Manupulating Images and all their Properties">
<link rel="prev" href="libgimp-gimplayer.html" title="gimplayer">
<link rel="next" href="libgimp-gimppixelfetcher.html" title="gimppixelfetcher">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="gimpdefinitions.html" title="Part I. GIMP Constants">
<link rel="part" href="libgimp.html" title="Part II. GIMP Library">
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and all their Properties">
<link rel="chapter" href="libgimp-data.html" title="Data Objects">
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
<link rel="part" href="libgimpui.html" title="Part III. GIMP User Interface Library">
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libgimp-gimplayer.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimp-image.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Library Reference Manual</th>
<td><a accesskey="n" href="libgimp-gimppixelfetcher.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2565123" class="shortcut">Top</a>
 | 
<a href="#id2600396" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgimp-gimppaths"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2565123"></a><span class="refentrytitle">gimppaths</span>
</h2>
<p>gimppaths — Operations related to paths.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
gchar** <a href="libgimp-gimppaths.html#gimp-path-list">gimp_path_list</a> (gint32 image_ID,
gint *num_paths);
gint <a href="libgimp-gimppaths.html#gimp-path-get-points">gimp_path_get_points</a> (gint32 image_ID,
const gchar *name,
gint *path_closed,
gint *num_path_point_details,
gdouble **points_pairs);
gchar* <a href="libgimp-gimppaths.html#gimp-path-get-current">gimp_path_get_current</a> (gint32 image_ID);
gboolean <a href="libgimp-gimppaths.html#gimp-path-set-current">gimp_path_set_current</a> (gint32 image_ID,
const gchar *name);
gboolean <a href="libgimp-gimppaths.html#gimp-path-set-points">gimp_path_set_points</a> (gint32 image_ID,
const gchar *name,
gint ptype,
gint num_path_points,
const gdouble *points_pairs);
gboolean <a href="libgimp-gimppaths.html#gimp-path-stroke-current">gimp_path_stroke_current</a> (gint32 image_ID);
gint <a href="libgimp-gimppaths.html#gimp-path-get-point-at-dist">gimp_path_get_point_at_dist</a> (gint32 image_ID,
gdouble distance,
gint *y_point,
gdouble *slope);
gint <a href="libgimp-gimppaths.html#gimp-path-get-tattoo">gimp_path_get_tattoo</a> (gint32 image_ID,
const gchar *name);
gchar* <a href="libgimp-gimppaths.html#gimp-get-path-by-tattoo">gimp_get_path_by_tattoo</a> (gint32 image_ID,
gint tattoo);
gboolean <a href="libgimp-gimppaths.html#gimp-path-delete">gimp_path_delete</a> (gint32 image_ID,
const gchar *name);
gint <a href="libgimp-gimppaths.html#gimp-path-get-locked">gimp_path_get_locked</a> (gint32 image_ID,
const gchar *name);
gboolean <a href="libgimp-gimppaths.html#gimp-path-set-locked">gimp_path_set_locked</a> (gint32 image_ID,
const gchar *name,
gint lockstatus);
gboolean <a href="libgimp-gimppaths.html#gimp-path-set-tattoo">gimp_path_set_tattoo</a> (gint32 image_ID,
const gchar *name,
gint tattovalue);
gboolean <a href="libgimp-gimppaths.html#gimp-path-to-selection">gimp_path_to_selection</a> (gint32 image_ID,
const gchar *name,
<a href="libgimp-gimpenums.html#GimpChannelOps">GimpChannelOps</a> op,
gboolean antialias,
gboolean feather,
gdouble feather_radius_x,
gdouble feather_radius_y);
gboolean <a href="libgimp-gimppaths.html#gimp-path-import">gimp_path_import</a> (gint32 image_ID,
const gchar *filename,
gboolean merge,
gboolean scale);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2600396"></a><h2>Description</h2>
<p>
Operations related to paths.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2600411"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2600422"></a><h3>
<a name="gimp-path-list"></a>gimp_path_list ()</h3>
<a class="indexterm" name="id2600435"></a><pre class="programlisting">gchar** gimp_path_list (gint32 image_ID,
gint *num_paths);</pre>
<p>
List the paths associated with the passed image.
</p>
<p>
List the paths associated with the passed image.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>
<td> The ID of the image to list the paths from.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>num_paths</code></em> :</span></td>
<td> The number of paths returned.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> List of the paths belonging to this image.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603257"></a><h3>
<a name="gimp-path-get-points"></a>gimp_path_get_points ()</h3>
<a class="indexterm" name="id2603268"></a><pre class="programlisting">gint gimp_path_get_points (gint32 image_ID,
const gchar *name,
gint *path_closed,
gint *num_path_point_details,
gdouble **points_pairs);</pre>
<p>
List the points associated with the named path.
</p>
<p>
List the points associated with the named path.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>
<td> The ID of the image to list the paths from.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> The name of the path whose points should be listed.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>path_closed</code></em> :</span></td>
<td> Return if the path is closed. (0 = path open, 1 = path closed).
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>num_path_point_details</code></em> :</span></td>
<td> The number of points returned. Each point is made up of (x, y, pnt_type) of floats.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>points_pairs</code></em> :</span></td>
<td> The points in the path represented as 3 floats. The first is the x pos, next is the y pos, last is the type of the pnt. The type field is dependant on the path type. For beziers (type 1 paths) the type can either be (1.0 = BEZIER_ANCHOR, 2.0 = BEZIER_CONTROL, 3.0 = BEZIER_MOVE). Note all points are returned in pixel resolution.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The type of the path. Currently only one type (1 = Bezier) is supported.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603427"></a><h3>
<a name="gimp-path-get-current"></a>gimp_path_get_current ()</h3>
<a class="indexterm" name="id2603438"></a><pre class="programlisting">gchar* gimp_path_get_current (gint32 image_ID);</pre>
<p>
The name of the current path. Error if no paths.
</p>
<p>
The name of the current path. Error if no paths.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>
<td> The ID of the image to get the current path from.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The name of the current path.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2603503"></a><h3>
<a name="gimp-path-set-current"></a>gimp_path_set_current ()</h3>
<a class="indexterm" name="id2608546"></a><pre class="programlisting">gboolean gimp_path_set_current (gint32 image_ID,
const gchar *name);</pre>
<p>
Sets the current path associated with the passed image.
</p>
<p>
Sets a named path as the current path.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>
<td> The ID of the image in which a path will become current.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> The name of the path to make current.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2608631"></a><h3>
<a name="gimp-path-set-points"></a>gimp_path_set_points ()</h3>
<a class="indexterm" name="id2608642"></a><pre class="programlisting">gboolean gimp_path_set_points (gint32 image_ID,
const gchar *name,
gint ptype,
gint num_path_points,
const gdouble *points_pairs);</pre>
<p>
Set the points associated with the named path.
</p>
<p>
Set the points associated with the named path.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>
<td> The ID of the image to set the paths in.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> The name of the path to create. If it exists then a unique name will be created - query the list of paths if you want to make sure that the name of the path you create is unique. This will be set as the current path.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>ptype</code></em> :</span></td>
<td> The type of the path. Currently only one type (1 = Bezier) is supported.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>num_path_points</code></em> :</span></td>
<td> The number of elements in the array, i.e. the number of points in the path * 3. Each point is made up of (x, y, type) of floats. Currently only the creation of bezier curves is allowed. The type parameter must be set to (1) to indicate a BEZIER type curve. Note that for BEZIER curves, points must be given in the following order: ACCACCAC... If the path is not closed the last control point is missed off. Points consist of three control points (control/anchor/control) so for a curve that is not closed there must be at least two points passed (2 x,y pairs). If (num_path_points/3) % 3 = 0 then the path is assumed to be closed and the points are ACCACCACCACC.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>points_pairs</code></em> :</span></td>
<td> The points in the path represented as 3 floats. The first is the x pos, next is the y pos, last is the type of the pnt. The type field is dependant on the path type. For beziers (type 1 paths) the type can either be (1.0 = BEZIER_ANCHOR, 2.0 = BEZIER_CONTROL, 3.0= BEZIER_MOVE). Note all points are returned in pixel resolution.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2608789"></a><h3>
<a name="gimp-path-stroke-current"></a>gimp_path_stroke_current ()</h3>
<a class="indexterm" name="id2608800"></a><pre class="programlisting">gboolean gimp_path_stroke_current (gint32 image_ID);</pre>
<p>
Stroke the current path in the passed image.
</p>
<p>
Stroke the current path in the passed image.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>
<td> The ID of the image which contains the path to stroke.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2608866"></a><h3>
<a name="gimp-path-get-point-at-dist"></a>gimp_path_get_point_at_dist ()</h3>
<a class="indexterm" name="id2608877"></a><pre class="programlisting">gint gimp_path_get_point_at_dist (gint32 image_ID,
gdouble distance,
gint *y_point,
gdouble *slope);</pre>
<p>
Get point on a path at a specified distance along the path.
</p>
<p>
This will return the x,y position of a point at a given distance
along the bezier curve. The distance will be obtained by first
digitizing the curve internally and then walking along the curve.
For a closed curve the start of the path is the first point on the
path that was created. This might not be obvious. Note the current
path is used.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>
<td> The ID of the image the paths belongs to.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>distance</code></em> :</span></td>
<td> The distance along the path.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>y_point</code></em> :</span></td>
<td> The y position of the point.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>slope</code></em> :</span></td>
<td> The slope (dy / dx) at the specified point.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The x position of the point.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609010"></a><h3>
<a name="gimp-path-get-tattoo"></a>gimp_path_get_tattoo ()</h3>
<a class="indexterm" name="id2609021"></a><pre class="programlisting">gint gimp_path_get_tattoo (gint32 image_ID,
const gchar *name);</pre>
<p>
Returns the tattoo associated with the name path.
</p>
<p>
This procedure returns the tattoo associated with the specified
path. A tattoo is a unique and permanent identifier attached to a
path that can be used to uniquely identify a path within an image
even between sessions.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>
<td> The image.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> The name of the path whose tattoo should be obtained.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The tattoo associated with the named path.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609110"></a><h3>
<a name="gimp-get-path-by-tattoo"></a>gimp_get_path_by_tattoo ()</h3>
<a class="indexterm" name="id2609122"></a><pre class="programlisting">gchar* gimp_get_path_by_tattoo (gint32 image_ID,
gint tattoo);</pre>
<p>
Return the name of the path with the given tattoo.
</p>
<p>
The procedure returns the name of the path in the specified image
which has the passed tattoo. The tattoos are unique within the image
and will be preserved across sessions and through renaming of the
path. An error is returned if no path with the specified tattoo can
be found.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>
<td> The image.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>tattoo</code></em> :</span></td>
<td> The tattoo of the required path.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The name of the path with the specified tattoo.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609212"></a><h3>
<a name="gimp-path-delete"></a>gimp_path_delete ()</h3>
<a class="indexterm" name="id2609225"></a><pre class="programlisting">gboolean gimp_path_delete (gint32 image_ID,
const gchar *name);</pre>
<p>
Delete the named path associated with the passed image.
</p>
<p>
Delete the named path.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>
<td> The ID of the image to delete the path from.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> The name of the path to delete.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609311"></a><h3>
<a name="gimp-path-get-locked"></a>gimp_path_get_locked ()</h3>
<a class="indexterm" name="id2609322"></a><pre class="programlisting">gint gimp_path_get_locked (gint32 image_ID,
const gchar *name);</pre>
<p>
Returns the locked status associated with the named path.
</p>
<p>
This procedure returns the lock status associated with the specified
path. A path can be \"locked\" which means that the transformation
tool operations will also apply to the path.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>
<td> The image.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> The name of the path whose locked status should be obtained.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The lock status associated with the name path. 0 is returned if the path is not locked. 1 is returned if the path is locked.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2602045"></a><h3>
<a name="gimp-path-set-locked"></a>gimp_path_set_locked ()</h3>
<a class="indexterm" name="id2602056"></a><pre class="programlisting">gboolean gimp_path_set_locked (gint32 image_ID,
const gchar *name,
gint lockstatus);</pre>
<p>
Set the locked status associated with the named path.
</p>
<p>
This procedure sets the lock status associated with the specified
path. A path can be \"locked\" which means that the transformation
tool operations will also apply to the path.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>
<td> The image.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> the name of the path whose locked status should be set.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>lockstatus</code></em> :</span></td>
<td> The lock status associated with the name path. 0 if the path is not locked. 1 if the path is to be locked.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2602168"></a><h3>
<a name="gimp-path-set-tattoo"></a>gimp_path_set_tattoo ()</h3>
<a class="indexterm" name="id2602179"></a><pre class="programlisting">gboolean gimp_path_set_tattoo (gint32 image_ID,
const gchar *name,
gint tattovalue);</pre>
<p>
Sets the tattoo associated with the named path.
</p>
<p>
This procedure sets the tattoo associated with the specified path. A
tattoo is a unique and permenant identifier attached to a path that
can be used to uniquely identify a path within an image even between
sessions. Note that the value passed to this function must have been
obtained from a previous call to path_get_tattoo.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>
<td> The image.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> the name of the path whose tattoo should be set.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>tattovalue</code></em> :</span></td>
<td> The tattoo associated with the name path. Only values returned from 'path_get_tattoo' should be used here.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2602294"></a><h3>
<a name="gimp-path-to-selection"></a>gimp_path_to_selection ()</h3>
<a class="indexterm" name="id2602305"></a><pre class="programlisting">gboolean gimp_path_to_selection (gint32 image_ID,
const gchar *name,
<a href="libgimp-gimpenums.html#GimpChannelOps">GimpChannelOps</a> op,
gboolean antialias,
gboolean feather,
gdouble feather_radius_x,
gdouble feather_radius_y);</pre>
<p>
Transforms the active path into a selection
</p>
<p>
This procedure renders the desired path into the current selection.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>
<td> The image.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> The name of the path which should be made into selection.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>op</code></em> :</span></td>
<td> The desired operation with current selection.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>antialias</code></em> :</span></td>
<td> Antialias selection.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>feather</code></em> :</span></td>
<td> Feather selection.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>feather_radius_x</code></em> :</span></td>
<td> Feather radius x.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>feather_radius_y</code></em> :</span></td>
<td> Feather radius y.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2602499"></a><h3>
<a name="gimp-path-import"></a>gimp_path_import ()</h3>
<a class="indexterm" name="id2602511"></a><pre class="programlisting">gboolean gimp_path_import (gint32 image_ID,
const gchar *filename,
gboolean merge,
gboolean scale);</pre>
<p>
Import paths from an SVG file.
</p>
<p>
This procedure imports paths from an SVG file. This is a temporary
solution until the new vectors PDB API is in place. Don't rely on
this function being available in future GIMP releases.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>
<td> The image.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>filename</code></em> :</span></td>
<td> The name of the SVG file to import.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>merge</code></em> :</span></td>
<td> Merge paths into a single vectors object.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>scale</code></em> :</span></td>
<td> Scale the SVG to image dimensions.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>
|
