@mlightcad/data-model
Version:
The data-model package provides the core classes for interacting with AutoCAD's database and entities. This package mimics AutoCAD ObjectARX's AcDb (Database) classes and implements the drawing database structure that AutoCAD developers are familiar with.
260 lines • 8.75 kB
TypeScript
import { AcGeBox3d, AcGePoint3dLike, AcGeVector3d } from '@mlightcad/geometry-engine';
import { AcGiRenderer } from '@mlightcad/graphic-interface';
import { AcGiMTextAttachmentPoint, AcGiMTextFlowDirection } from '@mlightcad/graphic-interface';
import { AcDbEntity } from './AcDbEntity';
import { AcDbEntityProperties } from './AcDbEntityProperties';
/**
* Represents a multiline text (mtext) entity in AutoCAD.
*
* A multiline text entity is a 2D geometric object that displays formatted text
* with support for multiple lines, word wrapping, and rich text formatting.
* MText entities are more advanced than regular text entities and support
* features like background fills, line spacing, and attachment points.
*
* @example
* ```typescript
* // Create a multiline text entity
* const mtext = new AcDbMText();
* mtext.contents = "This is a\nmultiline text\nwith formatting";
* mtext.height = 2.5;
* mtext.width = 20;
* mtext.location = new AcGePoint3d(0, 0, 0);
* mtext.attachmentPoint = AcGiMTextAttachmentPoint.TopLeft;
*
* // Access mtext properties
* console.log(`Contents: ${mtext.contents}`);
* console.log(`Height: ${mtext.height}`);
* console.log(`Width: ${mtext.width}`);
* ```
*/
export declare class AcDbMText extends AcDbEntity {
/** The entity type name */
static typeName: string;
/** The height of the text */
private _height;
/** The maximum width for word wrap formatting */
private _width;
/** The text contents */
private _contents;
/** The line spacing style */
private _lineSpacingStyle;
/** The line spacing factor */
private _lineSpacingFactor;
/** Whether background fill is enabled */
private _backgroundFill;
/** The background fill color */
private _backgroundFillColor;
/** The background scale factor */
private _backgroundScaleFactor;
/** The background fill transparency */
private _backgroundFillTransparency;
/** The rotation angle in radians */
private _rotation;
/** The text style name */
private _styleName;
/** The location point of the text */
private _location;
/** The attachment point for the text */
private _attachmentPoint;
/** The direction vector of the text */
private _direction;
/** The drawing direction of the text */
private _drawingDirection;
/**
* Creates a new multiline text entity.
*
* This constructor initializes an mtext entity with default values.
* The contents are empty, height and width are 0, and the location is at the origin.
*
* @example
* ```typescript
* const mtext = new AcDbMText();
* mtext.contents = "Sample multiline text";
* mtext.height = 3.0;
* mtext.width = 15;
* ```
*/
constructor();
/**
* Gets the contents of the mtext object.
*
* This returns a string that contains the contents of the mtext object.
* Formatting data used for word wrap calculations is removed.
*
* @returns The text contents
*
* @example
* ```typescript
* const contents = mtext.contents;
* console.log(`Text contents: ${contents}`);
* ```
*/
get contents(): string;
/**
* Sets the contents of the mtext object.
*
* @param value - The new text contents
*
* @example
* ```typescript
* mtext.contents = "New multiline\ntext content";
* ```
*/
set contents(value: string);
/**
* Gets the height of the text.
*
* @returns The text height
*
* @example
* ```typescript
* const height = mtext.height;
* console.log(`Text height: ${height}`);
* ```
*/
get height(): number;
/**
* Sets the height of the text.
*
* @param value - The new text height
*
* @example
* ```typescript
* mtext.height = 5.0;
* ```
*/
set height(value: number);
/**
* Gets the maximum width setting used by the MText object for word wrap formatting.
*
* It is possible that none of the lines resulting from word wrap formatting will
* reach this width value. Words which exceed this width value will not be broken,
* but will extend beyond the given width.
*
* @returns The maximum width for word wrap
*
* @example
* ```typescript
* const width = mtext.width;
* console.log(`Text width: ${width}`);
* ```
*/
get width(): number;
/**
* Sets the maximum width setting used by the MText object for word wrap formatting.
*
* @param value - The new maximum width for word wrap
*
* @example
* ```typescript
* mtext.width = 25;
* ```
*/
set width(value: number);
/**
* Gets the rotation angle of the text.
*
* The rotation angle is relative to the X axis of the text's OCS, with positive
* angles going counterclockwise when looking down the Z axis toward the origin.
*
* @returns The rotation angle in radians
*
* @example
* ```typescript
* const rotation = mtext.rotation;
* console.log(`Rotation: ${rotation} radians (${rotation * 180 / Math.PI} degrees)`);
* ```
*/
get rotation(): number;
set rotation(value: number);
/**
* The line spacing factor (a value between 0.25 and 4.00).
*/
get lineSpacingFactor(): number;
set lineSpacingFactor(value: number);
/**
* The line spacing style.
*/
get lineSpacingStyle(): number;
set lineSpacingStyle(value: number);
/**
* Toggle the background fill on or off. If it is true, background color is turned off, and no
* background fill color has been specified, this function sets the background fill color to
* an RGB value of 200,200,200.
*/
get backgroundFill(): boolean;
set backgroundFill(value: boolean);
/**
* The background fill color. This property is valid only if background fill is enable.
*/
get backgroundFillColor(): number;
set backgroundFillColor(value: number);
/**
* The background fill transparency. This property is valid only if background fill is enable.
*/
get backgroundFillTransparency(): number;
set backgroundFillTransparency(value: number);
/**
* The background scale factor.
*/
get backgroundScaleFactor(): number;
set backgroundScaleFactor(value: number);
/**
* The style name stored in text ttyle table record and used by this text entity
*/
get styleName(): string;
set styleName(value: string);
/**
* The insertion point of this mtext entity.
*/
get location(): AcGePoint3dLike;
set location(value: AcGePoint3dLike);
/**
* The attachment point value which determines how the text will be oriented around the insertion point
* of the mtext object. For example, if the attachment point is AcGiAttachmentPoint.MiddleCenter, then
* the text body will be displayed such that the insertion point appears at the geometric center of the
* text body.
*/
get attachmentPoint(): AcGiMTextAttachmentPoint;
set attachmentPoint(value: AcGiMTextAttachmentPoint);
/**
* Represent the X axis ("horizontal") for the text. This direction vector is used to determine the text
* flow direction.
*/
get direction(): AcGeVector3d;
set direction(value: AcGeVector3d);
get drawingDirection(): AcGiMTextFlowDirection;
set drawingDirection(value: AcGiMTextFlowDirection);
/**
* @inheritdoc
*/
get geometricExtents(): AcGeBox3d;
/**
* Returns the full property definition for this mtext entity, including
* general group and geometry group.
*
* The geometry group exposes editable start/end coordinates via
* {@link AcDbPropertyAccessor} so the property palette can update
* the mtext in real-time.
*
* Each property is an {@link AcDbEntityRuntimeProperty}.
*/
get properties(): AcDbEntityProperties;
private getTextStyle;
/**
* Draws this entity using the specified renderer.
*
* @param renderer - The renderer to use for drawing
* @param delay - The flag to delay creating one rendered entity and just create one dummy
* entity. Renderer can delay heavy calculation operation to avoid blocking UI when this flag
* is true.
* @returns The rendered entity, or undefined if drawing failed
*
* @example
* ```typescript
* const renderedEntity = entity.draw(renderer);
* ```
*/
draw(renderer: AcGiRenderer, delay?: boolean): import("@mlightcad/graphic-interface").AcGiEntity;
}
//# sourceMappingURL=AcDbMText.d.ts.map