@mlightcad/mtext-renderer 0.11.5 → 0.11.7

package/lib/font/fontManager.d.ts

@@ -1,3 +1,4 @@
+import { ShxFontType } from '@mlightcad/shx-parser';
 import { EventManager } from '../common';
 import { BaseFont } from './baseFont';
 import { BaseTextShape } from './baseTextShape';
@@ -240,6 +241,12 @@ export declare class FontManager {
      * @returns The type of the font. If the specified font can't be found, `undefined` is returned
      */
     getFontType(fontName: string): FontType | undefined;
+    /**
+     * Gets the type of the SHX font. Such as BIGFONT, SHAPES, UNIFONT.
+     * @param fontName - The name of the font
+     * @returns The type of the SHX font, or undefined if the specified font is not a SHX font
+     */
+    getShxFontType(fontName: string): ShxFontType | undefined;
     /**
      * Gets the shape to display when a character is not found
      * @param size - The size of the shape

package/lib/font/meshFont.d.ts

@@ -82,6 +82,11 @@ export declare class MeshFont extends BaseFont {
      * @returns An object containing the opentype font and parsed metadata
      */
     private parseMeshFont;
+    /**
+     * Resolves the opentype lookup character for a drawing character.
+     * Tries Unicode first, then Symbol encoding (0xF000 + ASCII) for GDT fonts.
+     */
+    private opentypeLookupChar;
     /**
      * Whether opentype maps the character to a real glyph (not .notdef at index 0).
      *

package/lib/font/shxFont.d.ts

@@ -1,7 +1,9 @@
-import { ShxFontData } from '@mlightcad/shx-parser';
+import { ShxFontData, ShxFontMetrics } from '@mlightcad/shx-parser';
 import { BaseFont } from './baseFont';
 import { FontData } from './font';
 import { ShxTextShape } from './shxTextShape';
+/** Scaled SHX font layout metrics (cap height, cell width, etc.) from `@mlightcad/shx-parser`. */
+export type { ShxFontMetrics } from '@mlightcad/shx-parser';
 /**
  * ShxFont is a class that extends BaseFont and represents a SHX font.
  * It provides methods to generate shapes for text and retrieve character shapes.
@@ -9,68 +11,88 @@ import { ShxTextShape } from './shxTextShape';
 export declare class ShxFont extends BaseFont {
     /** Internal shx font instance */
     private readonly font;
+    /** The type of font; always `'shx'`. */
     readonly type = "shx";
+    /** Parsed SHX font data used for glyph lookup and layout metrics. */
     readonly data: ShxFontData;
+    /**
+     * Creates a new SHX font wrapper.
+     * @param fontData - Font metadata and binary SHX data used to initialize the font.
+     */
     constructor(fontData: FontData);
     /**
-     * Return true if this font contains glyph of the specified character. Otherwise, return false.
-     * @param char - The character to check
-     * @returns True if this font contains glyph of the specified character. Otherwise, return false.
+     * Returns whether the font contains a glyph for the given character.
+     * @param char - The character to look up.
+     * @returns True if the font contains the character; otherwise, false.
      */
     hasChar(char: string): boolean;
     /**
-     * Return true if this font contains glyph of the specified character code. Otherwise, return false.
-     * @param code - The character code to check
-     * @returns True if this font contains glyph of the specified character code. Otherwise, return false.
+     * Returns whether the font contains a glyph for the given character code.
+     * @param code - The character code to look up.
+     * @returns True if the font contains the code point; otherwise, false.
      */
     hasCode(code: number): boolean;
     /**
-     * Horizontal advance for the space character (ASCII 32) at the given size.
-     * Uses the SHX glyph pen advance when defined; otherwise falls back to half the
-     * text height (common for AutoCAD SHX fonts).
+     * Computes the horizontal advance for a space at the requested size.
+     * @param size - The requested font size.
+     * @returns The width of the space advance.
      */
     getSpaceAdvance(size: number): number;
+    /**
+     * Converts a text string into a list of SHX text shapes.
+     * @param text - The text to convert.
+     * @param size - The requested font size.
+     * @returns An array of generated SHX text shapes.
+     */
     generateShapes(text: string, size: number): ShxTextShape[];
     /**
-     * SHX font always has fixed scale factor 1.
-     * @returns Always return value 1
+     * Returns the scale factor used by the SHX font implementation.
+     * @returns Always returns 1 for SHX fonts.
      */
     getScaleFactor(): number;
+    /**
+     * Gets the scaled layout metrics for the font at the requested size.
+     * @param size - The requested font size.
+     * @returns The SHX font metrics for the given size.
+     */
+    getFontMetrics(size: number): ShxFontMetrics;
     /**
      * Gets the shape data for a specific character at a given size.
-     * If the font type is BIGFONT, please use getCodeShape to get the shape data
-     * because the character code for BIGFONT isn't unicode.
-     * @param char - The character to get the shape for
-     * @param size - The desired size of the character
-     * @returns The shape data for the character, or undefined if not found
+     * @param char - The character to look up.
+     * @param size - The requested font size.
+     * @returns The shape data for the character, or undefined if not found.
      */
     getCharShape(char: string, size: number): ShxTextShape | undefined;
     /**
      * Gets the shape data for a specific character code at a given size.
-     * The passed code must the code stored in font instead of unicode.
-     * - Unicode shx font uses unicode as character code.
-     * - Bigfont uses a custom encoding for double-byte characters.
-     * @param code - The character code to get the shape for
-     * @param size - The desired size of the character
-     * @returns The shape data for the character code, or undefined if not found
+     * @param code - The character code to look up.
+     * @param size - The requested font size.
+     * @returns The shape data for the code, or undefined if not found.
      */
     getCodeShape(code: number, size: number): ShxTextShape | undefined;
     /**
-     * Gets the shape data for a named SHX shape at a given size.
-     *
-     * Shape names are matched case-insensitively via the underlying SHX parser.
+     * Gets the shape data for a named SHX shape at the requested size.
+     * @param name - The SHX shape name to look up.
+     * @param size - The requested font size.
+     * @returns The matching shape, or undefined if unavailable.
      */
     getShapeByName(name: string, size: number): ShxTextShape | undefined;
-    /** True when the SHX glyph has drawable strokes or a non-zero pen advance. */
+    /**
+     * Checks whether a parsed SHX shape contains renderable strokes.
+     * @param shape - The shape to inspect.
+     * @returns True when the shape has at least one renderable segment.
+     */
     private static hasRenderableStrokes;
     /**
-     * For an unsupported char, use "？" as a replacement.
+     * Gets the fallback text shape used for missing characters.
+     * @param size - The requested font size.
+     * @returns The fallback shape, or undefined if it cannot be built.
      */
     getNotFoundTextShape(size: number): ShxTextShape | undefined;
     /**
-     * Gets encoded code of the specified character according to font character encoding
-     * @param char - The character to get its code
-     * @returns Returns encoded code of the specified character
+     * Resolves the internal SHX character code for a given Unicode character.
+     * @param char - The input character.
+     * @returns The internal SHX code used for lookup.
      */
     private getCode;
 }

