Class PanTool

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

Implements

Tool

Index

Constructors

Properties

cursor id label shortcut snaps

Methods

cancel pointerDown pointerMove pointerUp

Constructors

constructor

new PanTool(): PanTool

Returns PanTool

Properties

`Readonly`cursor

cursor: "grab" = 'grab'

`Readonly`id

id: "pan" = 'pan'

`Readonly`label

label: "tool.pan" = 'tool.pan'

i18n key or plain label.

`Readonly`shortcut

shortcut: "h" = 'h'

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

`Readonly`snaps

snaps: false

Whether pointer positions are snapped (default true).

Methods

cancel

cancel(ctx: ToolContext): void
Abort the current operation and return to idle.
Parameters
- ctx: ToolContext
Returns void
Implementation of Tool.cancel
- Defined in packages/sdk/src/editor/tools/select.ts:232

pointerDown

pointerDown(ctx: ToolContext, p: ToolPointer): void
Parameters
- ctx: ToolContext
- p: ToolPointer
Returns void
Implementation of Tool.pointerDown
- Defined in packages/sdk/src/editor/tools/select.ts:215

pointerMove

pointerMove(ctx: ToolContext, p: ToolPointer): void
Parameters
- ctx: ToolContext
- p: ToolPointer
Returns void
Implementation of Tool.pointerMove
- Defined in packages/sdk/src/editor/tools/select.ts:220

pointerUp

pointerUp(ctx: ToolContext): void
Parameters
- ctx: ToolContext
Returns void
Implementation of Tool.pointerUp
- Defined in packages/sdk/src/editor/tools/select.ts:227