@mlightcad/cad-simple-viewer 1.0.0 → 1.0.2

package/lib/view/AcTrLayer.d.ts

@@ -1,16 +1,51 @@
 import { AcDbObjectId } from '@mlightcad/data-model';
 import { AcTrBatchedGroup, AcTrBatchedGroupStats, AcTrEntity } from '@mlightcad/three-renderer';
 import * as THREE from 'three';
+/**
+ * Statistics for a CAD layer including name and batched rendering metrics.
+ *
+ * Extends the standard batched group statistics with layer-specific information.
+ */
 export type AcTrLayerStats = AcTrBatchedGroupStats & {
+    /** The name of the layer */
     name: string;
 };
 /**
- * The class is used to render layer in AutoCAD.
+ * Represents a CAD layer for organizing and rendering entities in Three.js.
+ *
+ * This class manages a collection of CAD entities that belong to the same logical layer.
+ * It provides:
+ * - Entity organization and grouping
+ * - Layer visibility control
+ * - Efficient batched rendering through Three.js groups
+ * - Performance monitoring and statistics
+ *
+ * ## Technical Notes
+ * Unlike Three.js built-in layers (which only support 32 layers), this implementation
+ * uses Three.js groups to represent AutoCAD layers, allowing unlimited layer support.
+ * Each AutoCAD layer corresponds to one Three.js group containing all entities.
+ *
+ * ## Performance Benefits
+ * - Batched rendering reduces draw calls
+ * - Efficient visibility toggling for entire layers
+ * - Optimized entity grouping for better GPU performance
+ *
+ * @example
+ * ```typescript
+ * // Create a new layer
+ * const layer = new AcTrLayer('Dimensions');
+ *
+ * // Add entities to the layer
+ * const line = new AcTrLine(startPoint, endPoint);
+ * layer.add(line);
+ *
+ * // Control layer visibility
+ * layer.visible = false; // Hide all entities in this layer
  *
- * Notes:
- * Layers provided by THREE.js aren't used to control visibility of entities because it supports 32 layers only.
- * Instead groups are used to represent layers in AutoCAD. One AutoCAD layer is represented by one group in
- * THREE.js.
+ * // Get layer statistics
+ * const stats = layer.stats;
+ * console.log(`Layer ${stats.name} has ${stats.entityCount} entities`);
+ * ```
  */
 export declare class AcTrLayer {
     /**

package/lib/view/AcTrLayer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AcTrLayer.d.ts","sourceRoot":"","sources":["../../src/view/AcTrLayer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AACpD,OAAO,EACL,gBAAgB,EAChB,qBAAqB,EACrB,UAAU,EACX,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAE9B,MAAM,MAAM,cAAc,GAAG,qBAAqB,GAAG;IACnD,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED;;;;;;;GAOG;AACH,qBAAa,SAAS;IACpB;;OAEG;IACH,OAAO,CAAC,KAAK,CAAQ;IACrB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAkB;IAEhC;;;OAGG;gBACS,IAAI,EAAE,MAAM;IAKxB;;OAEG;IACH,IAAI,IAAI,IAGQ,MAAM,CADrB;IACD,IAAI,IAAI,CAAC,KAAK,EAAE,MAAM,EAErB;IAED,IAAI,OAAO,IAGQ,OAAO,CADzB;IACD,IAAI,OAAO,CAAC,KAAK,EAAE,OAAO,EAEzB;IAED,IAAI,cAAc,qBAEjB;IAED;;OAEG;IACH,IAAI,KAAK,IAKF,cAAc,CACpB;IAED;;OAEG;IACH,IAAI,WAAW,WAEd;IAED;;;OAGG;IACH,cAAc,CAAC,WAAW,EAAE,MAAM;IAIlC;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,EAAE,YAAY;IAIhC;;;OAGG;IACH,SAAS,CAAC,MAAM,EAAE,UAAU;IAI5B;;;;OAIG;IACH,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS;IAI5D;;;;OAIG;IACH,MAAM,CAAC,SAAS,EAAE,YAAY,GAAG,OAAO;IAKxC;;;;OAIG;IACH,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO;IAMnC;;OAEG;IACH,KAAK,CAAC,GAAG,EAAE,YAAY,EAAE;IAMzB;;OAEG;IACH,OAAO,CAAC,GAAG,EAAE,YAAY,EAAE;IAM3B;;OAEG;IACH,MAAM,CAAC,GAAG,EAAE,YAAY,EAAE;IAM1B;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,YAAY,EAAE;CAK7B"}
+{"version":3,"file":"AcTrLayer.d.ts","sourceRoot":"","sources":["../../src/view/AcTrLayer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AACpD,OAAO,EACL,gBAAgB,EAChB,qBAAqB,EACrB,UAAU,EACX,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAE9B;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,qBAAqB,GAAG;IACnD,4BAA4B;IAC5B,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,qBAAa,SAAS;IACpB;;OAEG;IACH,OAAO,CAAC,KAAK,CAAQ;IACrB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAkB;IAEhC;;;OAGG;gBACS,IAAI,EAAE,MAAM;IAKxB;;OAEG;IACH,IAAI,IAAI,IAGQ,MAAM,CADrB;IACD,IAAI,IAAI,CAAC,KAAK,EAAE,MAAM,EAErB;IAED,IAAI,OAAO,IAGQ,OAAO,CADzB;IACD,IAAI,OAAO,CAAC,KAAK,EAAE,OAAO,EAEzB;IAED,IAAI,cAAc,qBAEjB;IAED;;OAEG;IACH,IAAI,KAAK,IAKF,cAAc,CACpB;IAED;;OAEG;IACH,IAAI,WAAW,WAEd;IAED;;;OAGG;IACH,cAAc,CAAC,WAAW,EAAE,MAAM;IAIlC;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,EAAE,YAAY;IAIhC;;;OAGG;IACH,SAAS,CAAC,MAAM,EAAE,UAAU;IAI5B;;;;OAIG;IACH,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS;IAI5D;;;;OAIG;IACH,MAAM,CAAC,SAAS,EAAE,YAAY,GAAG,OAAO;IAKxC;;;;OAIG;IACH,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO;IAMnC;;OAEG;IACH,KAAK,CAAC,GAAG,EAAE,YAAY,EAAE;IAMzB;;OAEG;IACH,OAAO,CAAC,GAAG,EAAE,YAAY,EAAE;IAM3B;;OAEG;IACH,MAAM,CAAC,GAAG,EAAE,YAAY,EAAE;IAM1B;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,YAAY,EAAE;CAK7B"}

package/lib/view/AcTrLayer.js

@@ -11,12 +11,41 @@ var __assign = (this && this.__assign) || function () {
 };
 import { AcTrBatchedGroup } from '@mlightcad/three-renderer';
 /**
- * The class is used to render layer in AutoCAD.
+ * Represents a CAD layer for organizing and rendering entities in Three.js.
  *
- * Notes:
- * Layers provided by THREE.js aren't used to control visibility of entities because it supports 32 layers only.
- * Instead groups are used to represent layers in AutoCAD. One AutoCAD layer is represented by one group in
- * THREE.js.
+ * This class manages a collection of CAD entities that belong to the same logical layer.
+ * It provides:
+ * - Entity organization and grouping
+ * - Layer visibility control
+ * - Efficient batched rendering through Three.js groups
+ * - Performance monitoring and statistics
+ *
+ * ## Technical Notes
+ * Unlike Three.js built-in layers (which only support 32 layers), this implementation
+ * uses Three.js groups to represent AutoCAD layers, allowing unlimited layer support.
+ * Each AutoCAD layer corresponds to one Three.js group containing all entities.
+ *
+ * ## Performance Benefits
+ * - Batched rendering reduces draw calls
+ * - Efficient visibility toggling for entire layers
+ * - Optimized entity grouping for better GPU performance
+ *
+ * @example
+ * ```typescript
+ * // Create a new layer
+ * const layer = new AcTrLayer('Dimensions');
+ *
+ * // Add entities to the layer
+ * const line = new AcTrLine(startPoint, endPoint);
+ * layer.add(line);
+ *
+ * // Control layer visibility
+ * layer.visible = false; // Hide all entities in this layer
+ *
+ * // Get layer statistics
+ * const stats = layer.stats;
+ * console.log(`Layer ${stats.name} has ${stats.entityCount} entities`);
+ * ```
  */
 var AcTrLayer = /** @class */ (function () {
     /**

package/lib/view/AcTrLayer.js.map

@@ -1 +1 @@
-{"version":3,"file":"AcTrLayer.js","sourceRoot":"","sources":["../../src/view/AcTrLayer.ts"],"names":[],"mappings":";;;;;;;;;;;AACA,OAAO,EACL,gBAAgB,EAGjB,MAAM,2BAA2B,CAAA;AAOlC;;;;;;;GAOG;AACH;IAUE;;;OAGG;IACH,mBAAY,IAAY;QACtB,IAAI,CAAC,MAAM,GAAG,IAAI,gBAAgB,EAAE,CAAA;QACpC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;IACnB,CAAC;IAKD,sBAAI,2BAAI;QAHR;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,KAAK,CAAA;QACnB,CAAC;aACD,UAAS,KAAa;YACpB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QACpB,CAAC;;;OAHA;IAKD,sBAAI,8BAAO;aAAX;YACE,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAA;QAC5B,CAAC;aACD,UAAY,KAAc;YACxB,IAAI,CAAC,MAAM,CAAC,OAAO,GAAG,KAAK,CAAA;QAC7B,CAAC;;;OAHA;IAKD,sBAAI,qCAAc;aAAlB;YACE,OAAO,IAAI,CAAC,MAAM,CAAA;QACpB,CAAC;;;OAAA;IAKD,sBAAI,4BAAK;QAHT;;WAEG;aACH;YACE,IAAM,iBAAiB,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAA;YAC3C,OAAO,WACL,IAAI,EAAE,IAAI,CAAC,KAAK,IACb,iBAAiB,CACH,CAAA;QACrB,CAAC;;;OAAA;IAKD,sBAAI,kCAAW;QAHf;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAA;QAChC,CAAC;;;OAAA;IAED;;;OAGG;IACH,kCAAc,GAAd,UAAe,WAAmB;QAChC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,WAAW,CAAC,CAAA;IACzC,CAAC;IAED;;;;;OAKG;IACH,6BAAS,GAAT,UAAU,QAAsB;QAC9B,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAA;IACxC,CAAC;IAED;;;OAGG;IACH,6BAAS,GAAT,UAAU,MAAkB;QAC1B,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;IAC/B,CAAC;IAED;;;;OAIG;IACH,mCAAe,GAAf,UAAgB,QAAgB,EAAE,SAA0B;QAC1D,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAA;IACzD,CAAC;IAED;;;;OAIG;IACH,0BAAM,GAAN,UAAO,SAAuB;QAC5B,kBAAkB;QAClB,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAA;IACzC,CAAC;IAED;;;;OAIG;IACH,0BAAM,GAAN,UAAO,MAAkB;QACvB,kBAAkB;QAClB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;QACvB,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;OAEG;IACH,yBAAK,GAAL,UAAM,GAAmB;QAAzB,iBAIC;QAHC,GAAG,CAAC,OAAO,CAAC,UAAA,EAAE;YACZ,KAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;QACvB,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,2BAAO,GAAP,UAAQ,GAAmB;QAA3B,iBAIC;QAHC,GAAG,CAAC,OAAO,CAAC,UAAA,EAAE;YACZ,KAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;QACzB,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,0BAAM,GAAN,UAAO,GAAmB;QAA1B,iBAIC;QAHC,GAAG,CAAC,OAAO,CAAC,UAAA,EAAE;YACZ,KAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;QACxB,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,4BAAQ,GAAR,UAAS,GAAmB;QAA5B,iBAIC;QAHC,GAAG,CAAC,OAAO,CAAC,UAAA,EAAE;YACZ,KAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;QAC1B,CAAC,CAAC,CAAA;IACJ,CAAC;IACH,gBAAC;AAAD,CAAC,AArJD,IAqJC"}
+{"version":3,"file":"AcTrLayer.js","sourceRoot":"","sources":["../../src/view/AcTrLayer.ts"],"names":[],"mappings":";;;;;;;;;;;AACA,OAAO,EACL,gBAAgB,EAGjB,MAAM,2BAA2B,CAAA;AAalC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH;IAUE;;;OAGG;IACH,mBAAY,IAAY;QACtB,IAAI,CAAC,MAAM,GAAG,IAAI,gBAAgB,EAAE,CAAA;QACpC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;IACnB,CAAC;IAKD,sBAAI,2BAAI;QAHR;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,KAAK,CAAA;QACnB,CAAC;aACD,UAAS,KAAa;YACpB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QACpB,CAAC;;;OAHA;IAKD,sBAAI,8BAAO;aAAX;YACE,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAA;QAC5B,CAAC;aACD,UAAY,KAAc;YACxB,IAAI,CAAC,MAAM,CAAC,OAAO,GAAG,KAAK,CAAA;QAC7B,CAAC;;;OAHA;IAKD,sBAAI,qCAAc;aAAlB;YACE,OAAO,IAAI,CAAC,MAAM,CAAA;QACpB,CAAC;;;OAAA;IAKD,sBAAI,4BAAK;QAHT;;WAEG;aACH;YACE,IAAM,iBAAiB,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAA;YAC3C,OAAO,WACL,IAAI,EAAE,IAAI,CAAC,KAAK,IACb,iBAAiB,CACH,CAAA;QACrB,CAAC;;;OAAA;IAKD,sBAAI,kCAAW;QAHf;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAA;QAChC,CAAC;;;OAAA;IAED;;;OAGG;IACH,kCAAc,GAAd,UAAe,WAAmB;QAChC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,WAAW,CAAC,CAAA;IACzC,CAAC;IAED;;;;;OAKG;IACH,6BAAS,GAAT,UAAU,QAAsB;QAC9B,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAA;IACxC,CAAC;IAED;;;OAGG;IACH,6BAAS,GAAT,UAAU,MAAkB;QAC1B,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;IAC/B,CAAC;IAED;;;;OAIG;IACH,mCAAe,GAAf,UAAgB,QAAgB,EAAE,SAA0B;QAC1D,OAAO,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAA;IACzD,CAAC;IAED;;;;OAIG;IACH,0BAAM,GAAN,UAAO,SAAuB;QAC5B,kBAAkB;QAClB,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAA;IACzC,CAAC;IAED;;;;OAIG;IACH,0BAAM,GAAN,UAAO,MAAkB;QACvB,kBAAkB;QAClB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;QACvB,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;OAEG;IACH,yBAAK,GAAL,UAAM,GAAmB;QAAzB,iBAIC;QAHC,GAAG,CAAC,OAAO,CAAC,UAAA,EAAE;YACZ,KAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;QACvB,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,2BAAO,GAAP,UAAQ,GAAmB;QAA3B,iBAIC;QAHC,GAAG,CAAC,OAAO,CAAC,UAAA,EAAE;YACZ,KAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;QACzB,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,0BAAM,GAAN,UAAO,GAAmB;QAA1B,iBAIC;QAHC,GAAG,CAAC,OAAO,CAAC,UAAA,EAAE;YACZ,KAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;QACxB,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,4BAAQ,GAAR,UAAS,GAAmB;QAA5B,iBAIC;QAHC,GAAG,CAAC,OAAO,CAAC,UAAA,EAAE;YACZ,KAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;QAC1B,CAAC,CAAC,CAAA;IACJ,CAAC;IACH,gBAAC;AAAD,CAAC,AArJD,IAqJC"}

package/lib/view/AcTrLayout.d.ts

@@ -3,111 +3,210 @@ import { AcTrEntity, AcTrObject } from '@mlightcad/three-renderer';
 import * as THREE from 'three';
 import { AcEdSpatialQueryResultItem } from '../editor';
 import { AcTrLayer, AcTrLayerStats } from './AcTrLayer';
+/**
+ * Interface representing statistics for a layout.
+ * Provides detailed information about the layout's content including
+ * layer statistics and memory usage breakdown.
+ */
 export interface AcTrLayoutStats {
+    /** Statistics for each layer in the layout */
     layers: AcTrLayerStats[];
+    /** Summary statistics for the entire layout */
     summary: {
+        /** Total number of entities across all layers */
         entityCount: number;
+        /** Memory usage breakdown by object type */
         totalSize: {
+            /** Memory used by line geometries (bytes) */
             line: number;
+            /** Memory used by mesh geometries (bytes) */
             mesh: number;
+            /** Memory used by point geometries (bytes) */
             point: number;
+            /** Total geometry memory usage (bytes) */
             geometry: number;
+            /** Memory used by entity mappings (bytes) */
             mapping: number;
         };
     };
 }
 /**
- * This class represents objects contained in one AuotCAD layout (model space or paper space).
+ * This class represents objects contained in one AutoCAD layout (model space or paper space).
+ *
+ * A layout manages the organization and rendering of CAD entities within a specific coordinate space.
+ * It provides functionality for:
+ * - Managing entities organized by layers
+ * - Spatial indexing for efficient entity queries
+ * - Bounding box management for view operations
+ * - Entity selection and highlighting
+ * - Memory usage tracking and statistics
+ *
+ * Layouts use a spatial index (R-tree) for fast entity lookup operations and maintain
+ * a hierarchical structure where entities are grouped by layers for efficient rendering
+ * and visibility management.
+ *
+ * @example
+ * ```typescript
+ * const layout = new AcTrLayout();
+ * layout.addEntity(entity);
+ * const entities = layout.search(boundingBox);
+ * layout.select(['entity1', 'entity2']);
+ * ```
  */
 export declare class AcTrLayout {
+    /** The group that contains all entities in this layout */
     private _group;
+    /** Spatial index tree for efficient entity queries */
     private _indexTree;
+    /** Bounding box containing all entities in this layout */
     private _box;
+    /** Map of layers indexed by layer name */
     private _layers;
+    /** Optional object for displaying snap points */
     private _snapPointsObject?;
+    /**
+     * Creates a new layout instance.
+     * Initializes the layout with empty collections and a spatial index.
+     */
     constructor();
     /**
      * The internal THREE.js object to use by scene. This is internally used only. Try to avoid using it.
      * @internal
      */
     get internalObject(): THREE.Group<THREE.Object3DEventMap>;
+    /**
+     * Gets the map of layers in this layout.
+     *
+     * @returns Map of layer names to layer objects
+     */
     get layers(): Map<string, AcTrLayer>;
+    /**
+     * Gets the bounding box that contains all entities in this layout.
+     *
+     * @returns The layout's bounding box
+     */
     get box(): THREE.Box3;
     /**
-     * The visibility of this layout
+     * The visibility of this layout.
+     * When set to false, the entire layout and all its contents are hidden.
      */
     get visible(): boolean;
     set visible(value: boolean);
     /**
-     * The number of entities stored in this layer
+     * The number of entities stored in this layout.
+     * Calculates the total by summing entities across all layers.
      */
     get entityCount(): number;
     /**
-     * The statistics of this layout
+     * The statistics of this layout.
+     * Provides detailed information about memory usage and entity counts.
      */
     get stats(): AcTrLayoutStats;
+    /**
+     * Clears all entities from the layout.
+     * Removes all layers, resets the bounding box, and clears the spatial index.
+     *
+     * @returns This layout instance for method chaining
+     */
     clear(): this;
     /**
-     * Re-render points with latest point style settings
-     * @param displayMode Input display mode of points
+     * Re-render points with latest point style settings.
+     * Updates the visual representation of all point entities across all layers.
+     *
+     * @param displayMode - Input display mode of points
      */
     rerenderPoints(displayMode: number): void;
     /**
      * Return true if the object with the specified object id is intersected with the ray by using raycast.
-     * @param objectId  Input object id of object to check for intersection with the ray.
-     * @param raycaster Input raycaster to check intersection
+     *
+     * @param objectId - Input object id of object to check for intersection with the ray.
+     * @param raycaster - Input raycaster to check intersection
+     * @returns True if the object intersects with the ray, false otherwise
      */
     isIntersectWith(objectId: string, raycaster: THREE.Raycaster): boolean | undefined;
     /**
      * Add one AutoCAD entity into this layout. If layer group referenced by the entity doesn't exist, create one
      * layer group and add this entity this group.
-     * @param entity Input AutoCAD entity to be added into this layout.
-     * @param extendBbox Input the flag whether to extend the bounding box of the scene by union the bounding box
-     * of the specified entity.
+     *
+     * @param entity - Input AutoCAD entity to be added into this layout.
+     * @param extendBbox - Input the flag whether to extend the bounding box of the scene by union the bounding box
+     * of the specified entity. Defaults to true.
+     * @returns This layout instance for method chaining
+     *
+     * @throws {Error} When entity is missing required objectId or layerName
      */
     addEntity(entity: AcTrEntity, extendBbox?: boolean): this;
     /**
      * Remove the specified entity from this layout.
-     * @param objectId Input the object id of the entity to remove
+     *
+     * @param objectId - Input the object id of the entity to remove
      * @returns Return true if remove the specified entity successfully. Otherwise, return false.
      */
     remove(objectId: AcDbObjectId): boolean;
     /**
      * Update the specified entity in this layout.
-     * @param objectId Input the entity to update
+     *
+     * @param entity - Input the entity to update
      * @returns Return true if update the specified entity successfully. Otherwise, return false.
      */
     update(entity: AcTrEntity): boolean;
     /**
-     * Hover the specified entities
+     * Hover the specified entities.
+     * Applies hover highlighting to the entities with the given IDs.
+     *
+     * @param ids - Array of entity object IDs to hover
      */
     hover(ids: AcDbObjectId[]): void;
     /**
-     * Unhover the specified entities
+     * Unhover the specified entities.
+     * Removes hover highlighting from the entities with the given IDs.
+     *
+     * @param ids - Array of entity object IDs to unhover
      */
     unhover(ids: AcDbObjectId[]): void;
     /**
-     * Select the specified entities
+     * Select the specified entities.
+     * Applies selection highlighting to the entities with the given IDs.
+     *
+     * @param ids - Array of entity object IDs to select
      */
     select(ids: AcDbObjectId[]): void;
     /**
-     * Unselect the specified entities
+     * Unselect the specified entities.
+     * Removes selection highlighting from the entities with the given IDs.
+     *
+     * @param ids - Array of entity object IDs to unselect
      */
     unselect(ids: AcDbObjectId[]): void;
+    /**
+     * Sets the snap points object for this layout.
+     * Replaces any existing snap points object with the new one.
+     *
+     * @param object - The snap points object to display
+     */
     setSnapObject(object: AcTrObject): void;
     /**
      * Search entities intersected or contained in the specified bounding box.
-     * @param box Input the query bounding box
-     * @returns Return query results
+     * Uses the spatial index for efficient querying of entities within the given bounds.
+     *
+     * @param box - Input the query bounding box (2D or 3D)
+     * @returns Return query results containing entity IDs and their bounds
      */
     search(box: AcGeBox2d | AcGeBox3d): AcEdSpatialQueryResultItem[];
+    /**
+     * Finds the layer containing the entity with the specified object ID.
+     *
+     * @param objectId - The object ID to search for
+     * @returns The layer containing the entity, or undefined if not found
+     */
     private getLayerByObjectId;
     /**
      * Get layer group by name. If the layer doesn't exist, create one layer group into this layout.
-     * @param name Input layer name
-     * @param createIfNotExist Input one flag to indicate whether to create layer group if it doesn't exist in
-     * this layout.
-     * @returns Return matched layer
+     *
+     * @param name - Input layer name
+     * @param createIfNotExist - Input one flag to indicate whether to create layer group if it doesn't exist in
+     * this layout. Defaults to true.
+     * @returns Return matched layer, or undefined if not found and createIfNotExist is false
      */
     private getLayer;
 }

package/lib/view/AcTrLayout.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AcTrLayout.d.ts","sourceRoot":"","sources":["../../src/view/AcTrLayout.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AAC1E,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAA;AAElE,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAE9B,OAAO,EAAE,0BAA0B,EAAE,MAAM,WAAW,CAAA;AACtD,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAEvD,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,cAAc,EAAE,CAAA;IACxB,OAAO,EAAE;QACP,WAAW,EAAE,MAAM,CAAA;QACnB,SAAS,EAAE;YACT,IAAI,EAAE,MAAM,CAAA;YACZ,IAAI,EAAE,MAAM,CAAA;YACZ,KAAK,EAAE,MAAM,CAAA;YACb,QAAQ,EAAE,MAAM,CAAA;YAChB,OAAO,EAAE,MAAM,CAAA;SAChB,CAAA;KACF,CAAA;CACF;AAED;;GAEG;AACH,qBAAa,UAAU;IAErB,OAAO,CAAC,MAAM,CAAa;IAC3B,OAAO,CAAC,UAAU,CAAmC;IACrD,OAAO,CAAC,IAAI,CAAY;IACxB,OAAO,CAAC,OAAO,CAAwB;IACvC,OAAO,CAAC,iBAAiB,CAAC,CAAY;;IAStC;;;OAGG;IACH,IAAI,cAAc,wCAEjB;IAED,IAAI,MAAM,2BAET;IAED,IAAI,GAAG,eAEN;IAED;;OAEG;IACH,IAAI,OAAO,IAGQ,OAAO,CADzB;IACD,IAAI,OAAO,CAAC,KAAK,EAAE,OAAO,EAEzB;IAED;;OAEG;IACH,IAAI,WAAW,WAId;IAED;;OAEG;IACH,IAAI,KAAK,IA+BF,eAAe,CACrB;IAED,KAAK;IAUL;;;OAGG;IACH,cAAc,CAAC,WAAW,EAAE,MAAM;IAMlC;;;;OAIG;IACH,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS;IAK5D;;;;;;OAMG;IACH,SAAS,CAAC,MAAM,EAAE,UAAU,EAAE,UAAU,GAAE,OAAc;IA2BxD;;;;OAIG;IACH,MAAM,CAAC,QAAQ,EAAE,YAAY;IAO7B;;;;OAIG;IACH,MAAM,CAAC,MAAM,EAAE,UAAU;IAOzB;;OAEG;IACH,KAAK,CAAC,GAAG,EAAE,YAAY,EAAE;IASzB;;OAEG;IACH,OAAO,CAAC,GAAG,EAAE,YAAY,EAAE;IAS3B;;OAEG;IACH,MAAM,CAAC,GAAG,EAAE,YAAY,EAAE;IAS1B;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,YAAY,EAAE;IAS5B,aAAa,CAAC,MAAM,EAAE,UAAU;IAQhC;;;;OAIG;IACH,MAAM,CAAC,GAAG,EAAE,SAAS,GAAG,SAAS;IAUjC,OAAO,CAAC,kBAAkB;IAO1B;;;;;;OAMG;IACH,OAAO,CAAC,QAAQ;CASjB"}
+{"version":3,"file":"AcTrLayout.d.ts","sourceRoot":"","sources":["../../src/view/AcTrLayout.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AAC1E,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAA;AAElE,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAE9B,OAAO,EAAE,0BAA0B,EAAE,MAAM,WAAW,CAAA;AACtD,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAEvD;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,8CAA8C;IAC9C,MAAM,EAAE,cAAc,EAAE,CAAA;IACxB,+CAA+C;IAC/C,OAAO,EAAE;QACP,iDAAiD;QACjD,WAAW,EAAE,MAAM,CAAA;QACnB,4CAA4C;QAC5C,SAAS,EAAE;YACT,6CAA6C;YAC7C,IAAI,EAAE,MAAM,CAAA;YACZ,6CAA6C;YAC7C,IAAI,EAAE,MAAM,CAAA;YACZ,8CAA8C;YAC9C,KAAK,EAAE,MAAM,CAAA;YACb,0CAA0C;YAC1C,QAAQ,EAAE,MAAM,CAAA;YAChB,6CAA6C;YAC7C,OAAO,EAAE,MAAM,CAAA;SAChB,CAAA;KACF,CAAA;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,UAAU;IACrB,0DAA0D;IAC1D,OAAO,CAAC,MAAM,CAAa;IAC3B,sDAAsD;IACtD,OAAO,CAAC,UAAU,CAAmC;IACrD,0DAA0D;IAC1D,OAAO,CAAC,IAAI,CAAY;IACxB,0CAA0C;IAC1C,OAAO,CAAC,OAAO,CAAwB;IACvC,iDAAiD;IACjD,OAAO,CAAC,iBAAiB,CAAC,CAAY;IAEtC;;;OAGG;;IAQH;;;OAGG;IACH,IAAI,cAAc,wCAEjB;IAED;;;;OAIG;IACH,IAAI,MAAM,2BAET;IAED;;;;OAIG;IACH,IAAI,GAAG,eAEN;IAED;;;OAGG;IACH,IAAI,OAAO,IAGQ,OAAO,CADzB;IACD,IAAI,OAAO,CAAC,KAAK,EAAE,OAAO,EAEzB;IAED;;;OAGG;IACH,IAAI,WAAW,WAId;IAED;;;OAGG;IACH,IAAI,KAAK,IA+BF,eAAe,CACrB;IAED;;;;;OAKG;IACH,KAAK;IAUL;;;;;OAKG;IACH,cAAc,CAAC,WAAW,EAAE,MAAM;IAMlC;;;;;;OAMG;IACH,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS;IAK5D;;;;;;;;;;OAUG;IACH,SAAS,CAAC,MAAM,EAAE,UAAU,EAAE,UAAU,GAAE,OAAc;IA2BxD;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,EAAE,YAAY;IAO7B;;;;;OAKG;IACH,MAAM,CAAC,MAAM,EAAE,UAAU;IAOzB;;;;;OAKG;IACH,KAAK,CAAC,GAAG,EAAE,YAAY,EAAE;IASzB;;;;;OAKG;IACH,OAAO,CAAC,GAAG,EAAE,YAAY,EAAE;IAS3B;;;;;OAKG;IACH,MAAM,CAAC,GAAG,EAAE,YAAY,EAAE;IAS1B;;;;;OAKG;IACH,QAAQ,CAAC,GAAG,EAAE,YAAY,EAAE;IAS5B;;;;;OAKG;IACH,aAAa,CAAC,MAAM,EAAE,UAAU;IAQhC;;;;;;OAMG;IACH,MAAM,CAAC,GAAG,EAAE,SAAS,GAAG,SAAS;IAUjC;;;;;OAKG;IACH,OAAO,CAAC,kBAAkB;IAO1B;;;;;;;OAOG;IACH,OAAO,CAAC,QAAQ;CASjB"}

package/lib/view/AcTrLayout.js

@@ -29,9 +29,33 @@ import RBush from 'rbush';
 import * as THREE from 'three';
 import { AcTrLayer } from './AcTrLayer';
 /**
- * This class represents objects contained in one AuotCAD layout (model space or paper space).
+ * This class represents objects contained in one AutoCAD layout (model space or paper space).
+ *
+ * A layout manages the organization and rendering of CAD entities within a specific coordinate space.
+ * It provides functionality for:
+ * - Managing entities organized by layers
+ * - Spatial indexing for efficient entity queries
+ * - Bounding box management for view operations
+ * - Entity selection and highlighting
+ * - Memory usage tracking and statistics
+ *
+ * Layouts use a spatial index (R-tree) for fast entity lookup operations and maintain
+ * a hierarchical structure where entities are grouped by layers for efficient rendering
+ * and visibility management.
+ *
+ * @example
+ * ```typescript
+ * const layout = new AcTrLayout();
+ * layout.addEntity(entity);
+ * const entities = layout.search(boundingBox);
+ * layout.select(['entity1', 'entity2']);
+ * ```
  */
 var AcTrLayout = /** @class */ (function () {
+    /**
+     * Creates a new layout instance.
+     * Initializes the layout with empty collections and a spatial index.
+     */
     function AcTrLayout() {
         this._group = new THREE.Group();
         this._indexTree = new RBush();
@@ -50,6 +74,11 @@ var AcTrLayout = /** @class */ (function () {
         configurable: true
     });
     Object.defineProperty(AcTrLayout.prototype, "layers", {
+        /**
+         * Gets the map of layers in this layout.
+         *
+         * @returns Map of layer names to layer objects
+         */
         get: function () {
             return this._layers;
         },
@@ -57,6 +86,11 @@ var AcTrLayout = /** @class */ (function () {
         configurable: true
     });
     Object.defineProperty(AcTrLayout.prototype, "box", {
+        /**
+         * Gets the bounding box that contains all entities in this layout.
+         *
+         * @returns The layout's bounding box
+         */
         get: function () {
             return this._box;
         },
@@ -65,7 +99,8 @@ var AcTrLayout = /** @class */ (function () {
     });
     Object.defineProperty(AcTrLayout.prototype, "visible", {
         /**
-         * The visibility of this layout
+         * The visibility of this layout.
+         * When set to false, the entire layout and all its contents are hidden.
          */
         get: function () {
             return this._group.visible;
@@ -78,7 +113,8 @@ var AcTrLayout = /** @class */ (function () {
     });
     Object.defineProperty(AcTrLayout.prototype, "entityCount", {
         /**
-         * The number of entities stored in this layer
+         * The number of entities stored in this layout.
+         * Calculates the total by summing entities across all layers.
          */
         get: function () {
             var count = 0;
@@ -90,7 +126,8 @@ var AcTrLayout = /** @class */ (function () {
     });
     Object.defineProperty(AcTrLayout.prototype, "stats", {
         /**
-         * The statistics of this layout
+         * The statistics of this layout.
+         * Provides detailed information about memory usage and entity counts.
          */
         get: function () {
             var layers = [];
@@ -128,6 +165,12 @@ var AcTrLayout = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
+    /**
+     * Clears all entities from the layout.
+     * Removes all layers, resets the bounding box, and clears the spatial index.
+     *
+     * @returns This layout instance for method chaining
+     */
     AcTrLayout.prototype.clear = function () {
         var _this = this;
         this._layers.forEach(function (layer) {
@@ -139,8 +182,10 @@ var AcTrLayout = /** @class */ (function () {
         return this;
     };
     /**
-     * Re-render points with latest point style settings
-     * @param displayMode Input display mode of points
+     * Re-render points with latest point style settings.
+     * Updates the visual representation of all point entities across all layers.
+     *
+     * @param displayMode - Input display mode of points
      */
     AcTrLayout.prototype.rerenderPoints = function (displayMode) {
         this._layers.forEach(function (layer) {
@@ -149,8 +194,10 @@ var AcTrLayout = /** @class */ (function () {
     };
     /**
      * Return true if the object with the specified object id is intersected with the ray by using raycast.
-     * @param objectId  Input object id of object to check for intersection with the ray.
-     * @param raycaster Input raycaster to check intersection
+     *
+     * @param objectId - Input object id of object to check for intersection with the ray.
+     * @param raycaster - Input raycaster to check intersection
+     * @returns True if the object intersects with the ray, false otherwise
      */
     AcTrLayout.prototype.isIntersectWith = function (objectId, raycaster) {
         var layer = this.getLayerByObjectId(objectId);
@@ -159,9 +206,13 @@ var AcTrLayout = /** @class */ (function () {
     /**
      * Add one AutoCAD entity into this layout. If layer group referenced by the entity doesn't exist, create one
      * layer group and add this entity this group.
-     * @param entity Input AutoCAD entity to be added into this layout.
-     * @param extendBbox Input the flag whether to extend the bounding box of the scene by union the bounding box
-     * of the specified entity.
+     *
+     * @param entity - Input AutoCAD entity to be added into this layout.
+     * @param extendBbox - Input the flag whether to extend the bounding box of the scene by union the bounding box
+     * of the specified entity. Defaults to true.
+     * @returns This layout instance for method chaining
+     *
+     * @throws {Error} When entity is missing required objectId or layerName
      */
     AcTrLayout.prototype.addEntity = function (entity, extendBbox) {
         if (extendBbox === void 0) { extendBbox = true; }
@@ -190,7 +241,8 @@ var AcTrLayout = /** @class */ (function () {
     };
     /**
      * Remove the specified entity from this layout.
-     * @param objectId Input the object id of the entity to remove
+     *
+     * @param objectId - Input the object id of the entity to remove
      * @returns Return true if remove the specified entity successfully. Otherwise, return false.
      */
     AcTrLayout.prototype.remove = function (objectId) {
@@ -213,7 +265,8 @@ var AcTrLayout = /** @class */ (function () {
     };
     /**
      * Update the specified entity in this layout.
-     * @param objectId Input the entity to update
+     *
+     * @param entity - Input the entity to update
      * @returns Return true if update the specified entity successfully. Otherwise, return false.
      */
     AcTrLayout.prototype.update = function (entity) {
@@ -235,7 +288,10 @@ var AcTrLayout = /** @class */ (function () {
         return false;
     };
     /**
-     * Hover the specified entities
+     * Hover the specified entities.
+     * Applies hover highlighting to the entities with the given IDs.
+     *
+     * @param ids - Array of entity object IDs to hover
      */
     AcTrLayout.prototype.hover = function (ids) {
         var _this = this;
@@ -247,7 +303,10 @@ var AcTrLayout = /** @class */ (function () {
         });
     };
     /**
-     * Unhover the specified entities
+     * Unhover the specified entities.
+     * Removes hover highlighting from the entities with the given IDs.
+     *
+     * @param ids - Array of entity object IDs to unhover
      */
     AcTrLayout.prototype.unhover = function (ids) {
         var _this = this;
@@ -259,7 +318,10 @@ var AcTrLayout = /** @class */ (function () {
         });
     };
     /**
-     * Select the specified entities
+     * Select the specified entities.
+     * Applies selection highlighting to the entities with the given IDs.
+     *
+     * @param ids - Array of entity object IDs to select
      */
     AcTrLayout.prototype.select = function (ids) {
         var _this = this;
@@ -271,7 +333,10 @@ var AcTrLayout = /** @class */ (function () {
         });
     };
     /**
-     * Unselect the specified entities
+     * Unselect the specified entities.
+     * Removes selection highlighting from the entities with the given IDs.
+     *
+     * @param ids - Array of entity object IDs to unselect
      */
     AcTrLayout.prototype.unselect = function (ids) {
         var _this = this;
@@ -282,6 +347,12 @@ var AcTrLayout = /** @class */ (function () {
             }
         });
     };
+    /**
+     * Sets the snap points object for this layout.
+     * Replaces any existing snap points object with the new one.
+     *
+     * @param object - The snap points object to display
+     */
     AcTrLayout.prototype.setSnapObject = function (object) {
         if (this._snapPointsObject) {
             this._group.remove(this._snapPointsObject);
@@ -291,8 +362,10 @@ var AcTrLayout = /** @class */ (function () {
     };
     /**
      * Search entities intersected or contained in the specified bounding box.
-     * @param box Input the query bounding box
-     * @returns Return query results
+     * Uses the spatial index for efficient querying of entities within the given bounds.
+     *
+     * @param box - Input the query bounding box (2D or 3D)
+     * @returns Return query results containing entity IDs and their bounds
      */
     AcTrLayout.prototype.search = function (box) {
         var results = this._indexTree.search({
@@ -303,6 +376,12 @@ var AcTrLayout = /** @class */ (function () {
         });
         return results;
     };
+    /**
+     * Finds the layer containing the entity with the specified object ID.
+     *
+     * @param objectId - The object ID to search for
+     * @returns The layer containing the entity, or undefined if not found
+     */
     AcTrLayout.prototype.getLayerByObjectId = function (objectId) {
         var e_3, _a;
         try {
@@ -323,10 +402,11 @@ var AcTrLayout = /** @class */ (function () {
     };
     /**
      * Get layer group by name. If the layer doesn't exist, create one layer group into this layout.
-     * @param name Input layer name
-     * @param createIfNotExist Input one flag to indicate whether to create layer group if it doesn't exist in
-     * this layout.
-     * @returns Return matched layer
+     *
+     * @param name - Input layer name
+     * @param createIfNotExist - Input one flag to indicate whether to create layer group if it doesn't exist in
+     * this layout. Defaults to true.
+     * @returns Return matched layer, or undefined if not found and createIfNotExist is false
      */
     AcTrLayout.prototype.getLayer = function (name, createIfNotExist) {
         if (createIfNotExist === void 0) { createIfNotExist = true; }