ACTION-3633: Add text for getPointAtLength and getPathSegAtLength to describe behavior
authorErik Dahlstrom <ed@opera.com>
Thu, 26 Jun 2014 18:21:36 +0200
changeset 687 5f0c48cc0f64
parent 686 f1a677e91280
child 688 aa7681741dfa
ACTION-3633: Add text for getPointAtLength and getPathSegAtLength to describe behavior
for when there is no path data or when the index/length is beyond the ends of the path.
master/changes.html
master/paths.html
--- a/master/changes.html	Thu Jun 26 17:38:18 2014 +0200
+++ b/master/changes.html	Thu Jun 26 18:21:36 2014 +0200
@@ -167,6 +167,9 @@
 <ul>
   <li>Added new <strong>B</strong> and
   <strong>b</strong> "bearing" path commands.</li>
+
+  <li class='added-since-last-wd'>Define how <a href="paths.html#__svg__SVGPathElement__getPathSegAtLength">getPathSegAtLength</a> and 
+  <a href="paths.html#__svg__SVGPathElement__getPointAtLength">getPointAtLength</a> handle out-of-range input, and what to do in case there's no valid path data.</li>
 </ul>
 
 <h3 id="text">Text chapter</h3>
--- a/master/paths.html	Thu Jun 26 17:38:18 2014 +0200
+++ b/master/paths.html	Thu Jun 26 18:21:36 2014 +0200
@@ -2774,8 +2774,11 @@
 <div>
 Returns the (x,y) coordinate in user space which is <var>distance</var>
 units along the path, utilizing the user agent's distance-along-a-path
-algorithm. 
-
+algorithm. The <var>distance</var> shall be clamped to the range 
+[0, <em>total-length-of-path</em>] before passing it to the distance-along-a-path algorithm.
+<p>
+If no valid path data exists, returns (0,0).
+</p>
 
 </div>
 <dl class="operation">
@@ -2806,9 +2809,11 @@
 <div>
 Returns the index into <a>SVGAnimatedPathData::pathSegList</a> which is <var>distance</var>
 units along the path, utilizing the user agent's distance-along-a-path
-algorithm. 
-
-
+algorithm. The <var>distance</var> shall be clamped to the range 
+[0, <em>total-length-of-path</em>] before passing it to the distance-along-a-path algorithm.
+<p>
+If no valid path data exists, returns 0.
+</p>
 </div>
 <dl class="operation">
 <dt class="parameters-header">Parameters</dt>