ToolsOverlay

interface ToolsOverlay

import type { ToolsOverlay } from '@driftengine/tools';

Properties

Name	Type	Description
`root`readonly	`UiNode`	The tree the whole overlay is in. One absolutely placed child per panel.
`undo`readonly	`UndoStack`
`visible`readonly	`boolean`
`layoutCount`readonly	`number`	How many times the tree has been rebuilt and laid out. Read by tests, and by nothing else.

sites(): readonly OverlaySite[]

setVisible(visible: boolean): void

Parameter	Type	Description
`visible`	`boolean`

toggle(): void

resize(width: number, height: number): void

Parameter	Type	Description
`width`	`number`
`height`	`number`

frame(now: number): void

Parameter	Type	Description
`now`	`number`

route(event: UiEvent): boolean

Deliver one event. True where the overlay took it, so a host knows not to pass it on.

Parameter	Type	Description
`event`	`UiEvent`

invalidate(): void

Say the world changed, so the next frame rebuilds. A profiler calls this every frame.

dispose(): void