@mlightcad/data-model 1.1.1 → 1.1.3

package/lib/misc/AcDbObjectIterator.d.ts

@@ -1,15 +1,54 @@
 /**
- * Iterator used for iterating over database objects in a map.
+ * Iterator used for iterating over database objects.
+ *
+ * This class provides an iterator interface for traversing collections
+ * of database objects. It implements both IterableIterator and provides
+ * additional methods for checking if more items are available.
+ *
+ * @template ResultType - The type of objects being iterated over
  */
 export declare class AcDbObjectIterator<ResultType> implements IterableIterator<ResultType> {
+    /** Current index in the iteration */
     private i;
     private _records;
     private _keys;
+    /**
+     * Creates a new AcDbObjectIterator instance.
+     *
+     * @param records - Array of objects to iterate over
+     *
+     * @example
+     * ```typescript
+     * const entities = [entity1, entity2, entity3];
+     * const iterator = new AcDbObjectIterator(entities);
+     * ```
+     */
     constructor(records: Map<string, ResultType>);
+    /**
+     * Returns the iterator itself, allowing it to be used in for...of loops.
+     *
+     * @returns This iterator instance
+     *
+     * @example
+     * ```typescript
+     * for (const entity of iterator) {
+     *   console.log('Entity:', entity);
+     * }
+     * ```
+     */
     [Symbol.iterator](): IterableIterator<ResultType>;
     /**
-     * Increment the iterator to the next entry.
-     * @returns Return the next entry
+     * Increments the iterator to the next entry.
+     *
+     * @returns Iterator result containing the next value or null if done
+     *
+     * @example
+     * ```typescript
+     * const result = iterator.next();
+     * if (!result.done) {
+     *   console.log('Next item:', result.value);
+     * }
+     * ```
      */
     next(): IteratorResult<ResultType, null>;
 }

