scratchfoundation/paper.js
1
0
Fork 0
mirror of https://github.com/scratchfoundation/paper.js.git synced 2025-01-07 13:22:07 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Path: Improve docs of the 'Positions on Paths and Curves' group.

Browse source
This commit is contained in:
Jonathan Puckey 2014-04-28 18:12:44 +02:00
parent a9618b50f8
commit 2b712959f2
1 changed files with 13 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
src/path/Path.js
View file

@ -1616,12 +1616,13 @@ var Path = PathItem.extend(/** @lends Path# */{
return null; return null;
}, },
// DOCS: document Path#getLocationAt
/** /**
* Returns the curve location of the specified offset on the path.
* *
* @param {Number} offset * @param {Number} offset the offset on the path, where {@code 0} is at
* the beginning of the path and {@link Path#length} at the end.
* @param {Boolean} [isParameter=false] * @param {Boolean} [isParameter=false]
* @return {CurveLocation} * @return {CurveLocation} the curve location at the specified offset
*/ */
getLocationAt: function(offset, isParameter) { getLocationAt: function(offset, isParameter) {
var curves = this.getCurves(), var curves = this.getCurves(),
@ -1651,7 +1652,8 @@ var Path = PathItem.extend(/** @lends Path# */{
/** /**
* Calculates the point on the path at the given offset. * Calculates the point on the path at the given offset.
* *
* @param {Number} offset * @param {Number} offset the offset on the path, where {@code 0} is at
* the beginning of the path and {@link Path#length} at the end.
* @param {Boolean} [isParameter=false] * @param {Boolean} [isParameter=false]
* @return {Point} the point at the given offset * @return {Point} the point at the given offset
* *
@ -1713,9 +1715,11 @@ var Path = PathItem.extend(/** @lends Path# */{
}, },
/** /**
* Calculates the tangent to the path at the given offset as a vector point. * Calculates the tangent to the path at the given offset as a vector
* point.
* *
* @param {Number} offset * @param {Number} offset the offset on the path, where {@code 0} is at
* the beginning of the path and {@link Path#length} at the end.
* @param {Boolean} [isParameter=false] * @param {Boolean} [isParameter=false]
* @return {Point} the tangent vector at the given offset * @return {Point} the tangent vector at the given offset
* *
@ -1787,7 +1791,8 @@ var Path = PathItem.extend(/** @lends Path# */{
/** /**
* Calculates the normal to the path at the given offset as a vector point. * Calculates the normal to the path at the given offset as a vector point.
* *
* @param {Number} offset * @param {Number} offset the offset on the path, where {@code 0} is at
* the beginning of the path and {@link Path#length} at the end.
* @param {Boolean} [isParameter=false] * @param {Boolean} [isParameter=false]
* @return {Point} the normal vector at the given offset * @return {Point} the normal vector at the given offset
* *