@mlightcad/data-model 1.3.3 → 1.3.5

package/lib/entity/dimension/AcDbDimension.d.ts

@@ -0,0 +1,257 @@
+import { AcGeLine3d, AcGePoint2dLike, AcGePoint3d } from '@mlightcad/geometry-engine';
+import { AcGiArrowStyle, AcGiArrowType, AcGiLineArrowStyle, AcGiRenderer } from '@mlightcad/graphic-interface';
+import { AcDbDimStyleTableRecord } from '../../database';
+import { AcDbEntity } from '../AcDbEntity';
+import { AcDbLine } from '../AcDbLine';
+/**
+ * Defines the line spacing style for dimension text.
+ */
+export declare enum AcDbLineSpacingStyle {
+    /** At least the specified spacing */
+    AtLeast = 1,
+    /** Exactly the specified spacing */
+    Exactly = 2
+}
+/**
+ * Abstract base class for all dimension entity types in AutoCAD.
+ *
+ * This class provides the fundamental functionality for all dimension entities,
+ * including dimension text, style management, arrow handling, and measurement
+ * calculations. The appearance of dimensions is controlled by dimension variable
+ * settings and dimension styles.
+ *
+ * @example
+ * ```typescript
+ * class MyDimension extends AcDbDimension {
+ *   // Implementation for specific dimension type
+ *   draw(renderer: AcGiRenderer) {
+ *     // Custom drawing logic
+ *   }
+ * }
+ * ```
+ */
+export declare abstract class AcDbDimension extends AcDbEntity {
+    /** The entity type name */
+    static typeName: string;
+    /** The block table record ID containing the dimension entities */
+    private _dimBlockId;
+    /** The dimension style name used by this dimension */
+    private _dimensionStyleName;
+    /** The user-supplied dimension annotation text */
+    private _dimensionText;
+    /** The measured value of the dimension */
+    private _measurement?;
+    /** The line spacing factor for dimension text */
+    private _textLineSpacingFactor;
+    /** The line spacing style for dimension text */
+    private _textLineSpacingStyle;
+    /** The position of the dimension text */
+    private _textPosition;
+    /** The rotation angle of the dimension text */
+    private _textRotation;
+    /** The cached dimension style record */
+    private _dimStyle?;
+    /**
+     * Creates a new dimension entity.
+     *
+     * This constructor initializes a dimension with default values.
+     * Subclasses should override this constructor to set up dimension-specific properties.
+     *
+     * @example
+     * ```typescript
+     * const dimension = new MyDimension();
+     * dimension.dimensionText = "10.0";
+     * dimension.textPosition = new AcGePoint3d(5, 5, 0);
+     * ```
+     */
+    constructor();
+    /**
+     * Gets the block table record ID containing the entities that this dimension displays.
+     *
+     * @returns The block table record ID, or null if not set
+     *
+     * @example
+     * ```typescript
+     * const blockId = dimension.dimBlockId;
+     * console.log(`Dimension block ID: ${blockId}`);
+     * ```
+     */
+    get dimBlockId(): string | null;
+    /**
+     * Sets the block table record ID for this dimension.
+     *
+     * @param value - The block table record ID, or null to clear
+     *
+     * @example
+     * ```typescript
+     * dimension.dimBlockId = "MyDimensionBlock";
+     * ```
+     */
+    set dimBlockId(value: string | null);
+    /**
+     * Gets the dimension style name used by this dimension.
+     *
+     * @returns The dimension style name, or null if not set
+     *
+     * @example
+     * ```typescript
+     * const styleName = dimension.dimensionStyleName;
+     * console.log(`Dimension style: ${styleName}`);
+     * ```
+     */
+    get dimensionStyleName(): string | null;
+    /**
+     * Sets the dimension style name for this dimension.
+     *
+     * @param value - The dimension style name, or null to use default
+     *
+     * @example
+     * ```typescript
+     * dimension.dimensionStyleName = "Standard";
+     * ```
+     */
+    set dimensionStyleName(value: string | null);
+    /**
+     * Gets the dimension style used by this dimension.
+     *
+     * This method returns the dimension style record associated with this dimension.
+     * If no style is specified, it returns the default dimension style.
+     *
+     * @returns The dimension style record
+     *
+     * @example
+     * ```typescript
+     * const style = dimension.dimensionStyle;
+     * console.log(`Style name: ${style.name}`);
+     * ```
+     */
+    get dimensionStyle(): AcDbDimStyleTableRecord;
+    /**
+     * Gets the user-supplied dimension annotation text string.
+     *
+     * This string can contain multiline text formatting characters. The text can be:
+     * - Empty string ('') for default text only
+     * - Text with angle brackets for mixed default and user text (e.g., 'This is the default text <>')
+     * - Period ('.') for no text
+     * - User-defined text only
+     *
+     * @returns The dimension text string
+     *
+     * @example
+     * ```typescript
+     * const text = dimension.dimensionText;
+     * console.log(`Dimension text: ${text}`);
+     * ```
+     */
+    get dimensionText(): string | null;
+    set dimensionText(value: string | null);
+    /**
+     * The current measurement value for this dimension
+     */
+    get measurement(): number | undefined;
+    set measurement(value: number | undefined);
+    /**
+     * The line spacing factor (a value between 0.25 and 4.00).
+     */
+    get textLineSpacingFactor(): number;
+    set textLineSpacingFactor(value: number);
+    /**
+     * The line spacing style for the dimension.
+     */
+    get textLineSpacingStyle(): AcDbLineSpacingStyle;
+    set textLineSpacingStyle(value: AcDbLineSpacingStyle);
+    /**
+     * The dimension's text position point. This is the middle center point of the text (which is itself an
+     * MText object with middle-center justification).
+     */
+    get textPosition(): AcGePoint3d;
+    set textPosition(value: AcGePoint3d);
+    /**
+     * The rotation angle (in radians) of the dimension's annotation text. This is the angle from the
+     * dimension's horizontal axis to the horizontal axis used by the text. The angle is in the dimension's
+     * OCS X-Y plane with positive angles going counterclockwise when looking down the OCS Z axis towards
+     * the OCS origin. The value obtained from: (2 * pi) + the dimension's text rotation angle--the
+     * dimension's horizontal rotation angle
+     */
+    get textRotation(): number;
+    set textRotation(value: number);
+    /**
+     * @inheritdoc
+     */
+    draw(renderer: AcGiRenderer): import("@mlightcad/graphic-interface").AcGiEntity | undefined;
+    protected drawFirstArrow(renderer: AcGiRenderer): import("@mlightcad/graphic-interface").AcGiEntity | undefined;
+    protected drawSecondArrow(renderer: AcGiRenderer): import("@mlightcad/graphic-interface").AcGiEntity | undefined;
+    protected get arrowScaleFactor(): number;
+    /**
+     * Arrow style of the first arrow
+     */
+    protected get firstArrowStyle(): AcGiArrowStyle;
+    /**
+     * Arrow style of the second arrow
+     */
+    protected get secondArrowStyle(): AcGiArrowStyle;
+    /**
+     * The flag to determinate how to attach arrow to endpoint of the line.
+     * - true: append arrow to endpoint of the line
+     * - false: overlap arrow with endpoint of the line
+     */
+    protected get isAppendArrow(): boolean;
+    /**
+     * The BTR id associated with the first arrow type
+     */
+    protected get firstArrowTypeBtrId(): string;
+    /**
+     * The first arrow type
+     */
+    protected get firstArrowType(): AcGiArrowType;
+    /**
+     * The BTR id associated with the second arrow type
+     */
+    protected get secondArrowTypeBtrId(): string;
+    /**
+     * The second arrow type
+     */
+    protected get secondArrowType(): AcGiArrowType;
+    /**
+     * The maximum number of arrow lines of this dimension
+     */
+    protected get arrowLineCount(): number;
+    /**
+     * Get line arrow style of the specified line according to its type (extension line or dimension
+     * line). Return undefined if no line arrow style applied.
+     * @param line Input line to get its line style
+     * @returns Return the line style of the specified line. Return undefined if no line arrow style applied.
+     */
+    protected getLineArrowStyle(line: AcDbLine): AcGiLineArrowStyle | undefined;
+    /**
+     * Find the point `p3` on a line along the line direction at a distance `length` from `p2`.
+     *
+     * @param p1 - The start point of the line.
+     * @param p2 - The end point of the line.
+     * @param length - The distance from `p2` to `p3`.
+     * @returns Return the point `p3`.
+     */
+    protected findPointOnLine1(p1: AcGePoint3d, p2: AcGePoint3d, length: number): AcGePoint3d;
+    /**
+     * Find the point `p2` on a line starting from `p1` at a specified angle
+     * and at a distance `length` from `p1`.
+     *
+     * @param p1 - The start point of the line.
+     * @param angle - The angle of the line in radians relative to the x-axis.
+     * @param length - The distance from `p1` to `p2`.
+     * @returns Return the point `p2`.
+     */
+    protected findPointOnLine2(p1: AcGePoint2dLike, angle: number, length: number): AcGePoint2dLike;
+    /**
+     * Adjust start point and end point of extension line according current dimension style
+     * @param extensionLine Input extension line to adjust its start point and end point
+     */
+    protected adjustExtensionLine(extensionLine: AcGeLine3d): void;
+    /**
+     * Get dimension style name by dimension block id
+     * @param id Input dimension block id
+     * @returns Return dimension style name by dimension block id
+     */
+    private getArrowName;
+}
+//# sourceMappingURL=AcDbDimension.d.ts.map

