4
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
5
<title>gimppaths</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
6
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
7
7
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
8
<link rel="up" href="libgimp-image.html" title="Manupulating Images and all their Properties">
8
<link rel="up" href="libgimp-image.html" title="Manupulating Images and their Properties">
9
9
<link rel="prev" href="libgimp-gimplayer.html" title="gimplayer">
10
10
<link rel="next" href="libgimp-gimppixelfetcher.html" title="gimppixelfetcher">
11
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
<link rel="part" href="gimpdefinitions.html" title="Part I. GIMP Constants">
14
<link rel="part" href="libgimp.html" title="Part II. GIMP Library">
13
<link rel="part" href="libgimp.html" title="Part I. GIMP Library">
15
14
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
16
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and all their Properties">
15
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and their Properties">
17
16
<link rel="chapter" href="libgimp-data.html" title="Data Objects">
18
17
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
19
<link rel="part" href="libgimpui.html" title="Part III. GIMP User Interface Library">
18
<link rel="part" href="libgimpui.html" title="Part II. GIMP User Interface Library">
20
19
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
20
<link rel="index" href="libgimp-index.html" title="Index">
21
<link rel="index" href="libgimp-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
22
<link rel="index" href="libgimp-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
23
<link rel="index" href="libgimp-index-deprecated.html" title="Index of deprecated symbols">
22
25
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
23
26
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
28
31
<th width="100%" align="center">GIMP Library Reference Manual</th>
29
32
<td><a accesskey="n" href="libgimp-gimppixelfetcher.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
31
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2565123" class="shortcut">Top</a>
34
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2569944" class="shortcut">Top</a>
33
<a href="#id2600396" class="shortcut">Description</a></nobr></td></tr>
36
<a href="#id2643103" class="shortcut">Description</a></nobr></td></tr>
35
38
<div class="refentry" lang="en">
36
39
<a name="libgimp-gimppaths"></a><div class="titlepage"></div>
37
40
<div class="refnamediv"><table width="100%"><tr>
40
<a name="id2565123"></a><span class="refentrytitle">gimppaths</span>
43
<a name="id2569944"></a><span class="refentrytitle">gimppaths</span>
42
45
<p>gimppaths — Operations related to paths.</p>
52
gchar** <a href="libgimp-gimppaths.html#gimp-path-list">gimp_path_list</a> (gint32 image_ID,
54
gint <a href="libgimp-gimppaths.html#gimp-path-get-points">gimp_path_get_points</a> (gint32 image_ID,
57
gint *num_path_point_details,
58
gdouble **points_pairs);
59
gchar* <a href="libgimp-gimppaths.html#gimp-path-get-current">gimp_path_get_current</a> (gint32 image_ID);
60
gboolean <a href="libgimp-gimppaths.html#gimp-path-set-current">gimp_path_set_current</a> (gint32 image_ID,
62
gboolean <a href="libgimp-gimppaths.html#gimp-path-set-points">gimp_path_set_points</a> (gint32 image_ID,
66
const gdouble *points_pairs);
67
gboolean <a href="libgimp-gimppaths.html#gimp-path-stroke-current">gimp_path_stroke_current</a> (gint32 image_ID);
68
gint <a href="libgimp-gimppaths.html#gimp-path-get-point-at-dist">gimp_path_get_point_at_dist</a> (gint32 image_ID,
72
gint <a href="libgimp-gimppaths.html#gimp-path-get-tattoo">gimp_path_get_tattoo</a> (gint32 image_ID,
74
gchar* <a href="libgimp-gimppaths.html#gimp-get-path-by-tattoo">gimp_get_path_by_tattoo</a> (gint32 image_ID,
76
gboolean <a href="libgimp-gimppaths.html#gimp-path-delete">gimp_path_delete</a> (gint32 image_ID,
78
gint <a href="libgimp-gimppaths.html#gimp-path-get-locked">gimp_path_get_locked</a> (gint32 image_ID,
80
gboolean <a href="libgimp-gimppaths.html#gimp-path-set-locked">gimp_path_set_locked</a> (gint32 image_ID,
83
gboolean <a href="libgimp-gimppaths.html#gimp-path-set-tattoo">gimp_path_set_tattoo</a> (gint32 image_ID,
86
gboolean <a href="libgimp-gimppaths.html#gimp-path-to-selection">gimp_path_to_selection</a> (gint32 image_ID,
88
<a href="libgimp-gimpenums.html#GimpChannelOps">GimpChannelOps</a> op,
91
gdouble feather_radius_x,
92
gdouble feather_radius_y);
93
gboolean <a href="libgimp-gimppaths.html#gimp-path-import">gimp_path_import</a> (gint32 image_ID,
94
const gchar *filename,
55
gchar** <a href="libgimp-gimppaths.html#gimp-path-list">gimp_path_list</a> (gint32 image_ID,
57
gint <a href="libgimp-gimppaths.html#gimp-path-get-points">gimp_path_get_points</a> (gint32 image_ID,
60
gint *num_path_point_details,
61
gdouble **points_pairs);
62
gchar* <a href="libgimp-gimppaths.html#gimp-path-get-current">gimp_path_get_current</a> (gint32 image_ID);
63
gboolean <a href="libgimp-gimppaths.html#gimp-path-set-current">gimp_path_set_current</a> (gint32 image_ID,
65
gboolean <a href="libgimp-gimppaths.html#gimp-path-set-points">gimp_path_set_points</a> (gint32 image_ID,
69
const gdouble *points_pairs);
70
gboolean <a href="libgimp-gimppaths.html#gimp-path-stroke-current">gimp_path_stroke_current</a> (gint32 image_ID);
71
gint <a href="libgimp-gimppaths.html#gimp-path-get-point-at-dist">gimp_path_get_point_at_dist</a> (gint32 image_ID,
75
gint <a href="libgimp-gimppaths.html#gimp-path-get-tattoo">gimp_path_get_tattoo</a> (gint32 image_ID,
77
gchar* <a href="libgimp-gimppaths.html#gimp-get-path-by-tattoo">gimp_get_path_by_tattoo</a> (gint32 image_ID,
79
gboolean <a href="libgimp-gimppaths.html#gimp-path-delete">gimp_path_delete</a> (gint32 image_ID,
81
gboolean <a href="libgimp-gimppaths.html#gimp-path-get-locked">gimp_path_get_locked</a> (gint32 image_ID,
83
gboolean <a href="libgimp-gimppaths.html#gimp-path-set-locked">gimp_path_set_locked</a> (gint32 image_ID,
86
gboolean <a href="libgimp-gimppaths.html#gimp-path-set-tattoo">gimp_path_set_tattoo</a> (gint32 image_ID,
89
gboolean <a href="libgimp-gimppaths.html#gimp-path-to-selection">gimp_path_to_selection</a> (gint32 image_ID,
92
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpChannelOps"
93
>GimpChannelOps</a> op,
96
gdouble feather_radius_x,
97
gdouble feather_radius_y);
98
gboolean <a href="libgimp-gimppaths.html#gimp-path-import">gimp_path_import</a> (gint32 image_ID,
99
const gchar *filename,
99
104
<div class="refsect1" lang="en">
100
<a name="id2600396"></a><h2>Description</h2>
105
<a name="id2643103"></a><h2>Description</h2>
102
107
Operations related to paths.
105
110
<div class="refsect1" lang="en">
106
<a name="id2600411"></a><h2>Details</h2>
111
<a name="id2639644"></a><h2>Details</h2>
107
112
<div class="refsect2" lang="en">
108
<a name="id2600422"></a><h3>
113
<a name="id2639654"></a><h3>
109
114
<a name="gimp-path-list"></a>gimp_path_list ()</h3>
110
<a class="indexterm" name="id2600435"></a><pre class="programlisting">gchar** gimp_path_list (gint32 image_ID,
111
gint *num_paths);</pre>
113
List the paths associated with the passed image.
116
List the paths associated with the passed image.</p>
115
<a class="indexterm" name="id2639669"></a><pre class="programlisting">gchar** gimp_path_list (gint32 image_ID,
116
gint *num_paths);</pre>
117
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
118
<h3 class="title">Warning</h3>
119
<p><code class="literal">gimp_path_list</code> is deprecated and should not be used in newly-written code.</p>
122
This procedure is deprecated! Use <a href="libgimp-gimpimage.html#gimp-image-get-vectors"><code class="function">gimp_image_get_vectors()</code></a> instead.</p>
145
148
<div class="refsect2" lang="en">
146
<a name="id2603257"></a><h3>
149
<a name="id2639773"></a><h3>
147
150
<a name="gimp-path-get-points"></a>gimp_path_get_points ()</h3>
148
<a class="indexterm" name="id2603268"></a><pre class="programlisting">gint gimp_path_get_points (gint32 image_ID,
151
gint *num_path_point_details,
152
gdouble **points_pairs);</pre>
154
List the points associated with the named path.
157
List the points associated with the named path.</p>
151
<a class="indexterm" name="id2639786"></a><pre class="programlisting">gint gimp_path_get_points (gint32 image_ID,
154
gint *num_path_point_details,
155
gdouble **points_pairs);</pre>
156
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
157
<h3 class="title">Warning</h3>
158
<p><code class="literal">gimp_path_get_points</code> is deprecated and should not be used in newly-written code.</p>
161
This procedure is deprecated! Use <a href="libgimp-gimpvectors.html#gimp-vectors-stroke-get-points"><code class="function">gimp_vectors_stroke_get_points()</code></a>
162
167
<col align="left" valign="top">
166
<span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>
167
<td> The ID of the image to list the paths from.
170
<td><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>
171
<td> The image to list the paths from.
172
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
175
<td><span class="term"><em class="parameter"><code>name</code></em> :</span></td>
173
176
<td> The name of the path whose points should be listed.
178
<span class="term"><em class="parameter"><code>path_closed</code></em> :</span></td>
180
<td><span class="term"><em class="parameter"><code>path_closed</code></em> :</span></td>
179
181
<td> Return if the path is closed. (0 = path open, 1 = path closed).
184
<span class="term"><em class="parameter"><code>num_path_point_details</code></em> :</span></td>
185
<td><span class="term"><em class="parameter"><code>num_path_point_details</code></em> :</span></td>
185
186
<td> The number of points returned. Each point is made up of (x, y, pnt_type) of floats.
190
<span class="term"><em class="parameter"><code>points_pairs</code></em> :</span></td>
190
<td><span class="term"><em class="parameter"><code>points_pairs</code></em> :</span></td>
191
191
<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.
196
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
195
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
197
196
<td> The type of the path. Currently only one type (1 = Bezier) is supported.
204
203
<div class="refsect2" lang="en">
205
<a name="id2603427"></a><h3>
204
<a name="id2639962"></a><h3>
206
205
<a name="gimp-path-get-current"></a>gimp_path_get_current ()</h3>
207
<a class="indexterm" name="id2603438"></a><pre class="programlisting">gchar* gimp_path_get_current (gint32 image_ID);</pre>
209
The name of the current path. Error if no paths.
212
The name of the current path. Error if no paths.</p>
206
<a class="indexterm" name="id2639975"></a><pre class="programlisting">gchar* gimp_path_get_current (gint32 image_ID);</pre>
207
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
208
<h3 class="title">Warning</h3>
209
<p><code class="literal">gimp_path_get_current</code> is deprecated and should not be used in newly-written code.</p>
212
This procedure is deprecated! Use <a href="libgimp-gimpimage.html#gimp-image-get-active-vectors"><code class="function">gimp_image_get_active_vectors()</code></a>
235
234
<div class="refsect2" lang="en">
236
<a name="id2603503"></a><h3>
235
<a name="id2640312"></a><h3>
237
236
<a name="gimp-path-set-current"></a>gimp_path_set_current ()</h3>
238
<a class="indexterm" name="id2608546"></a><pre class="programlisting">gboolean gimp_path_set_current (gint32 image_ID,
239
const gchar *name);</pre>
241
Sets the current path associated with the passed image.
244
Sets a named path as the current path.</p>
237
<a class="indexterm" name="id2640325"></a><pre class="programlisting">gboolean gimp_path_set_current (gint32 image_ID,
238
const gchar *name);</pre>
239
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
240
<h3 class="title">Warning</h3>
241
<p><code class="literal">gimp_path_set_current</code> is deprecated and should not be used in newly-written code.</p>
244
This procedure is deprecated! Use <a href="libgimp-gimpimage.html#gimp-image-set-active-vectors"><code class="function">gimp_image_set_active_vectors()</code></a>
273
271
<div class="refsect2" lang="en">
274
<a name="id2608631"></a><h3>
272
<a name="id2640428"></a><h3>
275
273
<a name="gimp-path-set-points"></a>gimp_path_set_points ()</h3>
276
<a class="indexterm" name="id2608642"></a><pre class="programlisting">gboolean gimp_path_set_points (gint32 image_ID,
279
gint num_path_points,
280
const gdouble *points_pairs);</pre>
282
Set the points associated with the named path.
285
Set the points associated with the named path.</p>
274
<a class="indexterm" name="id2640442"></a><pre class="programlisting">gboolean gimp_path_set_points (gint32 image_ID,
277
gint num_path_points,
278
const gdouble *points_pairs);</pre>
279
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
280
<h3 class="title">Warning</h3>
281
<p><code class="literal">gimp_path_set_points</code> is deprecated and should not be used in newly-written code.</p>
284
This procedure is deprecated! Use <code class="function">vectors_stroke_new_from_points()</code>
290
290
<col align="left" valign="top">
294
<span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>
295
<td> The ID of the image to set the paths in.
293
<td><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>
294
<td> The image to set the paths in.
300
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
298
<td><span class="term"><em class="parameter"><code>name</code></em> :</span></td>
301
299
<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.
306
<span class="term"><em class="parameter"><code>ptype</code></em> :</span></td>
303
<td><span class="term"><em class="parameter"><code>ptype</code></em> :</span></td>
307
304
<td> The type of the path. Currently only one type (1 = Bezier) is supported.
312
<span class="term"><em class="parameter"><code>num_path_points</code></em> :</span></td>
308
<td><span class="term"><em class="parameter"><code>num_path_points</code></em> :</span></td>
313
309
<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.
318
<span class="term"><em class="parameter"><code>points_pairs</code></em> :</span></td>
313
<td><span class="term"><em class="parameter"><code>points_pairs</code></em> :</span></td>
319
314
<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.
324
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
318
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
325
319
<td> TRUE on success.
332
326
<div class="refsect2" lang="en">
333
<a name="id2608789"></a><h3>
327
<a name="id2640629"></a><h3>
334
328
<a name="gimp-path-stroke-current"></a>gimp_path_stroke_current ()</h3>
335
<a class="indexterm" name="id2608800"></a><pre class="programlisting">gboolean gimp_path_stroke_current (gint32 image_ID);</pre>
337
Stroke the current path in the passed image.
340
Stroke the current path in the passed image.</p>
329
<a class="indexterm" name="id2640642"></a><pre class="programlisting">gboolean gimp_path_stroke_current (gint32 image_ID);</pre>
330
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
331
<h3 class="title">Warning</h3>
332
<p><code class="literal">gimp_path_stroke_current</code> is deprecated and should not be used in newly-written code.</p>
335
This procedure is deprecated! Use <a href="libgimp-gimpedit.html#gimp-edit-stroke-vectors"><code class="function">gimp_edit_stroke_vectors()</code></a>
363
357
<div class="refsect2" lang="en">
364
<a name="id2608866"></a><h3>
358
<a name="id2640724"></a><h3>
365
359
<a name="gimp-path-get-point-at-dist"></a>gimp_path_get_point_at_dist ()</h3>
366
<a class="indexterm" name="id2608877"></a><pre class="programlisting">gint gimp_path_get_point_at_dist (gint32 image_ID,
369
gdouble *slope);</pre>
371
Get point on a path at a specified distance along the path.
374
This will return the x,y position of a point at a given distance
375
along the bezier curve. The distance will be obtained by first
376
digitizing the curve internally and then walking along the curve.
377
For a closed curve the start of the path is the first point on the
378
path that was created. This might not be obvious. Note the current
360
<a class="indexterm" name="id2640737"></a><pre class="programlisting">gint gimp_path_get_point_at_dist (gint32 image_ID,
363
gdouble *slope);</pre>
364
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
365
<h3 class="title">Warning</h3>
366
<p><code class="literal">gimp_path_get_point_at_dist</code> is deprecated and should not be used in newly-written code.</p>
369
This procedure is deprecated! Use
370
<a href="libgimp-gimpvectors.html#gimp-vectors-stroke-get-point-at-dist"><code class="function">gimp_vectors_stroke_get_point_at_dist()</code></a> instead.</p>
384
375
<col align="left" valign="top">
388
<span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>
389
<td> The ID of the image the paths belongs to.
378
<td><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>
379
<td> The image the paths belongs to.
394
<span class="term"><em class="parameter"><code>distance</code></em> :</span></td>
383
<td><span class="term"><em class="parameter"><code>distance</code></em> :</span></td>
395
384
<td> The distance along the path.
400
<span class="term"><em class="parameter"><code>y_point</code></em> :</span></td>
388
<td><span class="term"><em class="parameter"><code>y_point</code></em> :</span></td>
401
389
<td> The y position of the point.
406
<span class="term"><em class="parameter"><code>slope</code></em> :</span></td>
393
<td><span class="term"><em class="parameter"><code>slope</code></em> :</span></td>
407
394
<td> The slope (dy / dx) at the specified point.
412
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
398
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
413
399
<td> The x position of the point.
420
406
<div class="refsect2" lang="en">
421
<a name="id2609010"></a><h3>
407
<a name="id2640883"></a><h3>
422
408
<a name="gimp-path-get-tattoo"></a>gimp_path_get_tattoo ()</h3>
423
<a class="indexterm" name="id2609021"></a><pre class="programlisting">gint gimp_path_get_tattoo (gint32 image_ID,
424
const gchar *name);</pre>
426
Returns the tattoo associated with the name path.
429
This procedure returns the tattoo associated with the specified
430
path. A tattoo is a unique and permanent identifier attached to a
431
path that can be used to uniquely identify a path within an image
432
even between sessions.</p>
409
<a class="indexterm" name="id2640896"></a><pre class="programlisting">gint gimp_path_get_tattoo (gint32 image_ID,
410
const gchar *name);</pre>
411
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
412
<h3 class="title">Warning</h3>
413
<p><code class="literal">gimp_path_get_tattoo</code> is deprecated and should not be used in newly-written code.</p>
416
This procedure is deprecated! Use <a href="libgimp-gimpvectors.html#gimp-vectors-get-tattoo"><code class="function">gimp_vectors_get_tattoo()</code></a> instead.</p>
461
442
<div class="refsect2" lang="en">
462
<a name="id2609110"></a><h3>
443
<a name="id2641001"></a><h3>
463
444
<a name="gimp-get-path-by-tattoo"></a>gimp_get_path_by_tattoo ()</h3>
464
<a class="indexterm" name="id2609122"></a><pre class="programlisting">gchar* gimp_get_path_by_tattoo (gint32 image_ID,
467
Return the name of the path with the given tattoo.
470
The procedure returns the name of the path in the specified image
471
which has the passed tattoo. The tattoos are unique within the image
472
and will be preserved across sessions and through renaming of the
473
path. An error is returned if no path with the specified tattoo can
445
<a class="indexterm" name="id2641014"></a><pre class="programlisting">gchar* gimp_get_path_by_tattoo (gint32 image_ID,
447
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
448
<h3 class="title">Warning</h3>
449
<p><code class="literal">gimp_get_path_by_tattoo</code> is deprecated and should not be used in newly-written code.</p>
452
This procedure is deprecated! Use <a
453
href="../app/GimpImage.html#gimp-image-get-vectors-by-tattoo"
454
><code class="function">gimp_image_get_vectors_by_tattoo()</code></a>
503
481
<div class="refsect2" lang="en">
504
<a name="id2609212"></a><h3>
482
<a name="id2641120"></a><h3>
505
483
<a name="gimp-path-delete"></a>gimp_path_delete ()</h3>
506
<a class="indexterm" name="id2609225"></a><pre class="programlisting">gboolean gimp_path_delete (gint32 image_ID,
507
const gchar *name);</pre>
509
Delete the named path associated with the passed image.
512
Delete the named path.</p>
484
<a class="indexterm" name="id2641135"></a><pre class="programlisting">gboolean gimp_path_delete (gint32 image_ID,
485
const gchar *name);</pre>
486
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
487
<h3 class="title">Warning</h3>
488
<p><code class="literal">gimp_path_delete</code> is deprecated and should not be used in newly-written code.</p>
491
This procedure is deprecated! Use <a href="libgimp-gimpimage.html#gimp-image-remove-vectors"><code class="function">gimp_image_remove_vectors()</code></a>
541
518
<div class="refsect2" lang="en">
542
<a name="id2609311"></a><h3>
519
<a name="id2648687"></a><h3>
543
520
<a name="gimp-path-get-locked"></a>gimp_path_get_locked ()</h3>
544
<a class="indexterm" name="id2609322"></a><pre class="programlisting">gint gimp_path_get_locked (gint32 image_ID,
545
const gchar *name);</pre>
547
Returns the locked status associated with the named path.
550
This procedure returns the lock status associated with the specified
551
path. A path can be \"locked\" which means that the transformation
552
tool operations will also apply to the path.</p>
521
<a class="indexterm" name="id2648700"></a><pre class="programlisting">gboolean gimp_path_get_locked (gint32 image_ID,
522
const gchar *name);</pre>
523
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
524
<h3 class="title">Warning</h3>
525
<p><code class="literal">gimp_path_get_locked</code> is deprecated and should not be used in newly-written code.</p>
528
This procedure is deprecated! Use <a href="libgimp-gimpvectors.html#gimp-vectors-get-linked"><code class="function">gimp_vectors_get_linked()</code></a> instead.</p>
581
554
<div class="refsect2" lang="en">
582
<a name="id2602045"></a><h3>
555
<a name="id2648805"></a><h3>
583
556
<a name="gimp-path-set-locked"></a>gimp_path_set_locked ()</h3>
584
<a class="indexterm" name="id2602056"></a><pre class="programlisting">gboolean gimp_path_set_locked (gint32 image_ID,
586
gint lockstatus);</pre>
588
Set the locked status associated with the named path.
591
This procedure sets the lock status associated with the specified
592
path. A path can be \"locked\" which means that the transformation
593
tool operations will also apply to the path.</p>
557
<a class="indexterm" name="id2648819"></a><pre class="programlisting">gboolean gimp_path_set_locked (gint32 image_ID,
559
gboolean locked);</pre>
560
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
561
<h3 class="title">Warning</h3>
562
<p><code class="literal">gimp_path_set_locked</code> is deprecated and should not be used in newly-written code.</p>
565
This procedure is deprecated! Use <a href="libgimp-gimpvectors.html#gimp-vectors-set-linked"><code class="function">gimp_vectors_set_linked()</code></a> instead.</p>
598
570
<col align="left" valign="top">
602
<span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>
573
<td><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>
608
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
578
<td><span class="term"><em class="parameter"><code>name</code></em> :</span></td>
609
579
<td> the name of the path whose locked status should be set.
614
<span class="term"><em class="parameter"><code>lockstatus</code></em> :</span></td>
615
<td> The lock status associated with the name path. 0 if the path is not locked. 1 if the path is to be locked.
583
<td><span class="term"><em class="parameter"><code>locked</code></em> :</span></td>
584
<td> Whether the path is locked.
620
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
588
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
621
589
<td> TRUE on success.
628
596
<div class="refsect2" lang="en">
629
<a name="id2602168"></a><h3>
597
<a name="id2648944"></a><h3>
630
598
<a name="gimp-path-set-tattoo"></a>gimp_path_set_tattoo ()</h3>
631
<a class="indexterm" name="id2602179"></a><pre class="programlisting">gboolean gimp_path_set_tattoo (gint32 image_ID,
633
gint tattovalue);</pre>
635
Sets the tattoo associated with the named path.
638
This procedure sets the tattoo associated with the specified path. A
639
tattoo is a unique and permenant identifier attached to a path that
640
can be used to uniquely identify a path within an image even between
641
sessions. Note that the value passed to this function must have been
642
obtained from a previous call to path_get_tattoo.</p>
599
<a class="indexterm" name="id2648958"></a><pre class="programlisting">gboolean gimp_path_set_tattoo (gint32 image_ID,
601
gint tattovalue);</pre>
602
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
603
<h3 class="title">Warning</h3>
604
<p><code class="literal">gimp_path_set_tattoo</code> is deprecated and should not be used in newly-written code.</p>
607
This procedure is deprecated! Use <a href="libgimp-gimpvectors.html#gimp-vectors-set-tattoo"><code class="function">gimp_vectors_set_tattoo()</code></a> instead.</p>
677
638
<div class="refsect2" lang="en">
678
<a name="id2602294"></a><h3>
639
<a name="id2649085"></a><h3>
679
640
<a name="gimp-path-to-selection"></a>gimp_path_to_selection ()</h3>
680
<a class="indexterm" name="id2602305"></a><pre class="programlisting">gboolean gimp_path_to_selection (gint32 image_ID,
682
<a href="libgimp-gimpenums.html#GimpChannelOps">GimpChannelOps</a> op,
685
gdouble feather_radius_x,
686
gdouble feather_radius_y);</pre>
688
Transforms the active path into a selection
691
This procedure renders the desired path into the current selection.</p>
641
<a class="indexterm" name="id2649098"></a><pre class="programlisting">gboolean gimp_path_to_selection (gint32 image_ID,
644
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpChannelOps"
645
>GimpChannelOps</a> op,
648
gdouble feather_radius_x,
649
gdouble feather_radius_y);</pre>
650
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
651
<h3 class="title">Warning</h3>
652
<p><code class="literal">gimp_path_to_selection</code> is deprecated and should not be used in newly-written code.</p>
655
This procedure is deprecated! Use <a href="libgimp-gimpvectors.html#gimp-vectors-to-selection"><code class="function">gimp_vectors_to_selection()</code></a>
696
661
<col align="left" valign="top">
700
<span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>
664
<td><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>
706
<span class="term"><em class="parameter"><code>name</code></em> :</span></td>
669
<td><span class="term"><em class="parameter"><code>name</code></em> :</span></td>
707
670
<td> The name of the path which should be made into selection.
712
<span class="term"><em class="parameter"><code>op</code></em> :</span></td>
674
<td><span class="term"><em class="parameter"><code>op</code></em> :</span></td>
713
675
<td> The desired operation with current selection.
718
<span class="term"><em class="parameter"><code>antialias</code></em> :</span></td>
679
<td><span class="term"><em class="parameter"><code>antialias</code></em> :</span></td>
719
680
<td> Antialias selection.
724
<span class="term"><em class="parameter"><code>feather</code></em> :</span></td>
684
<td><span class="term"><em class="parameter"><code>feather</code></em> :</span></td>
725
685
<td> Feather selection.
730
<span class="term"><em class="parameter"><code>feather_radius_x</code></em> :</span></td>
689
<td><span class="term"><em class="parameter"><code>feather_radius_x</code></em> :</span></td>
731
690
<td> Feather radius x.
736
<span class="term"><em class="parameter"><code>feather_radius_y</code></em> :</span></td>
694
<td><span class="term"><em class="parameter"><code>feather_radius_y</code></em> :</span></td>
737
695
<td> Feather radius y.
742
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
699
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
743
700
<td> TRUE on success.
750
707
<div class="refsect2" lang="en">
751
<a name="id2602499"></a><h3>
708
<a name="id2649310"></a><h3>
752
709
<a name="gimp-path-import"></a>gimp_path_import ()</h3>
753
<a class="indexterm" name="id2602511"></a><pre class="programlisting">gboolean gimp_path_import (gint32 image_ID,
754
const gchar *filename,
756
gboolean scale);</pre>
758
Import paths from an SVG file.
761
This procedure imports paths from an SVG file. This is a temporary
762
solution until the new vectors PDB API is in place. Don't rely on
763
this function being available in future GIMP releases.</p>
710
<a class="indexterm" name="id2649324"></a><pre class="programlisting">gboolean gimp_path_import (gint32 image_ID,
711
const gchar *filename,
713
gboolean scale);</pre>
714
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
715
<h3 class="title">Warning</h3>
716
<p><code class="literal">gimp_path_import</code> is deprecated and should not be used in newly-written code.</p>
719
This procedure is deprecated! Use <code class="function">vectors_import_from_file()</code>
768
725
<col align="left" valign="top">
772
<span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>
728
<td><span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>
778
<span class="term"><em class="parameter"><code>filename</code></em> :</span></td>
733
<td><span class="term"><em class="parameter"><code>filename</code></em> :</span></td>
779
734
<td> The name of the SVG file to import.
784
<span class="term"><em class="parameter"><code>merge</code></em> :</span></td>
738
<td><span class="term"><em class="parameter"><code>merge</code></em> :</span></td>
785
739
<td> Merge paths into a single vectors object.
790
<span class="term"><em class="parameter"><code>scale</code></em> :</span></td>
743
<td><span class="term"><em class="parameter"><code>scale</code></em> :</span></td>
791
744
<td> Scale the SVG to image dimensions.
796
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
748
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
797
749
<td> TRUE on success.
added
removed
devel-docs/libgimp/html/libgimp-gimppaths.html
