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

Documentation: remove part of the constructor explanation of CurveLocation until the mentioned functions have been added.

Browse source
This commit is contained in:
Jonathan Puckey 2011-05-27 20:06:57 +02:00
parent b3617cdab6
commit 25c3534dc1
1 changed files with 11 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
src/path/CurveLocation.js
View file

@ -19,6 +19,12 @@ CurveLocation = Base.extend({
beans: true,
// DOCS: CurveLocation class description: add this comment back when the
// mentioned functioned have been added:
// The class is in use in many places, such as {@link Path#getLocationAt(offset)},
// {@link Path#getLength(CurveLocation)}, {@link Path#getPoint(length)},
// {@link Path#split(CurveLocation)},
// {@link PathItem#getIntersections(PathItem)}, etc.
/**
* Creates a new CurveLocation object.
*
@ -28,16 +34,11 @@ CurveLocation = Base.extend({
* @param {number} parameter
* @param {Point} point
*
* @class CurveLocation objects describe a location on {@Curve} objects, as
* defined by the curve {@link #parameter}, a value between {@code 0}
* (beginning of the curve) and {@code 1} (end of the curve). If the curve is
* part of a {@link Path} item, its {@link #index} inside the
* @class CurveLocation objects describe a location on {@link Curve}
* objects, as defined by the curve {@link #parameter}, a value between
* {@code 0} (beginning of the curve) and {@code 1} (end of the curve). If
* the curve is part of a {@link Path} item, its {@link #index} inside the
* {@link Path#curves} array is also provided.
*
* The class is in use in many places, such as {@link Path#getLocationAt(length)},
* {@link Path#getLength(CurveLocation)}, {@link Path#getPoint(length)},
* {@link Path#split(CurveLocation)},
* {@link PathItem#getIntersections(PathItem)}, etc.
*/
initialize: function(curve, parameter, point) {
this._curve = curve;
@ -92,7 +93,7 @@ CurveLocation = Base.extend({
},
/**
* The index of the curve within the {@link Path#getCurves()} list, if the
* The index of the curve within the {@link Path#curves} list, if the
* curve is part of a {@link Path} item.
*
* @type Index