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

One or more icon classes for the control, typically Font Awesome classes such as "fa-solid fa-face-smile"

name

name: string

A unique identifier for the control

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

An integer indicating the control's order, with 0 being at the top

title

title: string

A title for the control: can be a localization path

tools

tools: Record<string, SceneControlTool>

Optionalvisible

visible?: boolean

Whether the control should be visible to the current User

Settings

Member Visibility

On This Page

Properties