mirror of
https://github.com/scratchfoundation/paper.js.git
synced 2025-01-06 04:42:15 -05:00
Improve Segment and Curve documentation.
This commit is contained in:
parent
e35b171bec
commit
50c7649421
2 changed files with 10 additions and 6 deletions
|
@ -18,8 +18,8 @@
|
||||||
* @name Curve
|
* @name Curve
|
||||||
*
|
*
|
||||||
* @class The Curve object represents the parts of a path that are connected by
|
* @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
|
* two following {@link Segment} objects. The curves of a path can be accessed
|
||||||
* {@link Path#curves} array
|
* through its {@link Path#curves} array.
|
||||||
*
|
*
|
||||||
* While a segment describe the anchor point and its incoming and outgoing
|
* While a segment describe the anchor point and its incoming and outgoing
|
||||||
* handles, a Curve object describes the curve passing between two such
|
* handles, a Curve object describes the curve passing between two such
|
||||||
|
|
|
@ -16,11 +16,15 @@
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @name Segment
|
* @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# */{
|
var Segment = this.Segment = Base.extend(/** @lends Segment# */{
|
||||||
/**
|
/**
|
||||||
|
|
Loading…
Reference in a new issue