@mlightcad/data-model 1.1.2 → 1.1.3

package/lib/converter/AcDbObjectConverter.js

@@ -1,7 +1,33 @@
 import { AcDbLayout, AcDbRasterImageDef } from '../object';
+/**
+ * Converts DXF objects to AcDbObject instances.
+ *
+ * This class provides functionality to convert various DXF object types
+ * (such as layouts and image definitions) into their corresponding
+ * AcDbObject instances.
+ *
+ * @example
+ * ```typescript
+ * const converter = new AcDbObjectConverter();
+ * const layout = converter.convertLayout(dxfLayout);
+ * const imageDef = converter.convertImageDef(dxfImageDef);
+ * ```
+ */
 var AcDbObjectConverter = /** @class */ (function () {
     function AcDbObjectConverter() {
     }
+    /**
+     * Converts a DXF layout object to an AcDbLayout.
+     *
+     * @param layout - The DXF layout object to convert
+     * @returns The converted AcDbLayout instance
+     *
+     * @example
+     * ```typescript
+     * const dxfLayout = { layoutName: 'Model', tabOrder: 1, ... };
+     * const acDbLayout = converter.convertLayout(dxfLayout);
+     * ```
+     */
     AcDbObjectConverter.prototype.convertLayout = function (layout) {
         var dbObject = new AcDbLayout();
         dbObject.layoutName = layout.layoutName;
@@ -14,12 +40,38 @@ var AcDbObjectConverter = /** @class */ (function () {
         this.processCommonAttrs(layout, dbObject);
         return dbObject;
     };
+    /**
+     * Converts a DXF image definition object to an AcDbRasterImageDef.
+     *
+     * @param image - The DXF image definition object to convert
+     * @returns The converted AcDbRasterImageDef instance
+     *
+     * @example
+     * ```typescript
+     * const dxfImageDef = { fileName: 'image.jpg', ... };
+     * const acDbImageDef = converter.convertImageDef(dxfImageDef);
+     * ```
+     */
     AcDbObjectConverter.prototype.convertImageDef = function (image) {
         var dbObject = new AcDbRasterImageDef();
         dbObject.sourceFileName = image.fileName;
         this.processCommonAttrs(image, dbObject);
         return dbObject;
     };
+    /**
+     * Processes common attributes from a DXF object to an AcDbObject.
+     *
+     * This method copies common properties like object ID and owner ID
+     * from the DXF object to the corresponding AcDbObject.
+     *
+     * @param object - The source DXF object
+     * @param dbObject - The target AcDbObject to populate
+     *
+     * @example
+     * ```typescript
+     * converter.processCommonAttrs(dxfObject, acDbObject);
+     * ```
+     */
     AcDbObjectConverter.prototype.processCommonAttrs = function (object, dbObject) {
         dbObject.objectId = object.handle;
         dbObject.ownerId = object.ownerObjectId;

package/lib/converter/AcDbObjectConverter.js.map

@@ -1 +1 @@
-{"version":3,"file":"AcDbObjectConverter.js","sourceRoot":"","sources":["../../src/converter/AcDbObjectConverter.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAA;AAE1D;IAAA;IAyBA,CAAC;IAxBC,2CAAa,GAAb,UAAc,MAAuB;QACnC,IAAM,QAAQ,GAAG,IAAI,UAAU,EAAE,CAAA;QACjC,QAAQ,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAA;QACvC,QAAQ,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAA;QACnC,QAAQ,CAAC,kBAAkB,GAAG,MAAM,CAAC,aAAa,CAAA;QAClD,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;QACzC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;QACzC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;QAC3C,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;QAC3C,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;QACzC,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED,6CAAe,GAAf,UAAgB,KAAwB;QACtC,IAAM,QAAQ,GAAG,IAAI,kBAAkB,EAAE,CAAA;QACzC,QAAQ,CAAC,cAAc,GAAG,KAAK,CAAC,QAAQ,CAAA;QACxC,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAA;QACxC,OAAO,QAAQ,CAAA;IACjB,CAAC;IAEO,gDAAkB,GAA1B,UAA2B,MAAuB,EAAE,QAAoB;QACtE,QAAQ,CAAC,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAA;QACjC,QAAQ,CAAC,OAAO,GAAG,MAAM,CAAC,aAAa,CAAA;IACzC,CAAC;IACH,0BAAC;AAAD,CAAC,AAzBD,IAyBC"}
+{"version":3,"file":"AcDbObjectConverter.js","sourceRoot":"","sources":["../../src/converter/AcDbObjectConverter.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAA;AAE1D;;;;;;;;;;;;;GAaG;AACH;IAAA;IA+DA,CAAC;IA9DC;;;;;;;;;;;OAWG;IACH,2CAAa,GAAb,UAAc,MAAuB;QACnC,IAAM,QAAQ,GAAG,IAAI,UAAU,EAAE,CAAA;QACjC,QAAQ,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAA;QACvC,QAAQ,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAA;QACnC,QAAQ,CAAC,kBAAkB,GAAG,MAAM,CAAC,aAAa,CAAA;QAClD,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;QACzC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;QACzC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;QAC3C,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;QAC3C,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;QACzC,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,6CAAe,GAAf,UAAgB,KAAwB;QACtC,IAAM,QAAQ,GAAG,IAAI,kBAAkB,EAAE,CAAA;QACzC,QAAQ,CAAC,cAAc,GAAG,KAAK,CAAC,QAAQ,CAAA;QACxC,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAA;QACxC,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;;;;;;;;;;;;OAaG;IACK,gDAAkB,GAA1B,UAA2B,MAAuB,EAAE,QAAoB;QACtE,QAAQ,CAAC,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAA;QACjC,QAAQ,CAAC,OAAO,GAAG,MAAM,CAAC,aAAa,CAAA;IACzC,CAAC;IACH,0BAAC;AAAD,CAAC,AA/DD,IA+DC"}

package/lib/database/AcDbBlockTable.d.ts

@@ -2,13 +2,45 @@ import { AcDbBlockTableRecord } from './AcDbBlockTableRecord';
 import { AcDbDatabase } from './AcDbDatabase';
 import { AcDbSymbolTable } from './AcDbSymbolTable';
 /**
- * This class is the symbol table for block table records, which represent
- * block definitions within a drawing database.
+ * Symbol table for block table records.
+ *
+ * This class manages block table records which represent block definitions
+ * within a drawing database. Blocks are reusable collections of entities
+ * that can be inserted multiple times into a drawing.
+ *
+ * @example
+ * ```typescript
+ * const blockTable = new AcDbBlockTable(database);
+ * const modelSpace = blockTable.modelSpace;
+ * const block = blockTable.getAt('MyBlock');
+ * ```
  */
 export declare class AcDbBlockTable extends AcDbSymbolTable<AcDbBlockTableRecord> {
+    /**
+     * Creates a new AcDbBlockTable instance.
+     *
+     * @param db - The database this block table belongs to
+     *
+     * @example
+     * ```typescript
+     * const blockTable = new AcDbBlockTable(database);
+     * ```
+     */
     constructor(db: AcDbDatabase);
     /**
-     * Get MODEL_SPACE block table record
+     * Gets the MODEL_SPACE block table record.
+     *
+     * This method returns the model space block table record, creating it
+     * if it doesn't exist. Model space is the primary drawing area where
+     * most entities are created and stored.
+     *
+     * @returns The MODEL_SPACE block table record
+     *
+     * @example
+     * ```typescript
+     * const modelSpace = blockTable.modelSpace;
+     * const entities = modelSpace.entities;
+     * ```
      */
     get modelSpace(): AcDbBlockTableRecord;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"AcDbBlockTable.d.ts","sourceRoot":"","sources":["../../src/database/AcDbBlockTable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAC7D,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAEnD;;;GAGG;AACH,qBAAa,cAAe,SAAQ,eAAe,CAAC,oBAAoB,CAAC;gBAC3D,EAAE,EAAE,YAAY;IAI5B;;OAEG;IACH,IAAI,UAAU,IAAI,oBAAoB,CAQrC;CACF"}
+{"version":3,"file":"AcDbBlockTable.d.ts","sourceRoot":"","sources":["../../src/database/AcDbBlockTable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAC7D,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAEnD;;;;;;;;;;;;;GAaG;AACH,qBAAa,cAAe,SAAQ,eAAe,CAAC,oBAAoB,CAAC;IACvE;;;;;;;;;OASG;gBACS,EAAE,EAAE,YAAY;IAI5B;;;;;;;;;;;;;;OAcG;IACH,IAAI,UAAU,IAAI,oBAAoB,CAQrC;CACF"}

package/lib/database/AcDbBlockTable.js

@@ -16,17 +16,49 @@ var __extends = (this && this.__extends) || (function () {
 import { AcDbBlockTableRecord } from './AcDbBlockTableRecord';
 import { AcDbSymbolTable } from './AcDbSymbolTable';
 /**
- * This class is the symbol table for block table records, which represent
- * block definitions within a drawing database.
+ * Symbol table for block table records.
+ *
+ * This class manages block table records which represent block definitions
+ * within a drawing database. Blocks are reusable collections of entities
+ * that can be inserted multiple times into a drawing.
+ *
+ * @example
+ * ```typescript
+ * const blockTable = new AcDbBlockTable(database);
+ * const modelSpace = blockTable.modelSpace;
+ * const block = blockTable.getAt('MyBlock');
+ * ```
  */
 var AcDbBlockTable = /** @class */ (function (_super) {
     __extends(AcDbBlockTable, _super);
+    /**
+     * Creates a new AcDbBlockTable instance.
+     *
+     * @param db - The database this block table belongs to
+     *
+     * @example
+     * ```typescript
+     * const blockTable = new AcDbBlockTable(database);
+     * ```
+     */
     function AcDbBlockTable(db) {
         return _super.call(this, db) || this;
     }
     Object.defineProperty(AcDbBlockTable.prototype, "modelSpace", {
         /**
-         * Get MODEL_SPACE block table record
+         * Gets the MODEL_SPACE block table record.
+         *
+         * This method returns the model space block table record, creating it
+         * if it doesn't exist. Model space is the primary drawing area where
+         * most entities are created and stored.
+         *
+         * @returns The MODEL_SPACE block table record
+         *
+         * @example
+         * ```typescript
+         * const modelSpace = blockTable.modelSpace;
+         * const entities = modelSpace.entities;
+         * ```
          */
         get: function () {
             var modelSpace = this.getAt(AcDbBlockTableRecord.MODEL_SPACE_NAME);

package/lib/database/AcDbBlockTable.js.map

@@ -1 +1 @@
-{"version":3,"file":"AcDbBlockTable.js","sourceRoot":"","sources":["../../src/database/AcDbBlockTable.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAE7D,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAEnD;;;GAGG;AACH;IAAoC,kCAAqC;IACvE,wBAAY,EAAgB;QAC1B,OAAA,MAAK,YAAC,EAAE,CAAC,SAAA;IACX,CAAC;IAKD,sBAAI,sCAAU;QAHd;;WAEG;aACH;YACE,IAAI,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,gBAAgB,CAAC,CAAA;YAClE,IAAI,CAAC,UAAU,EAAE,CAAC;gBAChB,UAAU,GAAG,IAAI,oBAAoB,EAAE,CAAA;gBACvC,UAAU,CAAC,IAAI,GAAG,oBAAoB,CAAC,gBAAgB,CAAA;gBACvD,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;YACtB,CAAC;YACD,OAAO,UAAU,CAAA;QACnB,CAAC;;;OAAA;IACH,qBAAC;AAAD,CAAC,AAjBD,CAAoC,eAAe,GAiBlD"}
+{"version":3,"file":"AcDbBlockTable.js","sourceRoot":"","sources":["../../src/database/AcDbBlockTable.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAE7D,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAEnD;;;;;;;;;;;;;GAaG;AACH;IAAoC,kCAAqC;IACvE;;;;;;;;;OASG;IACH,wBAAY,EAAgB;QAC1B,OAAA,MAAK,YAAC,EAAE,CAAC,SAAA;IACX,CAAC;IAiBD,sBAAI,sCAAU;QAfd;;;;;;;;;;;;;;WAcG;aACH;YACE,IAAI,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,gBAAgB,CAAC,CAAA;YAClE,IAAI,CAAC,UAAU,EAAE,CAAC;gBAChB,UAAU,GAAG,IAAI,oBAAoB,EAAE,CAAA;gBACvC,UAAU,CAAC,IAAI,GAAG,oBAAoB,CAAC,gBAAgB,CAAA;gBACvD,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;YACtB,CAAC;YACD,OAAO,UAAU,CAAA;QACnB,CAAC;;;OAAA;IACH,qBAAC;AAAD,CAAC,AAvCD,CAAoC,eAAe,GAuClD"}

package/lib/database/AcDbBlockTableRecord.d.ts

@@ -3,46 +3,129 @@ import { AcDbEntity } from '../entity/AcDbEntity';
 import { AcDbObjectIterator } from '../misc/AcDbObjectIterator';
 import { AcDbSymbolTableRecord } from './AcDbSymbolTableRecord';
 /**
- * Objects of the block table record are used as containers for entities within drawing file
- * databases. There are two special BTRs that are always present in every database. They are
- * *Model_Space and *Paper_Space. They are the Model and Paper Spaces for the database.
+ * 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;
+    /** Map of entities indexed by their object IDs */
     private _entities;
+    /**
+     * Creates a new AcDbBlockTableRecord instance.
+     *
+     * @example
+     * ```typescript
+     * const blockRecord = new AcDbBlockTableRecord();
+     * ```
+     */
     constructor();
     /**
-     * Return true if it is model space block table record.
+     * 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;
     /**
-     * Return true if it is paper space block table record.
+     * 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;
     /**
-     * The base point of the block in WCS coordinates. This point is the origin of the MCS (which is the
-     * local WCS for the entities within the block table record).
+     * 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);
     /**
-     * Append the specified entity to this block table record.
-     * @param entity Input entity to append
+     * Appends the specified entity 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 to append to this block table record
+     *
+     * @example
+     * ```typescript
+     * const line = new AcDbLine();
+     * blockRecord.appendEntity(line);
+     * ```
      */
     appendEntity(entity: AcDbEntity): void;
     /**
-     * Create an iterator object that can be used to iterate over the entities in the block table record.
+     * 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
      *
-     * @returns Return an iterator object that can be used to iterate over the entities in the block table record.
+     * @example
+     * ```typescript
+     * const iterator = blockRecord.newIterator();
+     * for (const entity of iterator) {
+     *   console.log('Entity:', entity.type);
+     * }
+     * ```
      */
     newIterator(): AcDbObjectIterator<AcDbEntity>;
     /**
-     * Search entities in this block table record with the specified id. If found, it return the entity.
-     * Otherwise, return undefined.
-     * @param id Input the entity id to search
-     * @returns If found the entity with the specified id, return it. Otherwise, return undefined.
+     * 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;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"AcDbBlockTableRecord.d.ts","sourceRoot":"","sources":["../../src/database/AcDbBlockTableRecord.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAA;AAGxD,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;;;;GAIG;AACH,qBAAa,oBAAqB,SAAQ,qBAAqB;IAC7D,MAAM,CAAC,gBAAgB,SAAiB;IACxC,MAAM,CAAC,uBAAuB,SAAiB;IAC/C,OAAO,CAAC,OAAO,CAAa;IAC5B,OAAO,CAAC,SAAS,CAA+B;;IAQhD;;OAEG;IACH,IAAI,YAAY,YAKf;IAED;;OAEG;IACH,IAAI,YAAY,YAIf;IAED;;;OAGG;IACH,IAAI,MAAM,IAGQ,WAAW,CAD5B;IACD,IAAI,MAAM,CAAC,KAAK,EAAE,WAAW,EAE5B;IAED;;;OAGG;IACH,YAAY,CAAC,MAAM,EAAE,UAAU;IAe/B;;;;OAIG;IACH,WAAW,IAAI,kBAAkB,CAAC,UAAU,CAAC;IAI7C;;;;;OAKG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM;CAGnB"}
+{"version":3,"file":"AcDbBlockTableRecord.d.ts","sourceRoot":"","sources":["../../src/database/AcDbBlockTableRecord.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAA;AAGxD,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,kDAAkD;IAClD,OAAO,CAAC,SAAS,CAA+B;IAEhD;;;;;;;OAOG;;IAOH;;;;;;;;;;;;;OAaG;IACH,IAAI,YAAY,YAKf;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,YAAY,YAIf;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,MAAM,IAGQ,WAAW,CAD5B;IACD,IAAI,MAAM,CAAC,KAAK,EAAE,WAAW,EAE5B;IAED;;;;;;;;;;;;;OAaG;IACH,YAAY,CAAC,MAAM,EAAE,UAAU;IAe/B;;;;;;;;;;;;OAYG;IACH,WAAW,IAAI,kBAAkB,CAAC,UAAU,CAAC;IAI7C;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM;CAGnB"}

package/lib/database/AcDbBlockTableRecord.js

@@ -17,12 +17,33 @@ import { AcGePoint3d } from '@mlightcad/geometry-engine';
 import { AcDbObjectIterator } from '../misc/AcDbObjectIterator';
 import { AcDbSymbolTableRecord } from './AcDbSymbolTableRecord';
 /**
- * Objects of the block table record are used as containers for entities within drawing file
- * databases. There are two special BTRs that are always present in every database. They are
- * *Model_Space and *Paper_Space. They are the Model and Paper Spaces for the database.
+ * 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();
@@ -31,7 +52,18 @@ var AcDbBlockTableRecord = /** @class */ (function (_super) {
     }
     Object.defineProperty(AcDbBlockTableRecord.prototype, "isModelSapce", {
         /**
-         * Return true if it is model space block table record.
+         * 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 (this.name.toLowerCase() ==
@@ -42,7 +74,18 @@ var AcDbBlockTableRecord = /** @class */ (function (_super) {
     });
     Object.defineProperty(AcDbBlockTableRecord.prototype, "isPaperSapce", {
         /**
-         * Return true if it is paper space block table record.
+         * 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 this.name
@@ -54,8 +97,18 @@ var AcDbBlockTableRecord = /** @class */ (function (_super) {
     });
     Object.defineProperty(AcDbBlockTableRecord.prototype, "origin", {
         /**
-         * The base point of the block in WCS coordinates. This point is the origin of the MCS (which is the
-         * local WCS for the entities within the block table record).
+         * 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;
@@ -67,8 +120,18 @@ var AcDbBlockTableRecord = /** @class */ (function (_super) {
         configurable: true
     });
     /**
-     * Append the specified entity to this block table record.
-     * @param entity Input entity to append
+     * Appends the specified entity 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 to append to this block table record
+     *
+     * @example
+     * ```typescript
+     * const line = new AcDbLine();
+     * blockRecord.appendEntity(line);
+     * ```
      */
     AcDbBlockTableRecord.prototype.appendEntity = function (entity) {
         entity.database = this.database;
@@ -84,23 +147,41 @@ var AcDbBlockTableRecord = /** @class */ (function (_super) {
         }
     };
     /**
-     * Create an iterator object that can be used to iterate over the entities in the block table record.
+     * 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
      *
-     * @returns Return an iterator object that can be used to iterate over the entities in the block table record.
+     * @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);
     };
     /**
-     * Search entities in this block table record with the specified id. If found, it return the entity.
-     * Otherwise, return undefined.
-     * @param id Input the entity id to search
-     * @returns If found the entity with the specified id, return it. Otherwise, return undefined.
+     * 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));

package/lib/database/AcDbBlockTableRecord.js.map

@@ -1 +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;;;;GAIG;AACH;IAA0C,wCAAqB;IAM7D;QACE,YAAA,MAAK,WAAE,SAAA;QACP,KAAI,CAAC,OAAO,GAAG,IAAI,WAAW,EAAE,CAAA;QAChC,KAAI,CAAC,SAAS,GAAG,IAAI,GAAG,EAAsB,CAAA;;IAChD,CAAC;IAKD,sBAAI,8CAAY;QAHhB;;WAEG;aACH;YACE,OAAO,CACL,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;gBACvB,oBAAoB,CAAC,gBAAgB,CAAC,WAAW,EAAE,CACpD,CAAA;QACH,CAAC;;;OAAA;IAKD,sBAAI,8CAAY;QAHhB;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,IAAI;iBACb,WAAW,EAAE;iBACb,UAAU,CAAC,oBAAoB,CAAC,uBAAuB,CAAC,WAAW,EAAE,CAAC,CAAA;QAC3E,CAAC;;;OAAA;IAMD,sBAAI,wCAAM;QAJV;;;WAGG;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;IAKD;;;OAGG;IACH,2CAAY,GAAZ,UAAa,MAAkB;QAC7B,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAA;QAC/B,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAA;QAC9B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;QAE3C,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;;;;OAIG;IACH,0CAAW,GAAX;QACE,OAAO,IAAI,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;IAC/C,CAAC;IAED;;;;;OAKG;IACH,sCAAO,GAAP,UAAQ,EAAU;QAChB,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;IAC/B,CAAC;IA7EM,qCAAgB,GAAG,cAAc,CAAA;IACjC,4CAAuB,GAAG,cAAc,CAAA;IA6EjD,2BAAC;CAAA,AA/ED,CAA0C,qBAAqB,GA+E9D;SA/EY,oBAAoB"}
+{"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;IAW7D;;;;;;;OAOG;IACH;QACE,YAAA,MAAK,WAAE,SAAA;QACP,KAAI,CAAC,OAAO,GAAG,IAAI,WAAW,EAAE,CAAA;QAChC,KAAI,CAAC,SAAS,GAAG,IAAI,GAAG,EAAsB,CAAA;;IAChD,CAAC;IAgBD,sBAAI,8CAAY;QAdhB;;;;;;;;;;;;;WAaG;aACH;YACE,OAAO,CACL,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;gBACvB,oBAAoB,CAAC,gBAAgB,CAAC,WAAW,EAAE,CACpD,CAAA;QACH,CAAC;;;OAAA;IAgBD,sBAAI,8CAAY;QAdhB;;;;;;;;;;;;;WAaG;aACH;YACE,OAAO,IAAI,CAAC,IAAI;iBACb,WAAW,EAAE;iBACb,UAAU,CAAC,oBAAoB,CAAC,uBAAuB,CAAC,WAAW,EAAE,CAAC,CAAA;QAC3E,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;IAKD;;;;;;;;;;;;;OAaG;IACH,2CAAY,GAAZ,UAAa,MAAkB;QAC7B,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAA;QAC/B,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAA;QAC9B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;QAE3C,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;IApJD,uDAAuD;IAChD,qCAAgB,GAAG,cAAc,CAAA;IACxC,sDAAsD;IAC/C,4CAAuB,GAAG,cAAc,CAAA;IAkJjD,2BAAC;CAAA,AAtJD,CAA0C,qBAAqB,GAsJ9D;SAtJY,oBAAoB"}