@mlightcad/mtext-renderer 0.4.5 → 0.4.7

package/{dist → lib}/index.d.ts

@@ -1,3 +1,4 @@
 export * from './common/eventManager';
 export * from './font';
 export * from './renderer';
+export * from './worker';

package/lib/worker/base-renderer.d.ts

@@ -0,0 +1,50 @@
+import { MTextData, TextStyle, ColorSettings } from '../renderer/types';
+import * as THREE from 'three';
+/**
+ * Defines the common rendering contract for producing Three.js objects from MText content.
+ *
+ * Implementations may render on the main thread or delegate work to a Web Worker,
+ * but they must expose the same high-level API so callers can switch strategies
+ * without changing usage.
+ */
+export interface MTextBaseRenderer {
+    /**
+     * Render the provided MText content into a Three.js object hierarchy.
+     *
+     * The returned root object contains meshes/lines for glyphs and exposes a
+     * bounding box on `object.box` if available.
+     *
+     * @param mtextContent Structured MText input (text, height, width, position).
+     * @param textStyle Text style to apply (font, width factor, oblique, etc.).
+     * @param colorSettings Optional color context (ByLayer, ByBlock colors).
+     * @returns A Promise resolving to a populated `THREE.Object3D` ready to add to a scene.
+     */
+    renderMText(mtextContent: MTextData, textStyle: TextStyle, colorSettings?: ColorSettings): Promise<THREE.Object3D>;
+    /**
+     * Ensure the specified fonts are available to the renderer.
+     *
+     * Implementations should load and cache missing fonts; repeated calls should be cheap.
+     *
+     * @param fonts Font names to load (without extension for built-ins).
+     * @returns A Promise with the list of fonts that were processed.
+     */
+    loadFonts(fonts: string[]): Promise<{
+        loaded: string[];
+    }>;
+    /**
+     * Retrieve the list of fonts that can be used by the renderer.
+     *
+     * The shape of each font entry is implementation-defined but should include a displayable name.
+     *
+     * @returns A Promise with available font metadata.
+     */
+    getAvailableFonts(): Promise<{
+        fonts: any[];
+    }>;
+    /**
+     * Release any resources owned by the renderer (e.g., terminate Web Workers).
+     *
+     * Safe to call multiple times.
+     */
+    destroy(): void;
+}

package/lib/worker/baseRenderer.d.ts

@@ -0,0 +1,64 @@
+import { MTextData, TextStyle, ColorSettings } from '../renderer/types';
+import * as THREE from 'three';
+/**
+ * Represents a rendered MText object that extends THREE.Object3D with additional MText-specific properties.
+ * This interface defines the contract for objects returned by MText renderers.
+ */
+export interface MTextObject extends THREE.Object3D {
+    /**
+     * The bounding box of the MText object in local coordinates.
+     * This box represents the bounds of the text content without considering transformations.
+     * To get the world-space bounding box, apply the object's world matrix to this box.
+     */
+    box: THREE.Box3;
+}
+/**
+ * Defines the common rendering contract for producing Three.js objects from MText content.
+ *
+ * Implementations may render on the main thread or delegate work to a Web Worker,
+ * but they must expose the same high-level API so callers can switch strategies
+ * without changing usage.
+ */
+export interface MTextBaseRenderer {
+    /**
+     * Render the provided MText content into a Three.js object hierarchy.
+     *
+     * The returned root object contains meshes/lines for glyphs and exposes a
+     * bounding box on `object.box`.
+     *
+     * @param mtextContent Structured MText input (text, height, width, position).
+     * @param textStyle Text style to apply (font, width factor, oblique, etc.).
+     * @param colorSettings Optional color context (ByLayer, ByBlock colors).
+     * @returns A Promise resolving to a populated `MTextObject` ready to add to a scene.
+     */
+    renderMText(mtextContent: MTextData, textStyle: TextStyle, colorSettings?: ColorSettings): Promise<MTextObject>;
+    /**
+     * Ensure the specified fonts are available to the renderer.
+     *
+     * Implementations should load and cache missing fonts; repeated calls should be cheap.
+     *
+     * @param fonts Font names to load (without extension for built-ins).
+     * @returns A Promise with the list of fonts that were processed.
+     */
+    loadFonts(fonts: string[]): Promise<{
+        loaded: string[];
+    }>;
+    /**
+     * Retrieve the list of fonts that can be used by the renderer.
+     *
+     * The shape of each font entry is implementation-defined but should include a displayable name.
+     *
+     * @returns A Promise with available font metadata.
+     */
+    getAvailableFonts(): Promise<{
+        fonts: Array<{
+            name: string[];
+        }>;
+    }>;
+    /**
+     * Release any resources owned by the renderer (e.g., terminate Web Workers).
+     *
+     * Safe to call multiple times.
+     */
+    destroy(): void;
+}

package/lib/worker/index.d.ts

