Engine API

The EditxEngine class is the main entry point for the engine.

Properties

History

All mutations are automatically tracked for undo/redo.

engine.undo();
engine.redo();
engine.canUndo(); // boolean
engine.canRedo(); // boolean
engine.clearHistory();

Batching

Batch multiple mutations into a single undo step:

engine.beginBatch();
engine.block.setPosition(id, 10, 20);
engine.block.setRotation(id, 45);
engine.endBatch(); // single undo step

Silent Mode

Suppress history tracking temporarily:

engine.beginSilent();
// ... mutations won't be recorded in history
engine.endSilent();

Active Scene & Page

engine.setActiveScene(sceneId);
engine.getActiveScene(); // number | null
engine.setActivePage(pageId);
engine.getActivePage(); // number | null

Events

// Generic event bus
engine.on("history:undo", () => { /* ... */ });
engine.off("history:undo", handler);

// Typed subscriptions (return unsubscribe function)
const unsub = engine.onHistoryChanged(() => { /* ... */ });
const unsub = engine.onZoomChanged((zoom) => { /* ... */ });
const unsub = engine.onEditModeChanged(({ mode, previousMode }) => { /* ... */ });

Export

const blob = await engine.exportScene({
  format: "png",   // "png" | "jpeg" | "webp"
  quality: 0.92,   // 0—1, for jpeg/webp
  pixelRatio: 2,   // DPR multiplier
});

Lifecycle

engine.dispose(); // clean up renderer and image cache