mirror of
https://github.com/scratchfoundation/paper.js.git
synced 2025-01-24 08:20:09 -05:00
141 lines
4.3 KiB
JavaScript
141 lines
4.3 KiB
JavaScript
/*
|
|
* Paper.js - The Swiss Army Knife of Vector Graphics Scripting.
|
|
* http://paperjs.org/
|
|
*
|
|
* Copyright (c) 2011 - 2016, Juerg Lehni & Jonathan Puckey
|
|
* http://scratchdisk.com/ & http://jonathanpuckey.com/
|
|
*
|
|
* Distributed under the MIT license. See LICENSE file for details.
|
|
*
|
|
* All rights reserved.
|
|
*/
|
|
|
|
/**
|
|
* @name HitResult
|
|
*
|
|
* @class A HitResult object contains information about the results of a hit
|
|
* test. It is returned by {@link Item#hitTest(point)} and
|
|
* {@link Project#hitTest(point)}.
|
|
*/
|
|
var HitResult = Base.extend(/** @lends HitResult# */{
|
|
_class: 'HitResult',
|
|
|
|
initialize: function HitResult(type, item, values) {
|
|
this.type = type;
|
|
this.item = item;
|
|
// Inject passed values, so we can be flexible about the HitResult
|
|
// properties.
|
|
// This allows the definition of getters too, e.g. for 'pixel'.
|
|
if (values) {
|
|
// Make enumerable so toString() works.
|
|
values.enumerable = true;
|
|
this.inject(values);
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Describes the type of the hit result. For example, if you hit a segment
|
|
* point, the type would be `'segment'`.
|
|
*
|
|
* @name HitResult#type
|
|
* @property
|
|
* @type String
|
|
* @values 'segment', 'handle-in', 'handle-out', 'curve', 'stroke', 'fill',
|
|
* 'bounds', 'center', 'pixel'
|
|
*/
|
|
|
|
/**
|
|
* If the HitResult has a {@link HitResult#type} of `'bounds'`, this
|
|
* property describes which corner of the bounding rectangle was hit.
|
|
*
|
|
* @name HitResult#name
|
|
* @property
|
|
* @type String
|
|
* @values 'top-left', 'top-right', 'bottom-left', 'bottom-right',
|
|
* 'left-center', 'top-center', 'right-center', 'bottom- center'
|
|
*/
|
|
|
|
/**
|
|
* The item that was hit.
|
|
*
|
|
* @name HitResult#item
|
|
* @property
|
|
* @type Item
|
|
*/
|
|
|
|
/**
|
|
* If the HitResult has a type of 'curve' or 'stroke', this property gives
|
|
* more information about the exact position that was hit on the path.
|
|
*
|
|
* @name HitResult#location
|
|
* @property
|
|
* @type CurveLocation
|
|
*/
|
|
|
|
/**
|
|
* If the HitResult has a type of 'pixel', this property refers to the color
|
|
* of the pixel on the {@link Raster} that was hit.
|
|
*
|
|
* @name HitResult#color
|
|
* @property
|
|
* @type Color
|
|
*/
|
|
|
|
/**
|
|
* If the HitResult has a type of 'stroke', 'segment', 'handle-in' or
|
|
* 'handle-out', this property refers to the segment that was hit or that
|
|
* is closest to the hitResult.location on the curve.
|
|
*
|
|
* @name HitResult#segment
|
|
* @property
|
|
* @type Segment
|
|
*/
|
|
|
|
/**
|
|
* Describes the actual coordinates of the segment, handle or bounding box
|
|
* corner that was hit.
|
|
*
|
|
* @name HitResult#point
|
|
* @property
|
|
* @type Point
|
|
*/
|
|
|
|
statics: {
|
|
/**
|
|
* Merges default options into options hash for #hitTest() calls.
|
|
*
|
|
* @private
|
|
*/
|
|
getOptions: function(args) {
|
|
var options = args && Base.read(args);
|
|
return Base.set({
|
|
// Type of item, for instanceof check: Group, Layer, Path,
|
|
// CompoundPath, Shape, Raster, SymbolItem, ...
|
|
type: null,
|
|
// Tolerance
|
|
tolerance: paper.settings.hitTolerance,
|
|
// Hit the fill of items
|
|
fill: !options,
|
|
// Hit the curves of path items, taking into account the stroke
|
|
// width.
|
|
stroke: !options,
|
|
// Hit the part of segments that curves pass through, excluding
|
|
// its segments (Segment#point)
|
|
segments: !options,
|
|
// Hit the parts of segments that define the curvature
|
|
handles: false,
|
|
// Only first or last segment hits on path (mutually exclusive
|
|
// with segments: true)
|
|
ends: false,
|
|
// Hit test the center of the bounds
|
|
center: false,
|
|
// Hit test the corners and side-centers of the bounding box
|
|
bounds: false,
|
|
// Hit items that are marked as guides
|
|
guides: false,
|
|
// Only hit selected objects
|
|
selected: false
|
|
}, options);
|
|
}
|
|
}
|
|
});
|