Interface SceneControl

The data structure for a set of controls in the SceneControls#controls record.

interface SceneControl {
    activeTool: string;
    icon: string;
    name: string;
    onChange?: (event: Event, active: boolean) => void;
    onToolChange?: (event: Event, tool: SceneControlTool) => void;
    order: number;
    title: string;
    tools: Record<string, SceneControlTool>;
    visible?: boolean;
}

Properties

activeTool icon name onChange? onToolChange? order title tools visible?

Properties

activeTool

activeTool: string

icon

icon: string

name

name: string

OptionalonChange

onChange?: (event: Event, active: boolean) => void

A callback invoked when control set is activated or deactivated

OptionalonToolChange

onToolChange?: (event: Event, tool: SceneControlTool) => void

A callback invoked when the active tool changes

order

order: number

title

title: string

tools

tools: Record<string, SceneControlTool>

Optionalvisible

visible?: boolean

Settings

Member Visibility

On This Page

Properties