@mlightcad/mtext-renderer 0.2.0

package/dist/renderer/index.d.ts

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

package/dist/renderer/mtext.d.ts

@@ -0,0 +1,90 @@
+import { FontManager } from '../font';
+import { ColorSettings, MTextData, TextStyle } from './types';
+import { StyleManager } from './styleManager';
+import * as THREE from 'three';
+/**
+ * Represents an AutoCAD MText object in Three.js.
+ * This class extends THREE.Object3D to provide MText rendering capabilities,
+ * including text layout, alignment, and transformation.
+ */
+export declare class MText extends THREE.Object3D {
+    /** The text style configuration for this MText object */
+    private _style;
+    /** The style manager instance for handling text styles */
+    private _styleManager;
+    /** The font manager instance for handling font operations */
+    private _fontManager;
+    /** Color settings used to decided font color */
+    private _colorSettings;
+    /** The bounding box of the entire MText object */
+    private _box;
+    /** Array of bounding boxes for individual text elements */
+    private _boxes;
+    /**
+     * Creates a new instance of MText.
+     * @param text - The MText data containing text content and properties
+     * @param style - The text style configuration
+     * @param styleManager - The style manager instance
+     * @param fontManager - The font manager instance
+     * @param colorSettings - Color settings used to decided font color
+     */
+    constructor(text: MTextData, style: TextStyle, styleManager: StyleManager, fontManager: FontManager, colorSettings?: ColorSettings);
+    /**
+     * Gets the font manager instance associated with this MText object.
+     * @returns The FontManager instance
+     */
+    get fontManager(): FontManager;
+    /**
+     * Gets the style manager instance associated with this MText object.
+     * @returns The StyleManager instance
+     */
+    get styleManager(): StyleManager;
+    /**
+     * Gets the text style configuration for this MText object.
+     * @returns The TextStyle configuration
+     */
+    get textStyle(): TextStyle;
+    /**
+     * Gets or sets the bounding box of this MText object.
+     * The bounding box is calculated without considering the transformation matrix.
+     * To get the bounding box with transformation, call `applyMatrix4` on this box.
+     */
+    get box(): THREE.Box3;
+    set box(box: THREE.Box3);
+    /**
+     * Calculates intersections between a ray and this MText object.
+     * Overrides the base THREE.Object3D raycast method to use the text's bounding boxes.
+     * @param raycaster - The raycaster to use for intersection testing
+     * @param intersects - Array to store intersection results
+     */
+    raycast(raycaster: THREE.Raycaster, intersects: THREE.Intersection[]): void;
+    /**
+     * Loads and processes MText data to create a Three.js object.
+     * @param mtextData - The MText data to process
+     * @param style - The text style configuration
+     * @returns The created Three.js object, or undefined if creation fails
+     */
+    private loadMText;
+    /**
+     * Creates a group of text elements from MText data.
+     * @param mtextData - The MText data to process
+     * @param style - The text style configuration
+     * @returns An object containing the created Three.js object and its height
+     */
+    private createMTextGroup;
+    /**
+     * Calculates the anchor point for text positioning based on alignment and flow direction.
+     * @param width - The width of the text
+     * @param height - The height of the text
+     * @param attachmentPoint - The attachment point for text alignment
+     * @param flowDirection - The text flow direction
+     * @returns The calculated anchor point coordinates
+     */
+    private calculateAnchorPoint;
+    /**
+     * Recursively calculates bounding boxes for an object and its children.
+     * @param object - The Three.js object to process
+     * @param boxes - Array to store the calculated bounding boxes
+     */
+    private getBoxes;
+}

package/dist/renderer/mtextProcessor.d.ts

