js-draw 1.8.0 → 1.9.1

package/dist/mjs/Viewport.d.ts

@@ -50,6 +50,11 @@ export declare class Viewport {
     private getScaleFactorToNearestPowerOf;
     /** Returns the size of a grid cell (in canvas units) as used by {@link snapToGrid}. */
     static getGridSize(scaleFactor: number): number;
+    /**
+     * Snaps `canvasPos` to the nearest grid cell corner.
+     *
+     * @see {@link getGridSize} and {@link getScaleFactorToNearestPowerOf}.
+     */
     snapToGrid(canvasPos: Point2): Vec3;
     /** Returns the size of one screen pixel in canvas units. */
     getSizeOfPixelOnCanvas(): number;
@@ -65,6 +70,7 @@ export declare class Viewport {
      * its original location. This is useful for preparing data for base-10 conversion.
      */
     static roundPoint<T extends Point2 | number>(point: T, tolerance: number): PointDataType<T>;
+    /** Round a point with a tolerance of ±1 screen unit. */
     roundPoint(point: Point2): Point2;
     static roundScaleRatio(scaleRatio: number, roundAmount?: number): number;
     computeZoomToTransform(toMakeVisible: Rect2, allowZoomIn?: boolean, allowZoomOut?: boolean): Mat33;

package/dist/mjs/Viewport.mjs

@@ -97,6 +97,11 @@ export class Viewport {
     static getGridSize(scaleFactor) {
         return 50 / scaleFactor;
     }
+    /**
+     * Snaps `canvasPos` to the nearest grid cell corner.
+     *
+     * @see {@link getGridSize} and {@link getScaleFactorToNearestPowerOf}.
+     */
     snapToGrid(canvasPos) {
         const scaleFactor = this.getScaleFactorToNearestPowerOf(2);
         const snapCoordinate = (coordinate) => {
@@ -133,7 +138,7 @@ export class Viewport {
         }
         return point.map(roundComponent);
     }
-    // Round a point with a tolerance of ±1 screen unit.
+    /** Round a point with a tolerance of ±1 screen unit. */
     roundPoint(point) {
         return Viewport.roundPoint(point, 1 / this.getScaleFactor());
     }

package/dist/mjs/image/EditorImage.d.ts

@@ -123,8 +123,28 @@ export default class EditorImage {
      */
     private setExportRectDirectly;
     private onExportViewportChanged;
+    /**
+     * @internal
+     *
+     * Enables debug mode for **all** `EditorImage`s.
+     *
+     * **Only use for debugging**.
+     *
+     * @internal
+     */
+    setDebugMode(newDebugMode: boolean): void;
     private static SetImportExportRectCommand;
 }
+/**
+ * Determines the first index in `sortedLeaves` that needs to be rendered
+ * (based on occlusion -- everything before that index can be skipped and
+ * produce a visually-equivalent image).
+ *
+ * Does nothing if visibleRect is not provided
+ *
+ * @internal
+ */
+export declare const computeFirstIndexToRender: (sortedLeaves: Array<ImageNode>, visibleRect?: Rect2) => number;
 type TooSmallToRenderCheck = (rect: Rect2) => boolean;
 /**
  * Part of the Editor's image. Does not handle fullscreen/invisible components.

package/dist/mjs/image/EditorImage.mjs

@@ -19,7 +19,7 @@ export var EditorImageEventType;
     EditorImageEventType[EditorImageEventType["ExportViewportChanged"] = 0] = "ExportViewportChanged";
     EditorImageEventType[EditorImageEventType["AutoresizeModeChanged"] = 1] = "AutoresizeModeChanged";
 })(EditorImageEventType || (EditorImageEventType = {}));
-const debugMode = false;
+let debugMode = false;
 // Handles lookup/storage of elements in the image
 class EditorImage {
     // @internal
@@ -271,6 +271,18 @@ class EditorImage {
             });
         }
     }
+    /**
+     * @internal
+     *
+     * Enables debug mode for **all** `EditorImage`s.
+     *
+     * **Only use for debugging**.
+     *
+     * @internal
+     */
+    setDebugMode(newDebugMode) {
+        debugMode = newDebugMode;
+    }
 }
 _a = EditorImage;
 // A Command that can access private [EditorImage] functionality
@@ -410,6 +422,30 @@ EditorImage.SetImportExportRectCommand = (_c = class extends SerializableCommand
     })(),
     _c);
 export default EditorImage;
+/**
+ * Determines the first index in `sortedLeaves` that needs to be rendered
+ * (based on occlusion -- everything before that index can be skipped and
+ * produce a visually-equivalent image).
+ *
+ * Does nothing if visibleRect is not provided
+ *
+ * @internal
+ */
+export const computeFirstIndexToRender = (sortedLeaves, visibleRect) => {
+    let startIndex = 0;
+    if (visibleRect) {
+        for (let i = sortedLeaves.length - 1; i >= 1; i--) {
+            if (
+            // Check for occlusion
+            sortedLeaves[i].getBBox().containsRect(visibleRect)
+                && sortedLeaves[i].getContent()?.occludesEverythingBelowWhenRenderedInRect(visibleRect)) {
+                startIndex = i;
+                break;
+            }
+        }
+    }
+    return startIndex;
+};
 /**
  * Part of the Editor's image. Does not handle fullscreen/invisible components.
  * @internal
@@ -666,15 +702,7 @@ export class ImageNode {
         // If some components hide others (and we're permitted to simplify,
         // which is true in the case of visibleRect being defined), then only
         // draw the non-hidden components:
-        let startIndex = 0;
-        if (visibleRect) {
-            for (let i = leaves.length - 1; i >= 1; i--) {
-                if (leaves[i].getContent()?.occludesEverythingBelowWhenRenderedInRect(visibleRect)) {
-                    startIndex = i;
-                    break;
-                }
-            }
-        }
+        const startIndex = computeFirstIndexToRender(leaves);
         for (let i = startIndex; i < leaves.length; i++) {
             const leaf = leaves[i];
             // Leaves by definition have content

package/dist/mjs/rendering/Display.d.ts

@@ -26,6 +26,7 @@ export default class Display {
     private textRenderer;
     private textRerenderOutput;
     private cache;
+    private devicePixelRatio;
     private resizeSurfacesCallback?;
     private flattenCallback?;
     /** @internal */
@@ -46,6 +47,14 @@ export default class Display {
     getColorAt: (_screenPos: Point2) => Color4 | null;
     private initializeCanvasRendering;
     private initializeTextRendering;
+    /**
+     * Sets the device-pixel-ratio.
+     *
+     * Intended for debugging. Users do not need to call this manually.
+     *
+     * @internal
+     */
+    setDevicePixelRatio(dpr: number): Promise<void> | undefined;
     /**
      * Rerenders the text-based display.
      * The text-based display is intended for screen readers and can be navigated to by pressing `tab`.

package/dist/mjs/rendering/Display.mjs

@@ -28,6 +28,7 @@ export default class Display {
         this.editor = editor;
         this.parent = parent;
         this.textRerenderOutput = null;
+        this.devicePixelRatio = window.devicePixelRatio ?? 1;
         /**
          * @returns the color at the given point on the dry ink renderer, or `null` if `screenPos`
          * 	is not on the display.
@@ -112,16 +113,32 @@ export default class Display {
             this.parent.appendChild(wetInkCanvas);
         }
         this.resizeSurfacesCallback = () => {
+            const expectedWidth = (canvas) => {
+                return Math.ceil(canvas.clientWidth * this.devicePixelRatio);
+            };
+            const expectedHeight = (canvas) => {
+                return Math.ceil(canvas.clientHeight * this.devicePixelRatio);
+            };
             const hasSizeMismatch = (canvas) => {
-                return canvas.clientHeight !== canvas.height || canvas.clientWidth !== canvas.width;
+                return expectedHeight(canvas) !== canvas.height || expectedWidth(canvas) !== canvas.width;
             };
             // Ensure that the drawing surfaces sizes match the
             // canvas' sizes to prevent stretching.
             if (hasSizeMismatch(dryInkCanvas) || hasSizeMismatch(wetInkCanvas)) {
-                dryInkCanvas.width = dryInkCanvas.clientWidth;
-                dryInkCanvas.height = dryInkCanvas.clientHeight;
-                wetInkCanvas.width = wetInkCanvas.clientWidth;
-                wetInkCanvas.height = wetInkCanvas.clientHeight;
+                dryInkCanvas.width = expectedWidth(dryInkCanvas);
+                dryInkCanvas.height = expectedHeight(dryInkCanvas);
+                wetInkCanvas.width = expectedWidth(wetInkCanvas);
+                wetInkCanvas.height = expectedHeight(wetInkCanvas);
+                // Ensure correct drawing operations on high-resolution screens.
+                // See
+                // https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API/Tutorial/Optimizing_canvas#scaling_for_high_resolution_displays
+                //
+                // This scaling causes the rendering contexts to automatically convert
+                // between screen coordinates and pixel coordinates.
+                wetInkCtx.resetTransform();
+                dryInkCtx.resetTransform();
+                dryInkCtx.scale(this.devicePixelRatio, this.devicePixelRatio);
+                wetInkCtx.scale(this.devicePixelRatio, this.devicePixelRatio);
                 this.editor.notifier.dispatch(EditorEventType.DisplayResized, {
                     kind: EditorEventType.DisplayResized,
                     newSize: Vec2.of(this.width, this.height),
@@ -130,10 +147,17 @@ export default class Display {
         };
         this.resizeSurfacesCallback();
         this.flattenCallback = () => {
+            dryInkCtx.save();
+            dryInkCtx.resetTransform();
             dryInkCtx.drawImage(wetInkCanvas, 0, 0);
+            dryInkCtx.restore();
         };
         this.getColorAt = (screenPos) => {
-            const pixel = dryInkCtx.getImageData(screenPos.x, screenPos.y, 1, 1);
+            // getImageData isn't affected by a transformation matrix -- we need to
+            // pre-transform screenPos to convert it from screen coordinates into pixel
+            // coordinates.
+            const adjustedScreenPos = screenPos.times(this.devicePixelRatio);
+            const pixel = dryInkCtx.getImageData(adjustedScreenPos.x, adjustedScreenPos.y, 1, 1);
             const data = pixel?.data;
             if (data) {
                 const color = Color4.ofRGBA(data[0] / 255, data[1] / 255, data[2] / 255, data[3] / 255);
@@ -156,6 +180,23 @@ export default class Display {
         textRendererOutputContainer.replaceChildren(rerenderButton, this.textRerenderOutput);
         this.editor.createHTMLOverlay(textRendererOutputContainer);
     }
+    /**
+     * Sets the device-pixel-ratio.
+     *
+     * Intended for debugging. Users do not need to call this manually.
+     *
+     * @internal
+     */
+    setDevicePixelRatio(dpr) {
+        const minDpr = 0.001;
+        const maxDpr = 10;
+        if (isFinite(dpr) && dpr >= minDpr && dpr <= maxDpr && dpr !== this.devicePixelRatio) {
+            this.devicePixelRatio = dpr;
+            this.resizeSurfacesCallback?.();
+            return this.editor.queueRerender();
+        }
+        return undefined;
+    }
     /**
      * Rerenders the text-based display.
      * The text-based display is intended for screen readers and can be navigated to by pressing `tab`.

package/dist/mjs/rendering/caching/CacheRecordManager.mjs

@@ -1,5 +1,4 @@
 import  CacheRecord  from './CacheRecord.mjs';
-const debugMode = false;
 export class CacheRecordManager {
     constructor(cacheProps) {
         // Fixed-size array: Cache blocks are assigned indicies into [cachedCanvases].
@@ -16,19 +15,19 @@ export class CacheRecordManager {
             const record = new CacheRecord(onDealloc, this.cacheState);
             record.setRenderingRegion(drawTo);
             this.cacheRecords.push(record);
-            if (debugMode) {
+            if (this.cacheState.debugMode) {
                 console.log('[Cache] Cache spaces used: ', this.cacheRecords.length, ' of ', this.maxCanvases);
             }
             return record;
         }
         else {
             const lru = this.getLeastRecentlyUsedRecord();
-            if (debugMode) {
+            if (this.cacheState.debugMode) {
                 console.log('[Cache] Re-alloc. Times allocated: ', lru.allocCount, '\nLast used cycle: ', lru.getLastUsedCycle(), '\nCurrent cycle: ', this.cacheState.currentRenderingCycle);
             }
             lru.realloc(onDealloc);
             lru.setRenderingRegion(drawTo);
-            if (debugMode) {
+            if (this.cacheState.debugMode) {
                 console.log('[Cache] Now re-alloc\'d. Last used cycle: ', lru.getLastUsedCycle());
                 console.assert(lru['cacheState'] === this.cacheState, '[Cache] Unequal cache states! cacheState should be a shared object!');
             }

package/dist/mjs/rendering/caching/RenderingCache.d.ts

@@ -9,4 +9,5 @@ export default class RenderingCache {
     constructor(cacheProps: CacheProps);
     render(screenRenderer: AbstractRenderer, image: ImageNode, viewport: Viewport): void;
     getDebugInfo(): string;
+    setIsDebugMode(debugMode: boolean): void;
 }

package/dist/mjs/rendering/caching/RenderingCache.mjs

@@ -8,6 +8,7 @@ export default class RenderingCache {
             props: cacheProps,
             currentRenderingCycle: 0,
             recordManager: this.recordManager,
+            debugMode: false,
         };
         this.recordManager.setSharedState(this.sharedState);
     }
@@ -44,4 +45,7 @@ export default class RenderingCache {
     getDebugInfo() {
         return this.recordManager.getDebugInfo();
     }
+    setIsDebugMode(debugMode) {
+        this.sharedState.debugMode = debugMode;
+    }
 }

package/dist/mjs/rendering/caching/RenderingCacheNode.mjs

@@ -1,10 +1,8 @@
 // A cache record with sub-nodes.
-import  { sortLeavesByZIndex }  from '../../image/EditorImage.mjs';
+import  { computeFirstIndexToRender, sortLeavesByZIndex }  from '../../image/EditorImage.mjs';
 import { Rect2, Color4 } from '@js-draw/math';
 // 3x3 divisions for each node.
 const cacheDivisionSize = 3;
-// True: Show rendering updates.
-const debugMode = false;
 export default class RenderingCacheNode {
     constructor(region, cacheState) {
         this.region = region;
@@ -161,8 +159,8 @@ export default class RenderingCacheNode {
             items.forEach(item => item.render(screenRenderer, viewport.visibleRect));
             return;
         }
-        if (debugMode) {
-            screenRenderer.drawRect(this.region, 0.5 * viewport.getSizeOfPixelOnCanvas(), { fill: Color4.yellow });
+        if (this.cacheState.debugMode) {
+            screenRenderer.drawRect(this.region, viewport.getSizeOfPixelOnCanvas(), { fill: Color4.yellow });
         }
         // Could we render direclty from [this] or do we need to recurse?
         const couldRender = this.renderingWouldBeHighEnoughResolution(viewport);
@@ -197,7 +195,9 @@ export default class RenderingCacheNode {
                 }
                 let leafApproxRenderTime = 0;
                 for (const leaf of leavesByIds) {
-                    leafApproxRenderTime += leaf.getContent().getProportionalRenderingTime();
+                    if (!tooSmallToRender(leaf.getBBox())) {
+                        leafApproxRenderTime += leaf.getContent().getProportionalRenderingTime();
+                    }
                 }
                 // Is it worth it to render the items?
                 if (leafApproxRenderTime > this.cacheState.props.minProportionalRenderTimePerCache) {
@@ -233,26 +233,30 @@ export default class RenderingCacheNode {
                                     this.renderedMaxZIndex = zIndex;
                                 }
                             }
-                            if (debugMode) {
-                                screenRenderer.drawRect(this.region, viewport.getSizeOfPixelOnCanvas(), { fill: Color4.clay });
+                            if (this.cacheState.debugMode) {
+                                // Clay for adding new elements
+                                screenRenderer.drawRect(this.region, 2 * viewport.getSizeOfPixelOnCanvas(), { fill: Color4.clay });
                             }
                         }
                     }
-                    else if (debugMode) {
+                    else if (this.cacheState.debugMode) {
                         console.log('Decided on a full re-render. Reason: At least one of the following is false:', '\n leafIds.length > this.renderedIds.length: ', leafIds.length > this.renderedIds.length, '\n this.allRenderedIdsIn(leafIds): ', this.allRenderedIdsIn(leafIds), '\n this.renderedMaxZIndex !== null: ', this.renderedMaxZIndex !== null, '\n\nthis.rerenderedIds: ', this.renderedIds, ', leafIds: ', leafIds);
                     }
                     if (fullRerenderNeeded) {
                         thisRenderer = this.cachedRenderer.startRender();
                         thisRenderer.clear();
                         this.renderedMaxZIndex = null;
-                        for (const leaf of leaves) {
+                        const startIndex = computeFirstIndexToRender(leaves, this.region);
+                        for (let i = startIndex; i < leaves.length; i++) {
+                            const leaf = leaves[i];
                             const content = leaf.getContent();
                             this.renderedMaxZIndex ??= content.getZIndex();
                             this.renderedMaxZIndex = Math.max(this.renderedMaxZIndex, content.getZIndex());
                             leaf.render(thisRenderer, this.region);
                         }
-                        if (debugMode) {
-                            screenRenderer.drawRect(this.region, viewport.getSizeOfPixelOnCanvas(), { fill: Color4.red });
+                        if (this.cacheState.debugMode) {
+                            // Red for full rerender
+                            screenRenderer.drawRect(this.region, 3 * viewport.getSizeOfPixelOnCanvas(), { fill: Color4.red });
                         }
                     }
                     this.renderedIds = leafIds;
@@ -269,6 +273,10 @@ export default class RenderingCacheNode {
                         leaf.render(screenRenderer, this.region.intersection(viewport.visibleRect));
                     }
                     screenRenderer.endObject();
+                    if (this.cacheState.debugMode) {
+                        // Green for no cache needed render
+                        screenRenderer.drawRect(this.region, 2 * viewport.getSizeOfPixelOnCanvas(), { fill: Color4.green });
+                    }
                 }
             }
             else {

package/dist/mjs/rendering/caching/types.d.ts

@@ -16,4 +16,5 @@ export interface CacheState {
     currentRenderingCycle: number;
     props: CacheProps;
     recordManager: CacheRecordManager;
+    debugMode: boolean;
 }

package/dist/mjs/rendering/renderers/CanvasRenderer.mjs

@@ -77,7 +77,10 @@ export default class CanvasRenderer extends AbstractRenderer {
         return Vec2.of(this.ctx.canvas.clientWidth, this.ctx.canvas.clientHeight);
     }
     clear() {
+        this.ctx.save();
+        this.ctx.resetTransform();
         this.ctx.clearRect(0, 0, this.ctx.canvas.width, this.ctx.canvas.height);
+        this.ctx.restore();
     }
     beginPath(startPoint) {
         startPoint = this.canvasToScreen(startPoint);

package/dist/mjs/version.mjs

@@ -1,3 +1,3 @@
 export default {
-    number: '1.8.0',
+    number: '1.9.1',
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "js-draw",
-  "version": "1.8.0",
+  "version": "1.9.1",
   "description": "Draw pictures using a pen, touchscreen, or mouse! JS-draw is a drawing library for JavaScript and TypeScript. ",
   "types": "./dist/mjs/lib.d.ts",
   "main": "./dist/cjs/lib.js",
@@ -55,7 +55,7 @@
   "license": "MIT",
   "private": false,
   "scripts": {
-    "dist-test": "npm run build && cd dist-test/test_imports && npm install && npm run test",
+    "dist-test": "cd dist-test/test_imports && npm install && npm run test",
     "dist": "npm run build && npm run dist-test",
     "build": "rm -rf ./dist/* && mkdir -p dist && build-tool build",
     "watch": "rm -rf ./dist/* && mkdir -p dist && build-tool watch",
@@ -64,7 +64,7 @@
     "postpack": "ts-node tools/copyREADME.ts revert"
   },
   "dependencies": {
-    "@js-draw/math": "^1.8.0",
+    "@js-draw/math": "^1.9.0",
     "@melloware/coloris": "0.21.0"
   },
   "devDependencies": {
@@ -86,5 +86,5 @@
     "freehand",
     "svg"
   ],
-  "gitHead": "89f7991833dec5c17ce0890321286198ff7b1900"
+  "gitHead": "b4bae7b437b2ce4ba8378a062b8e3959dca0f26e"
 }