@mlightcad/mtext-renderer 0.8.10 → 0.9.0

package/lib/renderer/mtext.d.ts

@@ -86,7 +86,17 @@ export declare class MText extends THREE.Object3D {
     get box(): THREE.Box3;
     set box(box: THREE.Box3);
     /**
-     * Gets per-character bounding boxes with debug characters.
+     * Gets logical text token boxes for picking/debug.
+     *
+     * Token semantics:
+     * - `CHAR`: `char` is the rendered character, `box` is defined, `children` is empty.
+     * - `NEW_PARAGRAPH`: `char` is `\n`, `box` is `undefined`, `children` is empty.
+     * - `STACK`: `char` is empty string (`''`), `box` is the union of stack component boxes,
+     *   and `children` contains the stack sub-components.
+     *
+     * Notes:
+     * - Superscript/subscript stacks (`^`) are emitted as regular `CHAR` entries.
+     * - Fraction stacks (`/`, `#`) are emitted as one `STACK` entry.
      */
     get charBoxes(): CharBox[];
     /**

package/lib/renderer/mtextProcessor.d.ts

@@ -3,6 +3,7 @@ import { FontManager } from '../font';
 import { StyleManager } from './styleManager';
 import { MTextFlowDirection, TextStyle } from './types';
 import * as THREE from 'three';
+export declare const STACK_DIVIDER_CHAR = "\uE000";
 export interface MTextFormatOptions {
     /**
      * Font size.
@@ -71,6 +72,7 @@ export declare class MTextProcessor {
      * so it persists until explicitly changed by another paragraph alignment command.
      */
     private _currentHorizontalAlignment;
+    private _lastCharBoxTarget;
     private _currentIndent;
     private _currentLeftMargin;
     private _currentRightMargin;
@@ -189,6 +191,12 @@ export declare class MTextProcessor {
     private processGeometries;
     private processWord;
     private processStack;
+    private recordStackDivider;
+    /**
+     * Convert a legacy top-anchored vOffset (used by stack/sub/sup logic) into
+     * the current baseline-anchored coordinate system.
+     */
+    private convertTopAlignedVOffset;
     private processBlank;
     private recordLineBreak;
     private processChar;
@@ -206,6 +214,8 @@ export declare class MTextProcessor {
      */
     private getCharShape;
     private startNewLine;
+    private advanceToNextLine;
+    private resolveCharBoxTarget;
     /**
      * Apply translation on the specified buffer geometries according to text alignment setting
      */

package/lib/renderer/types.d.ts

@@ -1,34 +1,90 @@
 import * as THREE from 'three';
+/**
+ * A 3D point in drawing coordinates.
+ */
 export interface Point3d {
+    /** X coordinate */
     x: number;
+    /** Y coordinate */
     y: number;
+    /** Z coordinate */
     z: number;
 }
+/**
+ * A 2D point in drawing coordinates.
+ */
 export interface Point2d {
+    /** X coordinate */
     x: number;
+    /** Y coordinate */
     y: number;
 }
+/**
+ * Defines the global text flow direction for MText layout.
+ */
 export declare enum MTextFlowDirection {
+    /** Text flows from left to right. */
     LEFT_TO_RIGHT = 1,
+    /** Text flows from right to left. */
     RIGHT_TO_LEFT = 2,
+    /** Text flows from top to bottom. */
     TOP_TO_BOTTOM = 3,
+    /** Text flows from bottom to top. */
     BOTTOM_TO_TOP = 4,
+    /** Use the direction defined by the active text style. */
     BY_STYLE = 5
 }
+/**
+ * Anchor position used to align rendered MText relative to its insertion point.
+ */
 export declare enum MTextAttachmentPoint {
+    /** Top-left corner. */
     TopLeft = 1,
+    /** Top-center point. */
     TopCenter = 2,
+    /** Top-right corner. */
     TopRight = 3,
+    /** Middle-left point. */
     MiddleLeft = 4,
+    /** Center point. */
     MiddleCenter = 5,
+    /** Middle-right point. */
     MiddleRight = 6,
+    /** Bottom-left corner. */
     BottomLeft = 7,
+    /** Bottom-center point. */
     BottomCenter = 8,
+    /** Bottom-right corner. */
     BottomRight = 9
 }
+/**
+ * Logical text token with optional pick box information.
+ *
+ * Semantics by {@link CharBoxType}:
+ * - `CHAR`: `char` is the rendered character, `box` is defined, `children` is empty.
+ * - `NEW_PARAGRAPH`: `char` is `\n`, `box` is `undefined`, `children` is empty.
+ * - `STACK`: `char` is `''`, `box` is the union box of stack components, `children` contains stack parts.
+ */
 export interface CharBox {
-    box: THREE.Box3;
+    /** Token type. */
+    type: CharBoxType;
+    /** Token bounding box in local MText coordinates (undefined for `NEW_PARAGRAPH`). */
+    box?: THREE.Box3;
+    /** Token character payload (`''` for `STACK`, `\n` for `NEW_PARAGRAPH`). */
     char: string;
+    /** Nested token components (currently used by `STACK`). */
+    children: CharBox[];
+}
+/**
+ * Type of logical token emitted in {@link CharBox} output.
+ */
+export declare enum CharBoxType {
+    /** Regular rendered character token. */
+    CHAR = "CHAR",
+    /** Explicit paragraph break token. */
+    NEW_PARAGRAPH = "NEW_PARAGRAPH",
+    /** Stack token (for fraction-style stacked expressions). */
+    STACK = "STACK"
 }
 export interface StyleTraits {
     /**

package/package.json

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