mirror of
https://github.com/scratchfoundation/paper.js.git
synced 2025-01-01 02:38:43 -05:00
Improve hit test point documentation (#1559)
Specifies that hit test point should be provided in global coordinates system. Closes #1430
This commit is contained in:
parent
c0abbe1459
commit
dfe4397a96
1 changed files with 2 additions and 0 deletions
|
@ -1905,6 +1905,7 @@ new function() { // Injection scope for hit-test functions shared with project
|
||||||
* @option options.selected {Boolean} only hit selected items
|
* @option options.selected {Boolean} only hit selected items
|
||||||
*
|
*
|
||||||
* @param {Point} point the point where the hit-test should be performed
|
* @param {Point} point the point where the hit-test should be performed
|
||||||
|
* (in global coordinates system).
|
||||||
* @param {Object} [options={ fill: true, stroke: true, segments: true,
|
* @param {Object} [options={ fill: true, stroke: true, segments: true,
|
||||||
* tolerance: settings.hitTolerance }]
|
* tolerance: settings.hitTolerance }]
|
||||||
* @return {HitResult} a hit result object describing what exactly was hit
|
* @return {HitResult} a hit result object describing what exactly was hit
|
||||||
|
@ -1922,6 +1923,7 @@ new function() { // Injection scope for hit-test functions shared with project
|
||||||
* @name Item#hitTestAll
|
* @name Item#hitTestAll
|
||||||
* @function
|
* @function
|
||||||
* @param {Point} point the point where the hit-test should be performed
|
* @param {Point} point the point where the hit-test should be performed
|
||||||
|
* (in global coordinates system).
|
||||||
* @param {Object} [options={ fill: true, stroke: true, segments: true,
|
* @param {Object} [options={ fill: true, stroke: true, segments: true,
|
||||||
* tolerance: settings.hitTolerance }]
|
* tolerance: settings.hitTolerance }]
|
||||||
* @return {HitResult[]} hit result objects for all hits, describing what
|
* @return {HitResult[]} hit result objects for all hits, describing what
|
||||||
|
|
Loading…
Reference in a new issue