<?xml version="1.0"?>
<page id="Gimp.Path.stroke_get_point_at_dist"
      type="topic"
      style="method"
      xmlns="http://projectmallard.org/1.0/"
      xmlns:api="http://projectmallard.org/experimental/api/"
      xmlns:ui="http://projectmallard.org/1.0/ui/">
  <info>
    <link xref="Gimp.Path" group="method" type="guide"/>
    <api:function>
      <api:returns>
        <api:type>Boolean</api:type>
      </api:returns>
      <api:name>gimp_path_stroke_get_point_at_dist</api:name>
      <api:arg>
        <api:type>Number(gint)</api:type>
        <api:name>stroke_id</api:name>
      </api:arg>
      <api:arg>
        <api:type>Number(gdouble)</api:type>
        <api:name>dist</api:name>
      </api:arg>
      <api:arg>
        <api:type>Number(gdouble)</api:type>
        <api:name>precision</api:name>
      </api:arg>
    </api:function>
  </info>
  <title>Gimp.Path.prototype.stroke_get_point_at_dist</title>
  <synopsis><code mime="text/x-gjs">
function stroke_get_point_at_dist(stroke_id: Number(gint), dist: Number(gdouble), precision: Number(gdouble)): [ok: Boolean, x_point: Number(gdouble), y_point: Number(gdouble), slope: Number(gdouble), valid: Boolean] {
    // Gjs wrapper for gimp_path_stroke_get_point_at_dist()
}
  </code></synopsis>
  <p>Get point at a specified distance along the stroke.</p>  <p>This will return the x,y position of a point at a given distance
along the stroke. The distance will be obtained by first digitizing
the curve internally and then walking along the curve. For a closed
stroke the start of the path is the first point on the path that was
created. This might not be obvious. If the stroke is not long
enough, a \"valid\" flag will be FALSE.</p>
  <p>Since 2.4</p>
<terms>
<item>
<title><code>stroke_id</code></title>
  <p>The stroke ID.</p>
</item>
<item>
<title><code>dist</code></title>
  <p>The given distance.</p>
</item>
<item>
<title><code>precision</code></title>
  <p>The precision used for the approximation.</p>
</item>
<item>
<title><code>ok</code></title>
  <p>TRUE on success.</p>
</item>
<item>
<title><code>x_point</code></title>
  <p>The x position of the point.</p>
</item>
<item>
<title><code>y_point</code></title>
  <p>The y position of the point.</p>
</item>
<item>
<title><code>slope</code></title>
  <p>The slope (dy / dx) at the specified point.</p>
</item>
<item>
<title><code>valid</code></title>
  <p>Indicator for the validity of the returned data.</p>
</item>
</terms>

</page>
