@mlightcad/data-model 1.1.1 → 1.1.3

package/lib/database/AcDbViewportTableRecord.js

@@ -16,6 +16,9 @@ var __extends = (this && this.__extends) || (function () {
 import { AcGePoint2d, AcGePoint3d } from '@mlightcad/geometry-engine';
 import { AcGiDefaultLightingType, AcGiOrthographicType, AcGiRenderMode } from '@mlightcad/graphic-interface';
 import { AcDbSymbolTableRecord } from './AcDbSymbolTableRecord';
+/**
+ * Default view configuration for viewport table records.
+ */
 var DEFAULT_VIEW = {
     center: new AcGePoint2d(),
     viewDirectionFromTarget: new AcGePoint3d(0, 0, 1),
@@ -44,10 +47,32 @@ var DEFAULT_VIEW = {
     ambientColor: undefined
 };
 /**
- * This class represents viewport arrangements in AutoCAD.
+ * Represents a viewport table record in AutoCAD.
+ *
+ * This class represents viewport arrangements in AutoCAD, which define how
+ * the drawing is displayed in different areas of the screen or paper space.
+ * Viewports can have their own zoom levels, pan positions, grid settings,
+ * and other display properties.
+ *
+ * @example
+ * ```typescript
+ * const viewportRecord = new AcDbViewportTableRecord();
+ * viewportRecord.name = '*Active';
+ * viewportRecord.circleSides = 100;
+ * viewportRecord.lowerLeftCorner = new AcGePoint2d(0, 0);
+ * viewportRecord.upperRightCorner = new AcGePoint2d(1, 1);
+ * ```
  */
 var AcDbViewportTableRecord = /** @class */ (function (_super) {
     __extends(AcDbViewportTableRecord, _super);
+    /**
+     * Creates a new AcDbViewportTableRecord instance.
+     *
+     * @example
+     * ```typescript
+     * const viewportRecord = new AcDbViewportTableRecord();
+     * ```
+     */
     function AcDbViewportTableRecord() {
         var _this = _super.call(this) || this;
         _this._circleSides = 100;
@@ -66,9 +91,19 @@ var AcDbViewportTableRecord = /** @class */ (function (_super) {
     }
     Object.defineProperty(AcDbViewportTableRecord.prototype, "circleSides", {
         /**
-         * The circle zoom percent. It controls the number of sides to the tessellation used when displaying
-         * curves. The value can be between 1 and 20000, with higher settings using more sides in the curve
-         * tessellation.
+         * Gets or sets the circle zoom percent.
+         *
+         * This controls the number of sides to the tessellation used when displaying
+         * curves. The value can be between 1 and 20000, with higher settings using
+         * more sides in the curve tessellation.
+         *
+         * @returns The number of sides used for circle tessellation
+         *
+         * @example
+         * ```typescript
+         * const sides = viewportRecord.circleSides;
+         * viewportRecord.circleSides = 200; // Higher quality circles
+         * ```
          */
         get: function () {
             return this._circleSides;
@@ -80,6 +115,16 @@ var AcDbViewportTableRecord = /** @class */ (function (_super) {
         configurable: true
     });
     Object.defineProperty(AcDbViewportTableRecord.prototype, "center", {
+        /**
+         * Gets the center point of the viewport.
+         *
+         * @returns The center point of the viewport
+         *
+         * @example
+         * ```typescript
+         * const center = viewportRecord.center;
+         * ```
+         */
         get: function () {
             return this._center;
         },
@@ -88,11 +133,22 @@ var AcDbViewportTableRecord = /** @class */ (function (_super) {
     });
     Object.defineProperty(AcDbViewportTableRecord.prototype, "lowerLeftCorner", {
         /**
-         * The lower left corner of the viewport window. The X and Y values of this point are expressed as
-         * a value between (0.0, 0.0) for the lower left corner of the AutoCAD graphics area and (1.0, 1.0)
-         * for upper right corner of the AutoCAD graphics area. For example, a lower left corner value of
-         * (0.5, 0.0) indicates that the viewport's lower left corner is along the bottom of the AutoCAD
-         * graphics area, midway between the left and right edges of the graphics area.
+         * Gets or sets the lower left corner of the viewport window.
+         *
+         * The X and Y values of this point are expressed as a value between (0.0, 0.0)
+         * for the lower left corner of the AutoCAD graphics area and (1.0, 1.0) for
+         * the upper right corner of the AutoCAD graphics area. For example, a lower
+         * left corner value of (0.5, 0.0) indicates that the viewport's lower left
+         * corner is along the bottom of the AutoCAD graphics area, midway between
+         * the left and right edges of the graphics area.
+         *
+         * @returns The lower left corner point
+         *
+         * @example
+         * ```typescript
+         * const corner = viewportRecord.lowerLeftCorner;
+         * viewportRecord.lowerLeftCorner = new AcGePoint2d(0.25, 0.25);
+         * ```
          */
         get: function () {
             return this._lowerLeftCorner;

package/lib/database/AcDbViewportTableRecord.js.map

@@ -1 +1 @@
-{"version":3,"file":"AcDbViewportTableRecord.js","sourceRoot":"","sources":["../../src/database/AcDbViewportTableRecord.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,EACL,uBAAuB,EACvB,oBAAoB,EACpB,cAAc,EAEf,MAAM,8BAA8B,CAAA;AAErC,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAE/D,IAAM,YAAY,GAAa;IAC7B,MAAM,EAAE,IAAI,WAAW,EAAE;IACzB,uBAAuB,EAAE,IAAI,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IACjD,UAAU,EAAE,IAAI,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IACpC,UAAU,EAAE,GAAG;IACf,kBAAkB,EAAE,CAAC;IACrB,iBAAiB,EAAE,CAAC;IACpB,UAAU,EAAE,IAAI;IAChB,cAAc,EAAE,CAAC;IACjB,YAAY,EAAE,EAAE;IAChB,UAAU,EAAE,EAAE;IACd,UAAU,EAAE,cAAc,CAAC,YAAY;IACvC,QAAQ,EAAE,CAAC;IACX,cAAc,EAAE,CAAC;IACjB,SAAS,EAAE,IAAI,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IACnC,QAAQ,EAAE,IAAI,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAClC,QAAQ,EAAE,IAAI,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAClC,gBAAgB,EAAE,oBAAoB,CAAC,GAAG;IAC1C,gBAAgB,EAAE,CAAC;IACnB,iBAAiB,EAAE,SAAS;IAC5B,mBAAmB,EAAE,SAAS;IAC9B,mBAAmB,EAAE,KAAK;IAC1B,mBAAmB,EAAE,uBAAuB,CAAC,iBAAiB;IAC9D,UAAU,EAAE,CAAC;IACb,QAAQ,EAAE,CAAC;IACX,YAAY,EAAE,SAAS;CACxB,CAAA;AAED;;GAEG;AACH;IAA6C,2CAAqB;IAchE;QACE,YAAA,MAAK,WAAE,SAAA;QACP,KAAI,CAAC,YAAY,GAAG,GAAG,CAAA;QACvB,KAAI,CAAC,OAAO,GAAG,IAAI,WAAW,EAAE,CAAA;QAChC,KAAI,CAAC,gBAAgB,GAAG,IAAI,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QAC7C,KAAI,CAAC,iBAAiB,GAAG,IAAI,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QAC9C,KAAI,CAAC,SAAS,GAAG,IAAI,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QACtC,KAAI,CAAC,UAAU,GAAG,CAAC,CAAA;QACnB,KAAI,CAAC,YAAY,GAAG,IAAI,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QACzC,KAAI,CAAC,aAAa,GAAG,CAAC,CAAA;QACtB,KAAI,CAAC,YAAY,GAAG,IAAI,WAAW,EAAE,CAAA;QACrC,kDAAkD;QAClD,KAAI,CAAC,UAAU,GAAG,EAAE,CAAA;QACpB,KAAI,CAAC,OAAO,GAAG,YAAY,CAAA;;IAC7B,CAAC;IAOD,sBAAI,gDAAW;QALf;;;;WAIG;aACH;YACE,OAAO,IAAI,CAAC,YAAY,CAAA;QAC1B,CAAC;aACD,UAAgB,KAAa;YAC3B,IAAI,CAAC,YAAY,GAAG,KAAK,CAAA;QAC3B,CAAC;;;OAHA;IAKD,sBAAI,2CAAM;aAAV;YACE,OAAO,IAAI,CAAC,OAAO,CAAA;QACrB,CAAC;;;OAAA;IASD,sBAAI,oDAAe;QAPnB;;;;;;WAMG;aACH;YACE,OAAO,IAAI,CAAC,gBAAgB,CAAA;QAC9B,CAAC;aACD,UAAoB,KAAkB;YACpC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACnC,CAAC;;;OAHA;IAYD,sBAAI,qDAAgB;QAPpB;;;;;;WAMG;aACH;YACE,OAAO,IAAI,CAAC,iBAAiB,CAAA;QAC/B,CAAC;aACD,UAAqB,KAAkB;YACrC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACpC,CAAC;;;OAHA;IAQD,sBAAI,6CAAQ;QAHZ;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,SAAS,CAAA;QACvB,CAAC;aACD,UAAa,KAAkB;YAC7B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC5B,CAAC;;;OAHA;IAUD,sBAAI,8CAAS;QALb;;;;WAIG;aACH;YACE,OAAO,IAAI,CAAC,UAAU,CAAA;QACxB,CAAC;aACD,UAAc,KAAa;YACzB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAA;QACzB,CAAC;;;OAHA;IASD,sBAAI,mDAAc;QAJlB;;;WAGG;aACH;YACE,OAAO,IAAI,CAAC,YAAY,CAAA;QAC1B,CAAC;aACD,UAAmB,KAAkB;YACnC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC/B,CAAC;;;OAHA;IAQD,sBAAI,8CAAS;QAHb;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,UAAU,CAAA;QACxB,CAAC;aACD,UAAc,KAAa;YACzB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAA;QACzB,CAAC;;;OAHA;IASD,sBAAI,mDAAc;QAJlB;;;WAGG;aACH;YACE,OAAO,IAAI,CAAC,YAAY,CAAA;QAC1B,CAAC;aACD,UAAmB,KAAkB;YACnC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC/B,CAAC;;;OAHA;IAgCD,sBAAI,iDAAY;QA3BhB;;;;;;;;;;;;;;;;;;;;;;;;;;WA0BG;aACH;YACE,OAAO,IAAI,CAAC,aAAa,CAAA;QAC3B,CAAC;aACD,UAAiB,KAAa;YAC5B,IAAI,CAAC,aAAa,GAAG,KAAK,CAAA;QAC5B,CAAC;;;OAHA;IAKD,sBAAI,gDAAW;aAAf;YACE,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,CAAA;QACvC,CAAC;;;OAAA;IAKD,sBAAI,uDAAkB;QAHtB;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,mBAAmB,CAAA;QACjC,CAAC;aACD,UAAuB,KAAyB;YAC9C,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAA;QAClC,CAAC;;;OAHA;IAQD,sBAAI,2CAAM;QAHV;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,OAAO,CAAA;QACrB,CAAC;;;OAAA;IACH,8BAAC;AAAD,CAAC,AAtLD,CAA6C,qBAAqB,GAsLjE"}
+{"version":3,"file":"AcDbViewportTableRecord.js","sourceRoot":"","sources":["../../src/database/AcDbViewportTableRecord.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,EACL,uBAAuB,EACvB,oBAAoB,EACpB,cAAc,EAEf,MAAM,8BAA8B,CAAA;AAErC,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAE/D;;GAEG;AACH,IAAM,YAAY,GAAa;IAC7B,MAAM,EAAE,IAAI,WAAW,EAAE;IACzB,uBAAuB,EAAE,IAAI,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IACjD,UAAU,EAAE,IAAI,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IACpC,UAAU,EAAE,GAAG;IACf,kBAAkB,EAAE,CAAC;IACrB,iBAAiB,EAAE,CAAC;IACpB,UAAU,EAAE,IAAI;IAChB,cAAc,EAAE,CAAC;IACjB,YAAY,EAAE,EAAE;IAChB,UAAU,EAAE,EAAE;IACd,UAAU,EAAE,cAAc,CAAC,YAAY;IACvC,QAAQ,EAAE,CAAC;IACX,cAAc,EAAE,CAAC;IACjB,SAAS,EAAE,IAAI,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IACnC,QAAQ,EAAE,IAAI,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAClC,QAAQ,EAAE,IAAI,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAClC,gBAAgB,EAAE,oBAAoB,CAAC,GAAG;IAC1C,gBAAgB,EAAE,CAAC;IACnB,iBAAiB,EAAE,SAAS;IAC5B,mBAAmB,EAAE,SAAS;IAC9B,mBAAmB,EAAE,KAAK;IAC1B,mBAAmB,EAAE,uBAAuB,CAAC,iBAAiB;IAC9D,UAAU,EAAE,CAAC;IACb,QAAQ,EAAE,CAAC;IACX,YAAY,EAAE,SAAS;CACxB,CAAA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH;IAA6C,2CAAqB;IA0BhE;;;;;;;OAOG;IACH;QACE,YAAA,MAAK,WAAE,SAAA;QACP,KAAI,CAAC,YAAY,GAAG,GAAG,CAAA;QACvB,KAAI,CAAC,OAAO,GAAG,IAAI,WAAW,EAAE,CAAA;QAChC,KAAI,CAAC,gBAAgB,GAAG,IAAI,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QAC7C,KAAI,CAAC,iBAAiB,GAAG,IAAI,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QAC9C,KAAI,CAAC,SAAS,GAAG,IAAI,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QACtC,KAAI,CAAC,UAAU,GAAG,CAAC,CAAA;QACnB,KAAI,CAAC,YAAY,GAAG,IAAI,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QACzC,KAAI,CAAC,aAAa,GAAG,CAAC,CAAA;QACtB,KAAI,CAAC,YAAY,GAAG,IAAI,WAAW,EAAE,CAAA;QACrC,kDAAkD;QAClD,KAAI,CAAC,UAAU,GAAG,EAAE,CAAA;QACpB,KAAI,CAAC,OAAO,GAAG,YAAY,CAAA;;IAC7B,CAAC;IAiBD,sBAAI,gDAAW;QAff;;;;;;;;;;;;;;WAcG;aACH;YACE,OAAO,IAAI,CAAC,YAAY,CAAA;QAC1B,CAAC;aACD,UAAgB,KAAa;YAC3B,IAAI,CAAC,YAAY,GAAG,KAAK,CAAA;QAC3B,CAAC;;;OAHA;IAeD,sBAAI,2CAAM;QAVV;;;;;;;;;WASG;aACH;YACE,OAAO,IAAI,CAAC,OAAO,CAAA;QACrB,CAAC;;;OAAA;IAoBD,sBAAI,oDAAe;QAlBnB;;;;;;;;;;;;;;;;;WAiBG;aACH;YACE,OAAO,IAAI,CAAC,gBAAgB,CAAA;QAC9B,CAAC;aACD,UAAoB,KAAkB;YACpC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACnC,CAAC;;;OAHA;IAYD,sBAAI,qDAAgB;QAPpB;;;;;;WAMG;aACH;YACE,OAAO,IAAI,CAAC,iBAAiB,CAAA;QAC/B,CAAC;aACD,UAAqB,KAAkB;YACrC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACpC,CAAC;;;OAHA;IAQD,sBAAI,6CAAQ;QAHZ;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,SAAS,CAAA;QACvB,CAAC;aACD,UAAa,KAAkB;YAC7B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC5B,CAAC;;;OAHA;IAUD,sBAAI,8CAAS;QALb;;;;WAIG;aACH;YACE,OAAO,IAAI,CAAC,UAAU,CAAA;QACxB,CAAC;aACD,UAAc,KAAa;YACzB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAA;QACzB,CAAC;;;OAHA;IASD,sBAAI,mDAAc;QAJlB;;;WAGG;aACH;YACE,OAAO,IAAI,CAAC,YAAY,CAAA;QAC1B,CAAC;aACD,UAAmB,KAAkB;YACnC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC/B,CAAC;;;OAHA;IAQD,sBAAI,8CAAS;QAHb;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,UAAU,CAAA;QACxB,CAAC;aACD,UAAc,KAAa;YACzB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAA;QACzB,CAAC;;;OAHA;IASD,sBAAI,mDAAc;QAJlB;;;WAGG;aACH;YACE,OAAO,IAAI,CAAC,YAAY,CAAA;QAC1B,CAAC;aACD,UAAmB,KAAkB;YACnC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC/B,CAAC;;;OAHA;IAgCD,sBAAI,iDAAY;QA3BhB;;;;;;;;;;;;;;;;;;;;;;;;;;WA0BG;aACH;YACE,OAAO,IAAI,CAAC,aAAa,CAAA;QAC3B,CAAC;aACD,UAAiB,KAAa;YAC5B,IAAI,CAAC,aAAa,GAAG,KAAK,CAAA;QAC5B,CAAC;;;OAHA;IAKD,sBAAI,gDAAW;aAAf;YACE,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,CAAA;QACvC,CAAC;;;OAAA;IAKD,sBAAI,uDAAkB;QAHtB;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,mBAAmB,CAAA;QACjC,CAAC;aACD,UAAuB,KAAyB;YAC9C,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAA;QAClC,CAAC;;;OAHA;IAQD,sBAAI,2CAAM;QAHV;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,OAAO,CAAA;QACrB,CAAC;;;OAAA;IACH,8BAAC;AAAD,CAAC,AAzOD,CAA6C,qBAAqB,GAyOjE"}

package/lib/entity/AcDbArc.d.ts

@@ -2,65 +2,250 @@ import { AcGeMatrix3d, AcGePoint3d, AcGePoint3dLike } from '@mlightcad/geometry-
 import { AcGiRenderer } from '@mlightcad/graphic-interface';
 import { AcDbCurve } from './AcDbCurve';
 /**
- * The class represents the arc entity in AutoCAD.
+ * Represents an arc entity in AutoCAD.
+ *
+ * An arc is a 2D geometric object defined by its center point, radius, start angle,
+ * and end angle. Arcs are portions of circles that can be used to create curved
+ * line segments in drawings. The arc is always drawn in the plane defined by its normal vector.
+ *
+ * @example
+ * ```typescript
+ * // Create a 90-degree arc from 0 to π/2 radians
+ * const arc = new AcDbArc(
+ *   new AcGePoint3d(0, 0, 0),
+ *   10,
+ *   0,
+ *   Math.PI / 2
+ * );
+ *
+ * // Access arc properties
+ * console.log(`Center: ${arc.center}`);
+ * console.log(`Radius: ${arc.radius}`);
+ * console.log(`Start angle: ${arc.startAngle}`);
+ * console.log(`End angle: ${arc.endAngle}`);
+ * ```
  */
 export declare class AcDbArc extends AcDbCurve {
+    /** The underlying geometric circular arc object */
     private _geo;
     /**
-     * This constructor creates an arc using the values passed in. 'center' must be in WCS coordinates.
+     * Creates a new arc entity.
      *
-     * @param center Input center point of the arc
-     * @param radius Input radius of the arc
-     * @param startAngle Input starting angle in radians of the arc
-     * @param endAngle Input ending angle in radians of the arc
+     * This constructor creates an arc using the specified center point, radius,
+     * start angle, and end angle. The center point must be in World Coordinate
+     * System (WCS) coordinates. Angles are specified in radians.
+     *
+     * @param center - The center point of the arc in WCS coordinates
+     * @param radius - The radius of the arc (must be positive)
+     * @param startAngle - The starting angle in radians (0 to 2π)
+     * @param endAngle - The ending angle in radians (0 to 2π)
+     *
+     * @example
+     * ```typescript
+     * // Create a quarter circle arc (0 to 90 degrees)
+     * const quarterArc = new AcDbArc(
+     *   new AcGePoint3d(0, 0, 0),
+     *   15,
+     *   0,
+     *   Math.PI / 2
+     * );
+     *
+     * // Create a semicircle arc (0 to 180 degrees)
+     * const semicircle = new AcDbArc(
+     *   new AcGePoint3d(10, 20, 0),
+     *   25,
+     *   0,
+     *   Math.PI
+     * );
+     * ```
      */
     constructor(center: AcGePoint3dLike, radius: number, startAngle: number, endAngle: number);
     /**
-     * Center point of circular arc
+     * Gets the center point of this arc.
+     *
+     * @returns The center point as a 3D point
+     *
+     * @example
+     * ```typescript
+     * const centerPoint = arc.center;
+     * console.log(`Arc center: ${centerPoint.x}, ${centerPoint.y}, ${centerPoint.z}`);
+     * ```
      */
     get center(): AcGePoint3d;
+    /**
+     * Sets the center point of this arc.
+     *
+     * @param value - The new center point
+     *
+     * @example
+     * ```typescript
+     * arc.center = new AcGePoint3d(5, 5, 0);
+     * ```
+     */
     set center(value: AcGePoint3dLike);
     /**
-     * Radius of circular arc
+     * Gets the radius of this arc.
+     *
+     * @returns The radius value
+     *
+     * @example
+     * ```typescript
+     * const radius = arc.radius;
+     * console.log(`Arc radius: ${radius}`);
+     * ```
      */
     get radius(): number;
+    /**
+     * Sets the radius of this arc.
+     *
+     * @param value - The new radius value (must be positive)
+     *
+     * @example
+     * ```typescript
+     * arc.radius = 25;
+     * ```
+     */
     set radius(value: number);
     /**
-     * Start angle in radians of circular arc
+     * Gets the start angle of this arc.
+     *
+     * @returns The start angle in radians
+     *
+     * @example
+     * ```typescript
+     * const startAngle = arc.startAngle;
+     * console.log(`Arc start angle: ${startAngle} radians (${startAngle * 180 / Math.PI} degrees)`);
+     * ```
      */
     get startAngle(): number;
+    /**
+     * Sets the start angle of this arc.
+     *
+     * @param value - The new start angle in radians (0 to 2π)
+     *
+     * @example
+     * ```typescript
+     * arc.startAngle = Math.PI / 4; // 45 degrees
+     * ```
+     */
     set startAngle(value: number);
     /**
-     * End angle in radians of circular arc
+     * Gets the end angle of this arc.
+     *
+     * @returns The end angle in radians
+     *
+     * @example
+     * ```typescript
+     * const endAngle = arc.endAngle;
+     * console.log(`Arc end angle: ${endAngle} radians (${endAngle * 180 / Math.PI} degrees)`);
+     * ```
      */
     get endAngle(): number;
+    /**
+     * Sets the end angle of this arc.
+     *
+     * @param value - The new end angle in radians (0 to 2π)
+     *
+     * @example
+     * ```typescript
+     * arc.endAngle = Math.PI; // 180 degrees
+     * ```
+     */
     set endAngle(value: number);
     /**
-     * Start point of circular arc
+     * Gets the start point of this arc.
+     *
+     * The start point is calculated based on the center, radius, and start angle.
+     *
+     * @returns The start point as a 3D point
+     *
+     * @example
+     * ```typescript
+     * const startPoint = arc.startPoint;
+     * console.log(`Arc start point: ${startPoint.x}, ${startPoint.y}, ${startPoint.z}`);
+     * ```
      */
     get startPoint(): AcGePoint3d;
     /**
-     * Get end point of circular arc
+     * Gets the end point of this arc.
+     *
+     * The end point is calculated based on the center, radius, and end angle.
+     *
+     * @returns The end point as a 3D point
+     *
+     * @example
+     * ```typescript
+     * const endPoint = arc.endPoint;
+     * console.log(`Arc end point: ${endPoint.x}, ${endPoint.y}, ${endPoint.z}`);
+     * ```
      */
     get endPoint(): AcGePoint3d;
     /**
-     * @inheritdoc
+     * Gets the geometric extents (bounding box) of this arc.
+     *
+     * @returns The bounding box that encompasses the entire arc
+     *
+     * @example
+     * ```typescript
+     * const extents = arc.geometricExtents;
+     * console.log(`Arc bounds: ${extents.minPoint} to ${extents.maxPoint}`);
+     * ```
      */
     get geometricExtents(): import("@mlightcad/geometry-engine").AcGeBox3d;
     /**
-     * @inheritdoc
+     * Gets whether this arc is closed.
+     *
+     * An arc is considered closed if the start and end angles are the same
+     * (forming a complete circle).
+     *
+     * @returns True if the arc is closed (forms a complete circle), false otherwise
      */
     get closed(): boolean;
     /**
-     * @inheritdoc
+     * Gets the grip points for this arc.
+     *
+     * Grip points are control points that can be used to modify the arc.
+     * For an arc, the grip points are the center point, start point, and end point.
+     *
+     * @returns Array of grip points (center, start point, end point)
+     *
+     * @example
+     * ```typescript
+     * const gripPoints = arc.subGetGripPoints();
+     * // gripPoints contains: [center, startPoint, endPoint]
+     * ```
      */
     subGetGripPoints(): AcGePoint3d[];
     /**
-     * @inheritdoc
+     * Transforms this arc by the specified matrix.
+     *
+     * This method applies a geometric transformation to the arc, updating
+     * the center point, radius, and angles according to the transformation matrix.
+     *
+     * @param matrix - The transformation matrix to apply
+     * @returns This arc after transformation
+     *
+     * @example
+     * ```typescript
+     * const translationMatrix = AcGeMatrix3d.translation(10, 0, 0);
+     * arc.transformBy(translationMatrix);
+     * // Arc is now translated 10 units in the X direction
+     * ```
      */
     transformBy(matrix: AcGeMatrix3d): this;
     /**
-     * @inheritdoc
+     * Draws this arc using the specified renderer.
+     *
+     * This method renders the arc as a circular arc using the arc's
+     * current style properties.
+     *
+     * @param renderer - The renderer to use for drawing
+     * @returns The rendered arc entity, or undefined if drawing failed
+     *
+     * @example
+     * ```typescript
+     * const renderedArc = arc.draw(renderer);
+     * ```
      */
     draw(renderer: AcGiRenderer): import("@mlightcad/graphic-interface").AcGiEntity;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"AcDbArc.d.ts","sourceRoot":"","sources":["../../src/entity/AcDbArc.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,YAAY,EACZ,WAAW,EACX,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,OAAQ,SAAQ,SAAS;IACpC,OAAO,CAAC,IAAI,CAAe;IAE3B;;;;;;;OAOG;gBAED,MAAM,EAAE,eAAe,EACvB,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM;IAalB;;OAEG;IACH,IAAI,MAAM,IAAI,WAAW,CAExB;IACD,IAAI,MAAM,CAAC,KAAK,EAAE,eAAe,EAEhC;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,MAAM,CAEnB;IACD,IAAI,MAAM,CAAC,KAAK,EAAE,MAAM,EAEvB;IAED;;OAEG;IACH,IAAI,UAAU,IAAI,MAAM,CAEvB;IACD,IAAI,UAAU,CAAC,KAAK,EAAE,MAAM,EAE3B;IAED;;OAEG;IACH,IAAI,QAAQ,IAAI,MAAM,CAErB;IACD,IAAI,QAAQ,CAAC,KAAK,EAAE,MAAM,EAEzB;IAED;;OAEG;IACH,IAAI,UAAU,IAAI,WAAW,CAE5B;IAED;;OAEG;IACH,IAAI,QAAQ,IAAI,WAAW,CAE1B;IAED;;OAEG;IACH,IAAI,gBAAgB,mDAEnB;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED;;OAEG;IACH,gBAAgB;IAQhB;;OAEG;IACH,WAAW,CAAC,MAAM,EAAE,YAAY;IAKhC;;OAEG;IACH,IAAI,CAAC,QAAQ,EAAE,YAAY;CAG5B"}
+{"version":3,"file":"AcDbArc.d.ts","sourceRoot":"","sources":["../../src/entity/AcDbArc.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,YAAY,EACZ,WAAW,EACX,eAAe,EAEhB,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAA;AAE3D,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAEvC;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAAa,OAAQ,SAAQ,SAAS;IACpC,mDAAmD;IACnD,OAAO,CAAC,IAAI,CAAe;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;gBAED,MAAM,EAAE,eAAe,EACvB,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM;IAalB;;;;;;;;;;OAUG;IACH,IAAI,MAAM,IAAI,WAAW,CAExB;IAED;;;;;;;;;OASG;IACH,IAAI,MAAM,CAAC,KAAK,EAAE,eAAe,EAEhC;IAED;;;;;;;;;;OAUG;IACH,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED;;;;;;;;;OASG;IACH,IAAI,MAAM,CAAC,KAAK,EAAE,MAAM,EAEvB;IAED;;;;;;;;;;OAUG;IACH,IAAI,UAAU,IAAI,MAAM,CAEvB;IAED;;;;;;;;;OASG;IACH,IAAI,UAAU,CAAC,KAAK,EAAE,MAAM,EAE3B;IAED;;;;;;;;;;OAUG;IACH,IAAI,QAAQ,IAAI,MAAM,CAErB;IAED;;;;;;;;;OASG;IACH,IAAI,QAAQ,CAAC,KAAK,EAAE,MAAM,EAEzB;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,UAAU,IAAI,WAAW,CAE5B;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,QAAQ,IAAI,WAAW,CAE1B;IAED;;;;;;;;;;OAUG;IACH,IAAI,gBAAgB,mDAEnB;IAED;;;;;;;OAOG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED;;;;;;;;;;;;;OAaG;IACH,gBAAgB;IAQhB;;;;;;;;;;;;;;;OAeG;IACH,WAAW,CAAC,MAAM,EAAE,YAAY;IAKhC;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,QAAQ,EAAE,YAAY;CAG5B"}