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

Write documentation for PathItem#getIntersections().

Browse source
This commit is contained in:
Jürg Lehni 2012-12-27 19:26:40 +01:00
parent 68ad4bb5ba
commit 00898908d3
1 changed files with 9 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
src/path/PathItem.js
View file

@ -25,6 +25,15 @@
*/ */
var PathItem = this.PathItem = Item.extend(/** @lends PathItem# */{ var PathItem = this.PathItem = Item.extend(/** @lends PathItem# */{
/**
* Returns all interesections between two {@link PathItem} items as an array
* of {@link CurveLocation} objects. {@link CompoundPath} items are also
* supported.
*
* @param {PathItem} the other item to find the intersections to.
* @return {CurveLocation[]} the locations of all intersection between the
* paths
*/
getIntersections: function(path) { getIntersections: function(path) {
// First check the bounds of the two paths. If they don't intersect, // First check the bounds of the two paths. If they don't intersect,
// we don't need to iterate through the whole path. // we don't need to iterate through the whole path.