@mlightcad/cad-simple-viewer 1.0.0 → 1.0.1

package/lib/editor/input/AcEdCursorManager.js

@@ -1,30 +1,105 @@
+/**
+ * Enumeration of cursor types available in the CAD editor.
+ *
+ * These cursor types provide visual feedback to users about the current
+ * operation mode or expected input type. Each cursor has a specific
+ * appearance and is used in different contexts.
+ *
+ * @example
+ * ```typescript
+ * // Set crosshair cursor for precise point input
+ * editor.setCursor(AcEdCorsorType.Crosshair);
+ *
+ * // Set grab cursor for pan operations
+ * editor.setCursor(AcEdCorsorType.Grab);
+ *
+ * // Restore default cursor
+ * editor.setCursor(AcEdCorsorType.NoSpecialCursor);
+ * ```
+ */
 export var AcEdCorsorType;
 (function (AcEdCorsorType) {
+    /** No special cursor - uses browser default */
     AcEdCorsorType[AcEdCorsorType["NoSpecialCursor"] = -1] = "NoSpecialCursor";
+    /** Crosshair cursor for precise point selection */
     AcEdCorsorType[AcEdCorsorType["Crosshair"] = 0] = "Crosshair";
+    /** Rectangle cursor for area selection */
     AcEdCorsorType[AcEdCorsorType["RectCursor"] = 1] = "RectCursor";
+    /** Rubber band cursor for dynamic drawing */
     AcEdCorsorType[AcEdCorsorType["RubberBand"] = 2] = "RubberBand";
+    /** Non-rotated cursor */
     AcEdCorsorType[AcEdCorsorType["NotRotated"] = 3] = "NotRotated";
+    /** Target box cursor for object snapping */
     AcEdCorsorType[AcEdCorsorType["TargetBox"] = 4] = "TargetBox";
+    /** Rotated crosshair cursor */
     AcEdCorsorType[AcEdCorsorType["RotatedCrosshair"] = 5] = "RotatedCrosshair";
+    /** Crosshair that doesn't rotate with view */
     AcEdCorsorType[AcEdCorsorType["CrosshairNoRotate"] = 6] = "CrosshairNoRotate";
+    /** Invisible cursor for hiding cursor */
     AcEdCorsorType[AcEdCorsorType["Invisible"] = 7] = "Invisible";
+    /** Entity selection cursor */
     AcEdCorsorType[AcEdCorsorType["EntitySelect"] = 8] = "EntitySelect";
+    /** Parallelogram cursor for skewed operations */
     AcEdCorsorType[AcEdCorsorType["Parallelogram"] = 9] = "Parallelogram";
+    /** Entity select cursor without perspective */
     AcEdCorsorType[AcEdCorsorType["EntitySelectNoPersp"] = 10] = "EntitySelectNoPersp";
+    /** Cursor for pick-first or grips operations */
     AcEdCorsorType[AcEdCorsorType["PkfirstOrGrips"] = 11] = "PkfirstOrGrips";
+    /** Dashed crosshair cursor */
     AcEdCorsorType[AcEdCorsorType["CrosshairDashed"] = 12] = "CrosshairDashed";
+    /** Grab/hand cursor for panning */
     AcEdCorsorType[AcEdCorsorType["Grab"] = 13] = "Grab";
 })(AcEdCorsorType || (AcEdCorsorType = {}));
 /**
- * The class to create and manage cursor
- * @internal
+ * Manages cursor appearance and behavior for the CAD editor.
+ *
+ * This class creates and applies custom cursors to HTML elements,
+ * providing visual feedback for different CAD operations. It supports
+ * both built-in browser cursors and custom SVG-based cursors.
+ *
+ * The cursor manager maintains a cache of cursor definitions to avoid
+ * recreating them repeatedly, improving performance.
+ *
+ * @internal This class is for internal use by the editor system
+ *
+ * @example
+ * ```typescript
+ * const cursorManager = new AcEdCursorManager();
+ * const canvas = document.getElementById('canvas') as HTMLCanvasElement;
+ *
+ * // Set crosshair cursor
+ * cursorManager.setCursor(AcEdCorsorType.Crosshair, canvas);
+ *
+ * // Set grab cursor for panning
+ * cursorManager.setCursor(AcEdCorsorType.Grab, canvas);
+ * ```
  */
 var AcEdCursorManager = /** @class */ (function () {
+    /**
+     * Creates a new cursor manager instance.
+     *
+     * Initializes the cursor cache and creates default cursor definitions.
+     */
     function AcEdCursorManager() {
         this._cursorMap = new Map();
         this._cursorMap.set(AcEdCorsorType.Crosshair, this.createRectCrossIcon(10, 10));
     }
+    /**
+     * Sets the cursor for the specified HTML element.
+     *
+     * Applies the appropriate cursor style based on the cursor type.
+     * For built-in cursor types, uses CSS cursor values. For custom
+     * cursor types, uses cached SVG-based cursor definitions.
+     *
+     * @param cursorType - The type of cursor to set
+     * @param element - The HTML element to apply the cursor to
+     *
+     * @example
+     * ```typescript
+     * const canvas = document.getElementById('canvas') as HTMLCanvasElement;
+     * cursorManager.setCursor(AcEdCorsorType.Crosshair, canvas);
+     * ```
+     */
     AcEdCursorManager.prototype.setCursor = function (cursorType, element) {
         if (cursorType <= AcEdCorsorType.NoSpecialCursor) {
             element.style.cursor = 'default';
@@ -40,15 +115,24 @@ var AcEdCursorManager = /** @class */ (function () {
         }
     };
     /**
-     * Encode SVG string to one cursor defined using url() in CSS
-     * @param svgString Input svg string
-     * @param xOffset Input x offset for cursor hotspot
-     * @param yOffset Input y offset for cursor hotspot
-     * @returns
+     * Encodes an SVG string into a CSS cursor URL.
+     *
+     * This method converts SVG markup into a data URI that can be used
+     * as a CSS cursor value, with specified hotspot coordinates.
+     *
+     * @param svgString - The SVG markup as a string
+     * @param xOffset - X coordinate of the cursor hotspot
+     * @param yOffset - Y coordinate of the cursor hotspot
+     * @returns CSS cursor string in url() format
+     *
+     * @example
+     * ```typescript
+     * const svgCursor = '<svg width="20" height="20">...</svg>';
+     * const cursorUrl = cursorManager.encodeSvgToCursor(svgCursor, 10, 10);
+     * element.style.cursor = cursorUrl;
+     * ```
      */
-    AcEdCursorManager.prototype.encodeSvg = function (svgString, xOffset, yOffset) {
-        if (xOffset === void 0) { xOffset = 0; }
-        if (yOffset === void 0) { yOffset = 0; }
+    AcEdCursorManager.prototype.encodeSvgToCursor = function (svgString, xOffset, yOffset) {
         return "url('data:image/svg+xml;base64,".concat(btoa(svgString), "') ").concat(xOffset, " ").concat(yOffset, ", auto");
     };
     /**
@@ -63,7 +147,7 @@ var AcEdCursorManager = /** @class */ (function () {
         var halfSize = rectSize / 2;
         var svgSize = rectSize + 2 * lineLength;
         var svg = "\n      <svg xmlns=\"http://www.w3.org/2000/svg\" width=\"".concat(svgSize, "\" height=\"").concat(svgSize, "\" viewBox=\"0 0 ").concat(svgSize, " ").concat(svgSize, "\">\n        <rect x=\"").concat(lineLength, "\" y=\"").concat(lineLength, "\" width=\"").concat(rectSize, "\" height=\"").concat(rectSize, "\" fill=\"none\" stroke=\"").concat(lineColor, "\" />\n        <line x1=\"").concat(halfSize + lineLength, "\" y1=\"0\" x2=\"").concat(halfSize + lineLength, "\" y2=\"").concat(lineLength, "\" stroke=\"").concat(lineColor, "\" />\n        <line x1=\"").concat(rectSize + lineLength, "\" y1=\"").concat(halfSize + lineLength, "\" x2=\"").concat(rectSize + 2 * lineLength, "\" y2=\"").concat(halfSize + lineLength, "\" stroke=\"").concat(lineColor, "\" />\n        <line x1=\"").concat(halfSize + lineLength, "\" y1=\"").concat(rectSize + lineLength, "\" x2=\"").concat(halfSize + lineLength, "\" y2=\"").concat(rectSize + 2 * lineLength, "\" stroke=\"").concat(lineColor, "\" />\n        <line x1=\"0\" y1=\"").concat(halfSize + lineLength, "\" x2=\"").concat(lineLength, "\" y2=\"").concat(halfSize + lineLength, "\" stroke=\"").concat(lineColor, "\" />\n      </svg>\n    ");
-        return this.encodeSvg(svg, halfSize + lineLength, halfSize + lineLength);
+        return this.encodeSvgToCursor(svg, halfSize + lineLength, halfSize + lineLength);
     };
     return AcEdCursorManager;
 }());

package/lib/editor/input/AcEdCursorManager.js.map

@@ -1 +1 @@
-{"version":3,"file":"AcEdCursorManager.js","sourceRoot":"","sources":["../../../src/editor/input/AcEdCursorManager.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,cAgBX;AAhBD,WAAY,cAAc;IACxB,0EAAoB,CAAA;IACpB,6DAAa,CAAA;IACb,+DAAU,CAAA;IACV,+DAAU,CAAA;IACV,+DAAU,CAAA;IACV,6DAAS,CAAA;IACT,2EAAgB,CAAA;IAChB,6EAAiB,CAAA;IACjB,6DAAS,CAAA;IACT,mEAAY,CAAA;IACZ,qEAAa,CAAA;IACb,kFAAmB,CAAA;IACnB,wEAAc,CAAA;IACd,0EAAe,CAAA;IACf,oDAAI,CAAA;AACN,CAAC,EAhBW,cAAc,KAAd,cAAc,QAgBzB;AAED;;;GAGG;AACH;IAEE;QACE,IAAI,CAAC,UAAU,GAAG,IAAI,GAAG,EAAE,CAAA;QAC3B,IAAI,CAAC,UAAU,CAAC,GAAG,CACjB,cAAc,CAAC,SAAS,EACxB,IAAI,CAAC,mBAAmB,CAAC,EAAE,EAAE,EAAE,CAAC,CACjC,CAAA;IACH,CAAC;IAED,qCAAS,GAAT,UAAU,UAA0B,EAAE,OAAoB;QACxD,IAAI,UAAU,IAAI,cAAc,CAAC,eAAe,EAAE,CAAC;YACjD,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,SAAS,CAAA;QAClC,CAAC;aAAM,IAAI,UAAU,IAAI,cAAc,CAAC,IAAI,EAAE,CAAC;YAC7C,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,MAAM,CAAA;QAC/B,CAAC;aAAM,CAAC;YACN,IAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;YAC9C,IAAI,MAAM,EAAE,CAAC;gBACX,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,MAAM,CAAA;YAC/B,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACK,qCAAS,GAAjB,UACE,SAAiB,EACjB,OAAmB,EACnB,OAAmB;QADnB,wBAAA,EAAA,WAAmB;QACnB,wBAAA,EAAA,WAAmB;QAEnB,OAAO,yCAAkC,IAAI,CAAC,SAAS,CAAC,gBAAM,OAAO,cAAI,OAAO,WAAQ,CAAA;IAC1F,CAAC;IAED;;;;;;OAMG;IACK,+CAAmB,GAA3B,UACE,QAAgB,EAChB,UAAkB,EAClB,SAA2B;QAA3B,0BAAA,EAAA,mBAA2B;QAE3B,IAAM,QAAQ,GAAG,QAAQ,GAAG,CAAC,CAAA;QAC7B,IAAM,OAAO,GAAG,QAAQ,GAAG,CAAC,GAAG,UAAU,CAAA;QACzC,IAAM,GAAG,GAAG,oEACuC,OAAO,yBAAa,OAAO,8BAAkB,OAAO,cAAI,OAAO,oCACnG,UAAU,oBAAQ,UAAU,wBAAY,QAAQ,yBAAa,QAAQ,uCAAyB,SAAS,uCACtG,QAAQ,GAAG,UAAU,8BAAgB,QAAQ,GAAG,UAAU,qBAAS,UAAU,yBAAa,SAAS,uCACnG,QAAQ,GAAG,UAAU,qBAAS,QAAQ,GAAG,UAAU,qBAAS,QAAQ,GAAG,CAAC,GAAG,UAAU,qBAAS,QAAQ,GAAG,UAAU,yBAAa,SAAS,uCACzI,QAAQ,GAAG,UAAU,qBAAS,QAAQ,GAAG,UAAU,qBAAS,QAAQ,GAAG,UAAU,qBAAS,QAAQ,GAAG,CAAC,GAAG,UAAU,yBAAa,SAAS,gDAClI,QAAQ,GAAG,UAAU,qBAAS,UAAU,qBAAS,QAAQ,GAAG,UAAU,yBAAa,SAAS,8BAElH,CAAA;QACD,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,QAAQ,GAAG,UAAU,EAAE,QAAQ,GAAG,UAAU,CAAC,CAAA;IAC1E,CAAC;IACH,wBAAC;AAAD,CAAC,AA/DD,IA+DC"}
+{"version":3,"file":"AcEdCursorManager.js","sourceRoot":"","sources":["../../../src/editor/input/AcEdCursorManager.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAN,IAAY,cA+BX;AA/BD,WAAY,cAAc;IACxB,+CAA+C;IAC/C,0EAAoB,CAAA;IACpB,mDAAmD;IACnD,6DAAa,CAAA;IACb,0CAA0C;IAC1C,+DAAU,CAAA;IACV,6CAA6C;IAC7C,+DAAU,CAAA;IACV,yBAAyB;IACzB,+DAAU,CAAA;IACV,4CAA4C;IAC5C,6DAAS,CAAA;IACT,+BAA+B;IAC/B,2EAAgB,CAAA;IAChB,8CAA8C;IAC9C,6EAAiB,CAAA;IACjB,yCAAyC;IACzC,6DAAS,CAAA;IACT,8BAA8B;IAC9B,mEAAY,CAAA;IACZ,iDAAiD;IACjD,qEAAa,CAAA;IACb,+CAA+C;IAC/C,kFAAmB,CAAA;IACnB,gDAAgD;IAChD,wEAAc,CAAA;IACd,8BAA8B;IAC9B,0EAAe,CAAA;IACf,mCAAmC;IACnC,oDAAI,CAAA;AACN,CAAC,EA/BW,cAAc,KAAd,cAAc,QA+BzB;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH;IAIE;;;;OAIG;IACH;QACE,IAAI,CAAC,UAAU,GAAG,IAAI,GAAG,EAAE,CAAA;QAC3B,IAAI,CAAC,UAAU,CAAC,GAAG,CACjB,cAAc,CAAC,SAAS,EACxB,IAAI,CAAC,mBAAmB,CAAC,EAAE,EAAE,EAAE,CAAC,CACjC,CAAA;IACH,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,qCAAS,GAAT,UAAU,UAA0B,EAAE,OAAoB;QACxD,IAAI,UAAU,IAAI,cAAc,CAAC,eAAe,EAAE,CAAC;YACjD,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,SAAS,CAAA;QAClC,CAAC;aAAM,IAAI,UAAU,IAAI,cAAc,CAAC,IAAI,EAAE,CAAC;YAC7C,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,MAAM,CAAA;QAC/B,CAAC;aAAM,CAAC;YACN,IAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;YAC9C,IAAI,MAAM,EAAE,CAAC;gBACX,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,MAAM,CAAA;YAC/B,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,6CAAiB,GAAjB,UAAkB,SAAiB,EAAE,OAAe,EAAE,OAAe;QACnE,OAAO,yCAAkC,IAAI,CAAC,SAAS,CAAC,gBAAM,OAAO,cAAI,OAAO,WAAQ,CAAA;IAC1F,CAAC;IAED;;;;;;OAMG;IACK,+CAAmB,GAA3B,UACE,QAAgB,EAChB,UAAkB,EAClB,SAA2B;QAA3B,0BAAA,EAAA,mBAA2B;QAE3B,IAAM,QAAQ,GAAG,QAAQ,GAAG,CAAC,CAAA;QAC7B,IAAM,OAAO,GAAG,QAAQ,GAAG,CAAC,GAAG,UAAU,CAAA;QACzC,IAAM,GAAG,GAAG,oEACuC,OAAO,yBAAa,OAAO,8BAAkB,OAAO,cAAI,OAAO,oCACnG,UAAU,oBAAQ,UAAU,wBAAY,QAAQ,yBAAa,QAAQ,uCAAyB,SAAS,uCACtG,QAAQ,GAAG,UAAU,8BAAgB,QAAQ,GAAG,UAAU,qBAAS,UAAU,yBAAa,SAAS,uCACnG,QAAQ,GAAG,UAAU,qBAAS,QAAQ,GAAG,UAAU,qBAAS,QAAQ,GAAG,CAAC,GAAG,UAAU,qBAAS,QAAQ,GAAG,UAAU,yBAAa,SAAS,uCACzI,QAAQ,GAAG,UAAU,qBAAS,QAAQ,GAAG,UAAU,qBAAS,QAAQ,GAAG,UAAU,qBAAS,QAAQ,GAAG,CAAC,GAAG,UAAU,yBAAa,SAAS,gDAClI,QAAQ,GAAG,UAAU,qBAAS,UAAU,qBAAS,QAAQ,GAAG,UAAU,yBAAa,SAAS,8BAElH,CAAA;QACD,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,QAAQ,GAAG,UAAU,EAAE,QAAQ,GAAG,UAAU,CAAC,CAAA;IAClF,CAAC;IACH,wBAAC;AAAD,CAAC,AA7FD,IA6FC"}

package/lib/editor/input/AcEdInputPoint.d.ts

@@ -2,13 +2,50 @@ import { AcGePoint2d } from '@mlightcad/data-model';
 import { AcEdBaseView } from '../view/AcEdBaseView';
 import { AcEdBaseInput } from './AcEdBaseInput';
 /**
- * Class used to input one point
+ * Class used to input one point from user interaction.
+ *
+ * This class provides functionality for capturing a single point input from the user
+ * by handling mouse click events. When the user clicks on the canvas, the click
+ * coordinates are converted from screen coordinates to world coordinates and
+ * returned as the result.
+ *
+ * The input operation can be canceled by pressing the Escape key (handled by the base class).
+ *
+ * @example
+ * ```typescript
+ * const pointInput = new AcEdInputPoint(view);
+ * const point = await pointInput.start();
+ * console.log(`User clicked at: ${point.x}, ${point.y}`);
+ * ```
+ *
  * @internal
  */
 export declare class AcEdInputPoint extends AcEdBaseInput<AcGePoint2d> {
+    /**
+     * Creates a new point input instance.
+     *
+     * @param view - The view that will handle this point input operation
+     */
     constructor(view: AcEdBaseView);
+    /**
+     * Activates the point input operation.
+     * Sets up the click event listener to capture user point selection.
+     * Overrides the base class to add click event handling.
+     */
     activate(): void;
+    /**
+     * Deactivates the point input operation.
+     * Removes the click event listener.
+     * Overrides the base class to clean up click event handling.
+     */
     deactivate(): void;
+    /**
+     * Handles mouse click events to capture the selected point.
+     * Converts the click coordinates from screen space to world coordinates
+     * and resolves the input operation with the resulting point.
+     *
+     * @param event - The mouse click event containing the screen coordinates
+     */
     private onClick;
 }
 //# sourceMappingURL=AcEdInputPoint.d.ts.map

package/lib/editor/input/AcEdInputPoint.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AcEdInputPoint.d.ts","sourceRoot":"","sources":["../../../src/editor/input/AcEdInputPoint.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAEnD,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE/C;;;GAGG;AACH,qBAAa,cAAe,SAAQ,aAAa,CAAC,WAAW,CAAC;gBAChD,IAAI,EAAE,YAAY;IAI9B,QAAQ;IAKR,UAAU;IAKV,OAAO,CAAC,OAAO,CAEd;CACF"}
+{"version":3,"file":"AcEdInputPoint.d.ts","sourceRoot":"","sources":["../../../src/editor/input/AcEdInputPoint.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAEnD,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE/C;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,cAAe,SAAQ,aAAa,CAAC,WAAW,CAAC;IAC5D;;;;OAIG;gBACS,IAAI,EAAE,YAAY;IAI9B;;;;OAIG;IACH,QAAQ;IAKR;;;;OAIG;IACH,UAAU;IAKV;;;;;;OAMG;IACH,OAAO,CAAC,OAAO,CAEd;CACF"}

package/lib/editor/input/AcEdInputPoint.js

@@ -15,22 +15,59 @@ var __extends = (this && this.__extends) || (function () {
 })();
 import { AcEdBaseInput } from './AcEdBaseInput';
 /**
- * Class used to input one point
+ * Class used to input one point from user interaction.
+ *
+ * This class provides functionality for capturing a single point input from the user
+ * by handling mouse click events. When the user clicks on the canvas, the click
+ * coordinates are converted from screen coordinates to world coordinates and
+ * returned as the result.
+ *
+ * The input operation can be canceled by pressing the Escape key (handled by the base class).
+ *
+ * @example
+ * ```typescript
+ * const pointInput = new AcEdInputPoint(view);
+ * const point = await pointInput.start();
+ * console.log(`User clicked at: ${point.x}, ${point.y}`);
+ * ```
+ *
  * @internal
  */
 var AcEdInputPoint = /** @class */ (function (_super) {
     __extends(AcEdInputPoint, _super);
+    /**
+     * Creates a new point input instance.
+     *
+     * @param view - The view that will handle this point input operation
+     */
     function AcEdInputPoint(view) {
         var _this = _super.call(this, view) || this;
+        /**
+         * Handles mouse click events to capture the selected point.
+         * Converts the click coordinates from screen space to world coordinates
+         * and resolves the input operation with the resulting point.
+         *
+         * @param event - The mouse click event containing the screen coordinates
+         */
         _this.onClick = function (event) {
             _this.resolve(_this.view.cwcs2Wcs({ x: event.clientX, y: event.clientY }));
         };
         return _this;
     }
+    /**
+     * Activates the point input operation.
+     * Sets up the click event listener to capture user point selection.
+     * Overrides the base class to add click event handling.
+     */
     AcEdInputPoint.prototype.activate = function () {
         _super.prototype.activate.call(this);
         this.view.canvas.addEventListener('click', this.onClick);
     };
+    /**
+     * Deactivates the point input operation.
+     * Removes the click event listener.
+     * Overrides the base class to clean up click event handling.
+     */
     AcEdInputPoint.prototype.deactivate = function () {
         _super.prototype.deactivate.call(this);
         this.view.canvas.removeEventListener('click', this.onClick);

package/lib/editor/input/AcEdInputPoint.js.map

@@ -1 +1 @@
-{"version":3,"file":"AcEdInputPoint.js","sourceRoot":"","sources":["../../../src/editor/input/AcEdInputPoint.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAGA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE/C;;;GAGG;AACH;IAAoC,kCAA0B;IAC5D,wBAAY,IAAkB;QAC5B,YAAA,MAAK,YAAC,IAAI,CAAC,SAAA;QAaL,aAAO,GAAG,UAAC,KAAiB;YAClC,KAAI,CAAC,OAAO,CAAC,KAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAA;QAC1E,CAAC,CAAA;;IAdD,CAAC;IAED,iCAAQ,GAAR;QACE,gBAAK,CAAC,QAAQ,WAAE,CAAA;QAChB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAA;IAC1D,CAAC;IAED,mCAAU,GAAV;QACE,gBAAK,CAAC,UAAU,WAAE,CAAA;QAClB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAA;IAC7D,CAAC;IAKH,qBAAC;AAAD,CAAC,AAlBD,CAAoC,aAAa,GAkBhD"}
+{"version":3,"file":"AcEdInputPoint.js","sourceRoot":"","sources":["../../../src/editor/input/AcEdInputPoint.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAGA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE/C;;;;;;;;;;;;;;;;;;GAkBG;AACH;IAAoC,kCAA0B;IAC5D;;;;OAIG;IACH,wBAAY,IAAkB;QAC5B,YAAA,MAAK,YAAC,IAAI,CAAC,SAAA;QAuBb;;;;;;WAMG;QACK,aAAO,GAAG,UAAC,KAAiB;YAClC,KAAI,CAAC,OAAO,CAAC,KAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAA;QAC1E,CAAC,CAAA;;IA/BD,CAAC;IAED;;;;OAIG;IACH,iCAAQ,GAAR;QACE,gBAAK,CAAC,QAAQ,WAAE,CAAA;QAChB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAA;IAC1D,CAAC;IAED;;;;OAIG;IACH,mCAAU,GAAV;QACE,gBAAK,CAAC,UAAU,WAAE,CAAA;QAClB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAA;IAC7D,CAAC;IAYH,qBAAC;AAAD,CAAC,AAxCD,CAAoC,aAAa,GAwChD"}

package/lib/editor/input/AcEdJig.d.ts

@@ -1,14 +1,180 @@
 import { AcEdBaseView } from '../view';
+/**
+ * Base class for interactive drawing operations (jigs) in the CAD editor.
+ *
+ * A jig is an interactive operation that allows users to dynamically preview
+ * and modify geometric elements during creation. Common examples include:
+ * - Drawing lines with real-time preview as the mouse moves
+ * - Selecting rectangular areas with visual feedback
+ * - Dynamic entity placement with instant visual updates
+ *
+ * The jig system provides:
+ * - Real-time visual feedback during user interaction
+ * - Event-driven updates based on mouse movement
+ * - Asynchronous completion handling
+ * - Cancellation and error handling
+ *
+ * @template TResult - The type of result returned when the jig completes
+ *
+ * @example
+ * ```typescript
+ * class RectangleSelectionJig extends AcEdJig<Rectangle> {
+ *   private startPoint?: Point;
+ *   private currentPoint?: Point;
+ *
+ *   async sampler() {
+ *     // Get start point
+ *     this.startPoint = await this.view.editor.getPoint();
+ *
+ *     // Continue updating until complete
+ *     this.view.events.mouseMove.addEventListener(this.onMouseMove);
+ *   }
+ *
+ *   update() {
+ *     if (this.startPoint && this.currentPoint) {
+ *       // Update preview rectangle
+ *       this.drawPreviewRectangle(this.startPoint, this.currentPoint);
+ *     }
+ *   }
+ *
+ *   private onMouseMove = (args) => {
+ *     this.currentPoint = args;
+ *     // Jig loop will call update() automatically
+ *   }
+ * }
+ *
+ * // Usage
+ * const jig = new RectangleSelectionJig(view);
+ * const rectangle = await jig.drag();
+ * ```
+ */
 export declare class AcEdJig<TResult> {
+    /** Internal jig loop that handles the interactive operation */
     private _jigLoop;
+    /** The view associated with this jig */
     private _view;
+    /**
+     * Creates a new jig instance for the specified view.
+     *
+     * Sets up the jig loop and connects update event handling.
+     *
+     * @param view - The view this jig will operate in
+     */
     constructor(view: AcEdBaseView);
+    /**
+     * Gets the view associated with this jig.
+     *
+     * @returns The view instance
+     */
     get view(): AcEdBaseView;
+    /**
+     * Resolves the jig operation with the specified result.
+     *
+     * This method should be called when the jig operation completes successfully.
+     * It cleans up event listeners and resolves the underlying promise.
+     *
+     * @param result - The result to return from the jig operation
+     *
+     * @example
+     * ```typescript
+     * // In a line drawing jig, when user completes the line
+     * if (this.hasValidEndPoint()) {
+     *   const line = new Line(this.startPoint, this.endPoint);
+     *   this.resolve(line);
+     * }
+     * ```
+     */
     resolve(result: TResult): void;
+    /**
+     * Rejects the jig operation with an error.
+     *
+     * This method should be called when the jig operation fails or is cancelled.
+     * It cleans up event listeners and rejects the underlying promise.
+     *
+     * @param reason - The reason for the rejection
+     *
+     * @example
+     * ```typescript
+     * // If user cancels or invalid input is detected
+     * if (userPressedEscape) {
+     *   this.reject('Operation cancelled by user');
+     * }
+     * ```
+     */
     reject(reason: string): void;
+    /**
+     * Starts the interactive jig operation.
+     *
+     * This method initiates both the jig loop and the sampling process.
+     * It returns a promise that resolves when the jig operation completes
+     * or rejects if an error occurs.
+     *
+     * @returns Promise that resolves when the jig operation completes
+     *
+     * @example
+     * ```typescript
+     * const jig = new MyCustomJig(view);
+     * try {
+     *   const result = await jig.drag();
+     *   console.log('Jig completed with result:', result);
+     * } catch (error) {
+     *   console.log('Jig was cancelled or failed:', error);
+     * }
+     * ```
+     */
     drag(): Promise<void>;
+    /**
+     * Abstract method for handling jig input sampling.
+     *
+     * This method should be overridden by subclasses to implement
+     * the specific input handling logic for the jig. It typically:
+     * - Gets initial user input (like a start point)
+     * - Sets up event listeners for dynamic updates
+     * - Handles user interaction until completion
+     *
+     * The sampler runs concurrently with the jig loop and should
+     * call `resolve()` or `reject()` when the operation completes.
+     *
+     * @example
+     * ```typescript
+     * async sampler() {
+     *   // Get initial point
+     *   const startPoint = await this.view.editor.getPoint();
+     *
+     *   // Set up mouse tracking for dynamic preview
+     *   this.view.events.mouseMove.addEventListener(this.onMouseMove);
+     *   this.view.events.mouseClick.addEventListener(this.onMouseClick);
+     * }
+     * ```
+     */
     sampler(): Promise<void>;
+    /**
+     * Called during each update cycle to refresh the jig display.
+     *
+     * This method should be overridden by subclasses to implement
+     * the visual update logic. It's called automatically by the jig loop
+     * whenever the display needs to be refreshed (typically on mouse movement).
+     *
+     * Common update operations include:
+     * - Redrawing preview geometry
+     * - Updating dimension displays
+     * - Refreshing visual feedback elements
+     *
+     * @example
+     * ```typescript
+     * update() {
+     *   if (this.startPoint && this.currentMousePoint) {
+     *     // Clear previous preview
+     *     this.clearPreview();
+     *
+     *     // Draw new preview line
+     *     this.drawPreviewLine(this.startPoint, this.currentMousePoint);
+     *   }
+     * }
+     * ```
+     */
     update(): void;
+    /** Internal event handler for jig loop updates */
     private onUpdate;
 }
 //# sourceMappingURL=AcEdJig.d.ts.map

package/lib/editor/input/AcEdJig.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AcEdJig.d.ts","sourceRoot":"","sources":["../../../src/editor/input/AcEdJig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAGtC,qBAAa,OAAO,CAAC,OAAO;IAC1B,OAAO,CAAC,QAAQ,CAAsB;IACtC,OAAO,CAAC,KAAK,CAAc;gBAEf,IAAI,EAAE,YAAY;IAM9B,IAAI,IAAI,iBAEP;IAED,OAAO,CAAC,MAAM,EAAE,OAAO;IAKvB,MAAM,CAAC,MAAM,EAAE,MAAM;IAKf,IAAI;IAMJ,OAAO;IAIb,MAAM;IAIN,OAAO,CAAC,QAAQ,CAEf;CACF"}
+{"version":3,"file":"AcEdJig.d.ts","sourceRoot":"","sources":["../../../src/editor/input/AcEdJig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAGtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,qBAAa,OAAO,CAAC,OAAO;IAC1B,+DAA+D;IAC/D,OAAO,CAAC,QAAQ,CAAsB;IACtC,wCAAwC;IACxC,OAAO,CAAC,KAAK,CAAc;IAE3B;;;;;;OAMG;gBACS,IAAI,EAAE,YAAY;IAM9B;;;;OAIG;IACH,IAAI,IAAI,iBAEP;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,OAAO,CAAC,MAAM,EAAE,OAAO;IAKvB;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM;IAKrB;;;;;;;;;;;;;;;;;;;OAmBG;IACG,IAAI;IAMV;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,OAAO;IAIb;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,MAAM;IAIN,kDAAkD;IAClD,OAAO,CAAC,QAAQ,CAEf;CACF"}