Class: PointPicker2D

Experimental

CPU picker for one 2D view: registered point sources, each with a lazily (re)built index. Coordinates are the view's world space (2D: CSS px, bottom-left origin).

Constructors

Constructor

new PointPicker2D(): PointPicker2D;

Experimental

Returns

PointPicker2D

Accessors

size

Get Signature

get size(): number;

Experimental

Number of registered sources.

Returns

number

Methods

add()

add(source, traceIndex?): number;

Experimental

Register a source (again: updates its trace index) and return its id.

Parameters

Parameter	Type	Default value
source	PointSource2D	undefined
traceIndex	number	0

Returns

number

---

clear()

clear(): void;

Experimental

Returns

void

---

has()

has(source): boolean;

Experimental

Parameters

Parameter	Type
source	PointSource2D

Returns

boolean

---

pick()

pick(
   wx,
   wy,
   radius,
   mode?
): PickResult[];

Experimental

Hits around world position (wx, wy) within radius (CSS px), per mode (see PickMode), sorted by distance, then trace, then point index.

Parameters

Parameter	Type	Default value
wx	number	undefined
wy	number	undefined
radius	number	undefined
mode	PickMode	'closest'

Returns

PickResult[]

---

remove()

remove(target): boolean;

Experimental

Unregister by id or source. Returns whether it was registered.

Parameters

Parameter	Type
target	number | PointSource2D

Returns

boolean