@mlightcad/data-model 1.1.1 → 1.1.3

package/lib/entity/AcDbTrace.d.ts

@@ -2,62 +2,189 @@ import { AcGeBox3d, AcGePoint3d, AcGePointLike } from '@mlightcad/geometry-engin
 import { AcGiRenderer } from '@mlightcad/graphic-interface';
 import { AcDbCurve } from './AcDbCurve';
 /**
- * The class represents the trace entity in AutoCAD, which represents a filled four-sided polygon.
- * It is typically used to create trace-like shapes. It is one of the simpler types of entities
- * within the AutoCAD database and can be visualized as a "filled polyline" with four vertices,
- * where each edge connects two consecutive points.
+ * Represents a trace entity in AutoCAD.
  *
- * This entity was more commonly used in earlier versions of AutoCAD, especially before the
- * introduction of more advanced entities like solid and hatches. Today, it's not as commonly used
- * since solid provides similar capabilities with more flexibility.
+ * A trace is a 3D geometric object that represents a filled four-sided polygon.
+ * It is typically used to create trace-like shapes and can be visualized as a
+ * "filled polyline" with four vertices, where each edge connects two consecutive points.
+ *
+ * This entity was more commonly used in earlier versions of AutoCAD, especially before
+ * the introduction of more advanced entities like solid and hatches. Today, it's not
+ * as commonly used since solid provides similar capabilities with more flexibility.
+ *
+ * @example
+ * ```typescript
+ * // Create a trace entity
+ * const trace = new AcDbTrace();
+ * trace.setPointAt(0, new AcGePoint3d(0, 0, 0));
+ * trace.setPointAt(1, new AcGePoint3d(10, 0, 0));
+ * trace.setPointAt(2, new AcGePoint3d(10, 5, 0));
+ * trace.setPointAt(3, new AcGePoint3d(0, 5, 0));
+ *
+ * // Access trace properties
+ * console.log(`Elevation: ${trace.elevation}`);
+ * console.log(`Thickness: ${trace.thickness}`);
+ * ```
  */
 export declare class AcDbTrace extends AcDbCurve {
+    /** The elevation (Z-coordinate) of the trace plane */
     private _elevation;
+    /** The four vertices of the trace */
     private _vertices;
+    /** The thickness (extrusion) of the trace */
     private _thickness;
     /**
-     * Create one empty trace entity
+     * Creates a new trace entity.
+     *
+     * This constructor initializes a trace with default values.
+     * All vertices are set to the origin, elevation is 0, and thickness is 1.
+     *
+     * @example
+     * ```typescript
+     * const trace = new AcDbTrace();
+     * // Set the four vertices to create a rectangle
+     * trace.setPointAt(0, new AcGePoint3d(0, 0, 0));
+     * trace.setPointAt(1, new AcGePoint3d(10, 0, 0));
+     * trace.setPointAt(2, new AcGePoint3d(10, 5, 0));
+     * trace.setPointAt(3, new AcGePoint3d(0, 5, 0));
+     * ```
      */
     constructor();
     /**
-     * The distance of the trace's plane from the WCS origin.
+     * Gets the elevation of this trace.
+     *
+     * The elevation is the distance of the trace's plane from the WCS origin
+     * along the Z-axis.
+     *
+     * @returns The elevation value
+     *
+     * @example
+     * ```typescript
+     * const elevation = trace.elevation;
+     * console.log(`Trace elevation: ${elevation}`);
+     * ```
      */
     get elevation(): number;
+    /**
+     * Sets the elevation of this trace.
+     *
+     * @param value - The new elevation value
+     *
+     * @example
+     * ```typescript
+     * trace.elevation = 10;
+     * ```
+     */
     set elevation(value: number);
     /**
-     * @inheritdoc
+     * Gets whether this trace is closed.
+     *
+     * Traces are always closed entities, so this always returns true.
+     *
+     * @returns Always true for traces
      */
     get closed(): boolean;
     /**
-     * The thickness for the text. The thickness is the text's dimension along its normal vector
-     * direction (sometimes called the extrusion direction).
+     * Gets the thickness of this trace.
+     *
+     * The thickness is the trace's dimension along its normal vector direction
+     * (sometimes called the extrusion direction).
+     *
+     * @returns The thickness value
+     *
+     * @example
+     * ```typescript
+     * const thickness = trace.thickness;
+     * console.log(`Trace thickness: ${thickness}`);
+     * ```
      */
     get thickness(): number;
+    /**
+     * Sets the thickness of this trace.
+     *
+     * @param value - The new thickness value
+     *
+     * @example
+     * ```typescript
+     * trace.thickness = 2.0;
+     * ```
+     */
     set thickness(value: number);
     /**
-     * Return the point in the trace whose index is equal to the specified `index` value. `index` can have
-     * a value of 0, 1, 2, or 3, depending on which point is desired (that is, 0 for the first point, 1 for
-     * the second point, etc.). The returned point is in WCS coordinates.
-     * @param index Input index (0 based) of the vertex.
-     * @returns Return the point in the trace whose index is equal to the specified `index` value.
+     * Gets the point at the specified index in this trace.
+     *
+     * The index can be 0, 1, 2, or 3, representing the four vertices of the trace.
+     * If the index is out of range, it returns the first or last vertex accordingly.
+     *
+     * @param index - The index (0-3) of the vertex to get
+     * @returns The point at the specified index in WCS coordinates
+     *
+     * @example
+     * ```typescript
+     * const point0 = trace.getPointAt(0);
+     * const point1 = trace.getPointAt(1);
+     * console.log(`Vertex 0: ${point0.x}, ${point0.y}, ${point0.z}`);
+     * ```
      */
     getPointAt(index: number): AcGePoint3d;
     /**
-     * Set sets the `index`'th point in the trace to the value `point`. `index` must be 0, 1, 2, or 3.
-     * `point` must be in WCS coordinates.
-     * @param index Input index (0-3) of the point to set in the trace
+     * Sets the point at the specified index in this trace.
+     *
+     * The index must be 0, 1, 2, or 3, representing the four vertices of the trace.
+     * If the index is out of range, it sets the first or last vertex accordingly.
+     *
+     * @param index - The index (0-3) of the vertex to set
+     * @param point - The new point in WCS coordinates
+     *
+     * @example
+     * ```typescript
+     * trace.setPointAt(0, new AcGePoint3d(0, 0, 0));
+     * trace.setPointAt(1, new AcGePoint3d(10, 0, 0));
+     * trace.setPointAt(2, new AcGePoint3d(10, 5, 0));
+     * trace.setPointAt(3, new AcGePoint3d(0, 5, 0));
+     * ```
      */
     setPointAt(index: number, point: AcGePointLike): AcGePoint3d | undefined;
     /**
-     * @inheritdoc
+     * Gets the geometric extents (bounding box) of this trace.
+     *
+     * @returns The bounding box that encompasses the entire trace
+     *
+     * @example
+     * ```typescript
+     * const extents = trace.geometricExtents;
+     * console.log(`Trace bounds: ${extents.minPoint} to ${extents.maxPoint}`);
+     * ```
      */
     get geometricExtents(): AcGeBox3d;
     /**
-     * @inheritdoc
+     * Gets the grip points for this trace.
+     *
+     * Grip points are control points that can be used to modify the trace.
+     * For a trace, the grip points are all four vertices.
+     *
+     * @returns Array of grip points (all four vertices)
+     *
+     * @example
+     * ```typescript
+     * const gripPoints = trace.subGetGripPoints();
+     * // gripPoints contains all four vertices of the trace
+     * ```
      */
     subGetGripPoints(): AcGePoint3d[];
     /**
-     * @inheritdoc
+     * Draws this trace using the specified renderer.
+     *
+     * This method renders the trace as a filled area using the trace's
+     * current style properties.
+     *
+     * @param renderer - The renderer to use for drawing
+     * @returns The rendered trace entity, or undefined if drawing failed
+     *
+     * @example
+     * ```typescript
+     * const renderedTrace = trace.draw(renderer);
+     * ```
      */
     draw(renderer: AcGiRenderer): import("@mlightcad/graphic-interface").AcGiEntity;
 }

