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

Optionalbutton

button?: boolean

icon

icon: string

name

name: string

OptionalonChange

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

A callback invoked when the tool is activated or deactivated

order

order: number

title

title: string

Optionaltoggle

toggle?: boolean

Optionaltoolclip

toolclip?: ToolclipConfiguration

Configuration for rendering the tool's toolclip

Optionalvisible

visible?: boolean

Settings

Member Visibility

On This Page

Properties