@mlightcad/data-model 1.3.3 → 1.3.5

package/lib/database/AcDbBlockTableRecord.d.ts

@@ -0,0 +1,185 @@
+import { AcGePoint3d } from '@mlightcad/geometry-engine';
+import { AcDbObjectId } from '../base/AcDbObject';
+import { AcDbEntity } from '../entity/AcDbEntity';
+import { AcDbObjectIterator } from '../misc/AcDbObjectIterator';
+import { AcDbSymbolTableRecord } from './AcDbSymbolTableRecord';
+/**
+ * Block table record that serves as a container for entities within drawing databases.
+ *
+ * Block table records (BTRs) are used to organize and group entities together.
+ * There are two special BTRs that are always present in every database:
+ * - *MODEL_SPACE: Contains entities in model space
+ * - *PAPER_SPACE: Contains entities in paper space
+ *
+ * Each block table record has an origin point and can contain multiple entities.
+ *
+ * @example
+ * ```typescript
+ * const blockRecord = new AcDbBlockTableRecord();
+ * blockRecord.name = 'MyBlock';
+ * blockRecord.origin = new AcGePoint3d(0, 0, 0);
+ * blockRecord.appendEntity(new AcDbLine());
+ * ```
+ */
+export declare class AcDbBlockTableRecord extends AcDbSymbolTableRecord {
+    /** Name constant for model space block table record */
+    static MODEL_SPACE_NAME: string;
+    /** Name prefix for paper space block table records */
+    static PAPER_SPACE_NAME_PREFIX: string;
+    /** The base point of the block in WCS coordinates */
+    private _origin;
+    /** The object id of the associated AcDbLayout object in the Layouts dictionary.*/
+    private _layoutId;
+    /** Map of entities indexed by their object IDs */
+    private _entities;
+    /**
+     * Returns true if the specified name is the name of the model space block table record.
+     *
+     * Model space is the primary drawing area where most entities are created.
+     *
+     * @param name - The name of one block table record.
+     * @returns True if the specified name is the name of the model space block table record.
+     *
+     * @example
+     * ```typescript
+     * if (AcDbBlockTableRecord.isModelSapceName('*Model_Space')) {
+     *   console.log('This is the name of the model space block table record.');
+     * }
+     * ```
+     */
+    static isModelSapceName(name: string): boolean;
+    /**
+     * Returns true if the specified name is the name of a paper space block table record.
+     *
+     * Paper space is used for creating layouts for printing and plotting.
+     *
+     * @param name - The name of one block table record.
+     * @returns True if the specified name is the name of a paper space block table record.
+     *
+     * @example
+     * ```typescript
+     * if (AcDbBlockTableRecord.isPaperSapceName('*Paper_Space1')) {
+     *   console.log('This is the name of the paper space block table record.');
+     * }
+     * ```
+     */
+    static isPaperSapceName(name: string): boolean;
+    /**
+     * Creates a new AcDbBlockTableRecord instance.
+     *
+     * @example
+     * ```typescript
+     * const blockRecord = new AcDbBlockTableRecord();
+     * ```
+     */
+    constructor();
+    /**
+     * Returns true if this is a model space block table record.
+     *
+     * Model space is the primary drawing area where most entities are created.
+     *
+     * @returns True if this is a model space block table record
+     *
+     * @example
+     * ```typescript
+     * if (blockRecord.isModelSapce) {
+     *   console.log('This is model space');
+     * }
+     * ```
+     */
+    get isModelSapce(): boolean;
+    /**
+     * Returns true if this is a paper space block table record.
+     *
+     * Paper space is used for creating layouts for printing and plotting.
+     *
+     * @returns True if this is a paper space block table record
+     *
+     * @example
+     * ```typescript
+     * if (blockRecord.isPaperSapce) {
+     *   console.log('This is paper space');
+     * }
+     * ```
+     */
+    get isPaperSapce(): boolean;
+    /**
+     * Gets or sets the base point of the block in WCS coordinates.
+     *
+     * This point is the origin of the MCS (Model Coordinate System), which is the
+     * local WCS for the entities within the block table record.
+     *
+     * @returns The origin point of the block
+     *
+     * @example
+     * ```typescript
+     * const origin = blockRecord.origin;
+     * blockRecord.origin = new AcGePoint3d(10, 20, 0);
+     * ```
+     */
+    get origin(): AcGePoint3d;
+    set origin(value: AcGePoint3d);
+    /**
+     * Gets or sets the object ID of the associated AcDbLayout object in the Layouts dictionary.
+     *
+     * This property links the block table record to its corresponding layout object,
+     * which defines the viewport configuration and display settings for the block.
+     * For model space blocks, this is typically empty, while paper space blocks
+     * have a corresponding layout ID.
+     *
+     * @returns The object ID of the associated layout
+     *
+     * @example
+     * ```typescript
+     * const layoutId = blockRecord.layoutId;
+     * blockRecord.layoutId = 'some-layout-object-id';
+     * ```
+     */
+    get layoutId(): AcDbObjectId;
+    set layoutId(value: AcDbObjectId);
+    /**
+     * Appends the specified entity or entities to this block table record.
+     *
+     * This method adds an entity to the block and sets up the necessary
+     * relationships between the entity and the block table record.
+     *
+     * @param entity - The entity or entities to append to this block table record
+     *
+     * @example
+     * ```typescript
+     * const line = new AcDbLine();
+     * blockRecord.appendEntity(line);
+     * ```
+     */
+    appendEntity(entity: AcDbEntity | AcDbEntity[]): void;
+    /**
+     * Creates an iterator object that can be used to iterate over the entities in the block table record.
+     *
+     * @returns An iterator object that can be used to iterate over the entities
+     *
+     * @example
+     * ```typescript
+     * const iterator = blockRecord.newIterator();
+     * for (const entity of iterator) {
+     *   console.log('Entity:', entity.type);
+     * }
+     * ```
+     */
+    newIterator(): AcDbObjectIterator<AcDbEntity>;
+    /**
+     * Searches for an entity in this block table record with the specified ID.
+     *
+     * @param id - The entity ID to search for
+     * @returns The entity with the specified ID, or undefined if not found
+     *
+     * @example
+     * ```typescript
+     * const entity = blockRecord.getIdAt('some-entity-id');
+     * if (entity) {
+     *   console.log('Found entity:', entity.type);
+     * }
+     * ```
+     */
+    getIdAt(id: string): AcDbEntity | undefined;
+}
+//# sourceMappingURL=AcDbBlockTableRecord.d.ts.map

