Interface SceneControlTool

The data structure for a single tool in the SceneControl#tools record.

interface SceneControlTool {
    active?: boolean;
    button?: boolean;
    icon: string;
    name: string;
    onChange?: (event: Event, active: boolean) => void;
    order: number;
    title: string;
    toggle?: boolean;
    toolclip?: ToolclipConfiguration;
    visible?: boolean;
}

Properties

active? button? icon name onChange? order title toggle? toolclip? visible?

Properties

Optionalactive

active?: boolean

Is the tool the currently the active one? Not applicable to toggles or buttons.

Optionalbutton

button?: boolean

Is the tool a "button" in the sense of immediately resolving on click without becoming the active tool?

icon

icon: string

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

name

name: string

An identifier for the tool, unique among the tools of its SceneControl

OptionalonChange

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

A callback invoked when the tool is activated or deactivated

order

order: number

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

title

title: string

A title for the tool: can be a localization path

Optionaltoggle

toggle?: boolean

Is the tool an on-or-off toggle?

Optionaltoolclip

toolclip?: ToolclipConfiguration

Configuration for rendering the tool's toolclip

Optionalvisible

visible?: boolean

Whether the tool should be visible to the current User

Settings

Member Visibility

On This Page

Properties