Interface ToolContext

interface ToolContext {
    engine: DotloomEngine;
    viewport: ViewportLike;
    apply(tx: Transaction): Promise<CommitReport | null>;
    pxToWorld(px: number): number;
    report(err: unknown): void;
    selection(): number[];
    setMarkers(markers: { at: Point; kind: MarkerKind }[] | undefined): void;
    setOverlay(o: OverlayState): void;
    setPrompt(key: string): void;
    setSelection(ids: number[]): Promise<void>;
    setSnapExclude(ids: number[]): void;
    setState(state: string): void;
    unitScale(): number;
}

Index

Properties

engine viewport

Methods

apply pxToWorld report selection setMarkers setOverlay setPrompt setSelection setSnapExclude setState unitScale

Properties

`Readonly`engine

engine: DotloomEngine

`Readonly`viewport

viewport: ViewportLike

Methods

apply

apply(tx: Transaction): Promise<CommitReport | null>
Apply a transaction; failures are reported in the editor state and return null.
Parameters
- tx: Transaction
Returns Promise<CommitReport | null>
- Defined in packages/sdk/src/editor/types.ts:59

pxToWorld

pxToWorld(px: number): number
CSS pixels → model units at the current zoom.
Parameters
- px: number
Returns number
- Defined in packages/sdk/src/editor/types.ts:64

report

report(err: unknown): void
Report an error without throwing.
Parameters
- err: unknown
Returns void
- Defined in packages/sdk/src/editor/types.ts:68

selection

selection(): number[]
Current selection.

Returns number[]
- Defined in packages/sdk/src/editor/types.ts:61

setMarkers

setMarkers(markers: { at: Point; kind: MarkerKind }[] | undefined): void
Show extra markers (e.g. grips).
Parameters
- markers: { at: Point; kind: MarkerKind }[] | undefined
Returns void
- Defined in packages/sdk/src/editor/types.ts:72

setOverlay

setOverlay(o: OverlayState): void
Draw the tool's preview (merged with the snap marker and grips).
Parameters
- o: OverlayState
Returns void
- Defined in packages/sdk/src/editor/types.ts:53

setPrompt

setPrompt(key: string): void
Status prompt key (UI translates it), e.g. tool.line.start.
Parameters
- key: string
Returns void
- Defined in packages/sdk/src/editor/types.ts:55

setSelection

setSelection(ids: number[]): Promise<void>
Parameters
- ids: number[]
Returns Promise<void>
- Defined in packages/sdk/src/editor/types.ts:62

setSnapExclude

setSnapExclude(ids: number[]): void
Entities ignored by snapping (e.g. the ones being dragged).
Parameters
- ids: number[]
Returns void
- Defined in packages/sdk/src/editor/types.ts:66

setState

setState(state: string): void
Tool state for the UI and tests: idle, start, preview, …
Parameters
- state: string
Returns void
- Defined in packages/sdk/src/editor/types.ts:57

unitScale

unitScale(): number
Model units per typed display unit.

Returns number
- Defined in packages/sdk/src/editor/types.ts:70