package/lib/database/AcDbBlockTableRecord.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AcDbBlockTableRecord.d.ts","sourceRoot":"","sources":["../../src/database/AcDbBlockTableRecord.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAA;AAExD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACjD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACjD,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAC/D,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAE/D;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,oBAAqB,SAAQ,qBAAqB;IAC7D,uDAAuD;IACvD,MAAM,CAAC,gBAAgB,SAAiB;IACxC,sDAAsD;IACtD,MAAM,CAAC,uBAAuB,SAAiB;IAE/C,qDAAqD;IACrD,OAAO,CAAC,OAAO,CAAa;IAC5B,kFAAkF;IAClF,OAAO,CAAC,SAAS,CAAc;IAC/B,kDAAkD;IAClD,OAAO,CAAC,SAAS,CAA+B;IAEhD;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,gBAAgB,CAAC,IAAI,EAAE,MAAM;IAMpC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,gBAAgB,CAAC,IAAI,EAAE,MAAM;IAMpC;;;;;;;OAOG;;IAQH;;;;;;;;;;;;;OAaG;IACH,IAAI,YAAY,YAEf;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,YAAY,YAEf;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,MAAM,IAGQ,WAAW,CAD5B;IACD,IAAI,MAAM,CAAC,KAAK,EAAE,WAAW,EAE5B;IAED;;;;;;;;;;;;;;;OAeG;IACH,IAAI,QAAQ,IAGQ,YAAY,CAD/B;IACD,IAAI,QAAQ,CAAC,KAAK,EAAE,YAAY,EAE/B;IAED;;;;;;;;;;;;;OAaG;IACH,YAAY,CAAC,MAAM,EAAE,UAAU,GAAG,UAAU,EAAE;IAwB9C;;;;;;;;;;;;OAYG;IACH,WAAW,IAAI,kBAAkB,CAAC,UAAU,CAAC;IAI7C;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM;CAGnB"}