package/lib/font/shxTextShape.d.ts

@@ -14,26 +14,27 @@ export declare class ShxTextShape extends BaseTextShape {
     private readonly font;
     private readonly fontSize;
     /**
-     * Creates a new instance of ShxTextShape
-     * @param code - The character code this shape represents
-     * @param shape - The shape data for this character
+     * Creates a new SHX text shape wrapper.
+     * @param code - The character code represented by this shape.
+     * @param fontSize - The font size used to resolve the shape advance width.
+     * @param shape - The parsed SHX shape data.
+     * @param font - The SHX font instance that owns the shape.
      */
     constructor(code: number, fontSize: number, shape: ShxShape, font: ShxFont);
     /**
-     * Resolves horizontal advance for SHX glyphs.
-     *
-     * - Unicode / shapes fonts: prefer the pen-down end X (lastPoint), which matches
-     *   AutoCAD's advance for single-byte SHX.
-     * - Big fonts (CJK): advance is the scaled font cell width (content.width /
-     *   content.height * fontSize). Glyph bbox or lastPoint can be narrower than the
-     *   cell; using only bbox caused successive Han characters to overlap visually.
+     * Computes the width of the shape from its bounding box.
+     * @returns The width of the shape's bounding box.
      */
-    private resolveAdvanceWidth;
     protected calcWidth(): number;
+    /**
+     * Returns a translated copy of this shape.
+     * @param offset - The offset to apply to the shape.
+     * @returns A new shape shifted by the given offset.
+     */
     offset(offset: Point): ShxTextShape;
     /**
-     * Converts the text shape to a THREE.js geometry
-     * @returns A THREE.js BufferGeometry representing the text shape
+     * Converts the text shape to a THREE.js geometry.
+     * @returns A BufferGeometry representing the text shape.
      */
     toGeometry(): THREE.BufferGeometry<THREE.NormalBufferAttributes>;
 }

package/lib/renderer/mtext.d.ts

@@ -105,6 +105,10 @@ export declare class MText extends THREE.Object3D {
      * Builds and places one SHX shape glyph.
      */
     loadShape(shapeData: ShapeData, style: TextStyle): THREE.Object3D<THREE.Object3DEventMap> | undefined;
+    /**
+     *
+     * @param options.shxFontType The type of SHX font.
+     */
     private finalizePlacement;
     private createShapeGroup;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mlightcad/mtext-renderer",
-  "version": "0.11.5",
+  "version": "0.11.7",
   "description": "AutoCAD MText renderer based on Three.js",
   "license": "MIT",
   "author": "MLight Lee <mlight.lee@outlook.com>",
@@ -44,7 +44,7 @@
   ],
   "dependencies": {
     "@mlightcad/mtext-parser": "^1.5.0",
-    "@mlightcad/shx-parser": "^1.3.5",
+    "@mlightcad/shx-parser": "^1.4.3",
     "iconv-lite": "^0.7.0",
     "idb": "^8.0.3",
     "opentype.js": "^2.0.0"