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

Improve Segment and Curve documentation.

Browse source
This commit is contained in:
Jürg Lehni 2011-06-27 15:07:08 +02:00
parent e35b171bec
commit 50c7649421
2 changed files with 10 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
src/path/Curve.js
View file

@ -18,8 +18,8 @@
* @name Curve
*
* @class The Curve object represents the parts of a path that are connected by
* two following segments. The curves of a path can be accessed through its
* {@link Path#curves} array
* two following {@link Segment} objects. The curves of a path can be accessed
* through its {@link Path#curves} array.
*
* While a segment describe the anchor point and its incoming and outgoing
* handles, a Curve object describes the curve passing between two such

12
src/path/Segment.js
View file

@ -16,11 +16,15 @@
/**
* @name Segment
* @class The Segment object represents a part of a path which is
* described by the {@link Path#segments} array. Every segment of a
* path corresponds to an anchor point (anchor points are the path handles
* that are visible when the path is selected).
*
* @class The Segment object represents the points of a path through which its
* {@link Curve} objects pass. The segments of a path can be accessed through
* its {@link Path#segments} array.
*
* Each segment consists of an anchor point ({@link Segment#point}) and
* optionaly an incoming and an outgoing handle ({@link Segment#handleIn} and
* {@link Segment#handleOut}), describing the tangents of the two {@link Curve}
* objects that are connected by this segment.
*/
var Segment = this.Segment = Base.extend(/** @lends Segment# */{
/**