package/lib/entity/dimension/AcDbDimension.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AcDbDimension.d.ts","sourceRoot":"","sources":["../../../src/entity/dimension/AcDbDimension.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,eAAe,EACf,WAAW,EACZ,MAAM,4BAA4B,CAAA;AACnC,OAAO,EACL,cAAc,EACd,aAAa,EACb,kBAAkB,EAClB,YAAY,EACb,MAAM,8BAA8B,CAAA;AAGrC,OAAO,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAA;AAExD,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAEtC;;GAEG;AACH,oBAAY,oBAAoB;IAC9B,qCAAqC;IACrC,OAAO,IAAI;IACX,oCAAoC;IACpC,OAAO,IAAI;CACZ;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,8BAAsB,aAAc,SAAQ,UAAU;IACpD,2BAA2B;IAC3B,OAAgB,QAAQ,EAAE,MAAM,CAAc;IAE9C,kEAAkE;IAClE,OAAO,CAAC,WAAW,CAAe;IAClC,sDAAsD;IACtD,OAAO,CAAC,mBAAmB,CAAe;IAC1C,kDAAkD;IAClD,OAAO,CAAC,cAAc,CAAe;IACrC,0CAA0C;IAC1C,OAAO,CAAC,YAAY,CAAC,CAAQ;IAC7B,iDAAiD;IACjD,OAAO,CAAC,sBAAsB,CAAQ;IACtC,gDAAgD;IAChD,OAAO,CAAC,qBAAqB,CAAsB;IACnD,yCAAyC;IACzC,OAAO,CAAC,aAAa,CAAa;IAClC,+CAA+C;IAC/C,OAAO,CAAC,aAAa,CAAQ;IAC7B,wCAAwC;IACxC,OAAO,CAAC,SAAS,CAAC,CAAyB;IAE3C;;;;;;;;;;;;OAYG;;IAYH;;;;;;;;;;OAUG;IACH,IAAI,UAAU,IAcQ,MAAM,GAAG,IAAI,CAZlC;IAED;;;;;;;;;OASG;IACH,IAAI,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,EAElC;IAED;;;;;;;;;;OAUG;IACH,IAAI,kBAAkB,IAcQ,MAAM,GAAG,IAAI,CAZ1C;IAED;;;;;;;;;OASG;IACH,IAAI,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,EAE1C;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,cAAc,IAAI,uBAAuB,CAY5C;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,aAAa,IAGQ,MAAM,GAAG,IAAI,CADrC;IACD,IAAI,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,EAErC;IAED;;OAEG;IACH,IAAI,WAAW,IAGQ,MAAM,GAAG,SAAS,CADxC;IACD,IAAI,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAExC;IAED;;OAEG;IACH,IAAI,qBAAqB,IAGQ,MAAM,CADtC;IACD,IAAI,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAEtC;IAED;;OAEG;IACH,IAAI,oBAAoB,IAGQ,oBAAoB,CADnD;IACD,IAAI,oBAAoB,CAAC,KAAK,EAAE,oBAAoB,EAEnD;IAED;;;OAGG;IACH,IAAI,YAAY,IAGQ,WAAW,CADlC;IACD,IAAI,YAAY,CAAC,KAAK,EAAE,WAAW,EAElC;IAED;;;;;;OAMG;IACH,IAAI,YAAY,IAGQ,MAAM,CAD7B;IACD,IAAI,YAAY,CAAC,KAAK,EAAE,MAAM,EAE7B;IAED;;OAEG;IACH,IAAI,CAAC,QAAQ,EAAE,YAAY;IAqB3B,SAAS,CAAC,cAAc,CAAC,QAAQ,EAAE,YAAY;IAe/C,SAAS,CAAC,eAAe,CAAC,QAAQ,EAAE,YAAY;IAehD,SAAS,KAAK,gBAAgB,WAM7B;IAED;;OAEG;IACH,SAAS,KAAK,eAAe,IAAI,cAAc,CAO9C;IAED;;OAEG;IACH,SAAS,KAAK,gBAAgB,IAAI,cAAc,CAO/C;IAED;;;;OAIG;IACH,SAAS,KAAK,aAAa,YAE1B;IAED;;OAEG;IACH,SAAS,KAAK,mBAAmB,WAGhC;IAED;;OAEG;IACH,SAAS,KAAK,cAAc,kBAG3B;IAED;;OAEG;IACH,SAAS,KAAK,oBAAoB,WAGjC;IAED;;OAEG;IACH,SAAS,KAAK,eAAe,kBAG5B;IAED;;OAEG;IACH,SAAS,KAAK,cAAc,WAE3B;IAED;;;;;OAKG;IAEH,SAAS,CAAC,iBAAiB,CAAC,IAAI,EAAE,QAAQ,GAAG,kBAAkB,GAAG,SAAS;IAI3E;;;;;;;OAOG;IACH,SAAS,CAAC,gBAAgB,CACxB,EAAE,EAAE,WAAW,EACf,EAAE,EAAE,WAAW,EACf,MAAM,EAAE,MAAM,GACb,WAAW;IAUd;;;;;;;;OAQG;IACH,SAAS,CAAC,gBAAgB,CACxB,EAAE,EAAE,eAAe,EACnB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,GACb,eAAe;IAOlB;;;OAGG;IACH,SAAS,CAAC,mBAAmB,CAAC,aAAa,EAAE,UAAU;IAMvD;;;;OAIG;IACH,OAAO,CAAC,YAAY;CAQrB"}