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: Hide matrix parameter in Item#hitTest() and add "options." in front of each options property.

Browse source
This commit is contained in:
Jürg Lehni 2011-08-01 11:47:42 +01:00
parent 884ea96a29
commit 31cc571e8a
1 changed files with 13 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
src/item/Item.js
View file

@ -692,30 +692,31 @@ var Item = this.Item = Base.extend(/** @lends Item# */{
* hit test and may contain a combination of the following values:
* <b>tolerance:</b> {@code Number} - The tolerance of the hit test in
* points.
* <b>type:</b> Only hit test again a certain item
* <b>options.type:</b> Only hit test again a certain item
* type: {@link PathItem}, {@link Raster}, {@link TextItem}, etc.
* <b>fill:</b> {@code Boolean} - Hit test the fill of items.
* <b>stroke:</b> {@code Boolean} - Hit test the curves of path items,
* <b>options.fill:</b> {@code Boolean} - Hit test the fill of items.
* <b>options.stroke:</b> {@code Boolean} - Hit test the curves of path items,
* taking into account stroke width.
* <b>segment:</b> {@code Boolean} - Hit test for {@link Segment#point} of
* <b>options.segment:</b> {@code Boolean} - Hit test for {@link Segment#point} of
* {@link Path} items.
* <b>handles:</b> {@code Boolean} - Hit test for the handles
* <b>options.handles:</b> {@code Boolean} - Hit test for the handles
* ({@link Segment#handleIn} / {@link Segment#handleOut}) of path segments.
* <b>ends:</b> {@code Boolean} - Only hit test for the first or last
* <b>options.ends:</b> {@code Boolean} - Only hit test for the first or last
* segment points of open path items.
* <b>bounds:</b> {@code Boolean} - Hit test the corners and side-centers
* <b>options.bounds:</b> {@code Boolean} - Hit test the corners and side-centers
* of the bounding rectangle of items ({@link Item#bounds}).
* <b>center:</b> {@code Boolean} - Hit test the {@link Rectangle#center}
* <b>options.center:</b> {@code Boolean} - Hit test the {@link Rectangle#center}
* of the bounding rectangle of items ({@link Item#bounds}).
* <b>guide:</b> {@code Boolean} - Hit test items that have
* <b>options.guide:</b> {@code Boolean} - Hit test items that have
* {@link Item#guide} set to {@code true}.
* <b>selected:</b> {@code Boolean} - Only hit selected items.
* <b>options.selected:</b> {@code Boolean} - Only hit selected items.
*
* @name Item#hitTest
* @function
* @param {Point} point The point where the hit test should be performed
* @param {Object} [options={ fill: true, stroke: true, segments: true,
* tolerance: 2 }]
* @param {Matrix} [matrix]
* @return {HitResult|null} A hit result object that contains more
* @return {HitResult} A hit result object that contains more
* information about what exactly was hit or {@code null} if nothing was
* hit.
*/