@mlightcad/mtext-renderer 0.10.4 → 0.10.5

package/lib/renderer/colorUtils.d.ts

@@ -0,0 +1,2 @@
+import { ColorSettings } from './types';
+export declare function resolveMTextColor(colorSettings: ColorSettings): number;

package/lib/renderer/defaultStyleManager.d.ts

@@ -1,5 +1,5 @@
 import { StyleManager } from './styleManager';
-import { StyleTraits } from './types';
+import { ColorSettings } from './types';
 import * as THREE from 'three';
 /**
  * Class to manage basic text style
@@ -8,11 +8,11 @@ export declare class DefaultStyleManager implements StyleManager {
     private lineBasicMaterials;
     private meshBasicMaterials;
     unsupportedTextStyles: Record<string, number>;
-    getMeshBasicMaterial(traits: StyleTraits): THREE.Material;
-    getLineBasicMaterial(traits: StyleTraits): THREE.Material;
+    getMeshBasicMaterial(colorSettings: ColorSettings): THREE.Material;
+    getLineBasicMaterial(colorSettings: ColorSettings): THREE.Material;
     /**
      * Builds a stable material key from traits.
      * Key differs for shader vs basic, ByLayer vs ByEntity.
      */
-    protected buildKey(traits: StyleTraits): string;
+    protected buildKey(colorSettings: ColorSettings): string;
 }

package/lib/renderer/index.d.ts

@@ -1,3 +1,4 @@
+export * from './colorUtils';
 export * from './mtext';
 export * from './styleManager';
 export * from './types';

package/lib/renderer/mtextProcessor.d.ts

@@ -1,7 +1,7 @@
 import { ChangedProperties, MTextParagraphAlignment, MTextToken } from '@mlightcad/mtext-parser';
 import { FontManager } from '../font';
 import { StyleManager } from './styleManager';
