Type Alias: PickingProps

PickingProps = object

Defined in: modules/engine/picking/picking.ts:17

Props for the picking module, which depending on mode renders picking colors or highlighted item. When active, renders picking colors, assumed to be rendered to off-screen "picking" buffer. When inactive, renders normal colors, with the exception of selected object which is rendered with highlight

Properties

highlightColor?

optional highlightColor?: NumberArray3 | NumberArray4

Defined in: modules/engine/picking/picking.ts:25

Color of visual highlight of "selected" item

---

highlightedObjectColor?

optional highlightedObjectColor?: NumberArray3 | null

Defined in: modules/engine/picking/picking.ts:23

Set to a picking color to visually highlight that item, or null to explicitly clear *

---

isActive?

optional isActive?: boolean

Defined in: modules/engine/picking/picking.ts:19

Are we picking? I.e. rendering picking colors?

---

isAttribute?

optional isAttribute?: boolean

Defined in: modules/engine/picking/picking.ts:21

Set to true when picking an attribute value instead of object index

---

useByteColors?

optional useByteColors?: boolean

Defined in: modules/engine/picking/picking.ts:27

Interpret highlight colors as byte-style 0-255 values.