@@ -0,0 +1,5 @@
+export * from './webWorkerRenderer';
+export * from './mainThreadRenderer';
+export * from './unifiedRenderer';
+export * from './unifiedRenderer';
+export * from './baseRenderer';

package/lib/worker/main-thread-renderer.d.ts

@@ -0,0 +1,30 @@
+import { MTextData, TextStyle, ColorSettings } from '../renderer/types';
+import { MTextBaseRenderer } from './base-renderer';
+import * as THREE from 'three';
+/**
+ * Main thread renderer for MText objects
+ * This provides the same interface as the worker but runs in the main thread
+ */
+export declare class MainThreadRenderer implements MTextBaseRenderer {
+    private fontManager;
+    private styleManager;
+    private fontLoader;
+    constructor();
+    /**
+     * Render MText directly in the main thread
+     */
+    renderMText(mtextContent: MTextData, textStyle: TextStyle, colorSettings?: ColorSettings): Promise<THREE.Object3D>;
+    /**
+     * Load fonts in the main thread
+     */
+    loadFonts(fonts: string[]): Promise<{
+        loaded: string[];
+    }>;
+    /**
+     * Get available fonts from the main thread
+     */
+    getAvailableFonts(): Promise<{
+        fonts: any[];
+    }>;
+    destroy(): void;
+}

package/lib/worker/mainThreadRenderer.d.ts

@@ -0,0 +1,32 @@
+import { MTextData, TextStyle, ColorSettings } from '../renderer/types';
+import { MTextBaseRenderer, MTextObject } from './baseRenderer';
+
+/**
+ * Main thread renderer for MText objects
+ * This provides the same interface as the worker but runs in the main thread
+ */
+export declare class MainThreadRenderer implements MTextBaseRenderer {
+    private fontManager;
+    private styleManager;
+    private fontLoader;
+    constructor();
+    /**
+     * Render MText directly in the main thread
+     */
+    renderMText(mtextContent: MTextData, textStyle: TextStyle, colorSettings?: ColorSettings): Promise<MTextObject>;
+    /**
+     * Load fonts in the main thread
+     */
+    loadFonts(fonts: string[]): Promise<{
+        loaded: string[];
+    }>;
+    /**
+     * Get available fonts from the main thread
+     */
+    getAvailableFonts(): Promise<{
+        fonts: Array<{
+            name: string[];
+        }>;
+    }>;
+    destroy(): void;
+}

package/lib/worker/mtext-worker.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/worker/mtextWorker.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/worker/unified-renderer.d.ts

@@ -0,0 +1,41 @@
+import { MTextData, TextStyle, ColorSettings } from '../renderer/types';
+import * as THREE from 'three';
+export type RenderMode = 'main' | 'worker';
+/**
+ * Unified renderer that can work in both main thread and web worker modes
+ */
+export declare class UnifiedRenderer {
+    private workerManager;
+    private mainThreadRenderer;
+    private adapter;
+    private currentMode;
+    constructor(mode?: RenderMode);
+    /**
+     * Switch between main thread and worker rendering modes
+     */
+    switchMode(mode: RenderMode): void;
+    /**
+     * Get current rendering mode
+     */
+    getMode(): RenderMode;
+    /**
+     * Render MText using the current mode
+     */
+    renderMText(mtextContent: MTextData, textStyle: TextStyle, colorSettings?: ColorSettings): Promise<THREE.Object3D>;
+    /**
+     * Load fonts using the current mode
+     */
+    loadFonts(fonts: string[]): Promise<{
+        loaded: string[];
+    }>;
+    /**
+     * Get available fonts using the current mode
+     */
+    getAvailableFonts(): Promise<{
+        fonts: any[];
+    }>;
+    /**
+     * Clean up resources
+     */
+    destroy(): void;
+}

package/lib/worker/unifiedRenderer.d.ts

@@ -0,0 +1,44 @@
+import { MTextData, TextStyle, ColorSettings } from '../renderer/types';
+import { MTextObject } from './baseRenderer';
+
+export type RenderMode = 'main' | 'worker';
+/**
+ * Unified renderer that can work in both main thread and web worker modes
+ */
+export declare class UnifiedRenderer {
+    private workerManager;
+    private mainThreadRenderer;
+    private adapter;
+    private currentMode;
+    constructor(mode?: RenderMode);
+    /**
+     * Switch between main thread and worker rendering modes
+     */
+    switchMode(mode: RenderMode): void;
+    /**
+     * Get current rendering mode
+     */
+    getMode(): RenderMode;
+    /**
+     * Render MText using the current mode
+     */
+    renderMText(mtextContent: MTextData, textStyle: TextStyle, colorSettings?: ColorSettings): Promise<MTextObject>;
+    /**
+     * Load fonts using the current mode
+     */
+    loadFonts(fonts: string[]): Promise<{
+        loaded: string[];
+    }>;
+    /**
+     * Get available fonts using the current mode
+     */
+    getAvailableFonts(): Promise<{
+        fonts: Array<{
+            name: string[];
+        }>;
+    }>;
+    /**
+     * Clean up resources
+     */
+    destroy(): void;
+}

