@mlightcad/data-model 1.1.2 → 1.1.4

package/lib/entity/AcDbBlockReference.js

@@ -28,11 +28,44 @@ import { AcGeBox3d, AcGeEuler, AcGeMatrix3d, AcGePoint3d, AcGeQuaternion, AcGeVe
 import { AcDbRenderingCache } from '../misc';
 import { AcDbEntity } from './AcDbEntity';
 /**
- * A block reference is used to place, size, and display an instance of the collection of entities within
- * the block table record that it references.
+ * Represents a block reference entity in AutoCAD.
+ *
+ * A block reference is used to place, size, and display an instance of the collection
+ * of entities within the block table record that it references. Block references allow
+ * you to reuse complex geometry by referencing a block definition multiple times with
+ * different positions, rotations, and scales.
+ *
+ * @example
+ * ```typescript
+ * // Create a block reference
+ * const blockRef = new AcDbBlockReference("MyBlock");
+ * blockRef.position = new AcGePoint3d(10, 20, 0);
+ * blockRef.rotation = Math.PI / 4; // 45 degrees
+ * blockRef.scaleFactors = new AcGePoint3d(2, 2, 1); // 2x scale
+ *
+ * // Access block reference properties
+ * console.log(`Block name: ${blockRef.blockTableRecord?.name}`);
+ * console.log(`Position: ${blockRef.position}`);
+ * console.log(`Rotation: ${blockRef.rotation}`);
+ * ```
  */
 var AcDbBlockReference = /** @class */ (function (_super) {
     __extends(AcDbBlockReference, _super);
+    /**
+     * Creates a new block reference entity.
+     *
+     * This constructor initializes a block reference with the specified block name.
+     * The position is set to the origin, rotation to 0, normal to Z-axis, and scale factors to 1.
+     *
+     * @param blockName - The name of the block table record to reference
+     *
+     * @example
+     * ```typescript
+     * const blockRef = new AcDbBlockReference("MyBlock");
+     * blockRef.position = new AcGePoint3d(5, 10, 0);
+     * blockRef.rotation = Math.PI / 6; // 30 degrees
+     * ```
+     */
     function AcDbBlockReference(blockName) {
         var _this = _super.call(this) || this;
         _this._blockName = blockName;
@@ -44,11 +77,29 @@ var AcDbBlockReference = /** @class */ (function (_super) {
     }
     Object.defineProperty(AcDbBlockReference.prototype, "position", {
         /**
-         * WCS position point (often referred to as the insertion point) of the block reference
+         * Gets the WCS position point (insertion point) of the block reference.
+         *
+         * @returns The position point in WCS coordinates
+         *
+         * @example
+         * ```typescript
+         * const position = blockRef.position;
+         * console.log(`Block position: ${position.x}, ${position.y}, ${position.z}`);
+         * ```
          */
         get: function () {
             return this._position;
         },
+        /**
+         * Sets the WCS position point (insertion point) of the block reference.
+         *
+         * @param value - The new position point
+         *
+         * @example
+         * ```typescript
+         * blockRef.position = new AcGePoint3d(15, 25, 0);
+         * ```
+         */
         set: function (value) {
             this._position.copy(value);
         },
@@ -57,15 +108,34 @@ var AcDbBlockReference = /** @class */ (function (_super) {
     });
     Object.defineProperty(AcDbBlockReference.prototype, "rotation", {
         /**
-         * The rotation value (in radians) of the block reference. The rotation value is relative to the X
-         * axis of a coordinate system that is parallel to the OCS of the block reference, but has its origin
-         * at the position point of the block reference. The rotation axis is the Z axis of this coordinate
-         * system with positive rotations going counterclockwise when looking down the Z axis towards the
-         * origin.
+         * Gets the rotation value of the block reference.
+         *
+         * The rotation value is relative to the X axis of a coordinate system that is parallel
+         * to the OCS of the block reference, but has its origin at the position point of the
+         * block reference. The rotation axis is the Z axis of this coordinate system with
+         * positive rotations going counterclockwise when looking down the Z axis towards the origin.
+         *
+         * @returns The rotation value in radians
+         *
+         * @example
+         * ```typescript
+         * const rotation = blockRef.rotation;
+         * console.log(`Rotation: ${rotation} radians (${rotation * 180 / Math.PI} degrees)`);
+         * ```
          */
         get: function () {
             return this._rotation;
         },
+        /**
+         * Sets the rotation value of the block reference.
+         *
+         * @param value - The new rotation value in radians
+         *
+         * @example
+         * ```typescript
+         * blockRef.rotation = Math.PI / 4; // 45 degrees
+         * ```
+         */
         set: function (value) {
             this._rotation = value;
         },
@@ -74,11 +144,29 @@ var AcDbBlockReference = /** @class */ (function (_super) {
     });
     Object.defineProperty(AcDbBlockReference.prototype, "scaleFactors", {
         /**
-         * The X, Y, and Z scale factors for the block reference.
+         * Gets the X, Y, and Z scale factors for the block reference.
+         *
+         * @returns The scale factors as a 3D point
+         *
+         * @example
+         * ```typescript
+         * const scaleFactors = blockRef.scaleFactors;
+         * console.log(`Scale factors: ${scaleFactors.x}, ${scaleFactors.y}, ${scaleFactors.z}`);
+         * ```
          */
         get: function () {
             return this._scaleFactors;
         },
+        /**
+         * Sets the X, Y, and Z scale factors for the block reference.
+         *
+         * @param value - The new scale factors
+         *
+         * @example
+         * ```typescript
+         * blockRef.scaleFactors = new AcGePoint3d(2, 1.5, 1); // 2x X scale, 1.5x Y scale
+         * ```
+         */
         set: function (value) {
             this._scaleFactors.copy(value);
         },
@@ -87,11 +175,29 @@ var AcDbBlockReference = /** @class */ (function (_super) {
     });
     Object.defineProperty(AcDbBlockReference.prototype, "normal", {
         /**
-         * The normal vector of the plane containing the block reference.
+         * Gets the normal vector of the plane containing the block reference.
+         *
+         * @returns The normal vector
+         *
+         * @example
+         * ```typescript
+         * const normal = blockRef.normal;
+         * console.log(`Normal: ${normal.x}, ${normal.y}, ${normal.z}`);
+         * ```
          */
         get: function () {
             return this._normal;
         },
+        /**
+         * Sets the normal vector of the plane containing the block reference.
+         *
+         * @param value - The new normal vector
+         *
+         * @example
+         * ```typescript
+         * blockRef.normal = new AcGeVector3d(0, 0, 1);
+         * ```
+         */
         set: function (value) {
             this._normal.copy(value).normalize();
         },
@@ -100,8 +206,19 @@ var AcDbBlockReference = /** @class */ (function (_super) {
     });
     Object.defineProperty(AcDbBlockReference.prototype, "blockTableRecord", {
         /**
-         * The block table record referenced by the block reference. The referenced block table record contains
-         * the entities that the block reference will display.
+         * Gets the block table record referenced by this block reference.
+         *
+         * The referenced block table record contains the entities that the block reference will display.
+         *
+         * @returns The block table record, or undefined if not found
+         *
+         * @example
+         * ```typescript
+         * const blockRecord = blockRef.blockTableRecord;
+         * if (blockRecord) {
+         *   console.log(`Block name: ${blockRecord.name}`);
+         * }
+         * ```
          */
         get: function () {
             return this.database.tables.blockTable.getAt(this._blockName);
@@ -111,7 +228,19 @@ var AcDbBlockReference = /** @class */ (function (_super) {
     });
     Object.defineProperty(AcDbBlockReference.prototype, "geometricExtents", {
         /**
-         * @inheritdoc
+         * Gets the geometric extents (bounding box) of this block reference.
+         *
+         * This method calculates the bounding box by transforming the geometric extents
+         * of all entities in the referenced block according to the block reference's
+         * position, rotation, and scale factors.
+         *
+         * @returns The bounding box that encompasses the entire block reference
+         *
+         * @example
+         * ```typescript
+         * const extents = blockRef.geometricExtents;
+         * console.log(`Block bounds: ${extents.minPoint} to ${extents.maxPoint}`);
+         * ```
          */
         get: function () {
             var e_1, _a;

package/lib/entity/AcDbBlockReference.js.map

@@ -1 +1 @@
-{"version":3,"file":"AcDbBlockReference.js","sourceRoot":"","sources":["../../src/entity/AcDbBlockReference.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EACL,SAAS,EACT,SAAS,EACT,YAAY,EACZ,WAAW,EACX,cAAc,EACd,YAAY,EACb,MAAM,4BAA4B,CAAA;AAGnC,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAEzC;;;GAGG;AACH;IAAwC,sCAAU;IAOhD,4BAAY,SAAiB;QAC3B,YAAA,MAAK,WAAE,SAAA;QACP,KAAI,CAAC,UAAU,GAAG,SAAS,CAAA;QAC3B,KAAI,CAAC,SAAS,GAAG,IAAI,WAAW,EAAE,CAAA;QAClC,KAAI,CAAC,SAAS,GAAG,GAAG,CAAA;QACpB,KAAI,CAAC,OAAO,GAAG,IAAI,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;QACxC,KAAI,CAAC,aAAa,GAAG,IAAI,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;;IAC/C,CAAC;IAKD,sBAAI,wCAAQ;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;IAYD,sBAAI,wCAAQ;QAPZ;;;;;;WAMG;aACH;YACE,OAAO,IAAI,CAAC,SAAS,CAAA;QACvB,CAAC;aACD,UAAa,KAAa;YACxB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAA;QACxB,CAAC;;;OAHA;IAQD,sBAAI,4CAAY;QAHhB;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,aAAa,CAAA;QAC3B,CAAC;aACD,UAAiB,KAAkB;YACjC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAChC,CAAC;;;OAHA;IAQD,sBAAI,sCAAM;QAHV;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,OAAO,CAAA;QACrB,CAAC;aACD,UAAW,KAAmB;YAC5B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,CAAA;QACtC,CAAC;;;OAHA;IASD,sBAAI,gDAAgB;QAJpB;;;WAGG;aACH;YACE,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QAC/D,CAAC;;;OAAA;IAKD,sBAAI,gDAAgB;QAHpB;;WAEG;aACH;;YACE,IAAM,GAAG,GAAG,IAAI,SAAS,EAAE,CAAA;YAC3B,IAAM,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAA;YAC9C,IAAI,gBAAgB,IAAI,IAAI,EAAE,CAAC;gBAC7B,IAAM,QAAQ,GAAG,gBAAgB,CAAC,WAAW,EAAE,CAAA;;oBAC/C,KAAqB,IAAA,aAAA,SAAA,QAAQ,CAAA,kCAAA,wDAAE,CAAC;wBAA3B,IAAM,MAAM,qBAAA;wBACf,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAA;oBACpC,CAAC;;;;;;;;;YACH,CAAC;YAED,IAAM,UAAU,GAAG,IAAI,cAAc,EAAE,CAAC,YAAY,CAClD,IAAI,SAAS,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC,CACnC,CAAA;YACD,IAAM,MAAM,GAAG,IAAI,YAAY,EAAE,CAAA;YACjC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,UAAU,EAAE,IAAI,CAAC,YAAY,CAAC,CAAA;YAC5D,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,CAAA;YAExB,OAAO,GAAG,CAAA;QACZ,CAAC;;;OAAA;IAED;;OAEG;IACH,iCAAI,GAAJ,UAAK,QAAsB;QACzB,IAAM,OAAO,GAAiB,EAAE,CAAA;QAChC,IAAM,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAA;QAC9C,IAAI,gBAAgB,IAAI,IAAI,EAAE,CAAC;YAC7B,IAAM,MAAM,GAAG,IAAI,CAAC,sBAAsB,EAAE,CAAA;YAC5C,IAAM,KAAK,GAAG,kBAAkB,CAAC,QAAQ,CAAC,IAAI,CAC5C,QAAQ,EACR,gBAAgB,EAChB,IAAI,CAAC,QAAQ,EACb,IAAI,EACJ,MAAM,EACN,IAAI,CAAC,MAAM,CACZ,CAAA;YACD,OAAO,KAAK,CAAA;QACd,CAAC;aAAM,CAAC;YACN,OAAO,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;QAChC,CAAC;IACH,CAAC;IAEO,mDAAsB,GAA9B;QACE,IAAM,UAAU,GAAG,IAAI,cAAc,EAAE,CAAA;QACvC,UAAU,CAAC,gBAAgB,CAAC,YAAY,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAA;QAC/D,OAAO,IAAI,YAAY,EAAE,CAAC,OAAO,CAC/B,IAAI,CAAC,SAAS,EACd,UAAU,EACV,IAAI,CAAC,aAAa,CACnB,CAAA;IACH,CAAC;IACH,yBAAC;AAAD,CAAC,AA1HD,CAAwC,UAAU,GA0HjD"}
+{"version":3,"file":"AcDbBlockReference.js","sourceRoot":"","sources":["../../src/entity/AcDbBlockReference.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EACL,SAAS,EACT,SAAS,EACT,YAAY,EACZ,WAAW,EACX,cAAc,EACd,YAAY,EACb,MAAM,4BAA4B,CAAA;AAGnC,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAEzC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH;IAAwC,sCAAU;IAYhD;;;;;;;;;;;;;;OAcG;IACH,4BAAY,SAAiB;QAC3B,YAAA,MAAK,WAAE,SAAA;QACP,KAAI,CAAC,UAAU,GAAG,SAAS,CAAA;QAC3B,KAAI,CAAC,SAAS,GAAG,IAAI,WAAW,EAAE,CAAA;QAClC,KAAI,CAAC,SAAS,GAAG,GAAG,CAAA;QACpB,KAAI,CAAC,OAAO,GAAG,IAAI,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;QACxC,KAAI,CAAC,aAAa,GAAG,IAAI,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;;IAC/C,CAAC;IAaD,sBAAI,wCAAQ;QAXZ;;;;;;;;;;WAUG;aACH;YACE,OAAO,IAAI,CAAC,SAAS,CAAA;QACvB,CAAC;QAED;;;;;;;;;WASG;aACH,UAAa,KAAkB;YAC7B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC5B,CAAC;;;OAdA;IAgCD,sBAAI,wCAAQ;QAhBZ;;;;;;;;;;;;;;;WAeG;aACH;YACE,OAAO,IAAI,CAAC,SAAS,CAAA;QACvB,CAAC;QAED;;;;;;;;;WASG;aACH,UAAa,KAAa;YACxB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAA;QACxB,CAAC;;;OAdA;IA2BD,sBAAI,4CAAY;QAXhB;;;;;;;;;;WAUG;aACH;YACE,OAAO,IAAI,CAAC,aAAa,CAAA;QAC3B,CAAC;QAED;;;;;;;;;WASG;aACH,UAAiB,KAAkB;YACjC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAChC,CAAC;;;OAdA;IA2BD,sBAAI,sCAAM;QAXV;;;;;;;;;;WAUG;aACH;YACE,OAAO,IAAI,CAAC,OAAO,CAAA;QACrB,CAAC;QAED;;;;;;;;;WASG;aACH,UAAW,KAAmB;YAC5B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,CAAA;QACtC,CAAC;;;OAdA;IA+BD,sBAAI,gDAAgB;QAfpB;;;;;;;;;;;;;;WAcG;aACH;YACE,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QAC/D,CAAC;;;OAAA;IAiBD,sBAAI,gDAAgB;QAfpB;;;;;;;;;;;;;;WAcG;aACH;;YACE,IAAM,GAAG,GAAG,IAAI,SAAS,EAAE,CAAA;YAC3B,IAAM,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAA;YAC9C,IAAI,gBAAgB,IAAI,IAAI,EAAE,CAAC;gBAC7B,IAAM,QAAQ,GAAG,gBAAgB,CAAC,WAAW,EAAE,CAAA;;oBAC/C,KAAqB,IAAA,aAAA,SAAA,QAAQ,CAAA,kCAAA,wDAAE,CAAC;wBAA3B,IAAM,MAAM,qBAAA;wBACf,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAA;oBACpC,CAAC;;;;;;;;;YACH,CAAC;YAED,IAAM,UAAU,GAAG,IAAI,cAAc,EAAE,CAAC,YAAY,CAClD,IAAI,SAAS,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC,CACnC,CAAA;YACD,IAAM,MAAM,GAAG,IAAI,YAAY,EAAE,CAAA;YACjC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,UAAU,EAAE,IAAI,CAAC,YAAY,CAAC,CAAA;YAC5D,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,CAAA;YAExB,OAAO,GAAG,CAAA;QACZ,CAAC;;;OAAA;IAED;;OAEG;IACH,iCAAI,GAAJ,UAAK,QAAsB;QACzB,IAAM,OAAO,GAAiB,EAAE,CAAA;QAChC,IAAM,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAA;QAC9C,IAAI,gBAAgB,IAAI,IAAI,EAAE,CAAC;YAC7B,IAAM,MAAM,GAAG,IAAI,CAAC,sBAAsB,EAAE,CAAA;YAC5C,IAAM,KAAK,GAAG,kBAAkB,CAAC,QAAQ,CAAC,IAAI,CAC5C,QAAQ,EACR,gBAAgB,EAChB,IAAI,CAAC,QAAQ,EACb,IAAI,EACJ,MAAM,EACN,IAAI,CAAC,MAAM,CACZ,CAAA;YACD,OAAO,KAAK,CAAA;QACd,CAAC;aAAM,CAAC;YACN,OAAO,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;QAChC,CAAC;IACH,CAAC;IAEO,mDAAsB,GAA9B;QACE,IAAM,UAAU,GAAG,IAAI,cAAc,EAAE,CAAA;QACvC,UAAU,CAAC,gBAAgB,CAAC,YAAY,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAA;QAC/D,OAAO,IAAI,YAAY,EAAE,CAAC,OAAO,CAC/B,IAAI,CAAC,SAAS,EACd,UAAU,EACV,IAAI,CAAC,aAAa,CACnB,CAAA;IACH,CAAC;IACH,yBAAC;AAAD,CAAC,AAlPD,CAAwC,UAAU,GAkPjD"}

package/lib/entity/AcDbCircle.d.ts

@@ -2,49 +2,182 @@ import { AcGeMatrix3d, AcGePoint3d, AcGePoint3dLike, AcGePointLike, AcGeVector3d
 import { AcGiRenderer } from '@mlightcad/graphic-interface';
 import { AcDbCurve } from './AcDbCurve';
 /**
- * The class represents the circle entity in AutoCAD.
+ * Represents a circle entity in AutoCAD.
+ *
+ * A circle is a 2D geometric object defined by its center point and radius.
+ * Circles are closed curves that can be used to create circular shapes
+ * in drawings. The circle is always drawn in the plane defined by its normal vector.
+ *
+ * @example
+ * ```typescript
+ * // Create a circle with center at (0,0,0) and radius 5
+ * const circle = new AcDbCircle(
+ *   new AcGePoint3d(0, 0, 0),
+ *   5
+ * );
+ *
+ * // Access circle properties
+ * console.log(`Center: ${circle.center}`);
+ * console.log(`Radius: ${circle.radius}`);
+ * console.log(`Normal: ${circle.normal}`);
+ * ```
  */
 export declare class AcDbCircle 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 circle entity.
      *
-     * @param center Input center point of the arc
-     * @param radius Input radius of the arc
+     * This constructor creates a circle using the specified center point and radius.
+     * The center point must be in World Coordinate System (WCS) coordinates.
+     * The circle is created as a full circle (0 to 2π radians).
+     *
+     * @param center - The center point of the circle in WCS coordinates
+     * @param radius - The radius of the circle (must be positive)
+     * @param normal - The normal vector defining the plane of the circle (defaults to Z-axis)
+     *
+     * @example
+     * ```typescript
+     * // Create a circle in the XY plane
+     * const circle = new AcDbCircle(
+     *   new AcGePoint3d(10, 20, 0),
+     *   15
+     * );
+     *
+     * // Create a circle in a different plane
+     * const circleInYZ = new AcDbCircle(
+     *   new AcGePoint3d(0, 0, 0),
+     *   10,
+     *   AcGeVector3d.X_AXIS
+     * );
+     * ```
      */
     constructor(center: AcGePointLike, radius: number, normal?: AcGeVector3d);
     /**
-     * Center point of circular arc
+     * Gets the center point of this circle.
+     *
+     * @returns The center point as a 3D point
+     *
+     * @example
+     * ```typescript
+     * const centerPoint = circle.center;
+     * console.log(`Circle center: ${centerPoint.x}, ${centerPoint.y}, ${centerPoint.z}`);
+     * ```
      */
     get center(): AcGePoint3d;
+    /**
+     * Sets the center point of this circle.
+     *
+     * @param value - The new center point
+     *
+     * @example
+     * ```typescript
+     * circle.center = new AcGePoint3d(5, 5, 0);
+     * ```
+     */
     set center(value: AcGePoint3dLike);
     /**
-     * Radius of circular arc
+     * Gets the radius of this circle.
+     *
+     * @returns The radius value
+     *
+     * @example
+     * ```typescript
+     * const radius = circle.radius;
+     * console.log(`Circle radius: ${radius}`);
+     * ```
      */
     get radius(): number;
+    /**
+     * Sets the radius of this circle.
+     *
+     * @param value - The new radius value (must be positive)
+     *
+     * @example
+     * ```typescript
+     * circle.radius = 25;
+     * ```
+     */
     set radius(value: number);
     /**
-     * Arc's unit normal vector in WCS coordinates.
+     * Gets the normal vector of this circle.
+     *
+     * The normal vector defines the plane in which the circle lies.
+     *
+     * @returns The unit normal vector in WCS coordinates
+     *
+     * @example
+     * ```typescript
+     * const normal = circle.normal;
+     * console.log(`Circle normal: ${normal.x}, ${normal.y}, ${normal.z}`);
+     * ```
      */
     get normal(): AcGeVector3d;
     /**
-     * @inheritdoc
+     * Gets the geometric extents (bounding box) of this circle.
+     *
+     * @returns The bounding box that encompasses the entire circle
+     *
+     * @example
+     * ```typescript
+     * const extents = circle.geometricExtents;
+     * console.log(`Circle bounds: ${extents.minPoint} to ${extents.maxPoint}`);
+     * ```
      */
     get geometricExtents(): import("@mlightcad/geometry-engine").AcGeBox3d;
     /**
-     * @inheritdoc
+     * Gets whether this circle is closed.
+     *
+     * Circles are always closed entities, so this always returns true.
+     *
+     * @returns Always true for circles
      */
     get closed(): boolean;
     /**
-     * @inheritdoc
+     * Gets the grip points for this circle.
+     *
+     * Grip points are control points that can be used to modify the circle.
+     * For a circle, the grip point is the center point.
+     *
+     * @returns Array of grip points (center point)
+     *
+     * @example
+     * ```typescript
+     * const gripPoints = circle.subGetGripPoints();
+     * // gripPoints contains: [center]
+     * ```
      */
     subGetGripPoints(): AcGePoint3d[];
     /**
-     * @inheritdoc
+     * Transforms this circle by the specified matrix.
+     *
+     * This method applies a geometric transformation to the circle, updating
+     * the center point, radius, and normal vector according to the transformation matrix.
+     *
+     * @param matrix - The transformation matrix to apply
+     * @returns This circle after transformation
+     *
+     * @example
+     * ```typescript
+     * const translationMatrix = AcGeMatrix3d.translation(10, 0, 0);
+     * circle.transformBy(translationMatrix);
+     * // Circle is now translated 10 units in the X direction
+     * ```
      */
     transformBy(matrix: AcGeMatrix3d): this;
     /**
-     * @inheritdoc
+     * Draws this circle using the specified renderer.
+     *
+     * This method renders the circle as a circular arc using the circle's
+     * current style properties.
+     *
+     * @param renderer - The renderer to use for drawing
+     * @returns The rendered circle entity, or undefined if drawing failed
+     *
+     * @example
+     * ```typescript
+     * const renderedCircle = circle.draw(renderer);
+     * ```
      */
     draw(renderer: AcGiRenderer): import("@mlightcad/graphic-interface").AcGiEntity;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"AcDbCircle.d.ts","sourceRoot":"","sources":["../../src/entity/AcDbCircle.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,YAAY,EACZ,WAAW,EACX,eAAe,EACf,aAAa,EACb,YAAY,EAEb,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,CAAe;IAE3B;;;;;OAKG;gBAED,MAAM,EAAE,aAAa,EACrB,MAAM,EAAE,MAAM,EACd,MAAM,GAAE,YAAkC;IAa5C;;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,MAAM,iBAET;IAED;;OAEG;IACH,IAAI,gBAAgB,mDAEnB;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED;;OAEG;IACH,gBAAgB;IAMhB;;OAEG;IACH,WAAW,CAAC,MAAM,EAAE,YAAY;IAKhC;;OAEG;IACH,IAAI,CAAC,QAAQ,EAAE,YAAY;CAG5B"}
+{"version":3,"file":"AcDbCircle.d.ts","sourceRoot":"","sources":["../../src/entity/AcDbCircle.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,YAAY,EACZ,WAAW,EACX,eAAe,EACf,aAAa,EACb,YAAY,EAEb,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAA;AAE3D,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAEvC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,UAAW,SAAQ,SAAS;IACvC,mDAAmD;IACnD,OAAO,CAAC,IAAI,CAAe;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;gBAED,MAAM,EAAE,aAAa,EACrB,MAAM,EAAE,MAAM,EACd,MAAM,GAAE,YAAkC;IAa5C;;;;;;;;;;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;;;;;;;;;;;;OAYG;IACH,IAAI,MAAM,iBAET;IAED;;;;;;;;;;OAUG;IACH,IAAI,gBAAgB,mDAEnB;IAED;;;;;;OAMG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED;;;;;;;;;;;;;OAaG;IACH,gBAAgB;IAMhB;;;;;;;;;;;;;;;OAeG;IACH,WAAW,CAAC,MAAM,EAAE,YAAY;IAKhC;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,QAAQ,EAAE,YAAY;CAG5B"}

package/lib/entity/AcDbCircle.js

@@ -16,15 +16,54 @@ var __extends = (this && this.__extends) || (function () {
 import { AcGeCircArc3d, AcGeVector3d, TAU } from '@mlightcad/geometry-engine';
 import { AcDbCurve } from './AcDbCurve';
 /**
- * The class represents the circle entity in AutoCAD.
+ * Represents a circle entity in AutoCAD.
+ *
+ * A circle is a 2D geometric object defined by its center point and radius.
+ * Circles are closed curves that can be used to create circular shapes
+ * in drawings. The circle is always drawn in the plane defined by its normal vector.
+ *
+ * @example
+ * ```typescript
+ * // Create a circle with center at (0,0,0) and radius 5
+ * const circle = new AcDbCircle(
+ *   new AcGePoint3d(0, 0, 0),
+ *   5
+ * );
+ *
+ * // Access circle properties
+ * console.log(`Center: ${circle.center}`);
+ * console.log(`Radius: ${circle.radius}`);
+ * console.log(`Normal: ${circle.normal}`);
+ * ```
  */
 var AcDbCircle = /** @class */ (function (_super) {
     __extends(AcDbCircle, _super);
     /**
-     * This constructor creates an arc using the values passed in. 'center' must be in WCS coordinates.
+     * Creates a new circle entity.
      *
-     * @param center Input center point of the arc
-     * @param radius Input radius of the arc
+     * This constructor creates a circle using the specified center point and radius.
+     * The center point must be in World Coordinate System (WCS) coordinates.
+     * The circle is created as a full circle (0 to 2π radians).
+     *
+     * @param center - The center point of the circle in WCS coordinates
+     * @param radius - The radius of the circle (must be positive)
+     * @param normal - The normal vector defining the plane of the circle (defaults to Z-axis)
+     *
+     * @example
+     * ```typescript
+     * // Create a circle in the XY plane
+     * const circle = new AcDbCircle(
+     *   new AcGePoint3d(10, 20, 0),
+     *   15
+     * );
+     *
+     * // Create a circle in a different plane
+     * const circleInYZ = new AcDbCircle(
+     *   new AcGePoint3d(0, 0, 0),
+     *   10,
+     *   AcGeVector3d.X_AXIS
+     * );
+     * ```
      */
     function AcDbCircle(center, radius, normal) {
         if (normal === void 0) { normal = AcGeVector3d.Z_AXIS; }
@@ -34,11 +73,29 @@ var AcDbCircle = /** @class */ (function (_super) {
     }
     Object.defineProperty(AcDbCircle.prototype, "center", {
         /**
-         * Center point of circular arc
+         * Gets the center point of this circle.
+         *
+         * @returns The center point as a 3D point
+         *
+         * @example
+         * ```typescript
+         * const centerPoint = circle.center;
+         * console.log(`Circle center: ${centerPoint.x}, ${centerPoint.y}, ${centerPoint.z}`);
+         * ```
          */
         get: function () {
             return this._geo.center;
         },
+        /**
+         * Sets the center point of this circle.
+         *
+         * @param value - The new center point
+         *
+         * @example
+         * ```typescript
+         * circle.center = new AcGePoint3d(5, 5, 0);
+         * ```
+         */
         set: function (value) {
             this._geo.center = value;
         },
@@ -47,11 +104,29 @@ var AcDbCircle = /** @class */ (function (_super) {
     });
     Object.defineProperty(AcDbCircle.prototype, "radius", {
         /**
-         * Radius of circular arc
+         * Gets the radius of this circle.
+         *
+         * @returns The radius value
+         *
+         * @example
+         * ```typescript
+         * const radius = circle.radius;
+         * console.log(`Circle radius: ${radius}`);
+         * ```
          */
         get: function () {
             return this._geo.radius;
         },
+        /**
+         * Sets the radius of this circle.
+         *
+         * @param value - The new radius value (must be positive)
+         *
+         * @example
+         * ```typescript
+         * circle.radius = 25;
+         * ```
+         */
         set: function (value) {
             this._geo.radius = value;
         },
@@ -60,7 +135,17 @@ var AcDbCircle = /** @class */ (function (_super) {
     });
     Object.defineProperty(AcDbCircle.prototype, "normal", {
         /**
-         * Arc's unit normal vector in WCS coordinates.
+         * Gets the normal vector of this circle.
+         *
+         * The normal vector defines the plane in which the circle lies.
+         *
+         * @returns The unit normal vector in WCS coordinates
+         *
+         * @example
+         * ```typescript
+         * const normal = circle.normal;
+         * console.log(`Circle normal: ${normal.x}, ${normal.y}, ${normal.z}`);
+         * ```
          */
         get: function () {
             return this._geo.normal;
@@ -70,7 +155,15 @@ var AcDbCircle = /** @class */ (function (_super) {
     });
     Object.defineProperty(AcDbCircle.prototype, "geometricExtents", {
         /**
-         * @inheritdoc
+         * Gets the geometric extents (bounding box) of this circle.
+         *
+         * @returns The bounding box that encompasses the entire circle
+         *
+         * @example
+         * ```typescript
+         * const extents = circle.geometricExtents;
+         * console.log(`Circle bounds: ${extents.minPoint} to ${extents.maxPoint}`);
+         * ```
          */
         get: function () {
             return this._geo.box;
@@ -80,7 +173,11 @@ var AcDbCircle = /** @class */ (function (_super) {
     });
     Object.defineProperty(AcDbCircle.prototype, "closed", {
         /**
-         * @inheritdoc
+         * Gets whether this circle is closed.
+         *
+         * Circles are always closed entities, so this always returns true.
+         *
+         * @returns Always true for circles
          */
         get: function () {
             return this._geo.closed;
@@ -89,7 +186,18 @@ var AcDbCircle = /** @class */ (function (_super) {
         configurable: true
     });
     /**
-     * @inheritdoc
+     * Gets the grip points for this circle.
+     *
+     * Grip points are control points that can be used to modify the circle.
+     * For a circle, the grip point is the center point.
+     *
+     * @returns Array of grip points (center point)
+     *
+     * @example
+     * ```typescript
+     * const gripPoints = circle.subGetGripPoints();
+     * // gripPoints contains: [center]
+     * ```
      */
     AcDbCircle.prototype.subGetGripPoints = function () {
         var gripPoints = new Array();
@@ -97,14 +205,38 @@ var AcDbCircle = /** @class */ (function (_super) {
         return gripPoints;
     };
     /**
-     * @inheritdoc
+     * Transforms this circle by the specified matrix.
+     *
+     * This method applies a geometric transformation to the circle, updating
+     * the center point, radius, and normal vector according to the transformation matrix.
+     *
+     * @param matrix - The transformation matrix to apply
+     * @returns This circle after transformation
+     *
+     * @example
+     * ```typescript
+     * const translationMatrix = AcGeMatrix3d.translation(10, 0, 0);
+     * circle.transformBy(translationMatrix);
+     * // Circle is now translated 10 units in the X direction
+     * ```
      */
     AcDbCircle.prototype.transformBy = function (matrix) {
         this._geo.transform(matrix);
         return this;
     };
     /**
-     * @inheritdoc
+     * Draws this circle using the specified renderer.
+     *
+     * This method renders the circle as a circular arc using the circle's
+     * current style properties.
+     *
+     * @param renderer - The renderer to use for drawing
+     * @returns The rendered circle entity, or undefined if drawing failed
+     *
+     * @example
+     * ```typescript
+     * const renderedCircle = circle.draw(renderer);
+     * ```
      */
     AcDbCircle.prototype.draw = function (renderer) {
         return renderer.circularArc(this._geo, this.lineStyle);

package/lib/entity/AcDbCircle.js.map

@@ -1 +1 @@
-{"version":3,"file":"AcDbCircle.js","sourceRoot":"","sources":["../../src/entity/AcDbCircle.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,OAAO,EACL,aAAa,EAKb,YAAY,EACZ,GAAG,EACJ,MAAM,4BAA4B,CAAA;AAGnC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAEvC;;GAEG;AACH;IAAgC,8BAAS;IAGvC;;;;;OAKG;IACH,oBACE,MAAqB,EACrB,MAAc,EACd,MAA0C;QAA1C,uBAAA,EAAA,SAAuB,YAAY,CAAC,MAAM;QAE1C,YAAA,MAAK,WAAE,SAAA;QACP,KAAI,CAAC,IAAI,GAAG,IAAI,aAAa,CAC3B,MAAM,EACN,MAAM,EACN,CAAC,EACD,GAAG,EACH,MAAM,EACN,YAAY,CAAC,MAAM,CACpB,CAAA;;IACH,CAAC;IAKD,sBAAI,8BAAM;QAHV;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAA;QACzB,CAAC;aACD,UAAW,KAAsB;YAC/B,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAA;QAC1B,CAAC;;;OAHA;IAQD,sBAAI,8BAAM;QAHV;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAA;QACzB,CAAC;aACD,UAAW,KAAa;YACtB,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAA;QAC1B,CAAC;;;OAHA;IAQD,sBAAI,8BAAM;QAHV;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAA;QACzB,CAAC;;;OAAA;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;;;OAAA;IAED;;OAEG;IACH,qCAAgB,GAAhB;QACE,IAAM,UAAU,GAAG,IAAI,KAAK,EAAe,CAAA;QAC3C,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAC5B,OAAO,UAAU,CAAA;IACnB,CAAC;IAED;;OAEG;IACH,gCAAW,GAAX,UAAY,MAAoB;QAC9B,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;QAC3B,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;OAEG;IACH,yBAAI,GAAJ,UAAK,QAAsB;QACzB,OAAO,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,CAAA;IACxD,CAAC;IACH,iBAAC;AAAD,CAAC,AAzFD,CAAgC,SAAS,GAyFxC"}
+{"version":3,"file":"AcDbCircle.js","sourceRoot":"","sources":["../../src/entity/AcDbCircle.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,OAAO,EACL,aAAa,EAKb,YAAY,EACZ,GAAG,EACJ,MAAM,4BAA4B,CAAA;AAGnC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAEvC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH;IAAgC,8BAAS;IAIvC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,oBACE,MAAqB,EACrB,MAAc,EACd,MAA0C;QAA1C,uBAAA,EAAA,SAAuB,YAAY,CAAC,MAAM;QAE1C,YAAA,MAAK,WAAE,SAAA;QACP,KAAI,CAAC,IAAI,GAAG,IAAI,aAAa,CAC3B,MAAM,EACN,MAAM,EACN,CAAC,EACD,GAAG,EACH,MAAM,EACN,YAAY,CAAC,MAAM,CACpB,CAAA;;IACH,CAAC;IAaD,sBAAI,8BAAM;QAXV;;;;;;;;;;WAUG;aACH;YACE,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAA;QACzB,CAAC;QAED;;;;;;;;;WASG;aACH,UAAW,KAAsB;YAC/B,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAA;QAC1B,CAAC;;;OAdA;IA2BD,sBAAI,8BAAM;QAXV;;;;;;;;;;WAUG;aACH;YACE,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAA;QACzB,CAAC;QAED;;;;;;;;;WASG;aACH,UAAW,KAAa;YACtB,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAA;QAC1B,CAAC;;;OAdA;IA6BD,sBAAI,8BAAM;QAbV;;;;;;;;;;;;WAYG;aACH;YACE,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAA;QACzB,CAAC;;;OAAA;IAaD,sBAAI,wCAAgB;QAXpB;;;;;;;;;;WAUG;aACH;YACE,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAA;QACtB,CAAC;;;OAAA;IASD,sBAAI,8BAAM;QAPV;;;;;;WAMG;aACH;YACE,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAA;QACzB,CAAC;;;OAAA;IAED;;;;;;;;;;;;;OAaG;IACH,qCAAgB,GAAhB;QACE,IAAM,UAAU,GAAG,IAAI,KAAK,EAAe,CAAA;QAC3C,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAC5B,OAAO,UAAU,CAAA;IACnB,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,gCAAW,GAAX,UAAY,MAAoB;QAC9B,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;QAC3B,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,yBAAI,GAAJ,UAAK,QAAsB;QACzB,OAAO,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,CAAA;IACxD,CAAC;IACH,iBAAC;AAAD,CAAC,AA9MD,CAAgC,SAAS,GA8MxC"}