@novorender/api / PickOptions

Interface: PickOptions

Defined in: @novorender/src/core3d/context.ts:1712

Extra pick options.

Properties

async?

readonly optional async: boolean;

Defined in: @novorender/src/core3d/context.ts:1719

---

pickCameraPlane?

readonly optional pickCameraPlane: boolean;

Defined in: @novorender/src/core3d/context.ts:1721

Return pick without depth.

---

pickOutline?

readonly optional pickOutline: boolean;

Defined in: @novorender/src/core3d/context.ts:1723

Return only picked pixels with clipping outline.

---

sampleDiscRadius?

readonly optional sampleDiscRadius: number;

Defined in: @novorender/src/core3d/context.ts:1714

The radius of the sample disc (0 yields a single pixel).

---

searchType?

readonly optional searchType: PickSearchType;

Defined in: @novorender/src/core3d/context.ts:1718

True to wait for the pick buffers to be available, false to return whatever is in the current pick buffer synchronously.

Remarks

The latter option is more error prone, but useful for e.g. mouse hover operations.