@mlightcad/mtext-renderer 0.10.0 → 0.10.2

package/lib/worker/webWorkerRenderer.d.ts

@@ -0,0 +1,190 @@
+import { StyleManager } from '../renderer/styleManager';
+import { CharBox, ColorSettings, MTextData, TextStyle } from '../renderer/types';
+import { MTextBaseRenderer, MTextObject } from './baseRenderer';
+/**
+ * Configuration options for WebWorkerRenderer
+ */
+export interface WebWorkerRendererConfig {
+    /**
+     * Number of worker instances to create in the pool
+     * @default Math.max(1, Math.min(4, navigator.hardwareConcurrency || 2))
+     */
+    poolSize?: number;
+    /**
+     * URL path to the worker script
+     * @default './assets/mtext-renderer-worker.js'
+     */
+    workerUrl?: string | URL;
+    /**
+     * Timeout duration in milliseconds for worker requests
+     * @default 120000
+     */
+    timeOut?: number;
+}
+interface SerializedMText {
+    type: string;
+    position: {
+        x: number;
+        y: number;
+        z: number;
+    };
+    rotation: {
+        x: number;
+        y: number;
+        z: number;
+        w: number;
+    };
+    scale: {
+        x: number;
+        y: number;
+        z: number;
+    };
+    box: {
+        min: {
+            x: number;
+            y: number;
+            z: number;
+        };
+        max: {
+            x: number;
+            y: number;
+            z: number;
+        };
+    };
+    children: SerializedChild[];
+}
+interface SerializedCharBox {
+    type: string;
+    char: string;
+    box: {
+        min: {
+            x: number;
+            y: number;
+            z: number;
+        };
+        max: {
+            x: number;
+            y: number;
+            z: number;
+        };
+    };
+    children: SerializedCharBox[];
+}
+interface SerializedChild {
+    type: 'mesh' | 'line';
+    position: {
+        x: number;
+        y: number;
+        z: number;
+    };
+    rotation: {
+        x: number;
+        y: number;
+        z: number;
+        w: number;
+    };
+    scale: {
+        x: number;
+        y: number;
+        z: number;
+    };
+    geometry: {
+        attributes: {
+            [key: string]: {
+                arrayBuffer: ArrayBuffer;
+                byteOffset: number;
+                length: number;
+                itemSize: number;
+                normalized: boolean;
+            };
+        };
+        index: {
+            arrayBuffer: ArrayBuffer;
+            byteOffset: number;
+            length: number;
+            componentType?: 'uint16' | 'uint32';
+        } | null;
+    };
+    material: {
+        type: string;
+        color: number;
+        transparent: boolean;
+        opacity: number;
+        side?: number;
+        linewidth?: number;
+    };
+    charBoxType?: CharBox['type'];
+    lineLayouts?: Array<{
+        y: number;
+        height: number;
+        breakIndex?: number;
+    }>;
+    charBoxes?: SerializedCharBox[];
+}
+/**
+ * Manages communication with the MText web worker
+ */
+export declare class WebWorkerRenderer implements MTextBaseRenderer {
+    private workers;
+    private inFlightPerWorker;
+    private pendingRequests;
+    private requestId;
+    private poolSize;
+    private timeOut;
+    private readyPromise;
+    private isInitialized;
+    private defaultStyleManager;
+    constructor(config?: WebWorkerRendererConfig);
+    /**
+     * Used to manage materials used by texts
+     */
+    get styleManager(): StyleManager;
+    set styleManager(value: StyleManager);
+    private ensureInitialized;
+    /**
+     * Handles messages coming from any worker.
+     */
+    private handleWorkerMessage;
+    /**
+     * Attaches message and error handlers to a worker.
+     */
+    private attachWorkerHandlers;
+    private pickLeastLoadedWorker;
+    private sendMessageToAllWorkers;
+    private sendMessageToOneWorker;
+    private ensureTasksFinished;
+    /**
+     * Set URL to load fonts
+     * @param value - URL to load fonts
+     */
+    setFontUrl(value: string): Promise<void>;
+    /**
+     * Render MText in one worker and return serialized data asynchronously.
+     */
+    asyncRenderMText(mtextContent: MTextData, textStyle: TextStyle, colorSettings?: ColorSettings): Promise<MTextObject>;
+    /**
+     * Render MText synchronously.
+     * Notes: It isn't supported yet.
+     */
+    syncRenderMText(_mtextContent: MTextData, _textStyle: TextStyle, _colorSettings?: ColorSettings): MTextObject;
+    loadFonts(fonts: string[]): Promise<{
+        loaded: string[];
+    }>;
+    getAvailableFonts(): Promise<{
+        fonts: Array<{
+            name: string[];
+        }>;
+    }>;
+    /**
+     * Reconstruct MText object from JSON serialized data
+     */
+    reconstructMText(serializedData: SerializedMText, textStyle: TextStyle): MTextObject;
+    private deserializeCharBoxes;
+    private collectLayout;
+    /**
+     * Terminate the worker
+     */
+    terminate(): void;
+    destroy(): void;
+}
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mlightcad/mtext-renderer",
-  "version": "0.10.0",
+  "version": "0.10.2",
   "description": "AutoCAD MText renderer based on Three.js",
   "license": "MIT",
   "author": "MLight Lee <mlight.lee@outlook.com>",
@@ -33,7 +33,7 @@
     "3d-text"
   ],
   "dependencies": {
-    "@mlightcad/mtext-parser": "^1.3.2",
+    "@mlightcad/mtext-parser": "^1.3.3",
     "@mlightcad/shx-parser": "^1.3.2",
     "iconv-lite": "^0.7.0",
     "idb": "^8.0.3",