-import { LineLayout, MTextFlowDirection, TextStyle } from './types';
+import { ColorSettings, LineLayout, MTextFlowDirection, TextStyle } from './types';
 import * as THREE from 'three';
 export interface MTextFormatOptions {
     /**
@@ -50,6 +50,7 @@ export interface MTextFormatOptions {
  */
 export declare class MTextProcessor {
     private _style;
+    private _colorSettings;
     private _styleManager;
     private _fontManager;
     private _options;
@@ -87,7 +88,7 @@ export declare class MTextProcessor {
      * @param fontManager Input font manager instance
      * @param options Input formating options
      */
-    constructor(style: TextStyle, styleManager: StyleManager, fontManager: FontManager, options: MTextFormatOptions);
+    constructor(style: TextStyle, colorSettings: ColorSettings, styleManager: StyleManager, fontManager: FontManager, options: MTextFormatOptions);
     get fontManager(): FontManager;
     get styleManager(): StyleManager;
     get textStyle(): TextStyle;
@@ -300,4 +301,6 @@ export declare class MTextProcessor {
     private toThreeObject;
     private changeFontSizeScaleFactor;
     private changeFontHeight;
+    private resolveBaseColor;
+    private getMaterialColorSettings;
 }

package/lib/renderer/styleManager.d.ts

@@ -1,4 +1,4 @@
-import { StyleTraits } from './types';
+import { ColorSettings } from './types';
 import * as THREE from 'three';
 /**
  * Class to manage materials used by texts
@@ -10,11 +10,11 @@ export interface StyleManager {
      * @param traits - Traits to define one mesh basic material
      * @returns - One reusable material for mesh type font.
      */
-    getMeshBasicMaterial(traits: StyleTraits): THREE.Material;
+    getMeshBasicMaterial(colorSettings: ColorSettings): THREE.Material;
     /**
      * Gets one reusable material for line type font. If not found in cache, just create one.
      * @param traits - Traits to define one line basic material
      * @returns - One reusable material for line type font.
      */
-    getLineBasicMaterial(traits: StyleTraits): THREE.Material;
+    getLineBasicMaterial(colorSettings: ColorSettings): THREE.Material;
 }

package/lib/renderer/types.d.ts

@@ -1,3 +1,4 @@
+import { MTextColor } from '@mlightcad/mtext-parser';
 import * as THREE from 'three';
 /**
  * A 3D point in drawing coordinates.
@@ -115,22 +116,26 @@ export declare enum CharBoxType {
  * Sentinel character used internally to represent a stack divider line.
  */
 export declare const STACK_DIVIDER_CHAR = "\uE000";
-export interface StyleTraits {
-    /**
-     * Optional layer name. Material is identified by layer and color. So it means different
-     * materials are created for the same color and differnt layer.
-     */
+/**
+ * Defines color settings for text rendering, including layer/material resolution
+ * and ByLayer/ByBlock fallback colors.
+ */
+export interface ColorSettings {
+    /** The color value to use when text is set to "by layer" color mode */
+    byLayerColor: number;
+    /** The color value to use when text is set to "by block" color mode */
+    byBlockColor: number;
+    /** Optional layer name used when resolving materials */
     layer?: string;
     /**
-     * The color of material
-     */
-    color: number;
-    /**
-     * One flag to indicate whether the color is by layer. If it is true, it means that the
-     * material become invalid once layer color changed.
+     * Default text color. Use `MTextColor.aci === 256` to indicate ByLayer.
      */
-    isByLayer?: boolean;
+    color: MTextColor;
 }
+/**
+ * Create default color settings (ByLayer + white fallback).
+ */
+export declare const createDefaultColorSettings: () => ColorSettings;
 /**
  * Represents the data structure for multiline text (MText) entities.
  * Contains all necessary properties to define the appearance and positioning of text.
@@ -164,7 +169,7 @@ export interface MTextData {
  * This interface contains properties that control various aspects of text rendering including font,
  * dimensions, and display characteristics.
  */
-export interface TextStyle extends StyleTraits {
+export interface TextStyle {
     /** The unique name identifier for this text style */
     name: string;
     /** Flag indicating standard text style settings. Controls various text generation behaviors */
@@ -186,14 +191,3 @@ export interface TextStyle extends StyleTraits {
     /** Optional extended font settings or alternative font specification */
     extendedFont?: string;
 }
-/**
- * Defines the default color settings for special color modes in text rendering.
- * These settings are used to resolve color values when text uses layer-dependent
- * or block-dependent coloring.
- */
-export interface ColorSettings {
-    /** The color value to use when text is set to "by layer" color mode */
-    byLayerColor: number;
-    /** The color value to use when text is set to "by block" color mode */
-    byBlockColor: number;
-}

package/lib/worker/unifiedRenderer.d.ts

@@ -40,12 +40,14 @@ export declare class UnifiedRenderer {
     getDefaultMode(): RenderMode;
     /**
      * Render MText using the current mode asynchronously.
+     * @param colorSettings - Optional color context (ByLayer, ByBlock colors).
      * @param mode - Rendering mode used. If undefined, the default rendering mode is used.
      */
     asyncRenderMText(mtextContent: MTextData, textStyle: TextStyle, colorSettings?: ColorSettings, mode?: RenderMode): Promise<MTextObject>;
     /**
      * Render MText using the current mode synchronously. Main thread render is always used
      * for this function because web worker renderer doesn't support rendering synchronously.
+     * @param colorSettings - Optional color context (ByLayer, ByBlock colors).
      */
     syncRenderMText(mtextContent: MTextData, textStyle: TextStyle, colorSettings?: ColorSettings): MTextObject;
     /**

package/lib/worker/webWorkerRenderer.d.ts

@@ -178,7 +178,8 @@ export declare class WebWorkerRenderer implements MTextBaseRenderer {
     /**
      * Reconstruct MText object from JSON serialized data
      */
-    reconstructMText(serializedData: SerializedMText, textStyle: TextStyle): MTextObject;
+    reconstructMText(serializedData: SerializedMText, colorSettings: ColorSettings): MTextObject;
+    private buildMaterialColorSettings;
     private deserializeCharBoxes;
     private collectLayout;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mlightcad/mtext-renderer",
-  "version": "0.10.4",
+  "version": "0.10.5",
   "description": "AutoCAD MText renderer based on Three.js",
   "license": "MIT",
   "author": "MLight Lee <mlight.lee@outlook.com>",