Files
gimp/devel-docs/libgimp/html/libgimp-gimppaths.html
2010-08-11 01:23:08 -04:00

995 lines
38 KiB
HTML

<!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.73.2">
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimp-image.html" title="Manupulating Images and 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.8 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimp.html" title="Part&#160;I.&#160;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 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&#160;II.&#160;GIMP User Interface Library">
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
<link rel="index" href="libgimp-index.html" title="Index">
<link rel="index" href="libgimp-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="libgimp-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="libgimp-index-deprecated.html" title="Index of deprecated symbols">
</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="#id2526865" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2657585" 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="id2526865"></a><span class="refentrytitle">gimppaths</span>
</h2>
<p>gimppaths &#8212; Operations related to paths.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>** <a class="link" href="libgimp-gimppaths.html#gimp-path-list">gimp_path_list</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *num_paths);
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> <a class="link" href="libgimp-gimppaths.html#gimp-path-get-points">gimp_path_get_points</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *path_closed,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *num_path_point_details,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> **points_pairs);
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a class="link" href="libgimp-gimppaths.html#gimp-path-get-current">gimp_path_get_current</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="libgimp-gimppaths.html#gimp-path-set-current">gimp_path_set_current</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="libgimp-gimppaths.html#gimp-path-set-points">gimp_path_set_points</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> ptype,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> num_path_points,
const <a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> *points_pairs);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="libgimp-gimppaths.html#gimp-path-stroke-current">gimp_path_stroke_current</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> <a class="link" href="libgimp-gimppaths.html#gimp-path-get-point-at-dist">gimp_path_get_point_at_dist</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> distance,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *y_point,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> *slope);
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> <a class="link" href="libgimp-gimppaths.html#gimp-path-get-tattoo">gimp_path_get_tattoo</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a class="link" href="libgimp-gimppaths.html#gimp-get-path-by-tattoo">gimp_get_path_by_tattoo</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> tattoo);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="libgimp-gimppaths.html#gimp-path-delete">gimp_path_delete</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="libgimp-gimppaths.html#gimp-path-get-locked">gimp_path_get_locked</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="libgimp-gimppaths.html#gimp-path-set-locked">gimp_path_set_locked</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> locked);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="libgimp-gimppaths.html#gimp-path-set-tattoo">gimp_path_set_tattoo</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> tattovalue);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="libgimp-gimppaths.html#gimp-path-to-selection">gimp_path_to_selection</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
<a
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpChannelOps"
>GimpChannelOps</a> op,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> antialias,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> feather,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> feather_radius_x,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> feather_radius_y);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="libgimp-gimppaths.html#gimp-path-import">gimp_path_import</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *filename,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> merge,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> scale);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2657585"></a><h2>Description</h2>
<p>
Operations related to paths.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2657600"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2657611"></a><h3>
<a name="gimp-path-list"></a>gimp_path_list ()</h3>
<a class="indexterm" name="id2657626"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>** gimp_path_list (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *num_paths);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_path_list</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
This procedure is deprecated! Use <a class="link" href="libgimp-gimpimage.html#gimp-image-get-vectors"><code class="function">gimp_image_get_vectors()</code></a> instead.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></p></td>
<td> The image to list the paths from.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>num_paths</code></em>&#160;:</span></p></td>
<td> The number of paths returned.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> List of the paths belonging to this image.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2657729"></a><h3>
<a name="gimp-path-get-points"></a>gimp_path_get_points ()</h3>
<a class="indexterm" name="id2658135"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> gimp_path_get_points (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *path_closed,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *num_path_point_details,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> **points_pairs);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_path_get_points</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
This procedure is deprecated! Use <a class="link" href="libgimp-gimpvectors.html#gimp-vectors-stroke-get-points"><code class="function">gimp_vectors_stroke_get_points()</code></a>
instead.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></p></td>
<td> The image to list the paths from.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
<td> The name of the path whose points should be listed.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>path_closed</code></em>&#160;:</span></p></td>
<td> Return if the path is closed. (0 = path open, 1 = path closed).
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>num_path_point_details</code></em>&#160;:</span></p></td>
<td> The number of points returned. Each point is made up of (x, y, pnt_type) of floats.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>points_pairs</code></em>&#160;:</span></p></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><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></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="id2658310"></a><h3>
<a name="gimp-path-get-current"></a>gimp_path_get_current ()</h3>
<a class="indexterm" name="id2658324"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_path_get_current (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_path_get_current</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
This procedure is deprecated! Use <a class="link" href="libgimp-gimpimage.html#gimp-image-get-active-vectors"><code class="function">gimp_image_get_active_vectors()</code></a>
instead.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></p></td>
<td> The image to get the current path from.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> The name of the current path.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2658404"></a><h3>
<a name="gimp-path-set-current"></a>gimp_path_set_current ()</h3>
<a class="indexterm" name="id2658418"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_path_set_current (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_path_set_current</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
This procedure is deprecated! Use <a class="link" href="libgimp-gimpimage.html#gimp-image-set-active-vectors"><code class="function">gimp_image_set_active_vectors()</code></a>
instead.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></p></td>
<td> The image in which a path will become current.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
<td> The name of the path to make current.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2659985"></a><h3>
<a name="gimp-path-set-points"></a>gimp_path_set_points ()</h3>
<a class="indexterm" name="id2659998"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_path_set_points (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> ptype,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> num_path_points,
const <a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> *points_pairs);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_path_set_points</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
This procedure is deprecated! Use <code class="function">vectors_stroke_new_from_points()</code>
instead.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></p></td>
<td> The image to set the paths in.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></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><p><span class="term"><em class="parameter"><code>ptype</code></em>&#160;:</span></p></td>
<td> The type of the path. Currently only one type (1 = Bezier) is supported.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>num_path_points</code></em>&#160;:</span></p></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><p><span class="term"><em class="parameter"><code>points_pairs</code></em>&#160;:</span></p></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><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2660186"></a><h3>
<a name="gimp-path-stroke-current"></a>gimp_path_stroke_current ()</h3>
<a class="indexterm" name="id2660199"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_path_stroke_current (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_path_stroke_current</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
This procedure is deprecated! Use <a class="link" href="libgimp-gimpedit.html#gimp-edit-stroke-vectors"><code class="function">gimp_edit_stroke_vectors()</code></a>
instead.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></p></td>
<td> The image which contains the path to stroke.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2660281"></a><h3>
<a name="gimp-path-get-point-at-dist"></a>gimp_path_get_point_at_dist ()</h3>
<a class="indexterm" name="id2660294"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> gimp_path_get_point_at_dist (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> distance,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *y_point,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> *slope);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_path_get_point_at_dist</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
This procedure is deprecated! Use
<a class="link" 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>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></p></td>
<td> The image the paths belongs to.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>distance</code></em>&#160;:</span></p></td>
<td> The distance along the path.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y_point</code></em>&#160;:</span></p></td>
<td> The y position of the point.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>slope</code></em>&#160;:</span></p></td>
<td> The slope (dy / dx) at the specified point.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> The x position of the point.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2660442"></a><h3>
<a name="gimp-path-get-tattoo"></a>gimp_path_get_tattoo ()</h3>
<a class="indexterm" name="id2660455"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> gimp_path_get_tattoo (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_path_get_tattoo</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
This procedure is deprecated! Use <a class="link" href="libgimp-gimpvectors.html#gimp-vectors-get-tattoo"><code class="function">gimp_vectors_get_tattoo()</code></a> instead.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></p></td>
<td> The image.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
<td> The name of the path whose tattoo should be obtained.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> The tattoo associated with the named path.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2660560"></a><h3>
<a name="gimp-get-path-by-tattoo"></a>gimp_get_path_by_tattoo ()</h3>
<a class="indexterm" name="id2660573"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_get_path_by_tattoo (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> tattoo);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_get_path_by_tattoo</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
This procedure is deprecated! Use <a
href="../app/GimpImage.html#gimp-image-get-vectors-by-tattoo"
><code class="function">gimp_image_get_vectors_by_tattoo()</code></a>
instead.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></p></td>
<td> The image.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tattoo</code></em>&#160;:</span></p></td>
<td> The tattoo of the required path.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></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="id2660679"></a><h3>
<a name="gimp-path-delete"></a>gimp_path_delete ()</h3>
<a class="indexterm" name="id2660693"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_path_delete (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_path_delete</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
This procedure is deprecated! Use <a class="link" href="libgimp-gimpimage.html#gimp-image-remove-vectors"><code class="function">gimp_image_remove_vectors()</code></a>
instead.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></p></td>
<td> The image to delete the path from.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
<td> The name of the path to delete.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2660797"></a><h3>
<a name="gimp-path-get-locked"></a>gimp_path_get_locked ()</h3>
<a class="indexterm" name="id2660811"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_path_get_locked (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_path_get_locked</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
This procedure is deprecated! Use <a class="link" href="libgimp-gimpvectors.html#gimp-vectors-get-linked"><code class="function">gimp_vectors_get_linked()</code></a> instead.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></p></td>
<td> The image.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
<td> The name of the path whose locked status should be obtained.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> TRUE if the path is locked, FALSE otherwise.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2666502"></a><h3>
<a name="gimp-path-set-locked"></a>gimp_path_set_locked ()</h3>
<a class="indexterm" name="id2666515"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_path_set_locked (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> locked);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_path_set_locked</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
This procedure is deprecated! Use <a class="link" href="libgimp-gimpvectors.html#gimp-vectors-set-linked"><code class="function">gimp_vectors_set_linked()</code></a> instead.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></p></td>
<td> The image.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
<td> the name of the path whose locked status should be set.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>locked</code></em>&#160;:</span></p></td>
<td> Whether the path is locked.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2666641"></a><h3>
<a name="gimp-path-set-tattoo"></a>gimp_path_set_tattoo ()</h3>
<a class="indexterm" name="id2666654"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_path_set_tattoo (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> tattovalue);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_path_set_tattoo</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
This procedure is deprecated! Use <a class="link" href="libgimp-gimpvectors.html#gimp-vectors-set-tattoo"><code class="function">gimp_vectors_set_tattoo()</code></a> instead.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></p></td>
<td> The image.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
<td> the name of the path whose tattoo should be set.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tattovalue</code></em>&#160;:</span></p></td>
<td> The tattoo associated with the name path. Only values returned from 'path_get_tattoo' should be used here.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2666781"></a><h3>
<a name="gimp-path-to-selection"></a>gimp_path_to_selection ()</h3>
<a class="indexterm" name="id2666794"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_path_to_selection (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
<a
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpChannelOps"
>GimpChannelOps</a> op,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> antialias,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> feather,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> feather_radius_x,
<a
href="../glib/glib-Basic-Types.html#gdouble"
>gdouble</a> feather_radius_y);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_path_to_selection</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
This procedure is deprecated! Use <a class="link" href="libgimp-gimpvectors.html#gimp-vectors-to-selection"><code class="function">gimp_vectors_to_selection()</code></a>
instead.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></p></td>
<td> The image.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
<td> The name of the path which should be made into selection.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>op</code></em>&#160;:</span></p></td>
<td> The desired operation with current selection.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>antialias</code></em>&#160;:</span></p></td>
<td> Antialias selection.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>feather</code></em>&#160;:</span></p></td>
<td> Feather selection.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>feather_radius_x</code></em>&#160;:</span></p></td>
<td> Feather radius x.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>feather_radius_y</code></em>&#160;:</span></p></td>
<td> Feather radius y.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2667006"></a><h3>
<a name="gimp-path-import"></a>gimp_path_import ()</h3>
<a class="indexterm" name="id2667021"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_path_import (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *filename,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> merge,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> scale);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_path_import</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
This procedure is deprecated! Use <code class="function">vectors_import_from_file()</code>
instead.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></p></td>
<td> The image.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em>&#160;:</span></p></td>
<td> The name of the SVG file to import.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>merge</code></em>&#160;:</span></p></td>
<td> Merge paths into a single vectors object.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>scale</code></em>&#160;:</span></p></td>
<td> Scale the SVG to image dimensions.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>