@@ -0,0 +1,225 @@
+import { ChangedProperties, MTextParagraphAlignment, MTextToken } from '@mlightcad/mtext-parser';
+import { FontManager } from '../font';
+import { StyleManager } from './styleManager';
+import { MTextFlowDirection, TextStyle } from './types';
+
+import * as THREE from 'three';
+export interface MTextFormatOptions {
+    /**
+     * Font size.
+     */
+    fontSize: number;
+    /**
+     * Scale factor of character width.
+     */
+    widthFactor: number;
+    /**
+     * The line space factor.
+     */
+    lineSpaceFactor: number;
+    /**
+     * The horizontal alignment.
+     */
+    horizontalAlignment: MTextParagraphAlignment;
+    /**
+     * The maximum width of one line of text string.
+     */
+    maxWidth: number;
+    /**
+     * The direction that the text string follows from its start to its finish.
+     */
+    flowDirection: MTextFlowDirection;
+    /**
+     * The color of the current block which is used when the text color is by block.
+     */
+    byBlockColor: number;
+    /**
+     * The color of the current layer which is used when the text color is by layer.
+     */
+    byLayerColor: number;
+    /**
+     * Whether to remove font name extension.
+     */
+    removeFontExtension: boolean;
+}
+/**
+ * This class represents lines of texts.
+ */
+export declare class MTextProcessor {
+    private _style;
+    private _styleManager;
+    private _fontManager;
+    private _options;
+    private _totalHeight;
+    private _hOffset;
+    private _vOffset;
+    private _lineCount;
+    private _currentLineObjects;
+    private _currentHorizontalAlignment;
+    private _currentWidthFactor;
+    private _currentWordSpace;
+    private _currentBlankWidth;
+    private _currentFont;
+    private _currentFontScaleFactor;
+    private _currentFontSize;
+    private _currentFontSizeScaleFactor;
+    private _currentColor;
+    private _currentMaxFontSize;
+    private _currentUnderline;
+    private _currentOverline;
+    private _currentStrikeThrough;
+    private _currentObliqueAngle;
+    /**
+     * Construct one instance of this class and initialize some properties with default values.
+     * @param style Input text style
+     * @param styleManager Input text style manager instance
+     * @param fontManager Input font manager instance
+     * @param options Input formating options
+     */
+    constructor(style: TextStyle, styleManager: StyleManager, fontManager: FontManager, options: MTextFormatOptions);
+    get fontManager(): FontManager;
+    get styleManager(): StyleManager;
+    get textStyle(): TextStyle;
+    /**
+     * Total height of all lines of text
+     */
+    get totalHeight(): number;
+    /**
+     * The maximum width of one text line
+     */
+    get maxWidth(): number;
+    /**
+     * The direction that the text string follows from its start to its finish.
+     */
+    get flowDirection(): MTextFlowDirection;
+    /**
+     * The default horizontal alignment of one text line
+     */
+    get defaultHorizontalAlignment(): MTextParagraphAlignment;
+    /**
+     * The default scale factor of character width
+     */
+    get defaultWidthFactor(): number;
+    /**
+     * The default font size of texts
+     */
+    get defaultFontSize(): number;
+    /**
+     * The default line space factor
+     */
+    get defaultLineSpaceFactor(): number;
+    /**
+     * Font name of current character
+     */
+    get currentFont(): string;
+    /**
+     * The current horizontal alignment of one text line
+     */
+    get currentHorizontalAlignment(): MTextParagraphAlignment;
+    /**
+     * Scale factor of current font height. The scale factor isn't set by users in text editor.
+     * It is one scale factor binded to font. For ttf or woff fonts, it is calculated by certain
+     * algorithm. For shx font, it is alway equal to 1.
+     */
+    get currentFontScaleFactor(): number;
+    /**
+     * Font size of current character
+     */
+    get currentFontSize(): number;
+    /**
+     * Font size scale factor of current character
+     */
+    get currentFontSizeScaleFactor(): number;
+    /**
+     * The height of current line of texts
+     */
+    get currentLineHeight(): number;
+    /**
+     * The maximum font size in current line. Characters in one line may have different font and font
+     * size. So we need to store the maximum font size in current line in order to calculate the height
+     * of current line.
+     */
+    get currentMaxFontSize(): number;
+    /**
+     * The current space setting between two characters
+     */
+    get currentWordSpace(): number;
+    /**
+     * The current scale factor of character width
+     */
+    get currentWidthFactor(): number;
+    /**
+     * The current text color
+     */
+    get currentColor(): number;
+    /**
+     * All of THREE.js objects in current line. It contains objects in all of sections of this line.
+     */
+    get currentLineObjects(): THREE.Object3D<THREE.Object3DEventMap>[];
+    /**
+     * The horizental offset of current character in this line
+     */
+    get hOffset(): number;
+    set hOffset(value: number);
+    /**
+     * The vertical offset of current character in this line
+     */
+    get vOffset(): number;
+    set vOffset(value: number);
+    /**
+     * Oblique angle of current character
+     */
+    get currentObliqueAngle(): number;
+    /**
+     * Process text format information
+     * @param item Input mtext inline codes
+     */
+    processFormat(item: ChangedProperties): void;
+    /**
+     * Render the specified texts
+     * @param item Input texts to render
+     */
+    processText(tokens: Generator<MTextToken>): THREE.Group<THREE.Object3DEventMap>;
+    private processGeometries;
+    private processWord;
+    private processStack;
+    private processBlank;
+    private processChar;
+    processLastLine(): void;
+    private initLineParams;
+    private changeFontHeight;
+    private changeFont;
+    private changeFontSizeScaleFactor;
+    /**
+     * Calcuate font size, line space, line height and other parameters.
+     */
+    private calcuateLineParams;
+    /**
+     * Get text shape of the specified character
+     * @param char Input one character
+     * @returns Return the text shape of the specified character
+     */
+    private getCharShape;
+    private startNewLine;
+    /**
+     * Apply translation on the specified buffer geometries according to text alignment setting
+     */
+    private processAlignment;
+    /**
+     * In AutoCAD, the width of a regular space character (ASCII 32, the space key on the keyboard) in MText
+     * depends on the current font and text height, and is not a fixed value.
+     * Specifically:
+     * - Space width ≈ Text height × space width ratio defined by the font
+     * - For common TrueType fonts (like Arial), the space width is typically about 1/4 to 1/3 of the text height.
+     * For example, if the text height is 10 (units), the space width would be approximately 2.5 to 3.3 units.
+     * - For SHX fonts (AutoCAD's built-in vector fonts, such as txt.shx), the space width is often half the text height.
+     * So if the text height is 10, the space width is typically 5 units.
+     */
+    private calculateBlankWidth;
+    /**
+     * Convert the text shape geometries to three.js object
+     * @param geometries Input text shape geometries
+     * @returns Return three.js object created from the specified text shape geometries
+     */
+    private toThreeObject;
+}

