Interface Tool

A tool: a small state machine driven by pointer and keyboard input (idle → start → preview → commit | cancel). Tools only issue engine commands.

interface Tool {
    cursor?: string;
    id: string;
    label: string;
    shortcut?: string;
    snaps?: boolean;
    activate?(ctx: ToolContext): void;
    cancel?(ctx: ToolContext, reason: CancelReason): void | Promise<void>;
    capturesKeyboard?(): boolean;
    deactivate?(ctx: ToolContext): void;
    doubleClick?(ctx: ToolContext, p: ToolPointer): void | Promise<void>;
    key?(ctx: ToolContext, key: InputKey): boolean | Promise<boolean>;
    pointerDown?(ctx: ToolContext, p: ToolPointer): void | Promise<void>;
    pointerMove?(ctx: ToolContext, p: ToolPointer): void | Promise<void>;
    pointerUp?(ctx: ToolContext, p: ToolPointer): void | Promise<void>;
    value?(ctx: ToolContext, text: string): boolean | Promise<boolean>;
}

Implemented by

Index

Properties

cursor? id label shortcut? snaps?

Methods

activate? cancel? capturesKeyboard? deactivate? doubleClick? key? pointerDown? pointerMove? pointerUp? value?

Properties

`Optional` `Readonly`cursor

cursor?: string

`Readonly`id

id: string

`Readonly`label

label: string

i18n key or plain label.

`Optional` `Readonly`shortcut

shortcut?: string

Single-key shortcut (e.g. l).

`Optional` `Readonly`snaps

snaps?: boolean

Whether pointer positions are snapped (default true).

Methods

`Optional`activate

activate?(ctx: ToolContext): void
Parameters
- ctx: ToolContext
Returns void
- Defined in packages/sdk/src/editor/types.ts:88

`Optional`cancel

cancel?(ctx: ToolContext, reason: CancelReason): void | Promise<void>
Abort the current operation and return to idle.
Parameters
- ctx: ToolContext
- reason: CancelReason
Returns void | Promise<void>
- Defined in packages/sdk/src/editor/types.ts:101

`Optional`capturesKeyboard

capturesKeyboard?(): boolean
While true, every key goes to key first (text entry); shortcuts are suspended.

Returns boolean
- Defined in packages/sdk/src/editor/types.ts:95

`Optional`deactivate

deactivate?(ctx: ToolContext): void
Parameters
- ctx: ToolContext
Returns void
- Defined in packages/sdk/src/editor/types.ts:89

`Optional`doubleClick

doubleClick?(ctx: ToolContext, p: ToolPointer): void | Promise<void>
Parameters
- ctx: ToolContext
- p: ToolPointer
Returns void | Promise<void>
- Defined in packages/sdk/src/editor/types.ts:93

`Optional`key

key?(ctx: ToolContext, key: InputKey): boolean | Promise<boolean>
Keys not consumed by global shortcuts (Enter, Backspace, …). Return true if handled.
Parameters
- ctx: ToolContext
- key: InputKey
Returns boolean | Promise<boolean>
- Defined in packages/sdk/src/editor/types.ts:97

`Optional`pointerDown

pointerDown?(ctx: ToolContext, p: ToolPointer): void | Promise<void>
Parameters
- ctx: ToolContext
- p: ToolPointer
Returns void | Promise<void>
- Defined in packages/sdk/src/editor/types.ts:90

`Optional`pointerMove

pointerMove?(ctx: ToolContext, p: ToolPointer): void | Promise<void>
Parameters
- ctx: ToolContext
- p: ToolPointer
Returns void | Promise<void>
- Defined in packages/sdk/src/editor/types.ts:91

`Optional`pointerUp

pointerUp?(ctx: ToolContext, p: ToolPointer): void | Promise<void>
Parameters
- ctx: ToolContext
- p: ToolPointer
Returns void | Promise<void>
- Defined in packages/sdk/src/editor/types.ts:92

`Optional`value

value?(ctx: ToolContext, text: string): boolean | Promise<boolean>
Typed value (numbers like 1200 or 600,400), submitted with Enter. Return true if accepted.
Parameters
- ctx: ToolContext
- text: string
Returns boolean | Promise<boolean>
- Defined in packages/sdk/src/editor/types.ts:99