Class PathTool

Path: click for straight segments; press-and-drag to pull a smooth cubic handle; click the first point to close; Enter or double-click to finish.

Implements

Tool

Index

Constructors

Properties

cursor id label shortcut

Methods

activate cancel doubleClick key pointerDown pointerMove pointerUp

Constructors

constructor

new PathTool(): PathTool

Returns PathTool

Properties

`Readonly`cursor

cursor: "crosshair" = 'crosshair'

`Readonly`id

id: "path" = 'path'

`Readonly`label

label: "tool.path" = 'tool.path'

i18n key or plain label.

`Readonly`shortcut

shortcut: "b" = 'b'

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

Methods

activate

activate(ctx: ToolContext): void
Parameters
- ctx: ToolContext
Returns void
Implementation of Tool.activate
- Defined in packages/sdk/src/editor/tools/draw.ts:349

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/draw.ts:431

doubleClick

doubleClick(ctx: ToolContext): Promise<void>
Parameters
- ctx: ToolContext
Returns Promise<void>
Implementation of Tool.doubleClick
- Defined in packages/sdk/src/editor/tools/draw.ts:409

key

key(ctx: ToolContext, k: InputKey): Promise<boolean>
Keys not consumed by global shortcuts (Enter, Backspace, …). Return true if handled.
Parameters
- ctx: ToolContext
- k: InputKey
Returns Promise<boolean>
Implementation of Tool.key
- Defined in packages/sdk/src/editor/tools/draw.ts:413

pointerDown

pointerDown(ctx: ToolContext, p: ToolPointer): Promise<void>
Parameters
- ctx: ToolContext
- p: ToolPointer
Returns Promise<void>
Implementation of Tool.pointerDown
- Defined in packages/sdk/src/editor/tools/draw.ts:361

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/draw.ts:371

pointerUp

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