package/dist/renderer/styleManager.d.ts

@@ -0,0 +1,11 @@
+import * as THREE from 'three';
+/**
+ * Class to manage basic text style
+ */
+export declare class StyleManager {
+    private lineBasicMaterials;
+    private meshBasicMaterials;
+    unsupportedTextStyles: Record<string, number>;
+    getMeshBasicMaterial(color: number): THREE.Material;
+    getLineBasicMaterial(color: number): THREE.Material;
+}

package/dist/renderer/types.d.ts

@@ -0,0 +1,62 @@
+export interface Point3d {
+    x: number;
+    y: number;
+    z: number;
+}
+export interface Point2d {
+    x: number;
+    y: number;
+}
+export declare enum MTextFlowDirection {
+    LEFT_TO_RIGHT = 1,
+    RIGHT_TO_LEFT = 2,
+    TOP_TO_BOTTOM = 3,
+    BOTTOM_TO_TOP = 4,
+    BY_STYLE = 5
+}
+export declare enum MTextAttachmentPoint {
+    TopLeft = 1,
+    TopCenter = 2,
+    TopRight = 3,
+    MiddleLeft = 4,
+    MiddleCenter = 5,
+    MiddleRight = 6,
+    BottomLeft = 7,
+    BottomCenter = 8,
+    BottomRight = 9
+}
+export interface MTextData {
+    text: string;
+    height: number;
+    width: number;
+    position: Point3d;
+    rotation?: number;
+    directionVector?: Point3d;
+    attachmentPoint?: MTextAttachmentPoint;
+    drawingDirection?: MTextFlowDirection;
+    lineSpaceFactor?: number;
+    widthFactor?: number;
+}
+/**
+ * Text style
+ */
+export interface TextStyle {
+    name: string;
+    standardFlag: number;
+    fixedTextHeight: number;
+    widthFactor: number;
+    obliqueAngle: number;
+    textGenerationFlag: number;
+    lastHeight: number;
+    font: string;
+    bigFont: string;
+    extendedFont?: string;
+    color: number;
+}
+/**
+ * Color settings used to decided font color
+ */
+export interface ColorSettings {
+    byLayerColor: number;
+    byBlockColor: number;
+}

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@mlightcad/mtext-renderer",
+  "version": "0.2.0",
+  "description": "AutoCAD MText renderer based on Three.js",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "package.json"
+  ],
+  "keywords": [
+    "autocad",
+    "mtext",
+    "three.js",
+    "renderer",
+    "3d",
+    "text"
+  ],
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "@mlightcad/mtext-parser": "^1.1.1",
+    "@mlightcad/shx-parser": "^1.0.4",
+    "opentype.js": "^1.3.4",
+    "idb": "^8.0.3"
+  },
+  "devDependencies": {
+    "@types/node": "^20.10.6",
+    "@types/opentype.js": "^1.3.8",
+    "@types/three": "^0.172.0",
+    "@typescript-eslint/eslint-plugin": "^8.32.1",
+    "@typescript-eslint/parser": "^8.32.1",
+    "cp-cli": "^2.0.0",
+    "eslint": "^9.26.0",
+    "eslint-config-prettier": "^10.1.5",
+    "eslint-plugin-prettier": "^5.4.0",
+    "prettier": "^3.1.1",
+    "typescript": "~5.3.3",
+    "vite": "^5.0.0",
+    "vite-plugin-dts": "^3.7.0"
+  },
+  "peerDependencies": {
+    "three": "^0.172.0"
+  },
+  "scripts": {
+    "build": "vite build",
+    "build:example": "vite build --config examples/vite.config.ts",
+    "example": "npm run build:example && vite --config examples/vite.config.ts",
+    "lint": "eslint \"src/**/*.{ts,tsx,js,jsx}\" \"examples/**/*.{ts,tsx,js,jsx}\"",
+    "lint:fix": "eslint \"src/**/*.{ts,tsx,js,jsx}\" \"examples/**/*.{ts,tsx,js,jsx}\" --fix",
+    "format": "prettier --write \"src/**/*.{ts,tsx,js,jsx}\" \"examples/**/*.{ts,tsx,js,jsx}\""
+  }
+}