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

Docs: Improve description of option.class value in #hitTest()

Browse source 
See #632
This commit is contained in:
Jürg Lehni 2017-02-15 16:11:33 +01:00
parent 1ff4bc9665
commit e3c6245979
2 changed files with 10 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/item/Item.js
View file

@ -1814,9 +1814,11 @@ new function() { // Injection scope for hit-test functions shared with project
* *
* @option [options.tolerance={@link PaperScope#settings}.hitTolerance] * @option [options.tolerance={@link PaperScope#settings}.hitTolerance]
* {Number} the tolerance of the hit-test * {Number} the tolerance of the hit-test
* @option options.class {Function} only hit-test again a certain item * @option options.class {Function} only hit-test against a specific item
* class and its sub-classes: {@values Group, Layer, Path, * class, or any of its sub-classes, by providing the constructor
* CompoundPath, Shape, Raster, SymbolItem, PointText, ...} * function against which an `instanceof` check is performed:
* {@values Group, Layer, Path, CompoundPath, Shape, Raster,
* SymbolItem, PointText, ...}
* @option options.match {Function} a match function to be called for each * @option options.match {Function} a match function to be called for each
* found hit result: Return `true` to return the result, `false` to keep * found hit result: Return `true` to return the result, `false` to keep
* searching * searching

8
src/item/Project.js
View file

@ -405,9 +405,11 @@ var Project = PaperScopeItem.extend(/** @lends Project# */{
* *
* @option [options.tolerance={@link PaperScope#settings}.hitTolerance] * @option [options.tolerance={@link PaperScope#settings}.hitTolerance]
* {Number} the tolerance of the hit-test * {Number} the tolerance of the hit-test
* @option options.class {Function} only hit-test again a certain item * @option options.class {Function} only hit-test against a specific item
* class and its sub-classes: {@values Group, Layer, Path, * class, or any of its sub-classes, by providing the constructor
* CompoundPath, Shape, Raster, SymbolItem, PointText, ...} * function against which an `instanceof` check is performed:
* {@values Group, Layer, Path, CompoundPath, Shape, Raster,
* SymbolItem, PointText, ...}
* @option options.match {Function} a match function to be called for each * @option options.match {Function} a match function to be called for each
* found hit result: Return `true` to return the result, `false` to keep * found hit result: Return `true` to return the result, `false` to keep
* searching * searching