@mlightcad/data-model 1.1.2 → 1.1.4

package/lib/entity/AcDbRay.d.ts

@@ -2,40 +2,146 @@ import { AcGeBox3d, AcGePoint3d } from '@mlightcad/geometry-engine';
 import { AcGiRenderer } from '@mlightcad/graphic-interface';
 import { AcDbCurve } from './AcDbCurve';
 /**
- * The class represents the RAY entity type within AutoCAD. An xline entity is a line that extends to
- * infinity in both directions.
+ * Represents a ray entity in AutoCAD.
+ *
+ * A ray is a 3D geometric object that extends infinitely in one direction from a base point.
+ * Rays are commonly used for construction lines, reference lines, and temporary geometry.
+ * Unlike lines, rays have no end point and extend to infinity.
+ *
+ * @example
+ * ```typescript
+ * // Create a ray from origin in the positive X direction
+ * const ray = new AcDbRay();
+ * ray.basePoint = new AcGePoint3d(0, 0, 0);
+ * ray.unitDir = new AcGeVector3d(1, 0, 0);
+ *
+ * // Access ray properties
+ * console.log(`Base point: ${ray.basePoint}`);
+ * console.log(`Unit direction: ${ray.unitDir}`);
+ * ```
  */
 export declare class AcDbRay extends AcDbCurve {
+    /** The base point of the ray */
     private _basePoint;
+    /** The unit direction vector of the ray */
     private _unitDir;
     /**
-     * Create one empty polyline
+     * Creates a new ray entity.
+     *
+     * This constructor initializes a ray with default values.
+     * The base point is at the origin and the unit direction is undefined.
+     *
+     * @example
+     * ```typescript
+     * const ray = new AcDbRay();
+     * ray.basePoint = new AcGePoint3d(5, 10, 0);
+     * ray.unitDir = new AcGeVector3d(0, 1, 0); // Positive Y direction
+     * ```
      */
     constructor();
     /**
-     * The base point of the xline.
+     * Gets the base point of this ray.
+     *
+     * The base point is the starting point from which the ray extends infinitely.
+     *
+     * @returns The base point as a 3D point
+     *
+     * @example
+     * ```typescript
+     * const basePoint = ray.basePoint;
+     * console.log(`Ray base point: ${basePoint.x}, ${basePoint.y}, ${basePoint.z}`);
+     * ```
      */
     get basePoint(): AcGePoint3d;
+    /**
+     * Sets the base point of this ray.
+     *
+     * @param value - The new base point
+     *
+     * @example
+     * ```typescript
+     * ray.basePoint = new AcGePoint3d(10, 20, 0);
+     * ```
+     */
     set basePoint(value: AcGePoint3d);
     /**
-     * The second point of the xline.
+     * Gets the unit direction vector of this ray.
+     *
+     * The unit direction vector defines the direction in which the ray extends
+     * infinitely from the base point.
+     *
+     * @returns The unit direction vector
+     *
+     * @example
+     * ```typescript
+     * const unitDir = ray.unitDir;
+     * console.log(`Ray direction: ${unitDir.x}, ${unitDir.y}, ${unitDir.z}`);
+     * ```
      */
     get unitDir(): AcGePoint3d;
+    /**
+     * Sets the unit direction vector of this ray.
+     *
+     * @param value - The new unit direction vector
+     *
+     * @example
+     * ```typescript
+     * ray.unitDir = new AcGeVector3d(0, 0, 1); // Positive Z direction
+     * ```
+     */
     set unitDir(value: AcGePoint3d);
     /**
-     * @inheritdoc
+     * Gets whether this ray is closed.
+     *
+     * Rays are always open entities, so this always returns false.
+     *
+     * @returns Always false for rays
      */
     get closed(): boolean;
     /**
-     * @inheritdoc
+     * Gets the geometric extents (bounding box) of this ray.
+     *
+     * Since rays extend infinitely, this method returns a bounding box that
+     * encompasses a finite portion of the ray for practical purposes.
+     *
+     * @returns The bounding box that encompasses a portion of the ray
+     *
+     * @example
+     * ```typescript
+     * const extents = ray.geometricExtents;
+     * console.log(`Ray bounds: ${extents.minPoint} to ${extents.maxPoint}`);
+     * ```
      */
     get geometricExtents(): AcGeBox3d;
     /**
-     * @inheritdoc
+     * Gets the grip points for this ray.
+     *
+     * Grip points are control points that can be used to modify the ray.
+     * For a ray, the grip point is the base point.
+     *
+     * @returns Array of grip points (base point)
+     *
+     * @example
+     * ```typescript
+     * const gripPoints = ray.subGetGripPoints();
+     * // gripPoints contains: [basePoint]
+     * ```
      */
     subGetGripPoints(): AcGePoint3d[];
     /**
-     * @inheritdoc
+     * Draws this ray using the specified renderer.
+     *
+     * This method renders the ray as a line segment extending from the base point
+     * in the direction of the unit vector. For practical purposes, the ray is
+     * drawn with a finite length.
+     *
+     * @param renderer - The renderer to use for drawing
+     * @returns The rendered ray entity, or undefined if drawing failed
+     *
+     * @example
+     * ```typescript
+     * const renderedRay = ray.draw(renderer);
+     * ```
      */
     draw(renderer: AcGiRenderer): import("@mlightcad/graphic-interface").AcGiEntity;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"AcDbRay.d.ts","sourceRoot":"","sources":["../../src/entity/AcDbRay.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,WAAW,EAEZ,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAA;AAE3D,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAEvC;;;GAGG;AACH,qBAAa,OAAQ,SAAQ,SAAS;IACpC,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,QAAQ,CAAc;IAE9B;;OAEG;;IAOH;;OAEG;IACH,IAAI,SAAS,IAGQ,WAAW,CAD/B;IACD,IAAI,SAAS,CAAC,KAAK,EAAE,WAAW,EAE/B;IAED;;OAEG;IACH,IAAI,OAAO,IAGQ,WAAW,CAD7B;IACD,IAAI,OAAO,CAAC,KAAK,EAAE,WAAW,EAE7B;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED;;OAEG;IACH,IAAI,gBAAgB,IAAI,SAAS,CAShC;IAED;;OAEG;IACH,gBAAgB;IAMhB;;OAEG;IACH,IAAI,CAAC,QAAQ,EAAE,YAAY;CAQ5B"}
+{"version":3,"file":"AcDbRay.d.ts","sourceRoot":"","sources":["../../src/entity/AcDbRay.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,WAAW,EAEZ,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAA;AAE3D,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAEvC;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,OAAQ,SAAQ,SAAS;IACpC,gCAAgC;IAChC,OAAO,CAAC,UAAU,CAAa;IAC/B,2CAA2C;IAC3C,OAAO,CAAC,QAAQ,CAAc;IAE9B;;;;;;;;;;;;OAYG;;IAOH;;;;;;;;;;;;OAYG;IACH,IAAI,SAAS,IAcQ,WAAW,CAZ/B;IAED;;;;;;;;;OASG;IACH,IAAI,SAAS,CAAC,KAAK,EAAE,WAAW,EAE/B;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,OAAO,IAcQ,WAAW,CAZ7B;IAED;;;;;;;;;OASG;IACH,IAAI,OAAO,CAAC,KAAK,EAAE,WAAW,EAE7B;IAED;;;;;;OAMG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,gBAAgB,IAAI,SAAS,CAShC;IAED;;;;;;;;;;;;;OAaG;IACH,gBAAgB;IAMhB;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,QAAQ,EAAE,YAAY;CAQ5B"}

package/lib/entity/AcDbRay.js

@@ -16,13 +16,38 @@ var __extends = (this && this.__extends) || (function () {
 import { AcGeBox3d, AcGePoint3d, AcGeVector3d } from '@mlightcad/geometry-engine';
 import { AcDbCurve } from './AcDbCurve';
 /**
- * The class represents the RAY entity type within AutoCAD. An xline entity is a line that extends to
- * infinity in both directions.
+ * Represents a ray entity in AutoCAD.
+ *
+ * A ray is a 3D geometric object that extends infinitely in one direction from a base point.
+ * Rays are commonly used for construction lines, reference lines, and temporary geometry.
+ * Unlike lines, rays have no end point and extend to infinity.
+ *
+ * @example
+ * ```typescript
+ * // Create a ray from origin in the positive X direction
+ * const ray = new AcDbRay();
+ * ray.basePoint = new AcGePoint3d(0, 0, 0);
+ * ray.unitDir = new AcGeVector3d(1, 0, 0);
+ *
+ * // Access ray properties
+ * console.log(`Base point: ${ray.basePoint}`);
+ * console.log(`Unit direction: ${ray.unitDir}`);
+ * ```
  */
 var AcDbRay = /** @class */ (function (_super) {
     __extends(AcDbRay, _super);
     /**
-     * Create one empty polyline
+     * Creates a new ray entity.
+     *
+     * This constructor initializes a ray with default values.
+     * The base point is at the origin and the unit direction is undefined.
+     *
+     * @example
+     * ```typescript
+     * const ray = new AcDbRay();
+     * ray.basePoint = new AcGePoint3d(5, 10, 0);
+     * ray.unitDir = new AcGeVector3d(0, 1, 0); // Positive Y direction
+     * ```
      */
     function AcDbRay() {
         var _this = _super.call(this) || this;
@@ -32,11 +57,31 @@ var AcDbRay = /** @class */ (function (_super) {
     }
     Object.defineProperty(AcDbRay.prototype, "basePoint", {
         /**
-         * The base point of the xline.
+         * Gets the base point of this ray.
+         *
+         * The base point is the starting point from which the ray extends infinitely.
+         *
+         * @returns The base point as a 3D point
+         *
+         * @example
+         * ```typescript
+         * const basePoint = ray.basePoint;
+         * console.log(`Ray base point: ${basePoint.x}, ${basePoint.y}, ${basePoint.z}`);
+         * ```
          */
         get: function () {
             return this._basePoint;
         },
+        /**
+         * Sets the base point of this ray.
+         *
+         * @param value - The new base point
+         *
+         * @example
+         * ```typescript
+         * ray.basePoint = new AcGePoint3d(10, 20, 0);
+         * ```
+         */
         set: function (value) {
             this._basePoint.copy(value);
         },
@@ -45,11 +90,32 @@ var AcDbRay = /** @class */ (function (_super) {
     });
     Object.defineProperty(AcDbRay.prototype, "unitDir", {
         /**
-         * The second point of the xline.
+         * Gets the unit direction vector of this ray.
+         *
+         * The unit direction vector defines the direction in which the ray extends
+         * infinitely from the base point.
+         *
+         * @returns The unit direction vector
+         *
+         * @example
+         * ```typescript
+         * const unitDir = ray.unitDir;
+         * console.log(`Ray direction: ${unitDir.x}, ${unitDir.y}, ${unitDir.z}`);
+         * ```
          */
         get: function () {
             return this._unitDir;
         },
+        /**
+         * Sets the unit direction vector of this ray.
+         *
+         * @param value - The new unit direction vector
+         *
+         * @example
+         * ```typescript
+         * ray.unitDir = new AcGeVector3d(0, 0, 1); // Positive Z direction
+         * ```
+         */
         set: function (value) {
             this._unitDir.copy(value);
         },
@@ -58,7 +124,11 @@ var AcDbRay = /** @class */ (function (_super) {
     });
     Object.defineProperty(AcDbRay.prototype, "closed", {
         /**
-         * @inheritdoc
+         * Gets whether this ray is closed.
+         *
+         * Rays are always open entities, so this always returns false.
+         *
+         * @returns Always false for rays
          */
         get: function () {
             return false;
@@ -68,7 +138,18 @@ var AcDbRay = /** @class */ (function (_super) {
     });
     Object.defineProperty(AcDbRay.prototype, "geometricExtents", {
         /**
-         * @inheritdoc
+         * Gets the geometric extents (bounding box) of this ray.
+         *
+         * Since rays extend infinitely, this method returns a bounding box that
+         * encompasses a finite portion of the ray for practical purposes.
+         *
+         * @returns The bounding box that encompasses a portion of the ray
+         *
+         * @example
+         * ```typescript
+         * const extents = ray.geometricExtents;
+         * console.log(`Ray bounds: ${extents.minPoint} to ${extents.maxPoint}`);
+         * ```
          */
         get: function () {
             var extents = new AcGeBox3d();
@@ -80,7 +161,18 @@ var AcDbRay = /** @class */ (function (_super) {
         configurable: true
     });
     /**
-     * @inheritdoc
+     * Gets the grip points for this ray.
+     *
+     * Grip points are control points that can be used to modify the ray.
+     * For a ray, the grip point is the base point.
+     *
+     * @returns Array of grip points (base point)
+     *
+     * @example
+     * ```typescript
+     * const gripPoints = ray.subGetGripPoints();
+     * // gripPoints contains: [basePoint]
+     * ```
      */
     AcDbRay.prototype.subGetGripPoints = function () {
         var gripPoints = new Array();
@@ -88,7 +180,19 @@ var AcDbRay = /** @class */ (function (_super) {
         return gripPoints;
     };
     /**
-     * @inheritdoc
+     * Draws this ray using the specified renderer.
+     *
+     * This method renders the ray as a line segment extending from the base point
+     * in the direction of the unit vector. For practical purposes, the ray is
+     * drawn with a finite length.
+     *
+     * @param renderer - The renderer to use for drawing
+     * @returns The rendered ray entity, or undefined if drawing failed
+     *
+     * @example
+     * ```typescript
+     * const renderedRay = ray.draw(renderer);
+     * ```
      */
     AcDbRay.prototype.draw = function (renderer) {
         var points = [];

package/lib/entity/AcDbRay.js.map

@@ -1 +1 @@
-{"version":3,"file":"AcDbRay.js","sourceRoot":"","sources":["../../src/entity/AcDbRay.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,OAAO,EACL,SAAS,EACT,WAAW,EACX,YAAY,EACb,MAAM,4BAA4B,CAAA;AAGnC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAEvC;;;GAGG;AACH;IAA6B,2BAAS;IAIpC;;OAEG;IACH;QACE,YAAA,MAAK,WAAE,SAAA;QACP,KAAI,CAAC,UAAU,GAAG,IAAI,WAAW,EAAE,CAAA;QACnC,KAAI,CAAC,QAAQ,GAAG,IAAI,YAAY,EAAE,CAAA;;IACpC,CAAC;IAKD,sBAAI,8BAAS;QAHb;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,UAAU,CAAA;QACxB,CAAC;aACD,UAAc,KAAkB;YAC9B,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC7B,CAAC;;;OAHA;IAQD,sBAAI,4BAAO;QAHX;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,QAAQ,CAAA;QACtB,CAAC;aACD,UAAY,KAAkB;YAC5B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC3B,CAAC;;;OAHA;IAQD,sBAAI,2BAAM;QAHV;;WAEG;aACH;YACE,OAAO,KAAK,CAAA;QACd,CAAC;;;OAAA;IAKD,sBAAI,qCAAgB;QAHpB;;WAEG;aACH;YACE,IAAM,OAAO,GAAG,IAAI,SAAS,EAAE,CAAA;YAC/B,OAAO,CAAC,aAAa,CACnB,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAC9D,CAAA;YACD,OAAO,CAAC,aAAa,CACnB,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAC/D,CAAA;YACD,OAAO,OAAO,CAAA;QAChB,CAAC;;;OAAA;IAED;;OAEG;IACH,kCAAgB,GAAhB;QACE,IAAM,UAAU,GAAG,IAAI,KAAK,EAAe,CAAA;QAC3C,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QAC/B,OAAO,UAAU,CAAA;IACnB,CAAC;IAED;;OAEG;IACH,sBAAI,GAAJ,UAAK,QAAsB;QACzB,IAAM,MAAM,GAAkB,EAAE,CAAA;QAChC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QAC3B,MAAM,CAAC,IAAI,CACT,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CACnE,CAAA;QACD,OAAO,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,CAAA;IAC/C,CAAC;IACH,cAAC;AAAD,CAAC,AA1ED,CAA6B,SAAS,GA0ErC"}
+{"version":3,"file":"AcDbRay.js","sourceRoot":"","sources":["../../src/entity/AcDbRay.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,OAAO,EACL,SAAS,EACT,WAAW,EACX,YAAY,EACb,MAAM,4BAA4B,CAAA;AAGnC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAEvC;;;;;;;;;;;;;;;;;;GAkBG;AACH;IAA6B,2BAAS;IAMpC;;;;;;;;;;;;OAYG;IACH;QACE,YAAA,MAAK,WAAE,SAAA;QACP,KAAI,CAAC,UAAU,GAAG,IAAI,WAAW,EAAE,CAAA;QACnC,KAAI,CAAC,QAAQ,GAAG,IAAI,YAAY,EAAE,CAAA;;IACpC,CAAC;IAeD,sBAAI,8BAAS;QAbb;;;;;;;;;;;;WAYG;aACH;YACE,OAAO,IAAI,CAAC,UAAU,CAAA;QACxB,CAAC;QAED;;;;;;;;;WASG;aACH,UAAc,KAAkB;YAC9B,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC7B,CAAC;;;OAdA;IA8BD,sBAAI,4BAAO;QAdX;;;;;;;;;;;;;WAaG;aACH;YACE,OAAO,IAAI,CAAC,QAAQ,CAAA;QACtB,CAAC;QAED;;;;;;;;;WASG;aACH,UAAY,KAAkB;YAC5B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC3B,CAAC;;;OAdA;IAuBD,sBAAI,2BAAM;QAPV;;;;;;WAMG;aACH;YACE,OAAO,KAAK,CAAA;QACd,CAAC;;;OAAA;IAgBD,sBAAI,qCAAgB;QAdpB;;;;;;;;;;;;;WAaG;aACH;YACE,IAAM,OAAO,GAAG,IAAI,SAAS,EAAE,CAAA;YAC/B,OAAO,CAAC,aAAa,CACnB,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAC9D,CAAA;YACD,OAAO,CAAC,aAAa,CACnB,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAC/D,CAAA;YACD,OAAO,OAAO,CAAA;QAChB,CAAC;;;OAAA;IAED;;;;;;;;;;;;;OAaG;IACH,kCAAgB,GAAhB;QACE,IAAM,UAAU,GAAG,IAAI,KAAK,EAAe,CAAA;QAC3C,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QAC/B,OAAO,UAAU,CAAA;IACnB,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,sBAAI,GAAJ,UAAK,QAAsB;QACzB,IAAM,MAAM,GAAkB,EAAE,CAAA;QAChC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QAC3B,MAAM,CAAC,IAAI,CACT,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CACnE,CAAA;QACD,OAAO,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,CAAA;IAC/C,CAAC;IACH,cAAC;AAAD,CAAC,AAvKD,CAA6B,SAAS,GAuKrC"}

package/lib/entity/AcDbSpline.d.ts

@@ -2,37 +2,129 @@ import { AcGeKnotParameterizationType, AcGePoint3dLike } from '@mlightcad/geomet
 import { AcGiRenderer } from '@mlightcad/graphic-interface';
 import { AcDbCurve } from './AcDbCurve';
 /**
- * The class represents the spline entity in AutoCAD.
+ * Represents a spline entity in AutoCAD.
+ *
+ * A spline is a 3D geometric object defined by control points or fit points.
+ * Splines are smooth curves that can be used to create complex curved shapes
+ * in drawings. They can be either open or closed curves.
+ *
+ * @example
+ * ```typescript
+ * // Create a spline from control points
+ * const controlPoints = [
+ *   new AcGePoint3d(0, 0, 0),
+ *   new AcGePoint3d(5, 5, 0),
+ *   new AcGePoint3d(10, 0, 0)
+ * ];
+ * const knots = [0, 0, 0, 1, 1, 1];
+ * const spline = new AcDbSpline(controlPoints, knots);
+ *
+ * // Create a spline from fit points
+ * const fitPoints = [
+ *   new AcGePoint3d(0, 0, 0),
+ *   new AcGePoint3d(5, 5, 0),
+ *   new AcGePoint3d(10, 0, 0)
+ * ];
+ * const spline2 = new AcDbSpline(fitPoints, AcGeKnotParameterizationType.Uniform);
+ * ```
  */
 export declare class AcDbSpline extends AcDbCurve {
+    /** The underlying geometric spline object */
     private _geo;
     /**
-     * Construct an instance of the spline entity.
-     * @param controlPoints Input an array of control points (in WCS coordinates) of the spline
-     * @param knots Input an array of numbers that specifies the knot values of the spline
-     * @param weights Input an array of doubles that specifies the weights at each control point.
-     * Default weight of 1 if weights are not provided
-     * @param closed Whether the spline should be closed. Default is false
+     * Creates a new spline entity from control points.
+     *
+     * This constructor creates a spline using the specified control points, knots,
+     * and optional weights. The control points must be in World Coordinate System (WCS) coordinates.
+     *
+     * @param controlPoints - Array of control points in WCS coordinates
+     * @param knots - Array of knot values that define the spline's parameterization
+     * @param weights - Optional array of weights for each control point (default: 1 for all)
+     * @param closed - Whether the spline should be closed (default: false)
+     *
+     * @example
+     * ```typescript
+     * const controlPoints = [
+     *   new AcGePoint3d(0, 0, 0),
+     *   new AcGePoint3d(5, 5, 0),
+     *   new AcGePoint3d(10, 0, 0)
+     * ];
+     * const knots = [0, 0, 0, 1, 1, 1];
+     * const spline = new AcDbSpline(controlPoints, knots);
+     * ```
      */
     constructor(controlPoints: AcGePoint3dLike[], knots: number[], weights?: number[], closed?: boolean);
     /**
-     * Construct an instance of the spline entity.
-     * @param fitPoints Input an array of points (in WCS coordinates) through which to fit the curve
-     * @param knotParam Input knot parameterization which define the knot values
-     * @param closed Whether the spline should be closed. Default is false
+     * Creates a new spline entity from fit points.
+     *
+     * This constructor creates a spline that passes through the specified fit points.
+     * The fit points must be in World Coordinate System (WCS) coordinates.
+     *
+     * @param fitPoints - Array of fit points in WCS coordinates
+     * @param knotParam - Knot parameterization type that defines how knots are generated
+     * @param closed - Whether the spline should be closed (default: false)
+     *
+     * @example
+     * ```typescript
+     * const fitPoints = [
+     *   new AcGePoint3d(0, 0, 0),
+     *   new AcGePoint3d(5, 5, 0),
+     *   new AcGePoint3d(10, 0, 0)
+     * ];
+     * const spline = new AcDbSpline(fitPoints, AcGeKnotParameterizationType.Uniform);
+     * ```
      */
     constructor(fitPoints: AcGePoint3dLike[], knotParam: AcGeKnotParameterizationType, closed?: boolean);
     /**
-     * @inheritdoc
+     * Gets the geometric extents (bounding box) of this spline.
+     *
+     * @returns The bounding box that encompasses the entire spline
+     *
+     * @example
+     * ```typescript
+     * const extents = spline.geometricExtents;
+     * console.log(`Spline bounds: ${extents.minPoint} to ${extents.maxPoint}`);
+     * ```
      */
     get geometricExtents(): import("@mlightcad/geometry-engine").AcGeBox3d;
     /**
-     * @inheritdoc
+     * Gets whether this spline is closed.
+     *
+     * A closed spline forms a complete loop where the end point connects to the start point.
+     *
+     * @returns True if the spline is closed, false otherwise
+     *
+     * @example
+     * ```typescript
+     * const isClosed = spline.closed;
+     * console.log(`Spline is closed: ${isClosed}`);
+     * ```
      */
     get closed(): boolean;
+    /**
+     * Sets whether this spline is closed.
+     *
+     * @param value - True to close the spline, false to open it
+     *
+     * @example
+     * ```typescript
+     * spline.closed = true; // Close the spline
+     * ```
+     */
     set closed(value: boolean);
     /**
-     * @inheritdoc
+     * Draws this spline using the specified renderer.
+     *
+     * This method renders the spline as a series of connected line segments
+     * using the spline's current style properties.
+     *
+     * @param renderer - The renderer to use for drawing
+     * @returns The rendered spline entity, or undefined if drawing failed
+     *
+     * @example
+     * ```typescript
+     * const renderedSpline = spline.draw(renderer);
+     * ```
      */
     draw(renderer: AcGiRenderer): import("@mlightcad/graphic-interface").AcGiEntity;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"AcDbSpline.d.ts","sourceRoot":"","sources":["../../src/entity/AcDbSpline.ts"],"names":[],"mappings":"AACA,OAAO,EACL,4BAA4B,EAC5B,eAAe,EAEhB,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAA;AAE3D,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAEvC;;GAEG;AACH,qBAAa,UAAW,SAAQ,SAAS;IACvC,OAAO,CAAC,IAAI,CAAc;IAE1B;;;;;;;OAOG;gBAED,aAAa,EAAE,eAAe,EAAE,EAChC,KAAK,EAAE,MAAM,EAAE,EACf,OAAO,CAAC,EAAE,MAAM,EAAE,EAClB,MAAM,CAAC,EAAE,OAAO;IAElB;;;;;OAKG;gBAED,SAAS,EAAE,eAAe,EAAE,EAC5B,SAAS,EAAE,4BAA4B,EACvC,MAAM,CAAC,EAAE,OAAO;IAiClB;;OAEG;IACH,IAAI,gBAAgB,mDAEnB;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;IACD,IAAI,MAAM,CAAC,KAAK,EAAE,OAAO,EAExB;IAED;;OAEG;IACH,IAAI,CAAC,QAAQ,EAAE,YAAY;CAI5B"}
+{"version":3,"file":"AcDbSpline.d.ts","sourceRoot":"","sources":["../../src/entity/AcDbSpline.ts"],"names":[],"mappings":"AACA,OAAO,EACL,4BAA4B,EAC5B,eAAe,EAEhB,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAA;AAE3D,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAEvC;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBAAa,UAAW,SAAQ,SAAS;IACvC,6CAA6C;IAC7C,OAAO,CAAC,IAAI,CAAc;IAE1B;;;;;;;;;;;;;;;;;;;;;OAqBG;gBAED,aAAa,EAAE,eAAe,EAAE,EAChC,KAAK,EAAE,MAAM,EAAE,EACf,OAAO,CAAC,EAAE,MAAM,EAAE,EAClB,MAAM,CAAC,EAAE,OAAO;IAElB;;;;;;;;;;;;;;;;;;;OAmBG;gBAED,SAAS,EAAE,eAAe,EAAE,EAC5B,SAAS,EAAE,4BAA4B,EACvC,MAAM,CAAC,EAAE,OAAO;IAiClB;;;;;;;;;;OAUG;IACH,IAAI,gBAAgB,mDAEnB;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED;;;;;;;;;OASG;IACH,IAAI,MAAM,CAAC,KAAK,EAAE,OAAO,EAExB;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,QAAQ,EAAE,YAAY;CAI5B"}

package/lib/entity/AcDbSpline.js

@@ -17,7 +17,31 @@ import { AcCmErrors } from '@mlightcad/common';
 import { AcGeSpline3d } from '@mlightcad/geometry-engine';
 import { AcDbCurve } from './AcDbCurve';
 /**
- * The class represents the spline entity in AutoCAD.
+ * Represents a spline entity in AutoCAD.
+ *
+ * A spline is a 3D geometric object defined by control points or fit points.
+ * Splines are smooth curves that can be used to create complex curved shapes
+ * in drawings. They can be either open or closed curves.
+ *
+ * @example
+ * ```typescript
+ * // Create a spline from control points
+ * const controlPoints = [
+ *   new AcGePoint3d(0, 0, 0),
+ *   new AcGePoint3d(5, 5, 0),
+ *   new AcGePoint3d(10, 0, 0)
+ * ];
+ * const knots = [0, 0, 0, 1, 1, 1];
+ * const spline = new AcDbSpline(controlPoints, knots);
+ *
+ * // Create a spline from fit points
+ * const fitPoints = [
+ *   new AcGePoint3d(0, 0, 0),
+ *   new AcGePoint3d(5, 5, 0),
+ *   new AcGePoint3d(10, 0, 0)
+ * ];
+ * const spline2 = new AcDbSpline(fitPoints, AcGeKnotParameterizationType.Uniform);
+ * ```
  */
 var AcDbSpline = /** @class */ (function (_super) {
     __extends(AcDbSpline, _super);
@@ -42,7 +66,15 @@ var AcDbSpline = /** @class */ (function (_super) {
     }
     Object.defineProperty(AcDbSpline.prototype, "geometricExtents", {
         /**
-         * @inheritdoc
+         * Gets the geometric extents (bounding box) of this spline.
+         *
+         * @returns The bounding box that encompasses the entire spline
+         *
+         * @example
+         * ```typescript
+         * const extents = spline.geometricExtents;
+         * console.log(`Spline bounds: ${extents.minPoint} to ${extents.maxPoint}`);
+         * ```
          */
         get: function () {
             return this._geo.box;
@@ -52,11 +84,31 @@ var AcDbSpline = /** @class */ (function (_super) {
     });
     Object.defineProperty(AcDbSpline.prototype, "closed", {
         /**
-         * @inheritdoc
+         * Gets whether this spline is closed.
+         *
+         * A closed spline forms a complete loop where the end point connects to the start point.
+         *
+         * @returns True if the spline is closed, false otherwise
+         *
+         * @example
+         * ```typescript
+         * const isClosed = spline.closed;
+         * console.log(`Spline is closed: ${isClosed}`);
+         * ```
          */
         get: function () {
             return this._geo.closed;
         },
+        /**
+         * Sets whether this spline is closed.
+         *
+         * @param value - True to close the spline, false to open it
+         *
+         * @example
+         * ```typescript
+         * spline.closed = true; // Close the spline
+         * ```
+         */
         set: function (value) {
             this._geo.closed = value;
         },
@@ -64,7 +116,18 @@ var AcDbSpline = /** @class */ (function (_super) {
         configurable: true
     });
     /**
-     * @inheritdoc
+     * Draws this spline using the specified renderer.
+     *
+     * This method renders the spline as a series of connected line segments
+     * using the spline's current style properties.
+     *
+     * @param renderer - The renderer to use for drawing
+     * @returns The rendered spline entity, or undefined if drawing failed
+     *
+     * @example
+     * ```typescript
+     * const renderedSpline = spline.draw(renderer);
+     * ```
      */
     AcDbSpline.prototype.draw = function (renderer) {
         var points = this._geo.getPoints(100);

package/lib/entity/AcDbSpline.js.map

@@ -1 +1 @@
-{"version":3,"file":"AcDbSpline.js","sourceRoot":"","sources":["../../src/entity/AcDbSpline.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AAC9C,OAAO,EAGL,YAAY,EACb,MAAM,4BAA4B,CAAA;AAGnC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAEvC;;GAEG;AACH;IAAgC,8BAAS;IA4BvC,oBAAY,CAAW,EAAE,CAAW,EAAE,CAAW,EAAE,CAAW;QAC5D,YAAA,MAAK,WAAE,SAAA;QACP,IAAM,UAAU,GACd,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC;YAClB,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC;YAClB,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC;YAClB,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAA;QAEpB,IAAI,UAAU,GAAG,CAAC,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC;YACrC,MAAM,UAAU,CAAC,kBAAkB,CAAA;QACrC,CAAC;QAED,2FAA2F;QAC3F,IAAM,sBAAsB,GAAG,UAAU,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;QAEnE,IAAI,sBAAsB,EAAE,CAAC;YAC3B,KAAI,CAAC,IAAI,GAAG,IAAI,YAAY,CAC1B,CAAsB,EACtB,CAAiC,EACjC,CAAY,CACb,CAAA;QACH,CAAC;aAAM,CAAC;YACN,KAAI,CAAC,IAAI,GAAG,IAAI,YAAY,CAC1B,CAAsB,EACtB,CAAa,EACb,CAAyB,EACzB,CAAY,CACb,CAAA;QACH,CAAC;;IACH,CAAC;IAKD,sBAAI,wCAAgB;QAHpB;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAA;QACtB,CAAC;;;OAAA;IAKD,sBAAI,8BAAM;QAHV;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAA;QACzB,CAAC;aACD,UAAW,KAAc;YACvB,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAA;QAC1B,CAAC;;;OAHA;IAKD;;OAEG;IACH,yBAAI,GAAJ,UAAK,QAAsB;QACzB,IAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAA;QACvC,OAAO,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,CAAA;IAC/C,CAAC;IACH,iBAAC;AAAD,CAAC,AAnFD,CAAgC,SAAS,GAmFxC"}
+{"version":3,"file":"AcDbSpline.js","sourceRoot":"","sources":["../../src/entity/AcDbSpline.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AAC9C,OAAO,EAGL,YAAY,EACb,MAAM,4BAA4B,CAAA;AAGnC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAEvC;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH;IAAgC,8BAAS;IAyDvC,oBAAY,CAAW,EAAE,CAAW,EAAE,CAAW,EAAE,CAAW;QAC5D,YAAA,MAAK,WAAE,SAAA;QACP,IAAM,UAAU,GACd,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC;YAClB,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC;YAClB,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC;YAClB,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAA;QAEpB,IAAI,UAAU,GAAG,CAAC,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC;YACrC,MAAM,UAAU,CAAC,kBAAkB,CAAA;QACrC,CAAC;QAED,2FAA2F;QAC3F,IAAM,sBAAsB,GAAG,UAAU,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;QAEnE,IAAI,sBAAsB,EAAE,CAAC;YAC3B,KAAI,CAAC,IAAI,GAAG,IAAI,YAAY,CAC1B,CAAsB,EACtB,CAAiC,EACjC,CAAY,CACb,CAAA;QACH,CAAC;aAAM,CAAC;YACN,KAAI,CAAC,IAAI,GAAG,IAAI,YAAY,CAC1B,CAAsB,EACtB,CAAa,EACb,CAAyB,EACzB,CAAY,CACb,CAAA;QACH,CAAC;;IACH,CAAC;IAaD,sBAAI,wCAAgB;QAXpB;;;;;;;;;;WAUG;aACH;YACE,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAA;QACtB,CAAC;;;OAAA;IAeD,sBAAI,8BAAM;QAbV;;;;;;;;;;;;WAYG;aACH;YACE,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAA;QACzB,CAAC;QAED;;;;;;;;;WASG;aACH,UAAW,KAAc;YACvB,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAA;QAC1B,CAAC;;;OAdA;IAgBD;;;;;;;;;;;;;OAaG;IACH,yBAAI,GAAJ,UAAK,QAAsB;QACzB,IAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAA;QACvC,OAAO,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,CAAA;IAC/C,CAAC;IACH,iBAAC;AAAD,CAAC,AAxJD,CAAgC,SAAS,GAwJxC"}