package/lib/misc/AcDbObjectIterator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AcDbObjectIterator.d.ts","sourceRoot":"","sources":["../../src/misc/AcDbObjectIterator.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,qBAAa,kBAAkB,CAAC,UAAU,CACxC,YAAW,gBAAgB,CAAC,UAAU,CAAC;IAEvC,OAAO,CAAC,CAAC,CAAI;IACb,OAAO,CAAC,QAAQ,CAAyB;IACzC,OAAO,CAAC,KAAK,CAAU;gBAEX,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC;IAK5C,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,UAAU,CAAC;IAIjD;;;OAGG;IACH,IAAI,IAAI,cAAc,CAAC,UAAU,EAAE,IAAI,CAAC;CAQzC"}
+{"version":3,"file":"AcDbObjectIterator.d.ts","sourceRoot":"","sources":["../../src/misc/AcDbObjectIterator.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,qBAAa,kBAAkB,CAAC,UAAU,CACxC,YAAW,gBAAgB,CAAC,UAAU,CAAC;IAEvC,qCAAqC;IACrC,OAAO,CAAC,CAAC,CAAI;IACb,OAAO,CAAC,QAAQ,CAAyB;IACzC,OAAO,CAAC,KAAK,CAAU;IAEvB;;;;;;;;;;OAUG;gBACS,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC;IAK5C;;;;;;;;;;;OAWG;IACH,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,UAAU,CAAC;IAIjD;;;;;;;;;;;;OAYG;IACH,IAAI,IAAI,cAAc,CAAC,UAAU,EAAE,IAAI,CAAC;CAQzC"}

package/lib/misc/AcDbObjectIterator.js

@@ -1,18 +1,57 @@
 /**
- * Iterator used for iterating over database objects in a map.
+ * Iterator used for iterating over database objects.
+ *
+ * This class provides an iterator interface for traversing collections
+ * of database objects. It implements both IterableIterator and provides
+ * additional methods for checking if more items are available.
+ *
+ * @template ResultType - The type of objects being iterated over
  */
 var AcDbObjectIterator = /** @class */ (function () {
+    /**
+     * Creates a new AcDbObjectIterator instance.
+     *
+     * @param records - Array of objects to iterate over
+     *
+     * @example
+     * ```typescript
+     * const entities = [entity1, entity2, entity3];
+     * const iterator = new AcDbObjectIterator(entities);
+     * ```
+     */
     function AcDbObjectIterator(records) {
+        /** Current index in the iteration */
         this.i = 0;
         this._records = records;
         this._keys = Array.from(records.keys());
     }
+    /**
+     * Returns the iterator itself, allowing it to be used in for...of loops.
+     *
+     * @returns This iterator instance
+     *
+     * @example
+     * ```typescript
+     * for (const entity of iterator) {
+     *   console.log('Entity:', entity);
+     * }
+     * ```
+     */
     AcDbObjectIterator.prototype[Symbol.iterator] = function () {
         return this;
     };
     /**
-     * Increment the iterator to the next entry.
-     * @returns Return the next entry
+     * Increments the iterator to the next entry.
+     *
+     * @returns Iterator result containing the next value or null if done
+     *
+     * @example
+     * ```typescript
+     * const result = iterator.next();
+     * if (!result.done) {
+     *   console.log('Next item:', result.value);
+     * }
+     * ```
      */
     AcDbObjectIterator.prototype.next = function () {
         while (this.i < this._keys.length) {

package/lib/misc/AcDbObjectIterator.js.map

@@ -1 +1 @@
-{"version":3,"file":"AcDbObjectIterator.js","sourceRoot":"","sources":["../../src/misc/AcDbObjectIterator.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH;IAOE,4BAAY,OAAgC;QAJpC,MAAC,GAAG,CAAC,CAAA;QAKX,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAA;QACvB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAA;IACzC,CAAC;IAED,6BAAC,MAAM,CAAC,QAAQ,CAAC,GAAjB;QACE,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;OAGG;IACH,iCAAI,GAAJ;QACE,OAAO,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;YAClC,IAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAe,CAAA;YACjE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAA;YACX,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;QACtC,CAAC;QACD,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAA;IACpC,CAAC;IACH,yBAAC;AAAD,CAAC,AA5BD,IA4BC"}
+{"version":3,"file":"AcDbObjectIterator.js","sourceRoot":"","sources":["../../src/misc/AcDbObjectIterator.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH;IAQE;;;;;;;;;;OAUG;IACH,4BAAY,OAAgC;QAhB5C,qCAAqC;QAC7B,MAAC,GAAG,CAAC,CAAA;QAgBX,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAA;QACzB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAA;IACvC,CAAC;IAED;;;;;;;;;;;OAWG;IACH,6BAAC,MAAM,CAAC,QAAQ,CAAC,GAAjB;QACE,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,iCAAI,GAAJ;QACE,OAAO,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;YAClC,IAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAe,CAAA;YACjE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAA;YACX,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,CAAA;QACtC,CAAC;QACD,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAA;IACpC,CAAC;IACH,yBAAC;AAAD,CAAC,AA7DD,IA6DC"}

package/lib/misc/AcDbOsnapMode.d.ts

@@ -1,42 +1,50 @@
+/**
+ * Enumeration of object snap modes used in AutoCAD.
+ *
+ * Object snap modes define the types of geometric points that can be
+ * snapped to when drawing or editing entities. These modes help ensure
+ * precise positioning and alignment of objects.
+ */
 export declare enum AcDbOsnapMode {
     /**
-     * End point
+     * End point - snaps to the endpoint of a line, arc, or other entity
      */
     EndPoint = 1,
     /**
-     * Middle point
+     * Middle point - snaps to the midpoint of a line or arc
      */
     MidPoint = 2,
     /**
-     * Center
+     * Center - snaps to the center point of a circle, arc, or ellipse
      */
     Center = 3,
     /**
-     * Node
+     * Node - snaps to a point entity
      */
     Node = 4,
     /**
-     * Quadrant
+     * Quadrant - snaps to the quadrant points of a circle or ellipse
+     * (0°, 90°, 180°, 270°)
      */
     Quadrant = 5,
     /**
-     * Insertion
+     * Insertion - snaps to the insertion point of text, blocks, or other objects
      */
     Insertion = 7,
     /**
-     * Perpendicular
+     * Perpendicular - snaps to a point perpendicular to a line or arc
      */
     Perpendicular = 8,
     /**
-     * Tangent
+     * Tangent - snaps to a point tangent to a circle or arc
      */
     Tangent = 9,
     /**
-     * Nearest
+     * Nearest - snaps to the nearest point on an entity
      */
     Nearest = 10,
     /**
-     * Center of the object
+     * Center of the object - snaps to the centroid or center of mass of an object
      */
     Centroid = 11
 }

package/lib/misc/AcDbOsnapMode.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AcDbOsnapMode.d.ts","sourceRoot":"","sources":["../../src/misc/AcDbOsnapMode.ts"],"names":[],"mappings":"AAAA,oBAAY,aAAa;IACvB;;OAEG;IACH,QAAQ,IAAI;IACZ;;OAEG;IACH,QAAQ,IAAI;IACZ;;OAEG;IACH,MAAM,IAAI;IACV;;OAEG;IACH,IAAI,IAAI;IACR;;OAEG;IACH,QAAQ,IAAI;IACZ;;OAEG;IACH,SAAS,IAAI;IACb;;OAEG;IACH,aAAa,IAAI;IACjB;;OAEG;IACH,OAAO,IAAI;IACX;;OAEG;IACH,OAAO,KAAK;IACZ;;OAEG;IACH,QAAQ,KAAK;CACd"}
+{"version":3,"file":"AcDbOsnapMode.d.ts","sourceRoot":"","sources":["../../src/misc/AcDbOsnapMode.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,oBAAY,aAAa;IACvB;;OAEG;IACH,QAAQ,IAAI;IACZ;;OAEG;IACH,QAAQ,IAAI;IACZ;;OAEG;IACH,MAAM,IAAI;IACV;;OAEG;IACH,IAAI,IAAI;IACR;;;OAGG;IACH,QAAQ,IAAI;IACZ;;OAEG;IACH,SAAS,IAAI;IACb;;OAEG;IACH,aAAa,IAAI;IACjB;;OAEG;IACH,OAAO,IAAI;IACX;;OAEG;IACH,OAAO,KAAK;IACZ;;OAEG;IACH,QAAQ,KAAK;CACd"}

package/lib/misc/AcDbOsnapMode.js

@@ -1,43 +1,51 @@
+/**
+ * Enumeration of object snap modes used in AutoCAD.
+ *
+ * Object snap modes define the types of geometric points that can be
+ * snapped to when drawing or editing entities. These modes help ensure
+ * precise positioning and alignment of objects.
+ */
 export var AcDbOsnapMode;
 (function (AcDbOsnapMode) {
     /**
-     * End point
+     * End point - snaps to the endpoint of a line, arc, or other entity
      */
     AcDbOsnapMode[AcDbOsnapMode["EndPoint"] = 1] = "EndPoint";
     /**
-     * Middle point
+     * Middle point - snaps to the midpoint of a line or arc
      */
     AcDbOsnapMode[AcDbOsnapMode["MidPoint"] = 2] = "MidPoint";
     /**
-     * Center
+     * Center - snaps to the center point of a circle, arc, or ellipse
      */
     AcDbOsnapMode[AcDbOsnapMode["Center"] = 3] = "Center";
     /**
-     * Node
+     * Node - snaps to a point entity
      */
     AcDbOsnapMode[AcDbOsnapMode["Node"] = 4] = "Node";
     /**
-     * Quadrant
+     * Quadrant - snaps to the quadrant points of a circle or ellipse
+     * (0°, 90°, 180°, 270°)
      */
     AcDbOsnapMode[AcDbOsnapMode["Quadrant"] = 5] = "Quadrant";
     /**
-     * Insertion
+     * Insertion - snaps to the insertion point of text, blocks, or other objects
      */
     AcDbOsnapMode[AcDbOsnapMode["Insertion"] = 7] = "Insertion";
     /**
-     * Perpendicular
+     * Perpendicular - snaps to a point perpendicular to a line or arc
      */
     AcDbOsnapMode[AcDbOsnapMode["Perpendicular"] = 8] = "Perpendicular";
     /**
-     * Tangent
+     * Tangent - snaps to a point tangent to a circle or arc
      */
     AcDbOsnapMode[AcDbOsnapMode["Tangent"] = 9] = "Tangent";
     /**
-     * Nearest
+     * Nearest - snaps to the nearest point on an entity
      */
     AcDbOsnapMode[AcDbOsnapMode["Nearest"] = 10] = "Nearest";
     /**
-     * Center of the object
+     * Center of the object - snaps to the centroid or center of mass of an object
      */
     AcDbOsnapMode[AcDbOsnapMode["Centroid"] = 11] = "Centroid";
 })(AcDbOsnapMode || (AcDbOsnapMode = {}));

package/lib/misc/AcDbOsnapMode.js.map

@@ -1 +1 @@
-{"version":3,"file":"AcDbOsnapMode.js","sourceRoot":"","sources":["../../src/misc/AcDbOsnapMode.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,aAyCX;AAzCD,WAAY,aAAa;IACvB;;OAEG;IACH,yDAAY,CAAA;IACZ;;OAEG;IACH,yDAAY,CAAA;IACZ;;OAEG;IACH,qDAAU,CAAA;IACV;;OAEG;IACH,iDAAQ,CAAA;IACR;;OAEG;IACH,yDAAY,CAAA;IACZ;;OAEG;IACH,2DAAa,CAAA;IACb;;OAEG;IACH,mEAAiB,CAAA;IACjB;;OAEG;IACH,uDAAW,CAAA;IACX;;OAEG;IACH,wDAAY,CAAA;IACZ;;OAEG;IACH,0DAAa,CAAA;AACf,CAAC,EAzCW,aAAa,KAAb,aAAa,QAyCxB"}
+{"version":3,"file":"AcDbOsnapMode.js","sourceRoot":"","sources":["../../src/misc/AcDbOsnapMode.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,CAAN,IAAY,aA0CX;AA1CD,WAAY,aAAa;IACvB;;OAEG;IACH,yDAAY,CAAA;IACZ;;OAEG;IACH,yDAAY,CAAA;IACZ;;OAEG;IACH,qDAAU,CAAA;IACV;;OAEG;IACH,iDAAQ,CAAA;IACR;;;OAGG;IACH,yDAAY,CAAA;IACZ;;OAEG;IACH,2DAAa,CAAA;IACb;;OAEG;IACH,mEAAiB,CAAA;IACjB;;OAEG;IACH,uDAAW,CAAA;IACX;;OAEG;IACH,wDAAY,CAAA;IACZ;;OAEG;IACH,0DAAa,CAAA;AACf,CAAC,EA1CW,aAAa,KAAb,aAAa,QA0CxB"}

package/lib/misc/AcDbRenderingCache.d.ts

@@ -3,58 +3,136 @@ import { AcGiEntity, AcGiRenderer } from '@mlightcad/graphic-interface';
 import { AcDbBlockTableRecord } from '../database';
 /**
  * Internal class used to cache rendered results to avoid duplicated rendering.
- * It can be used to improve performance to render block references.
- * Because differnt color will result in different material, the block name and
- * color are used together to create the key.
+ *
+ * This class can be used to improve performance when rendering block references.
+ * Because different colors will result in different materials, the block name and
+ * color are used together to create the cache key.
+ *
  * @internal
+ *
+ * @example
+ * ```typescript
+ * const cache = AcDbRenderingCache.instance;
+ * const key = cache.createKey('MyBlock', 0xFF0000);
+ * const renderedEntity = cache.draw(renderer, blockRecord, 0xFF0000);
+ * ```
  */
 export declare class AcDbRenderingCache {
+    /** Map of cached rendering results indexed by key */
     private _blocks;
+    /** Singleton instance of the cache */
     private static _instance?;
+    /**
+     * Gets the singleton instance of the rendering cache.
+     *
+     * @returns The singleton instance of AcDbRenderingCache
+     *
+     * @example
+     * ```typescript
+     * const cache = AcDbRenderingCache.instance;
+     * ```
+     */
     static get instance(): AcDbRenderingCache;
+    /**
+     * Creates a new AcDbRenderingCache instance.
+     *
+     * @example
+     * ```typescript
+     * const cache = new AcDbRenderingCache();
+     * ```
+     */
     constructor();
     /**
-     * Create one key by combining the inputted name and the inputted color
-     * @param name Input the name
-     * @param color Input the color
+     * Creates a cache key by combining the block name and color.
+     *
+     * @param name - The block name
+     * @param color - The color value
+     * @returns A unique key for the cache entry
+     *
+     * @example
+     * ```typescript
+     * const key = cache.createKey('MyBlock', 0xFF0000);
+     * // Returns: "MyBlock_16711680"
+     * ```
      */
     createKey(name: string, color: number): string;
     /**
-     * Store rendering results of one block in the cache.
-     * @param key Input the key of the rendering results
-     * @param group Input rendering results with specified key
-     * @returns Return the inputted rendering results
+     * Stores rendering results of a block in the cache.
+     *
+     * @param key - The key for the rendering results
+     * @param group - The rendering results to store
+     * @returns The stored rendering results (deep cloned)
+     *
+     * @example
+     * ```typescript
+     * const renderedEntity = cache.set(key, entity);
+     * ```
      */
     set(key: string, group: AcGiEntity): AcGiEntity;
     /**
-     * Get rendering results with the specified key
-     * @param name Input the key of the rendering results
-     * @return Return rendering results with the specified key if found it.
-     * Othewise, return undefined.
+     * Gets rendering results with the specified key.
+     *
+     * @param name - The key of the rendering results
+     * @returns The rendering results with the specified key, or undefined if not found
+     *
+     * @example
+     * ```typescript
+     * const cachedEntity = cache.get('MyBlock_16711680');
+     * if (cachedEntity) {
+     *   // Use cached entity
+     * }
+     * ```
      */
     get(name: string): AcGiEntity | undefined;
     /**
-     * Return true if the cache contains rendering results with the specified key.
-     * @param name Input the key of the rendering results
-     * @return Return true if the cache contains rendering results with the specified
-     * key. Otherwise, reutrn false.
+     * Checks if rendering results with the specified key exist in the cache.
+     *
+     * @param name - The key to check
+     * @returns True if the key exists in the cache, false otherwise
+     *
+     * @example
+     * ```typescript
+     * if (cache.has('MyBlock_16711680')) {
+     *   console.log('Cached result found');
+     * }
+     * ```
      */
     has(name: string): boolean;
     /**
-     * Remove all of rendering results stored in the cache.
+     * Clears all cached rendering results.
+     *
+     * @example
+     * ```typescript
+     * cache.clear();
+     * console.log('Cache cleared');
+     * ```
      */
     clear(): void;
     /**
-     * Render the specified the block. If rendering results of the block is already in cache,
-     * use cached data. Otherwise, render it and store rendered results in cache.
-     * @param renderer Input renderer used to render the block
-     * @param blockTableRecord Input the block to render
-     * @param color Input overriden color when color of entitis in the block is 'ByBlock'. If
-     * not specified, use color of entities directly.
-     * @param cache Input the flag whether to cache the rendering results
-     * @param transform Input matrix transform applied on the block
-     * @param normal Input extrusion direction of the block
-     * @returns Return rendering results of the block
+     * Draws a block table record and optionally caches the result.
+     *
+     * This method renders the block table record using the specified renderer
+     * and color, and optionally stores the result in the cache for future use.
+     *
+     * @param renderer - The renderer to use for drawing
+     * @param blockTableRecord - The block table record to draw
+     * @param color - The color to use for rendering
+     * @param cache - Whether to cache the rendering result (default: true)
+     * @param transform - Optional transformation matrix to apply
+     * @param normal - Optional normal vector
+     * @returns The rendered entity
+     *
+     * @example
+     * ```typescript
+     * const renderedEntity = cache.draw(
+     *   renderer,
+     *   blockRecord,
+     *   0xFF0000,
+     *   true,
+     *   transform,
+     *   normal
+     * );
+     * ```
      */
     draw(renderer: AcGiRenderer, blockTableRecord: AcDbBlockTableRecord, color: number, cache?: boolean, transform?: AcGeMatrix3d, normal?: AcGeVector3d): AcGiEntity | undefined;
 }

package/lib/misc/AcDbRenderingCache.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AcDbRenderingCache.d.ts","sourceRoot":"","sources":["../../src/misc/AcDbRenderingCache.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAA;AACvE,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAA;AAEvE,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAA;AAElD;;;;;;GAMG;AACH,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,OAAO,CAAyB;IACxC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAoB;IAE7C,MAAM,KAAK,QAAQ,uBAKlB;;IAMD;;;;OAIG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAIrC;;;;;OAKG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU;IAMlC;;;;;OAKG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM;IAQhB;;;;;OAKG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM;IAIhB;;OAEG;IACH,KAAK;IAIL;;;;;;;;;;;OAWG;IACH,IAAI,CACF,QAAQ,EAAE,YAAY,EACtB,gBAAgB,EAAE,oBAAoB,EACtC,KAAK,EAAE,MAAM,EACb,KAAK,GAAE,OAAc,EACrB,SAAS,CAAC,EAAE,YAAY,EACxB,MAAM,CAAC,EAAE,YAAY;CAyCxB"}
+{"version":3,"file":"AcDbRenderingCache.d.ts","sourceRoot":"","sources":["../../src/misc/AcDbRenderingCache.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAA;AACvE,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAA;AAEvE,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAA;AAElD;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,kBAAkB;IAC7B,qDAAqD;IACrD,OAAO,CAAC,OAAO,CAAyB;IACxC,sCAAsC;IACtC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAoB;IAE7C;;;;;;;;;OASG;IACH,MAAM,KAAK,QAAQ,uBAKlB;IAED;;;;;;;OAOG;;IAKH;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAIrC;;;;;;;;;;;OAWG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU;IAMlC;;;;;;;;;;;;;OAaG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM;IAQhB;;;;;;;;;;;;OAYG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM;IAIhB;;;;;;;;OAQG;IACH,KAAK;IAIL;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,IAAI,CACF,QAAQ,EAAE,YAAY,EACtB,gBAAgB,EAAE,oBAAoB,EACtC,KAAK,EAAE,MAAM,EACb,KAAK,GAAE,OAAc,EACrB,SAAS,CAAC,EAAE,YAAY,EACxB,MAAM,CAAC,EAAE,YAAY;CAyCxB"}

package/lib/misc/AcDbRenderingCache.js

@@ -12,16 +12,43 @@ var __values = (this && this.__values) || function(o) {
 import { AcCmColor } from '@mlightcad/common';
 /**
  * Internal class used to cache rendered results to avoid duplicated rendering.
- * It can be used to improve performance to render block references.
- * Because differnt color will result in different material, the block name and
- * color are used together to create the key.
+ *
+ * This class can be used to improve performance when rendering block references.
+ * Because different colors will result in different materials, the block name and
+ * color are used together to create the cache key.
+ *
  * @internal
+ *
+ * @example
+ * ```typescript
+ * const cache = AcDbRenderingCache.instance;
+ * const key = cache.createKey('MyBlock', 0xFF0000);
+ * const renderedEntity = cache.draw(renderer, blockRecord, 0xFF0000);
+ * ```
  */
 var AcDbRenderingCache = /** @class */ (function () {
+    /**
+     * Creates a new AcDbRenderingCache instance.
+     *
+     * @example
+     * ```typescript
+     * const cache = new AcDbRenderingCache();
+     * ```
+     */
     function AcDbRenderingCache() {
         this._blocks = new Map();
     }
     Object.defineProperty(AcDbRenderingCache, "instance", {
+        /**
+         * Gets the singleton instance of the rendering cache.
+         *
+         * @returns The singleton instance of AcDbRenderingCache
+         *
+         * @example
+         * ```typescript
+         * const cache = AcDbRenderingCache.instance;
+         * ```
+         */
         get: function () {
             if (!this._instance) {
                 this._instance = new AcDbRenderingCache();
@@ -32,18 +59,32 @@ var AcDbRenderingCache = /** @class */ (function () {
         configurable: true
     });
     /**
-     * Create one key by combining the inputted name and the inputted color
-     * @param name Input the name
-     * @param color Input the color
+     * Creates a cache key by combining the block name and color.
+     *
+     * @param name - The block name
+     * @param color - The color value
+     * @returns A unique key for the cache entry
+     *
+     * @example
+     * ```typescript
+     * const key = cache.createKey('MyBlock', 0xFF0000);
+     * // Returns: "MyBlock_16711680"
+     * ```
      */
     AcDbRenderingCache.prototype.createKey = function (name, color) {
         return "".concat(name, "_").concat(color);
     };
     /**
-     * Store rendering results of one block in the cache.
-     * @param key Input the key of the rendering results
-     * @param group Input rendering results with specified key
-     * @returns Return the inputted rendering results
+     * Stores rendering results of a block in the cache.
+     *
+     * @param key - The key for the rendering results
+     * @param group - The rendering results to store
+     * @returns The stored rendering results (deep cloned)
+     *
+     * @example
+     * ```typescript
+     * const renderedEntity = cache.set(key, entity);
+     * ```
      */
     AcDbRenderingCache.prototype.set = function (key, group) {
         group = group.fastDeepClone();
@@ -51,10 +92,18 @@ var AcDbRenderingCache = /** @class */ (function () {
         return group;
     };
     /**
-     * Get rendering results with the specified key
-     * @param name Input the key of the rendering results
-     * @return Return rendering results with the specified key if found it.
-     * Othewise, return undefined.
+     * Gets rendering results with the specified key.
+     *
+     * @param name - The key of the rendering results
+     * @returns The rendering results with the specified key, or undefined if not found
+     *
+     * @example
+     * ```typescript
+     * const cachedEntity = cache.get('MyBlock_16711680');
+     * if (cachedEntity) {
+     *   // Use cached entity
+     * }
+     * ```
      */
     AcDbRenderingCache.prototype.get = function (name) {
         var block = this._blocks.get(name);
@@ -64,31 +113,58 @@ var AcDbRenderingCache = /** @class */ (function () {
         return block;
     };
     /**
-     * Return true if the cache contains rendering results with the specified key.
-     * @param name Input the key of the rendering results
-     * @return Return true if the cache contains rendering results with the specified
-     * key. Otherwise, reutrn false.
+     * Checks if rendering results with the specified key exist in the cache.
+     *
+     * @param name - The key to check
+     * @returns True if the key exists in the cache, false otherwise
+     *
+     * @example
+     * ```typescript
+     * if (cache.has('MyBlock_16711680')) {
+     *   console.log('Cached result found');
+     * }
+     * ```
      */
     AcDbRenderingCache.prototype.has = function (name) {
         return this._blocks.has(name);
     };
     /**
-     * Remove all of rendering results stored in the cache.
+     * Clears all cached rendering results.
+     *
+     * @example
+     * ```typescript
+     * cache.clear();
+     * console.log('Cache cleared');
+     * ```
      */
     AcDbRenderingCache.prototype.clear = function () {
         this._blocks.clear();
     };
     /**
-     * Render the specified the block. If rendering results of the block is already in cache,
-     * use cached data. Otherwise, render it and store rendered results in cache.
-     * @param renderer Input renderer used to render the block
-     * @param blockTableRecord Input the block to render
-     * @param color Input overriden color when color of entitis in the block is 'ByBlock'. If
-     * not specified, use color of entities directly.
-     * @param cache Input the flag whether to cache the rendering results
-     * @param transform Input matrix transform applied on the block
-     * @param normal Input extrusion direction of the block
-     * @returns Return rendering results of the block
+     * Draws a block table record and optionally caches the result.
+     *
+     * This method renders the block table record using the specified renderer
+     * and color, and optionally stores the result in the cache for future use.
+     *
+     * @param renderer - The renderer to use for drawing
+     * @param blockTableRecord - The block table record to draw
+     * @param color - The color to use for rendering
+     * @param cache - Whether to cache the rendering result (default: true)
+     * @param transform - Optional transformation matrix to apply
+     * @param normal - Optional normal vector
+     * @returns The rendered entity
+     *
+     * @example
+     * ```typescript
+     * const renderedEntity = cache.draw(
+     *   renderer,
+     *   blockRecord,
+     *   0xFF0000,
+     *   true,
+     *   transform,
+     *   normal
+     * );
+     * ```
      */
     AcDbRenderingCache.prototype.draw = function (renderer, blockTableRecord, color, cache, transform, normal) {
         var e_1, _a;

package/lib/misc/AcDbRenderingCache.js.map

@@ -1 +1 @@
-{"version":3,"file":"AcDbRenderingCache.js","sourceRoot":"","sources":["../../src/misc/AcDbRenderingCache.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAM7C;;;;;;GAMG;AACH;IAWE;QACE,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,EAAE,CAAA;IAC1B,CAAC;IATD,sBAAW,8BAAQ;aAAnB;YACE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;gBACpB,IAAI,CAAC,SAAS,GAAG,IAAI,kBAAkB,EAAE,CAAA;YAC3C,CAAC;YACD,OAAO,IAAI,CAAC,SAAS,CAAA;QACvB,CAAC;;;OAAA;IAMD;;;;OAIG;IACH,sCAAS,GAAT,UAAU,IAAY,EAAE,KAAa;QACnC,OAAO,UAAG,IAAI,cAAI,KAAK,CAAE,CAAA;IAC3B,CAAC;IAED;;;;;OAKG;IACH,gCAAG,GAAH,UAAI,GAAW,EAAE,KAAiB;QAChC,KAAK,GAAG,KAAK,CAAC,aAAa,EAAE,CAAA;QAC7B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;QAC5B,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;;OAKG;IACH,gCAAG,GAAH,UAAI,IAAY;QACd,IAAI,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QAClC,IAAI,KAAK,EAAE,CAAC;YACV,KAAK,GAAG,KAAK,CAAC,aAAa,EAAE,CAAA;QAC/B,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;;OAKG;IACH,gCAAG,GAAH,UAAI,IAAY;QACd,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IAC/B,CAAC;IAED;;OAEG;IACH,kCAAK,GAAL;QACE,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,iCAAI,GAAJ,UACE,QAAsB,EACtB,gBAAsC,EACtC,KAAa,EACb,KAAqB,EACrB,SAAwB,EACxB,MAAqB;;QAFrB,sBAAA,EAAA,YAAqB;QAIrB,IAAM,OAAO,GAAiB,EAAE,CAAA;QAChC,IAAI,gBAAgB,IAAI,IAAI,EAAE,CAAC;YAC7B,IAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;YACxD,IAAI,KAAK,SAAwB,CAAA;YACjC,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBAClB,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;YACvB,CAAC;iBAAM,CAAC;gBACN,IAAM,QAAQ,GAAG,gBAAgB,CAAC,WAAW,EAAE,CAAA;;oBAC/C,KAAqB,IAAA,aAAA,SAAA,QAAQ,CAAA,kCAAA,wDAAE,CAAC;wBAA3B,IAAM,MAAM,qBAAA;wBACf,+FAA+F;wBAC/F,4FAA4F;wBAC5F,qBAAqB;wBACrB,IAAI,MAAM,CAAC,KAAK,CAAC,SAAS,IAAI,KAAK,EAAE,CAAC;4BACpC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;4BAC5B,MAAM,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAA;4BAC1B,IAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;4BACpC,IAAI,MAAM;gCAAE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;4BAChC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;wBAC9B,CAAC;6BAAM,CAAC;4BACN,IAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;4BACpC,IAAI,MAAM;gCAAE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;wBAClC,CAAC;oBACH,CAAC;;;;;;;;;gBACD,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;gBAC/B,IAAI,KAAK,IAAI,KAAK;oBAAE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;YAC1C,CAAC;YAED,IAAI,KAAK,IAAI,SAAS,EAAE,CAAC;gBACvB,KAAK,CAAC,WAAW,CAAC,SAAS,CAAC,CAAA;gBAC5B,IAAI,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;oBAChE,SAAS,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAA;oBAC3C,KAAK,CAAC,WAAW,CAAC,SAAS,CAAC,CAAA;gBAC9B,CAAC;YACH,CAAC;YACD,OAAO,KAAK,CAAA;QACd,CAAC;aAAM,CAAC;YACN,OAAO,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;QAChC,CAAC;IACH,CAAC;IACH,yBAAC;AAAD,CAAC,AA9HD,IA8HC;;AAED,IAAM,SAAS,GAAG,aAAa,CAAC,IAAI,SAAS,EAAE,CAAA"}
+{"version":3,"file":"AcDbRenderingCache.js","sourceRoot":"","sources":["../../src/misc/AcDbRenderingCache.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAM7C;;;;;;;;;;;;;;;GAeG;AACH;IAuBE;;;;;;;OAOG;IACH;QACE,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,EAAE,CAAA;IAC1B,CAAC;IAjBD,sBAAW,8BAAQ;QAVnB;;;;;;;;;WASG;aACH;YACE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;gBACpB,IAAI,CAAC,SAAS,GAAG,IAAI,kBAAkB,EAAE,CAAA;YAC3C,CAAC;YACD,OAAO,IAAI,CAAC,SAAS,CAAA;QACvB,CAAC;;;OAAA;IAcD;;;;;;;;;;;;OAYG;IACH,sCAAS,GAAT,UAAU,IAAY,EAAE,KAAa;QACnC,OAAO,UAAG,IAAI,cAAI,KAAK,CAAE,CAAA;IAC3B,CAAC;IAED;;;;;;;;;;;OAWG;IACH,gCAAG,GAAH,UAAI,GAAW,EAAE,KAAiB;QAChC,KAAK,GAAG,KAAK,CAAC,aAAa,EAAE,CAAA;QAC7B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;QAC5B,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,gCAAG,GAAH,UAAI,IAAY;QACd,IAAI,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QAClC,IAAI,KAAK,EAAE,CAAC;YACV,KAAK,GAAG,KAAK,CAAC,aAAa,EAAE,CAAA;QAC/B,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,gCAAG,GAAH,UAAI,IAAY;QACd,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IAC/B,CAAC;IAED;;;;;;;;OAQG;IACH,kCAAK,GAAL;QACE,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,iCAAI,GAAJ,UACE,QAAsB,EACtB,gBAAsC,EACtC,KAAa,EACb,KAAqB,EACrB,SAAwB,EACxB,MAAqB;;QAFrB,sBAAA,EAAA,YAAqB;QAIrB,IAAM,OAAO,GAAiB,EAAE,CAAA;QAChC,IAAI,gBAAgB,IAAI,IAAI,EAAE,CAAC;YAC7B,IAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;YACxD,IAAI,KAAK,SAAwB,CAAA;YACjC,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBAClB,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;YACvB,CAAC;iBAAM,CAAC;gBACN,IAAM,QAAQ,GAAG,gBAAgB,CAAC,WAAW,EAAE,CAAA;;oBAC/C,KAAqB,IAAA,aAAA,SAAA,QAAQ,CAAA,kCAAA,wDAAE,CAAC;wBAA3B,IAAM,MAAM,qBAAA;wBACf,+FAA+F;wBAC/F,4FAA4F;wBAC5F,qBAAqB;wBACrB,IAAI,MAAM,CAAC,KAAK,CAAC,SAAS,IAAI,KAAK,EAAE,CAAC;4BACpC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;4BAC5B,MAAM,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAA;4BAC1B,IAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;4BACpC,IAAI,MAAM;gCAAE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;4BAChC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;wBAC9B,CAAC;6BAAM,CAAC;4BACN,IAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;4BACpC,IAAI,MAAM;gCAAE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;wBAClC,CAAC;oBACH,CAAC;;;;;;;;;gBACD,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;gBAC/B,IAAI,KAAK,IAAI,KAAK;oBAAE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;YAC1C,CAAC;YAED,IAAI,KAAK,IAAI,SAAS,EAAE,CAAC;gBACvB,KAAK,CAAC,WAAW,CAAC,SAAS,CAAC,CAAA;gBAC5B,IAAI,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;oBAChE,SAAS,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAA;oBAC3C,KAAK,CAAC,WAAW,CAAC,SAAS,CAAC,CAAA;gBAC9B,CAAC;YACH,CAAC;YACD,OAAO,KAAK,CAAA;QACd,CAAC;aAAM,CAAC;YACN,OAAO,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;QAChC,CAAC;IACH,CAAC;IACH,yBAAC;AAAD,CAAC,AAnMD,IAmMC;;AAED,IAAM,SAAS,GAAG,aAAa,CAAC,IAAI,SAAS,EAAE,CAAA"}