package/lib/entity/AcDbTrace.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AcDbTrace.d.ts","sourceRoot":"","sources":["../../src/entity/AcDbTrace.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,SAAS,EACT,WAAW,EACX,aAAa,EAEd,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAA;AAE3D,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAEvC;;;;;;;;;GASG;AACH,qBAAa,SAAU,SAAQ,SAAS;IACtC,OAAO,CAAC,UAAU,CAAQ;IAC1B,OAAO,CAAC,SAAS,CAAsD;IACvE,OAAO,CAAC,UAAU,CAAQ;IAE1B;;OAEG;;IAaH;;OAEG;IACH,IAAI,SAAS,IAAI,MAAM,CAEtB;IACD,IAAI,SAAS,CAAC,KAAK,EAAE,MAAM,EAE1B;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED;;;OAGG;IACH,IAAI,SAAS,IAGQ,MAAM,CAD1B;IACD,IAAI,SAAS,CAAC,KAAK,EAAE,MAAM,EAE1B;IAED;;;;;;OAMG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW;IAMtC;;;;OAIG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,aAAa;IAM9C;;OAEG;IACH,IAAI,gBAAgB,IAAI,SAAS,CAEhC;IAED;;OAEG;IACH,gBAAgB;IAQhB;;OAEG;IACH,IAAI,CAAC,QAAQ,EAAE,YAAY;CAW5B"}
+{"version":3,"file":"AcDbTrace.d.ts","sourceRoot":"","sources":["../../src/entity/AcDbTrace.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,SAAS,EACT,WAAW,EACX,aAAa,EAEd,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAA;AAE3D,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAEvC;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,qBAAa,SAAU,SAAQ,SAAS;IACtC,sDAAsD;IACtD,OAAO,CAAC,UAAU,CAAQ;IAC1B,qCAAqC;IACrC,OAAO,CAAC,SAAS,CAAsD;IACvE,6CAA6C;IAC7C,OAAO,CAAC,UAAU,CAAQ;IAE1B;;;;;;;;;;;;;;;OAeG;;IAaH;;;;;;;;;;;;;OAaG;IACH,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED;;;;;;;;;OASG;IACH,IAAI,SAAS,CAAC,KAAK,EAAE,MAAM,EAE1B;IAED;;;;;;OAMG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,SAAS,IAcQ,MAAM,CAZ1B;IAED;;;;;;;;;OASG;IACH,IAAI,SAAS,CAAC,KAAK,EAAE,MAAM,EAE1B;IAED;;;;;;;;;;;;;;;OAeG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW;IAMtC;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,aAAa;IAM9C;;;;;;;;;;OAUG;IACH,IAAI,gBAAgB,IAAI,SAAS,CAEhC;IAED;;;;;;;;;;;;;OAaG;IACH,gBAAgB;IAQhB;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,QAAQ,EAAE,YAAY;CAW5B"}

package/lib/entity/AcDbTrace.js

@@ -16,19 +16,47 @@ var __extends = (this && this.__extends) || (function () {
 import { AcGeArea2d, AcGeBox3d, AcGePoint3d, AcGePolyline2d } from '@mlightcad/geometry-engine';
 import { AcDbCurve } from './AcDbCurve';
 /**
- * The class represents the trace entity in AutoCAD, which represents a filled four-sided polygon.
- * It is typically used to create trace-like shapes. It is one of the simpler types of entities
- * within the AutoCAD database and can be visualized as a "filled polyline" with four vertices,
- * where each edge connects two consecutive points.
+ * Represents a trace entity in AutoCAD.
  *
- * This entity was more commonly used in earlier versions of AutoCAD, especially before the
- * introduction of more advanced entities like solid and hatches. Today, it's not as commonly used
- * since solid provides similar capabilities with more flexibility.
+ * A trace is a 3D geometric object that represents a filled four-sided polygon.
+ * It is typically used to create trace-like shapes and can be visualized as a
+ * "filled polyline" with four vertices, where each edge connects two consecutive points.
+ *
+ * This entity was more commonly used in earlier versions of AutoCAD, especially before
+ * the introduction of more advanced entities like solid and hatches. Today, it's not
+ * as commonly used since solid provides similar capabilities with more flexibility.
+ *
+ * @example
+ * ```typescript
+ * // Create a trace entity
+ * const trace = new AcDbTrace();
+ * trace.setPointAt(0, new AcGePoint3d(0, 0, 0));
+ * trace.setPointAt(1, new AcGePoint3d(10, 0, 0));
+ * trace.setPointAt(2, new AcGePoint3d(10, 5, 0));
+ * trace.setPointAt(3, new AcGePoint3d(0, 5, 0));
+ *
+ * // Access trace properties
+ * console.log(`Elevation: ${trace.elevation}`);
+ * console.log(`Thickness: ${trace.thickness}`);
+ * ```
  */
 var AcDbTrace = /** @class */ (function (_super) {
     __extends(AcDbTrace, _super);
     /**
-     * Create one empty trace entity
+     * Creates a new trace entity.
+     *
+     * This constructor initializes a trace with default values.
+     * All vertices are set to the origin, elevation is 0, and thickness is 1.
+     *
+     * @example
+     * ```typescript
+     * const trace = new AcDbTrace();
+     * // Set the four vertices to create a rectangle
+     * trace.setPointAt(0, new AcGePoint3d(0, 0, 0));
+     * trace.setPointAt(1, new AcGePoint3d(10, 0, 0));
+     * trace.setPointAt(2, new AcGePoint3d(10, 5, 0));
+     * trace.setPointAt(3, new AcGePoint3d(0, 5, 0));
+     * ```
      */
     function AcDbTrace() {
         var _this = _super.call(this) || this;
@@ -44,11 +72,32 @@ var AcDbTrace = /** @class */ (function (_super) {
     }
     Object.defineProperty(AcDbTrace.prototype, "elevation", {
         /**
-         * The distance of the trace's plane from the WCS origin.
+         * Gets the elevation of this trace.
+         *
+         * The elevation is the distance of the trace's plane from the WCS origin
+         * along the Z-axis.
+         *
+         * @returns The elevation value
+         *
+         * @example
+         * ```typescript
+         * const elevation = trace.elevation;
+         * console.log(`Trace elevation: ${elevation}`);
+         * ```
          */
         get: function () {
             return this._elevation;
         },
+        /**
+         * Sets the elevation of this trace.
+         *
+         * @param value - The new elevation value
+         *
+         * @example
+         * ```typescript
+         * trace.elevation = 10;
+         * ```
+         */
         set: function (value) {
             this._elevation = value;
         },
@@ -57,7 +106,11 @@ var AcDbTrace = /** @class */ (function (_super) {
     });
     Object.defineProperty(AcDbTrace.prototype, "closed", {
         /**
-         * @inheritdoc
+         * Gets whether this trace is closed.
+         *
+         * Traces are always closed entities, so this always returns true.
+         *
+         * @returns Always true for traces
          */
         get: function () {
             return true;
@@ -67,12 +120,32 @@ var AcDbTrace = /** @class */ (function (_super) {
     });
     Object.defineProperty(AcDbTrace.prototype, "thickness", {
         /**
-         * The thickness for the text. The thickness is the text's dimension along its normal vector
-         * direction (sometimes called the extrusion direction).
+         * Gets the thickness of this trace.
+         *
+         * The thickness is the trace's dimension along its normal vector direction
+         * (sometimes called the extrusion direction).
+         *
+         * @returns The thickness value
+         *
+         * @example
+         * ```typescript
+         * const thickness = trace.thickness;
+         * console.log(`Trace thickness: ${thickness}`);
+         * ```
          */
         get: function () {
             return this._thickness;
         },
+        /**
+         * Sets the thickness of this trace.
+         *
+         * @param value - The new thickness value
+         *
+         * @example
+         * ```typescript
+         * trace.thickness = 2.0;
+         * ```
+         */
         set: function (value) {
             this._thickness = value;
         },
@@ -80,11 +153,20 @@ var AcDbTrace = /** @class */ (function (_super) {
         configurable: true
     });
     /**
-     * Return the point in the trace whose index is equal to the specified `index` value. `index` can have
-     * a value of 0, 1, 2, or 3, depending on which point is desired (that is, 0 for the first point, 1 for
-     * the second point, etc.). The returned point is in WCS coordinates.
-     * @param index Input index (0 based) of the vertex.
-     * @returns Return the point in the trace whose index is equal to the specified `index` value.
+     * Gets the point at the specified index in this trace.
+     *
+     * The index can be 0, 1, 2, or 3, representing the four vertices of the trace.
+     * If the index is out of range, it returns the first or last vertex accordingly.
+     *
+     * @param index - The index (0-3) of the vertex to get
+     * @returns The point at the specified index in WCS coordinates
+     *
+     * @example
+     * ```typescript
+     * const point0 = trace.getPointAt(0);
+     * const point1 = trace.getPointAt(1);
+     * console.log(`Vertex 0: ${point0.x}, ${point0.y}, ${point0.z}`);
+     * ```
      */
     AcDbTrace.prototype.getPointAt = function (index) {
         if (index < 0)
@@ -94,9 +176,21 @@ var AcDbTrace = /** @class */ (function (_super) {
         return this._vertices[index];
     };
     /**
-     * Set sets the `index`'th point in the trace to the value `point`. `index` must be 0, 1, 2, or 3.
-     * `point` must be in WCS coordinates.
-     * @param index Input index (0-3) of the point to set in the trace
+     * Sets the point at the specified index in this trace.
+     *
+     * The index must be 0, 1, 2, or 3, representing the four vertices of the trace.
+     * If the index is out of range, it sets the first or last vertex accordingly.
+     *
+     * @param index - The index (0-3) of the vertex to set
+     * @param point - The new point in WCS coordinates
+     *
+     * @example
+     * ```typescript
+     * trace.setPointAt(0, new AcGePoint3d(0, 0, 0));
+     * trace.setPointAt(1, new AcGePoint3d(10, 0, 0));
+     * trace.setPointAt(2, new AcGePoint3d(10, 5, 0));
+     * trace.setPointAt(3, new AcGePoint3d(0, 5, 0));
+     * ```
      */
     AcDbTrace.prototype.setPointAt = function (index, point) {
         if (index < 0)
@@ -107,7 +201,15 @@ var AcDbTrace = /** @class */ (function (_super) {
     };
     Object.defineProperty(AcDbTrace.prototype, "geometricExtents", {
         /**
-         * @inheritdoc
+         * Gets the geometric extents (bounding box) of this trace.
+         *
+         * @returns The bounding box that encompasses the entire trace
+         *
+         * @example
+         * ```typescript
+         * const extents = trace.geometricExtents;
+         * console.log(`Trace bounds: ${extents.minPoint} to ${extents.maxPoint}`);
+         * ```
          */
         get: function () {
             return new AcGeBox3d().setFromPoints(this._vertices);
@@ -116,7 +218,18 @@ var AcDbTrace = /** @class */ (function (_super) {
         configurable: true
     });
     /**
-     * @inheritdoc
+     * Gets the grip points for this trace.
+     *
+     * Grip points are control points that can be used to modify the trace.
+     * For a trace, the grip points are all four vertices.
+     *
+     * @returns Array of grip points (all four vertices)
+     *
+     * @example
+     * ```typescript
+     * const gripPoints = trace.subGetGripPoints();
+     * // gripPoints contains all four vertices of the trace
+     * ```
      */
     AcDbTrace.prototype.subGetGripPoints = function () {
         var gripPoints = new Array();
@@ -126,7 +239,18 @@ var AcDbTrace = /** @class */ (function (_super) {
         return gripPoints;
     };
     /**
-     * @inheritdoc
+     * Draws this trace using the specified renderer.
+     *
+     * This method renders the trace as a filled area using the trace's
+     * current style properties.
+     *
+     * @param renderer - The renderer to use for drawing
+     * @returns The rendered trace entity, or undefined if drawing failed
+     *
+     * @example
+     * ```typescript
+     * const renderedTrace = trace.draw(renderer);
+     * ```
      */
     AcDbTrace.prototype.draw = function (renderer) {
         var polyline = new AcGePolyline2d(this._vertices, true);

package/lib/entity/AcDbTrace.js.map

@@ -1 +1 @@
-{"version":3,"file":"AcDbTrace.js","sourceRoot":"","sources":["../../src/entity/AcDbTrace.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,OAAO,EACL,UAAU,EACV,SAAS,EACT,WAAW,EAEX,cAAc,EACf,MAAM,4BAA4B,CAAA;AAGnC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAEvC;;;;;;;;;GASG;AACH;IAA+B,6BAAS;IAKtC;;OAEG;IACH;QACE,YAAA,MAAK,WAAE,SAAA;QACP,KAAI,CAAC,UAAU,GAAG,CAAC,CAAA;QACnB,KAAI,CAAC,UAAU,GAAG,CAAC,CAAA;QACnB,KAAI,CAAC,SAAS,GAAG;YACf,IAAI,WAAW,EAAE;YACjB,IAAI,WAAW,EAAE;YACjB,IAAI,WAAW,EAAE;YACjB,IAAI,WAAW,EAAE;SAClB,CAAA;;IACH,CAAC;IAKD,sBAAI,gCAAS;QAHb;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,UAAU,CAAA;QACxB,CAAC;aACD,UAAc,KAAa;YACzB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAA;QACzB,CAAC;;;OAHA;IAQD,sBAAI,6BAAM;QAHV;;WAEG;aACH;YACE,OAAO,IAAI,CAAA;QACb,CAAC;;;OAAA;IAMD,sBAAI,gCAAS;QAJb;;;WAGG;aACH;YACE,OAAO,IAAI,CAAC,UAAU,CAAA;QACxB,CAAC;aACD,UAAc,KAAa;YACzB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAA;QACzB,CAAC;;;OAHA;IAKD;;;;;;OAMG;IACH,8BAAU,GAAV,UAAW,KAAa;QACtB,IAAI,KAAK,GAAG,CAAC;YAAE,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;QACvC,IAAI,KAAK,GAAG,CAAC;YAAE,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;QACvC,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;IAC9B,CAAC;IAED;;;;OAIG;IACH,8BAAU,GAAV,UAAW,KAAa,EAAE,KAAoB;QAC5C,IAAI,KAAK,GAAG,CAAC;YAAE,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC5C,IAAI,KAAK,GAAG,CAAC;YAAE,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACnD,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACnC,CAAC;IAKD,sBAAI,uCAAgB;QAHpB;;WAEG;aACH;YACE,OAAO,IAAI,SAAS,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QACtD,CAAC;;;OAAA;IAED;;OAEG;IACH,oCAAgB,GAAhB;QACE,IAAM,UAAU,GAAG,IAAI,KAAK,EAAe,CAAA;QAC3C,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC;YACvC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAA;QACzC,CAAC;QACD,OAAO,UAAU,CAAA;IACnB,CAAC;IAED;;OAEG;IACH,wBAAI,GAAJ,UAAK,QAAsB;QACzB,IAAM,QAAQ,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAA;QACzD,IAAM,IAAI,GAAG,IAAI,UAAU,EAAE,CAAA;QAC7B,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QAClB,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE;YACzB,KAAK,EAAE,IAAI,CAAC,QAAQ;YACpB,SAAS,EAAE,IAAI;YACf,YAAY,EAAE,CAAC;YACf,YAAY,EAAE,EAAE;SACjB,CAAC,CAAA;IACJ,CAAC;IACH,gBAAC;AAAD,CAAC,AAxGD,CAA+B,SAAS,GAwGvC"}
+{"version":3,"file":"AcDbTrace.js","sourceRoot":"","sources":["../../src/entity/AcDbTrace.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,OAAO,EACL,UAAU,EACV,SAAS,EACT,WAAW,EAEX,cAAc,EACf,MAAM,4BAA4B,CAAA;AAGnC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAEvC;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH;IAA+B,6BAAS;IAQtC;;;;;;;;;;;;;;;OAeG;IACH;QACE,YAAA,MAAK,WAAE,SAAA;QACP,KAAI,CAAC,UAAU,GAAG,CAAC,CAAA;QACnB,KAAI,CAAC,UAAU,GAAG,CAAC,CAAA;QACnB,KAAI,CAAC,SAAS,GAAG;YACf,IAAI,WAAW,EAAE;YACjB,IAAI,WAAW,EAAE;YACjB,IAAI,WAAW,EAAE;YACjB,IAAI,WAAW,EAAE;SAClB,CAAA;;IACH,CAAC;IAgBD,sBAAI,gCAAS;QAdb;;;;;;;;;;;;;WAaG;aACH;YACE,OAAO,IAAI,CAAC,UAAU,CAAA;QACxB,CAAC;QAED;;;;;;;;;WASG;aACH,UAAc,KAAa;YACzB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAA;QACzB,CAAC;;;OAdA;IAuBD,sBAAI,6BAAM;QAPV;;;;;;WAMG;aACH;YACE,OAAO,IAAI,CAAA;QACb,CAAC;;;OAAA;IAgBD,sBAAI,gCAAS;QAdb;;;;;;;;;;;;;WAaG;aACH;YACE,OAAO,IAAI,CAAC,UAAU,CAAA;QACxB,CAAC;QAED;;;;;;;;;WASG;aACH,UAAc,KAAa;YACzB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAA;QACzB,CAAC;;;OAdA;IAgBD;;;;;;;;;;;;;;;OAeG;IACH,8BAAU,GAAV,UAAW,KAAa;QACtB,IAAI,KAAK,GAAG,CAAC;YAAE,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;QACvC,IAAI,KAAK,GAAG,CAAC;YAAE,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;QACvC,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;IAC9B,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,8BAAU,GAAV,UAAW,KAAa,EAAE,KAAoB;QAC5C,IAAI,KAAK,GAAG,CAAC;YAAE,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC5C,IAAI,KAAK,GAAG,CAAC;YAAE,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACnD,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACnC,CAAC;IAaD,sBAAI,uCAAgB;QAXpB;;;;;;;;;;WAUG;aACH;YACE,OAAO,IAAI,SAAS,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QACtD,CAAC;;;OAAA;IAED;;;;;;;;;;;;;OAaG;IACH,oCAAgB,GAAhB;QACE,IAAM,UAAU,GAAG,IAAI,KAAK,EAAe,CAAA;QAC3C,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC;YACvC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAA;QACzC,CAAC;QACD,OAAO,UAAU,CAAA;IACnB,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,wBAAI,GAAJ,UAAK,QAAsB;QACzB,IAAM,QAAQ,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAA;QACzD,IAAM,IAAI,GAAG,IAAI,UAAU,EAAE,CAAA;QAC7B,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QAClB,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE;YACzB,KAAK,EAAE,IAAI,CAAC,QAAQ;YACpB,SAAS,EAAE,IAAI;YACf,YAAY,EAAE,CAAC;YACf,YAAY,EAAE,EAAE;SACjB,CAAC,CAAA;IACJ,CAAC;IACH,gBAAC;AAAD,CAAC,AA1ND,CAA+B,SAAS,GA0NvC"}

package/lib/entity/AcDbViewport.d.ts

@@ -1,6 +1,28 @@
 import { AcGeBox3d, AcGePoint3d } from '@mlightcad/geometry-engine';
 import { AcGiEntity, AcGiRenderer, AcGiViewport } from '@mlightcad/graphic-interface';
 import { AcDbEntity } from './AcDbEntity';
+/**
+ * Represents a viewport entity in AutoCAD drawings.
+ *
+ * A viewport is a rectangular window that displays a portion of the drawing model space
+ * within paper space layouts. Viewports allow users to create multiple views of the same
+ * drawing at different scales and orientations on a single sheet.
+ *
+ * Key characteristics:
+ * - Viewports exist primarily in paper space layouts
+ * - Each viewport has a unique ID number (except the default system viewport with ID 1)
+ * - Viewports can be active or inactive
+ * - The viewport entity itself is drawn as a rectangular border in paper space
+ *
+ * @example
+ * ```typescript
+ * const viewport = new AcDbViewport();
+ * viewport.centerPoint = new AcGePoint3d(0, 0, 0);
+ * viewport.width = 10;
+ * viewport.height = 8;
+ * viewport.number = 2;
+ * ```
+ */
 export declare class AcDbViewport extends AcDbEntity {
     private _centerPoint;
     private _height;
@@ -8,51 +30,142 @@ export declare class AcDbViewport extends AcDbEntity {
     private _viewCenter;
     private _viewHeight;
     private _number;
+    /**
+     * Creates a new AcDbViewport instance.
+     *
+     * Initializes all properties with default values:
+     * - centerPoint: origin (0,0,0)
+     * - height: 0
+     * - width: 0
+     * - viewCenter: origin (0,0,0)
+     * - viewHeight: 0
+     * - number: -1 (indicating inactive viewport)
+     */
     constructor();
     /**
-     * The viewport ID number. This is the number that is reported by the AutoCAD CVPORT system variable
+     * Gets or sets the viewport ID number.
+     *
+     * This is the number that is reported by the AutoCAD CVPORT system variable
      * when the viewport is the current viewport in the AutoCAD editor. If the viewport is inactive, -1
      * is returned.
-     * This value is not saved with the drawing, and changes each time the drawing is opened.
+     *
+     * Important notes:
+     * - This value is not saved with the drawing, and changes each time the drawing is opened
+     * - Viewport ID 1 is reserved for the system-defined default viewport in paper space
+     * - Active viewports have IDs greater than 1
+     * - Inactive viewports return -1
+     *
+     * @returns The viewport ID number
      */
     get number(): number;
     set number(value: number);
     /**
-     * The center point of the viewport entity in WCS coordinates (within Paper Space).
+     * Gets or sets the center point of the viewport entity in WCS coordinates (within Paper Space).
+     *
+     * This point represents the geometric center of the viewport's rectangular boundary
+     * in paper space coordinates, not the center of the model space view within the viewport.
+     *
+     * @returns The center point of the viewport entity
      */
     get centerPoint(): AcGePoint3d;
     set centerPoint(value: AcGePoint3d);
     /**
-     * The height of the viewport entity's window in drawing units.
+     * Gets or sets the height of the viewport entity's window in drawing units.
+     *
+     * This represents the height of the viewport's rectangular boundary in paper space,
+     * measured in the current drawing units. It defines the vertical extent of the
+     * viewport border, not the height of the model space view within it.
+     *
+     * @returns The height of the viewport entity in drawing units
      */
     get height(): number;
     set height(value: number);
     /**
-     * The width of the viewport entity's window in drawing units. This is the width in Paper Space
-     * of the viewport itself, not the width of the Model Space view within the viewport.
+     * Gets or sets the width of the viewport entity's window in drawing units.
+     *
+     * This represents the width of the viewport's rectangular boundary in paper space,
+     * measured in the current drawing units. It defines the horizontal extent of the
+     * viewport border, not the width of the model space view within the viewport.
+     *
+     * Note: This is the width in Paper Space of the viewport itself, not the width
+     * of the Model Space view within the viewport.
+     *
+     * @returns The width of the viewport entity in drawing units
      */
     get width(): number;
     set width(value: number);
     /**
-     * The view center (in display coordinate system coordinates) of the view in the viewport.
+     * Gets or sets the view center in display coordinate system coordinates.
+     *
+     * This point represents the center of the model space view that is displayed
+     * within the viewport. It is specified in the display coordinate system and
+     * determines what portion of the model space drawing is visible in the viewport.
+     *
+     * @returns The center point of the model space view within the viewport
      */
     get viewCenter(): AcGePoint3d;
     set viewCenter(value: AcGePoint3d);
     /**
-     * The height (in display coordinate system coordinates) of the Model Space view within the viewport.
-     * Zooming the view out within the viewport increases this value and zooming in decreases this value.
+     * Gets or sets the height of the Model Space view within the viewport.
+     *
+     * This value represents the height of the model space view that is displayed
+     * within the viewport, specified in display coordinate system coordinates.
+     *
+     * Zoom behavior:
+     * - Zooming the view out within the viewport increases this value
+     * - Zooming the view in within the viewport decreases this value
+     *
+     * @returns The height of the model space view in display coordinates
      */
     get viewHeight(): number;
     set viewHeight(value: number);
     /**
+     * Gets the geometric extents of the viewport entity.
+     *
+     * This method returns a bounding box that encompasses the entire viewport entity
+     * in world coordinate system (WCS) coordinates.
+     *
+     * @returns A bounding box containing the viewport entity
      * @inheritdoc
      */
     get geometricExtents(): AcGeBox3d;
     /**
+     * Renders the viewport entity using the specified renderer.
+     *
+     * The viewport is drawn as a rectangular border when the following conditions are met:
+     * - The viewport entity is not in model space (i.e., it's in paper space)
+     * - The viewport ID number is greater than 1 (not the default system viewport)
+     *
+     * In paper space layouts, there is always a system-defined "default" viewport that exists as
+     * the bottom-most item. This viewport doesn't show any entities and is mainly for internal
+     * AutoCAD purposes. The viewport ID number of this system-defined "default" viewport is 1.
+     *
+     * @param renderer - The renderer to use for drawing the viewport
+     * @returns A render group containing the viewport border lines, or undefined if not drawn
      * @inheritdoc
      */
     draw(renderer: AcGiRenderer): AcGiEntity | undefined;
+    /**
+     * Converts this AcDbViewport to an AcGiViewport for rendering purposes.
+     *
+     * This method creates a graphic interface viewport object that contains all the
+     * necessary properties for rendering the viewport in the graphics system.
+     *
+     * @returns An AcGiViewport instance with all viewport properties copied
+     */
     toGiViewport(): AcGiViewport;
+    /**
+     * Creates the rectangular border lines for the viewport.
+     *
+     * This private method generates four line entities that form a rectangle representing
+     * the viewport's boundary. The rectangle is centered on the viewport's center point
+     * and has dimensions specified by the viewport's width and height.
+     *
+     * @param viewport - The graphic interface viewport containing rendering properties
+     * @param renderer - The renderer to use for creating the line entities
+     * @returns An array of line entities forming the viewport border
+     * @private
+     */
     private createViewportRect;
 }
 //# sourceMappingURL=AcDbViewport.d.ts.map

package/lib/entity/AcDbViewport.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AcDbViewport.d.ts","sourceRoot":"","sources":["../../src/entity/AcDbViewport.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAA;AACnE,OAAO,EACL,UAAU,EACV,YAAY,EACZ,YAAY,EACb,MAAM,8BAA8B,CAAA;AAErC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAEzC,qBAAa,YAAa,SAAQ,UAAU;IAC1C,OAAO,CAAC,YAAY,CAAa;IACjC,OAAO,CAAC,OAAO,CAAQ;IACvB,OAAO,CAAC,MAAM,CAAQ;IACtB,OAAO,CAAC,WAAW,CAAa;IAChC,OAAO,CAAC,WAAW,CAAQ;IAC3B,OAAO,CAAC,OAAO,CAAQ;;IAYvB;;;;;OAKG;IACH,IAAI,MAAM,IAGQ,MAAM,CADvB;IACD,IAAI,MAAM,CAAC,KAAK,EAAE,MAAM,EAEvB;IAED;;OAEG;IACH,IAAI,WAAW,IAGQ,WAAW,CADjC;IACD,IAAI,WAAW,CAAC,KAAK,EAAE,WAAW,EAEjC;IAED;;OAEG;IACH,IAAI,MAAM,IAGQ,MAAM,CADvB;IACD,IAAI,MAAM,CAAC,KAAK,EAAE,MAAM,EAEvB;IAED;;;OAGG;IACH,IAAI,KAAK,IAGQ,MAAM,CADtB;IACD,IAAI,KAAK,CAAC,KAAK,EAAE,MAAM,EAEtB;IAED;;OAEG;IACH,IAAI,UAAU,IAGQ,WAAW,CADhC;IACD,IAAI,UAAU,CAAC,KAAK,EAAE,WAAW,EAEhC;IAED;;;OAGG;IACH,IAAI,UAAU,IAGQ,MAAM,CAD3B;IACD,IAAI,UAAU,CAAC,KAAK,EAAE,MAAM,EAE3B;IAED;;OAEG;IACH,IAAI,gBAAgB,IAAI,SAAS,CAGhC;IAED;;OAEG;IACH,IAAI,CAAC,QAAQ,EAAE,YAAY;IAmB3B,YAAY;IAaZ,OAAO,CAAC,kBAAkB;CAwE3B"}
+{"version":3,"file":"AcDbViewport.d.ts","sourceRoot":"","sources":["../../src/entity/AcDbViewport.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAA;AACnE,OAAO,EACL,UAAU,EACV,YAAY,EACZ,YAAY,EACb,MAAM,8BAA8B,CAAA;AAErC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAEzC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,YAAa,SAAQ,UAAU;IAC1C,OAAO,CAAC,YAAY,CAAa;IACjC,OAAO,CAAC,OAAO,CAAQ;IACvB,OAAO,CAAC,MAAM,CAAQ;IACtB,OAAO,CAAC,WAAW,CAAa;IAChC,OAAO,CAAC,WAAW,CAAQ;IAC3B,OAAO,CAAC,OAAO,CAAQ;IAEvB;;;;;;;;;;OAUG;;IAWH;;;;;;;;;;;;;;OAcG;IACH,IAAI,MAAM,IAGQ,MAAM,CADvB;IACD,IAAI,MAAM,CAAC,KAAK,EAAE,MAAM,EAEvB;IAED;;;;;;;OAOG;IACH,IAAI,WAAW,IAGQ,WAAW,CADjC;IACD,IAAI,WAAW,CAAC,KAAK,EAAE,WAAW,EAEjC;IAED;;;;;;;;OAQG;IACH,IAAI,MAAM,IAGQ,MAAM,CADvB;IACD,IAAI,MAAM,CAAC,KAAK,EAAE,MAAM,EAEvB;IAED;;;;;;;;;;;OAWG;IACH,IAAI,KAAK,IAGQ,MAAM,CADtB;IACD,IAAI,KAAK,CAAC,KAAK,EAAE,MAAM,EAEtB;IAED;;;;;;;;OAQG;IACH,IAAI,UAAU,IAGQ,WAAW,CADhC;IACD,IAAI,UAAU,CAAC,KAAK,EAAE,WAAW,EAEhC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,UAAU,IAGQ,MAAM,CAD3B;IACD,IAAI,UAAU,CAAC,KAAK,EAAE,MAAM,EAE3B;IAED;;;;;;;;OAQG;IACH,IAAI,gBAAgB,IAAI,SAAS,CAGhC;IAED;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,QAAQ,EAAE,YAAY;IAmB3B;;;;;;;OAOG;IACH,YAAY;IAaZ;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,kBAAkB;CAwE3B"}