diff --git a/src/path/Curve.js b/src/path/Curve.js index cfcc9ff0..2cd8ed01 100644 --- a/src/path/Curve.js +++ b/src/path/Curve.js @@ -899,7 +899,7 @@ statics: { } /** - * Returns the point on the curve at the specified offset. + * Calculates the point on the curve at the given offset. * * @name Curve#getPointAt * @function @@ -911,7 +911,7 @@ statics: { */ /** - * Returns the tangent vector of the curve at the specified position. + * Calculates the tangent vector of the curve at the given offset. * * @name Curve#getTangentAt * @function @@ -923,7 +923,7 @@ statics: { */ /** - * Returns the normal vector of the curve at the specified position. + * Calculates the normal vector of the curve at the given offset. * * @name Curve#getNormalAt * @function @@ -935,9 +935,10 @@ statics: { */ /** - * Returns the curvature vector of the curve at the specified position. - * Curvatures indicate how sharply a curve changes direction. A straight - * line has zero curvature where as a circle has a constant curvature. + * Calculates the curvature of the curve at the given offset. Curvatures + * indicate how sharply a curve changes direction. A straight line has zero + * curvature, where as a circle has a constant curvature. The curve's radius + * at the given offset is the reciprocal value of its curvature. * * @name Curve#getCurvatureAt * @function diff --git a/src/path/Path.js b/src/path/Path.js index 9f701b88..3b97f343 100644 --- a/src/path/Path.js +++ b/src/path/Path.js @@ -1751,8 +1751,7 @@ var Path = PathItem.extend(/** @lends Path# */{ */ /** - * Calculates the tangent to the path at the given offset as a vector - * point. + * Calculates the tangent vector of the path at the given offset. * * @name Path#getTangentAt * @param {Number} offset the offset on the path, where {@code 0} is at @@ -1822,7 +1821,7 @@ var Path = PathItem.extend(/** @lends Path# */{ */ /** - * Calculates the normal to the path at the given offset as a vector point. + * Calculates the normal vector of the path at the given offset. * * @name Path#getNormalAt * @param {Number} offset the offset on the path, where {@code 0} is at @@ -1891,6 +1890,19 @@ var Path = PathItem.extend(/** @lends Path# */{ * } */ + /** + * Calculates the curvature of the path at the given offset. Curvatures + * indicate how sharply a path changes direction. A straight line has zero + * curvature, where as a circle has a constant curvature. The path's radius + * at the given offset is the reciprocal value of its curvature. + * + * @name Path#getCurvatureAt + * @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] + * @return {Point} the normal vector at the given offset + * + /** * Returns the nearest location on the path to the specified point. *