package/lib/database/AcDbBlockTableRecord.js

@@ -0,0 +1,261 @@
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+import { AcGePoint3d } from '@mlightcad/geometry-engine';
+import { AcDbObjectIterator } from '../misc/AcDbObjectIterator';
+import { AcDbSymbolTableRecord } from './AcDbSymbolTableRecord';
+/**
+ * Block table record that serves as a container for entities within drawing databases.
+ *
+ * Block table records (BTRs) are used to organize and group entities together.
+ * There are two special BTRs that are always present in every database:
+ * - *MODEL_SPACE: Contains entities in model space
+ * - *PAPER_SPACE: Contains entities in paper space
+ *
+ * Each block table record has an origin point and can contain multiple entities.
+ *
+ * @example
+ * ```typescript
+ * const blockRecord = new AcDbBlockTableRecord();
+ * blockRecord.name = 'MyBlock';
+ * blockRecord.origin = new AcGePoint3d(0, 0, 0);
+ * blockRecord.appendEntity(new AcDbLine());
+ * ```
+ */
+var AcDbBlockTableRecord = /** @class */ (function (_super) {
+    __extends(AcDbBlockTableRecord, _super);
+    /**
+     * Creates a new AcDbBlockTableRecord instance.
+     *
+     * @example
+     * ```typescript
+     * const blockRecord = new AcDbBlockTableRecord();
+     * ```
+     */
+    function AcDbBlockTableRecord() {
+        var _this = _super.call(this) || this;
+        _this._origin = new AcGePoint3d();
+        _this._layoutId = '';
+        _this._entities = new Map();
+        return _this;
+    }
+    /**
+     * Returns true if the specified name is the name of the model space block table record.
+     *
+     * Model space is the primary drawing area where most entities are created.
+     *
+     * @param name - The name of one block table record.
+     * @returns True if the specified name is the name of the model space block table record.
+     *
+     * @example
+     * ```typescript
+     * if (AcDbBlockTableRecord.isModelSapceName('*Model_Space')) {
+     *   console.log('This is the name of the model space block table record.');
+     * }
+     * ```
+     */
+    AcDbBlockTableRecord.isModelSapceName = function (name) {
+        return (name.toLowerCase() == AcDbBlockTableRecord.MODEL_SPACE_NAME.toLowerCase());
+    };
+    /**
+     * Returns true if the specified name is the name of a paper space block table record.
+     *
+     * Paper space is used for creating layouts for printing and plotting.
+     *
+     * @param name - The name of one block table record.
+     * @returns True if the specified name is the name of a paper space block table record.
+     *
+     * @example
+     * ```typescript
+     * if (AcDbBlockTableRecord.isPaperSapceName('*Paper_Space1')) {
+     *   console.log('This is the name of the paper space block table record.');
+     * }
+     * ```
+     */
+    AcDbBlockTableRecord.isPaperSapceName = function (name) {
+        return name
+            .toLowerCase()
+            .startsWith(AcDbBlockTableRecord.PAPER_SPACE_NAME_PREFIX.toLowerCase());
+    };
+    Object.defineProperty(AcDbBlockTableRecord.prototype, "isModelSapce", {
+        /**
+         * Returns true if this is a model space block table record.
+         *
+         * Model space is the primary drawing area where most entities are created.
+         *
+         * @returns True if this is a model space block table record
+         *
+         * @example
+         * ```typescript
+         * if (blockRecord.isModelSapce) {
+         *   console.log('This is model space');
+         * }
+         * ```
+         */
+        get: function () {
+            return AcDbBlockTableRecord.isModelSapceName(this.name);
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(AcDbBlockTableRecord.prototype, "isPaperSapce", {
+        /**
+         * Returns true if this is a paper space block table record.
+         *
+         * Paper space is used for creating layouts for printing and plotting.
+         *
+         * @returns True if this is a paper space block table record
+         *
+         * @example
+         * ```typescript
+         * if (blockRecord.isPaperSapce) {
+         *   console.log('This is paper space');
+         * }
+         * ```
+         */
+        get: function () {
+            return AcDbBlockTableRecord.isPaperSapceName(this.name);
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(AcDbBlockTableRecord.prototype, "origin", {
+        /**
+         * Gets or sets the base point of the block in WCS coordinates.
+         *
+         * This point is the origin of the MCS (Model Coordinate System), which is the
+         * local WCS for the entities within the block table record.
+         *
+         * @returns The origin point of the block
+         *
+         * @example
+         * ```typescript
+         * const origin = blockRecord.origin;
+         * blockRecord.origin = new AcGePoint3d(10, 20, 0);
+         * ```
+         */
+        get: function () {
+            return this._origin;
+        },
+        set: function (value) {
+            this._origin.copy(value);
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(AcDbBlockTableRecord.prototype, "layoutId", {
+        /**
+         * Gets or sets the object ID of the associated AcDbLayout object in the Layouts dictionary.
+         *
+         * This property links the block table record to its corresponding layout object,
+         * which defines the viewport configuration and display settings for the block.
+         * For model space blocks, this is typically empty, while paper space blocks
+         * have a corresponding layout ID.
+         *
+         * @returns The object ID of the associated layout
+         *
+         * @example
+         * ```typescript
+         * const layoutId = blockRecord.layoutId;
+         * blockRecord.layoutId = 'some-layout-object-id';
+         * ```
+         */
+        get: function () {
+            return this._layoutId;
+        },
+        set: function (value) {
+            this._layoutId = value;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * Appends the specified entity or entities to this block table record.
+     *
+     * This method adds an entity to the block and sets up the necessary
+     * relationships between the entity and the block table record.
+     *
+     * @param entity - The entity or entities to append to this block table record
+     *
+     * @example
+     * ```typescript
+     * const line = new AcDbLine();
+     * blockRecord.appendEntity(line);
+     * ```
+     */
+    AcDbBlockTableRecord.prototype.appendEntity = function (entity) {
+        if (Array.isArray(entity)) {
+            for (var i = 0; i < entity.length; ++i) {
+                var item = entity[i];
+                item.database = this.database;
+                item.ownerId = this.objectId;
+                this._entities.set(item.objectId, item);
+            }
+        }
+        else {
+            entity.database = this.database;
+            entity.ownerId = this.objectId;
+            this._entities.set(entity.objectId, entity);
+        }
+        // When creating one block, it will also go to this function. But we don't want `entityAppended` event
+        // tiggered in this case. So check whether the block name is name of the model space.
+        if (this.isModelSapce || this.isPaperSapce) {
+            this.database.events.entityAppended.dispatch({
+                database: this.database,
+                entity: entity
+            });
+        }
+    };
+    /**
+     * Creates an iterator object that can be used to iterate over the entities in the block table record.
+     *
+     * @returns An iterator object that can be used to iterate over the entities
+     *
+     * @example
+     * ```typescript
+     * const iterator = blockRecord.newIterator();
+     * for (const entity of iterator) {
+     *   console.log('Entity:', entity.type);
+     * }
+     * ```
+     */
+    AcDbBlockTableRecord.prototype.newIterator = function () {
+        return new AcDbObjectIterator(this._entities);
+    };
+    /**
+     * Searches for an entity in this block table record with the specified ID.
+     *
+     * @param id - The entity ID to search for
+     * @returns The entity with the specified ID, or undefined if not found
+     *
+     * @example
+     * ```typescript
+     * const entity = blockRecord.getIdAt('some-entity-id');
+     * if (entity) {
+     *   console.log('Found entity:', entity.type);
+     * }
+     * ```
+     */
+    AcDbBlockTableRecord.prototype.getIdAt = function (id) {
+        return this._entities.get(id);
+    };
+    /** Name constant for model space block table record */
+    AcDbBlockTableRecord.MODEL_SPACE_NAME = '*MODEL_SPACE';
+    /** Name prefix for paper space block table records */
+    AcDbBlockTableRecord.PAPER_SPACE_NAME_PREFIX = '*PAPER_SPACE';
+    return AcDbBlockTableRecord;
+}(AcDbSymbolTableRecord));
+export { AcDbBlockTableRecord };
+//# sourceMappingURL=AcDbBlockTableRecord.js.map

package/lib/database/AcDbBlockTableRecord.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AcDbBlockTableRecord.js","sourceRoot":"","sources":["../../src/database/AcDbBlockTableRecord.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAA;AAIxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAC/D,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAE/D;;;;;;;;;;;;;;;;;GAiBG;AACH;IAA0C,wCAAqB;IAuD7D;;;;;;;OAOG;IACH;QACE,YAAA,MAAK,WAAE,SAAA;QACP,KAAI,CAAC,OAAO,GAAG,IAAI,WAAW,EAAE,CAAA;QAChC,KAAI,CAAC,SAAS,GAAG,EAAE,CAAA;QACnB,KAAI,CAAC,SAAS,GAAG,IAAI,GAAG,EAAsB,CAAA;;IAChD,CAAC;IAvDD;;;;;;;;;;;;;;OAcG;IACI,qCAAgB,GAAvB,UAAwB,IAAY;QAClC,OAAO,CACL,IAAI,CAAC,WAAW,EAAE,IAAI,oBAAoB,CAAC,gBAAgB,CAAC,WAAW,EAAE,CAC1E,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACI,qCAAgB,GAAvB,UAAwB,IAAY;QAClC,OAAO,IAAI;aACR,WAAW,EAAE;aACb,UAAU,CAAC,oBAAoB,CAAC,uBAAuB,CAAC,WAAW,EAAE,CAAC,CAAA;IAC3E,CAAC;IA+BD,sBAAI,8CAAY;QAdhB;;;;;;;;;;;;;WAaG;aACH;YACE,OAAO,oBAAoB,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACzD,CAAC;;;OAAA;IAgBD,sBAAI,8CAAY;QAdhB;;;;;;;;;;;;;WAaG;aACH;YACE,OAAO,oBAAoB,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACzD,CAAC;;;OAAA;IAgBD,sBAAI,wCAAM;QAdV;;;;;;;;;;;;;WAaG;aACH;YACE,OAAO,IAAI,CAAC,OAAO,CAAA;QACrB,CAAC;aACD,UAAW,KAAkB;YAC3B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC1B,CAAC;;;OAHA;IAqBD,sBAAI,0CAAQ;QAhBZ;;;;;;;;;;;;;;;WAeG;aACH;YACE,OAAO,IAAI,CAAC,SAAS,CAAA;QACvB,CAAC;aACD,UAAa,KAAmB;YAC9B,IAAI,CAAC,SAAS,GAAG,KAAK,CAAA;QACxB,CAAC;;;OAHA;IAKD;;;;;;;;;;;;;OAaG;IACH,2CAAY,GAAZ,UAAa,MAAiC;QAC5C,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;gBACvC,IAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;gBACtB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAA;gBAC7B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAA;gBAC5B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;YACzC,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAA;YAC/B,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAA;YAC9B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;QAC7C,CAAC;QAED,sGAAsG;QACtG,qFAAqF;QACrF,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YAC3C,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC;gBAC3C,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,MAAM,EAAE,MAAM;aACf,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,0CAAW,GAAX;QACE,OAAO,IAAI,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;IAC/C,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,sCAAO,GAAP,UAAQ,EAAU;QAChB,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;IAC/B,CAAC;IA5ND,uDAAuD;IAChD,qCAAgB,GAAG,cAAc,CAAA;IACxC,sDAAsD;IAC/C,4CAAuB,GAAG,cAAc,CAAA;IA0NjD,2BAAC;CAAA,AA9ND,CAA0C,qBAAqB,GA8N9D;SA9NY,oBAAoB"}