Pick options.

interface PickOptions {
    filter?: PickFilterCallback;
    gpuPicking?: boolean;
    limit?: number;
    radius?: number;
}

Hierarchy (view full)

Properties

Filter on the picked results

gpuPicking?: boolean

If disabled, picking will using CPU raycasting when possible (rather than GPU picking). Main differences between CPU raycasting and GPU picking:

  • CPU raycasting is generally much faster to execute and does not require blocking the thread to wait for the GPU queue to complete.

Disadvantages:

  • CPU raycasting might give less accurate results in some specific cases,
  • CPU raycasting might not return complete information, only the picked point coordinates.
  • CPU raycasting does not ignore transparent pixels, whereas GPU picking does. It might be a disadvantage or advantage depending on the use case.

Default Value

false
limit?: number

Maximum number of objects to return.

Default Value

Infinity
radius?: number

Radius (in pixels) for picking (default 0).

Picking will happen in a circle centered on the coordinates provided. Radius is the radius of this circle, in pixels.

This is honored by all native Giro3D picking methods, but may not be honored by customized picking methods.

Default Value

0