package/lib/worker/web-worker-renderer.d.ts

@@ -0,0 +1,115 @@
+import { MTextData, TextStyle, ColorSettings } from '../renderer/types';
+import { MTextBaseRenderer } from './base-renderer';
+import * as THREE from 'three';
+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 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;
+        } | null;
+    };
+    material: {
+        type: string;
+        color: number;
+        transparent: boolean;
+        opacity: number;
+        side?: number;
+        linewidth?: number;
+    };
+}
+/**
+ * Manages communication with the MText web worker
+ */
+export declare class WebWorkerRenderer implements MTextBaseRenderer {
+    private worker;
+    private pendingRequests;
+    private requestId;
+    constructor();
+    private handleWorkerMessage;
+    private sendMessage;
+    /**
+     * Render MText in the worker and return serialized data
+     */
+    renderMText(mtextContent: MTextData, textStyle: TextStyle, colorSettings?: ColorSettings): Promise<THREE.Object3D>;
+    /**
+     * Load fonts in the worker
+     */
+    loadFonts(fonts: string[]): Promise<{
+        loaded: string[];
+    }>;
+    /**
+     * Get available fonts from the worker
+     */
+    getAvailableFonts(): Promise<{
+        fonts: any[];
+    }>;
+    /**
+     * Reconstruct MText object from JSON serialized data
+     */
+    reconstructMText(serializedData: SerializedMText): THREE.Object3D;
+    /**
+     * Terminate the worker
+     */
+    terminate(): void;
+    destroy(): void;
+}
+export {};

package/lib/worker/webWorkerRenderer.d.ts

@@ -0,0 +1,124 @@
+import { MTextData, TextStyle, ColorSettings } from '../renderer/types';
+import { MTextBaseRenderer, MTextObject } from './baseRenderer';
+
+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 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;
+    };
+}
+/**
+ * Manages communication with the MText web worker
+ */
+export declare class WebWorkerRenderer implements MTextBaseRenderer {
+    private workers;
+    private inFlightPerWorker;
+    private pendingRequests;
+    private requestId;
+    private poolSize;
+    private readyPromise;
+    constructor(poolSize?: number);
+    private handleWorkerMessage;
+    private attachWorkerHandlers;
+    private pickLeastLoadedWorker;
+    private sendMessage;
+    private ensureInitialized;
+    /**
+     * Render MText in the worker and return serialized data
+     */
+    renderMText(mtextContent: MTextData, textStyle: TextStyle, colorSettings?: ColorSettings): Promise<MTextObject>;
+    /**
+     * Load fonts in the worker
+     */
+    loadFonts(fonts: string[]): Promise<{
+        loaded: string[];
+    }>;
+    /**
+     * Get available fonts from the worker
+     */
+    getAvailableFonts(): Promise<{
+        fonts: Array<{
+            name: string[];
+        }>;
+    }>;
+    /**
+     * Reconstruct MText object from JSON serialized data
+     */
+    reconstructMText(serializedData: SerializedMText): MTextObject;
+    /**
+     * Terminate the worker
+     */
+    terminate(): void;
+    destroy(): void;
+}
+export {};

package/lib/worker/worker-manager.d.ts

@@ -0,0 +1,113 @@
+import { MTextData, TextStyle, ColorSettings } from '../renderer/types';
+import * as THREE from 'three';
+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 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;
+        } | null;
+    };
+    material: {
+        type: string;
+        color: number;
+        transparent: boolean;
+        opacity: number;
+        side?: number;
+        linewidth?: number;
+    };
+}
+/**
+ * Manages communication with the MText web worker
+ */
+export declare class MTextWorkerManager {
+    private worker;
+    private pendingRequests;
+    private requestId;
+    constructor();
+    private handleWorkerMessage;
+    private sendMessage;
+    /**
+     * Render MText in the worker and return serialized data
+     */
+    renderMText(mtextContent: MTextData, textStyle: TextStyle, colorSettings?: ColorSettings): Promise<SerializedMText>;
+    /**
+     * Load fonts in the worker
+     */
+    loadFonts(fonts: string[]): Promise<{
+        loaded: string[];
+    }>;
+    /**
+     * Get available fonts from the worker
+     */
+    getAvailableFonts(): Promise<{
+        fonts: any[];
+    }>;
+    /**
+     * Reconstruct MText object from JSON serialized data
+     */
+    reconstructMText(serializedData: SerializedMText): THREE.Object3D;
+    /**
+     * Terminate the worker
+     */
+    terminate(): void;
+}
+export {};

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@mlightcad/mtext-renderer",
-  "version": "0.4.5",
+  "version": "0.4.7",
   "description": "AutoCAD MText renderer based on Three.js",
   "type": "module",
   "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "types": "lib/index.d.ts",
   "files": [
     "dist",
+    "lib",
     "README.md",
     "package.json"
   ],