Class: GpuPicker

Experimental

GPU ID picker for one 3D view (see the module docs for the design). Create one per viewport; Picker does this automatically for 3D viewports.

Constructors

Constructor

new GpuPicker(
   renderer,
   view,
   host?
): GpuPicker;

Experimental

Parameters

Parameter	Type
renderer	WebGLRenderer
view	GpuPickView
host?	GpuPickHost

Returns

GpuPicker

Properties

Property	Modifier	Type	Description
renderer	readonly	WebGLRenderer	Experimental
view	readonly	GpuPickView	Experimental

Accessors

disposed

Get Signature

get disposed(): boolean;

Experimental

Returns

boolean

---

size

Get Signature

get size(): number;

Experimental

Number of registrations.

Returns

number

Methods

dispose()

dispose(): void;

Experimental

Release GPU resources, pick materials, and all registrations. In-flight picks resolve [].

Returns

void

---

has()

has(target): boolean;

Experimental

Whether target is registered.

Parameters

Parameter	Type
target	| Object3D<Object3DEventMap> | PickablePrimitive

Returns

boolean

---

pick()

pick(request): Promise<PickResult[]>;

Experimental

Resolve the hits around a CSS position, nearest first. Resolves to [] when the position is outside the view, nothing is registered, the context is lost, or the picker is disposed. Several picks may be in flight; each has its own readback buffer.

Parameters

Parameter	Type
request	GpuPickRequest

Returns

Promise<PickResult[]>

---

register()

register(target, options?): number;

Experimental

Make target pickable and return its registration id. Registering the same target again updates its options and returns the same id.

Parameters

Parameter	Type
target	| Object3D<Object3DEventMap> | PickablePrimitive
options	GpuPickableOptions

Returns

number

---

unregister()

unregister(target): boolean;

Experimental

Stop picking a target (by registration id or the registered object). Returns whether found.

Parameters

Parameter	Type
target	| number | Object3D<Object3DEventMap> | PickablePrimitive

Returns

boolean