Skip to content

Interface: PickResult ​

Experimental

A single picking hit.

Properties ​

PropertyTypeDescription
distancenumberExperimental Distance from the pick position in CSS px. 2D: to the point's centre. 3D (GPU): to the nearest rendered pixel of the hit (0 when it is under the cursor).
kindPickElementKindExperimental What pointIndex counts.
object?Object3D<Object3DEventMap>Experimental 3D only: the three.js mesh that was hit (for a marker set, its instanced mesh).
pointIndexnumberExperimental Index of the point / instance / vertex / triangle within the trace; -1 for object-level.
traceIndexnumberExperimental Index of the trace the hit belongs to (as given at registration).
viewport?ViewportExperimental The viewport the pick was routed to (set by Picker).

Released under the MIT License.