GizmoStyle

Defined in: client/api.d.ts:2278

Appearance and lifetime of a client debug drawing.

Properties

color?

optional color?: number

Defined in: client/api.d.ts:2282

Unsigned 0xAARRGGBB color. Defaults to 0xFF6EE678 (opaque green).

---

depthTest?

optional depthTest?: boolean

Defined in: client/api.d.ts:2292

Defaults to true: scene geometry occludes the drawing. Set false to show through walls. Drawings never write scene depth.

---

durationMs?

optional durationMs?: number

Defined in: client/api.d.ts:2302

Integer lifetime from 0 to 3600000 milliseconds. Zero (default) persists until removed. Replacing the drawing restarts its lifetime.

---

fillColor?

optional fillColor?: number

Defined in: client/api.d.ts:2297

Unsigned 0xAARRGGBB fill color. Defaults to transparent (outline only). Supports boxes, spheres, circles, cones, cylinders, capsules, arrow heads and meshes. Throws for lines, polylines, grids, axes and polygon areas, which have no faces; fill a polygon with explicit mesh triangles.

---

width?

optional width?: number

Defined in: client/api.d.ts:2287

Line width in pixels, 0.5 to 8. Defaults to 1.5; polygon vertical edges use 60% of this width.