scratchfoundation/paper.js
1
0
Fork 0
mirror of https://github.com/scratchfoundation/paper.js.git synced 2025-01-06 04:42:15 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Improve docs for boolean operations.

Browse source
This commit is contained in:
Jürg Lehni 2015-10-25 09:41:43 +01:00
parent e9d54a05f0
commit 238801e485
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
src/path/PathItem.Boolean.js
View file

@ -657,8 +657,8 @@ PathItem.inject(new function() {
/** /**
* {@grouptitle Boolean Path Operations} * {@grouptitle Boolean Path Operations}
* *
* Merges the geometry of the specified path from this path's * Merges the geometry of the specified path with this path's geometry
* geometry and returns the result as a new path item. * and returns the result as a new path item.
* *
* @param {PathItem} path the path to unite with * @param {PathItem} path the path to unite with
* @return {PathItem} the resulting path item * @return {PathItem} the resulting path item
@ -689,14 +689,12 @@ PathItem.inject(new function() {
return computeBoolean(this, path, 'subtract'); return computeBoolean(this, path, 'subtract');
}, },
// Compound boolean operators combine the basic boolean operations such
// as union, intersection, subtract etc.
/** /**
* Excludes the intersection of the geometry of the specified path with * Excludes the intersection of the geometry of the specified path with
* this path's geometry and returns the result as a new group item. * this path's geometry and returns the result as a new path item.
* *
* @param {PathItem} path the path to exclude the intersection of * @param {PathItem} path the path to exclude the intersection of
* @return {Group} the resulting group item * @return {PathItem} the resulting group item
*/ */
exclude: function(path) { exclude: function(path) {
return computeBoolean(this, path, 'exclude'); return computeBoolean(this, path, 'exclude');
@ -704,7 +702,9 @@ PathItem.inject(new function() {
/** /**
* Splits the geometry of this path along the geometry of the specified * Splits the geometry of this path along the geometry of the specified
* path returns the result as a new group item. * path returns the result as a new group item. This is equivalent to
* calling {@link #subtract(path)} and {@link #subtract(path)} and
* putting the results into a new group.
* *
* @param {PathItem} path the path to divide by * @param {PathItem} path the path to divide by
* @return {Group} the resulting group item * @return {Group} the resulting group item