@itwin/ecschema-rpcinterface-tests 5.0.0-dev.24 → 5.0.0-dev.25

package/lib/dist/bundled-tests.js

@@ -71821,8 +71821,10 @@ class ThreeAxes {
 class AccuDraw {
     constructor() {
         this._currentState = CurrentState.NotEnabled;
-        this.compassMode = CompassMode.Rectangular; // Compass mode
-        this.rotationMode = RotationMode.View; // Compass rotation
+        /** The current compass mode */
+        this.compassMode = CompassMode.Rectangular;
+        /** The current compass rotation */
+        this.rotationMode = RotationMode.View;
         /** @internal */
         this.published = new AccudrawData(); // Staging area for hints
         /** @internal */
@@ -71895,15 +71897,23 @@ class AccuDraw {
         this._frameColorNoFocus = _itwin_core_common__WEBPACK_IMPORTED_MODULE_2__.ColorDef.create(_itwin_core_common__WEBPACK_IMPORTED_MODULE_2__.ColorByName.darkGrey);
         /** @internal */
         this._fillColorNoFocus = _itwin_core_common__WEBPACK_IMPORTED_MODULE_2__.ColorDef.create(_itwin_core_common__WEBPACK_IMPORTED_MODULE_2__.ColorByName.lightGrey);
-        // User Preference Settings...
+        /** When true improve behavior for +/- input when cursor switches side and try to automatically manage focus */
         this.smartKeyin = true;
+        /** When true the compass follows the origin hint as opposed to remaining at a fixed location */
         this.floatingOrigin = true;
+        /** When true the z input field will remain locked with it's current value after a data button  */
         this.stickyZLock = false;
+        /** When true the compass is always active and on screen instead of following the current tools request to activate */
         this.alwaysShowCompass = false;
+        /** When true all tool hints are applied as opposed to only selected hints */
         this.contextSensitive = true;
+        /** When true the current point is adjusted to the x and y axes when within a close tolerance */
         this.axisIndexing = true;
+        /** When true the current point is adjusted to the last locked distance value when within a close tolerance */
         this.distanceIndexing = true;
+        /** When true locking the angle also moves focus to the angle input field */
         this.autoFocusFields = true;
+        /** When true fully specifying a point by entering both distance and angle in polar mode or XY[Z] in rectangular mode, the point is automatically accepted */
         this.autoPointPlacement = false;
     }
     /** Current AccuDraw state */
@@ -71925,9 +71935,13 @@ class AccuDraw {
         _itwin_core_geometry__WEBPACK_IMPORTED_MODULE_1__.Matrix3d.createRows(this.axes.x, this.axes.y, this.axes.z, rMatrix);
         return rMatrix;
     }
-    get isActive() { return CurrentState.Active === this.currentState; }
+    /** When true AccuDraw is enabled by the application and can be used by interactive tools */
     get isEnabled() { return (this.currentState > CurrentState.NotEnabled); }
+    /** When true the compass is displayed and adjusting input points for the current interactive tool */
+    get isActive() { return CurrentState.Active === this.currentState; }
+    /** When true the compass is not displayed or adjusting points, but it can be automatically activated by the current interactive tool or via shortcuts */
     get isInactive() { return (CurrentState.Inactive === this.currentState); }
+    /** When true the compass is not displayed or adjusting points, the current interactive tool has disabled automatic activation, but can still be enabled via shortcuts */
     get isDeactivated() { return (CurrentState.Deactivated === this.currentState); }
     /** Get the current lock state for the supplied input field */
     getFieldLock(index) { return this._fieldLocked[index]; }
@@ -72493,25 +72507,64 @@ class AccuDraw {
     getLengthParser() {
         return _IModelApp__WEBPACK_IMPORTED_MODULE_6__.IModelApp.quantityFormatter.findParserSpecByQuantityType(_quantity_formatting_QuantityFormatter__WEBPACK_IMPORTED_MODULE_12__.QuantityType.Length);
     }
+    /** Allow the AccuDraw user interface to supply the distance parser */
+    getLengthFormatter() {
+        return _IModelApp__WEBPACK_IMPORTED_MODULE_6__.IModelApp.quantityFormatter.findFormatterSpecByQuantityType(_quantity_formatting_QuantityFormatter__WEBPACK_IMPORTED_MODULE_12__.QuantityType.Length);
+    }
     stringToDistance(str) {
         const parserSpec = this.getLengthParser();
         if (parserSpec)
             return parserSpec.parseToQuantityValue(str);
         return { ok: false, error: _itwin_core_quantity__WEBPACK_IMPORTED_MODULE_13__.ParseError.InvalidParserSpec };
     }
+    stringFromDistance(distance) {
+        const formatterSpec = this.getLengthFormatter();
+        let formattedValue = distance.toString();
+        if (formatterSpec)
+            formattedValue = _IModelApp__WEBPACK_IMPORTED_MODULE_6__.IModelApp.quantityFormatter.formatQuantity(distance, formatterSpec);
+        return formattedValue;
+    }
     /** Allow the AccuDraw user interface to specify bearing */
-    get isBearingMode() { return false; }
+    get isBearingMode() { return this.getAngleParser()?.format.type === _itwin_core_quantity__WEBPACK_IMPORTED_MODULE_13__.FormatType.Bearing; }
+    /** Allow the AccuDraw user interface to specify bearing directions are always in xy plane */
+    get bearingFixedToPlane2d() { return this.flags.bearingFixToPlane2D; }
+    set bearingFixedToPlane2d(enable) { this.flags.bearingFixToPlane2D = enable; }
     /** Allow the AccuDraw user interface to supply the angle/direction parser */
     getAngleParser() {
-        // TODO: Use QuantityType.Angle when isBearingMode=false and "Bearing" for isBearingMode=true.
         return _IModelApp__WEBPACK_IMPORTED_MODULE_6__.IModelApp.quantityFormatter.findParserSpecByQuantityType(_quantity_formatting_QuantityFormatter__WEBPACK_IMPORTED_MODULE_12__.QuantityType.Angle);
     }
+    /** Allow the AccuDraw user interface to supply the angle/direction formatter */
+    getAngleFormatter() {
+        return _IModelApp__WEBPACK_IMPORTED_MODULE_6__.IModelApp.quantityFormatter.findFormatterSpecByQuantityType(_quantity_formatting_QuantityFormatter__WEBPACK_IMPORTED_MODULE_12__.QuantityType.Angle);
+    }
     stringToAngle(inString) {
         const parserSpec = this.getAngleParser();
         if (parserSpec)
             return parserSpec.parseToQuantityValue(inString);
         return { ok: false, error: _itwin_core_quantity__WEBPACK_IMPORTED_MODULE_13__.ParseError.InvalidParserSpec };
     }
+    stringFromAngle(angle) {
+        if (this.isBearingMode && this.flags.bearingFixToPlane2D) {
+            const point = _itwin_core_geometry__WEBPACK_IMPORTED_MODULE_1__.Vector3d.create(this.axes.x.x, this.axes.x.y, 0.0);
+            point.normalizeInPlace();
+            let adjustment = Math.acos(point.x);
+            if (point.y < 0.0)
+                adjustment = -adjustment;
+            angle += adjustment;
+        }
+        const formatterSpec = this.getAngleFormatter();
+        let formattedValue = angle.toString();
+        if (formatterSpec)
+            formattedValue = _IModelApp__WEBPACK_IMPORTED_MODULE_6__.IModelApp.quantityFormatter.formatQuantity(angle, formatterSpec);
+        return formattedValue;
+    }
+    /** Can be called by sub-classes to get a formatted value to display for an AccuDraw input field */
+    getFormattedValueByIndex(index) {
+        const value = _IModelApp__WEBPACK_IMPORTED_MODULE_6__.IModelApp.accuDraw.getValueByIndex(index);
+        if (ItemField.ANGLE_Item === index)
+            return this.stringFromAngle(value);
+        return this.stringFromDistance(value);
+    }
     updateFieldValue(index, input) {
         if (input.length === 0)
             return _itwin_core_bentley__WEBPACK_IMPORTED_MODULE_0__.BentleyStatus.ERROR;
@@ -74020,9 +74073,35 @@ class AccuDraw {
     onBeginDynamics() { return this.upgradeToActiveState(); }
     /** @internal */
     onEndDynamics() { return this.downgradeInactiveState(); }
+    /** Can be called by sub-classes as the default implementation of onMotion.
+     * @see [[onMotion]]
+     * @note Input fields are expected to call [[AccuDrawShortcuts.itemFieldNewInput]] when the user enters a value that is not a shortcut
+     * and call [[AccuDrawShortcuts.itemFieldCompletedInput]] when a value is accepted, such as when focusing out of the field. This is
+     * required for processMotion to correctly handle updating dynamic field values to reflect the current cursor location.
+     */
+    processMotion() {
+        if (this.flags.dialogNeedsUpdate || !this.isActive) {
+            if (this.isActive && this.smartKeyin) {
+                // NOTE: fixPointRectangular sets newFocus to either x or y based on which axis is closer to the input point...
+                if (CompassMode.Rectangular === this.compassMode && !this.dontMoveFocus && !this.getFieldLock(this.newFocus))
+                    this.setFocusItem(this.newFocus);
+            }
+            const sendDynamicFieldValueChange = (item) => {
+                if (KeyinStatus.Dynamic === this.getKeyinStatus(item))
+                    this.onFieldValueChange(item);
+            };
+            // NOTE: Shows the current deltas for rectangular mode when active and current coordinate when not active...
+            sendDynamicFieldValueChange(ItemField.X_Item);
+            sendDynamicFieldValueChange(ItemField.Y_Item);
+            sendDynamicFieldValueChange(ItemField.Z_Item);
+            sendDynamicFieldValueChange(ItemField.ANGLE_Item);
+            sendDynamicFieldValueChange(ItemField.DIST_Item);
+        }
+    }
     /** Implemented by sub-classes to update ui fields to show current deltas or coordinates when inactive.
      * Should also choose active x or y input field in rectangular mode based on cursor position when
      * axis isn't locked to support "smart lock".
+     * @see [[processMotion]]
      */
     onMotion(_ev) { }
     /** @internal */
@@ -162589,6 +162668,7 @@ class AccuDrawShortcuts {
         accudraw.dontMoveFocus = true;
     }
     static itemFieldNewInput(index) { _IModelApp__WEBPACK_IMPORTED_MODULE_6__.IModelApp.accuDraw.setKeyinStatus(index, _AccuDraw__WEBPACK_IMPORTED_MODULE_2__.KeyinStatus.Partial); }
+    static itemFieldCompletedInput(index) { _IModelApp__WEBPACK_IMPORTED_MODULE_6__.IModelApp.accuDraw.setKeyinStatus(index, _AccuDraw__WEBPACK_IMPORTED_MODULE_2__.KeyinStatus.Dynamic); }
     static async itemFieldAcceptInput(index, str) {
         const accudraw = _IModelApp__WEBPACK_IMPORTED_MODULE_6__.IModelApp.accuDraw;
         await accudraw.processFieldInput(index, str, true);
@@ -305538,7 +305618,7 @@ var loadLanguages = instance.loadLanguages;
 /***/ ((module) => {
 
 "use strict";
-module.exports = /*#__PURE__*/JSON.parse('{"name":"@itwin/core-frontend","version":"5.0.0-dev.24","description":"iTwin.js frontend components","main":"lib/cjs/core-frontend.js","module":"lib/esm/core-frontend.js","typings":"lib/cjs/core-frontend","license":"MIT","scripts":{"build":"npm run -s copy:public && npm run -s build:cjs && npm run -s build:esm && npm run -s webpackWorkers && npm run -s copy:workers","build:cjs":"npm run -s copy:js:cjs && tsc 1>&2 --outDir lib/cjs","build:esm":"npm run -s copy:js:esm && tsc 1>&2 --module ES2020 --outDir lib/esm","clean":"rimraf lib .rush/temp/package-deps*.json","copy:public":"cpx \\"./src/public/**/*\\" ./lib/public","copy:js:cjs":"cpx \\"./src/**/*.js\\" ./lib/cjs","copy:js:esm":"cpx \\"./src/**/*.js\\" ./lib/esm","copy:workers":"cpx \\"./lib/workers/webpack/parse-imdl-worker.js\\" ./lib/public/scripts","docs":"betools docs --json=../../generated-docs/core/core-frontend/file.json --tsIndexFile=./core-frontend.ts --onlyJson --excludes=webgl/**/*,**/map/*.d.ts,**/tile/*.d.ts,**/*-css.ts","extract-api":"betools extract-api --entry=core-frontend && npm run extract-extension-api","extract-extension-api":"eslint --no-inline-config -c extraction.eslint.config.js  \\"./src/**/*.ts\\" 1>&2","lint":"eslint \\"./src/**/*.ts\\" 1>&2","lint-fix":"eslint --fix -f visualstudio \\"./src/**/*.ts\\" 1>&2","pseudolocalize":"betools pseudolocalize --englishDir ./src/public/locales/en --out ./public/locales/en-PSEUDO","test":"npm run webpackTestWorker && vitest --run","cover":"npm run webpackTestWorker && vitest --run --coverage","test:debug":"vitest --run","webpackTests":"webpack --config ./src/test/utils/webpack.config.js 1>&2 && npm run -s webpackTestWorker","webpackTestWorker":"webpack --config ./src/test/worker/webpack.config.js 1>&2 && cpx \\"./lib/test/test-worker.js\\" ./lib/test","webpackWorkers":"webpack --config ./src/workers/ImdlParser/webpack.config.js 1>&2"},"repository":{"type":"git","url":"https://github.com/iTwin/itwinjs-core.git","directory":"core/frontend"},"keywords":["Bentley","BIM","iModel","digital-twin","iTwin"],"author":{"name":"Bentley Systems, Inc.","url":"http://www.bentley.com"},"peerDependencies":{"@itwin/appui-abstract":"workspace:*","@itwin/core-bentley":"workspace:*","@itwin/core-common":"workspace:*","@itwin/core-geometry":"workspace:*","@itwin/core-orbitgt":"workspace:*","@itwin/core-quantity":"workspace:*"},"//devDependencies":["NOTE: All peerDependencies should also be listed as devDependencies since peerDependencies are not considered by npm install","NOTE: All tools used by scripts in this package must be listed as devDependencies"],"devDependencies":{"@itwin/appui-abstract":"workspace:*","@itwin/build-tools":"workspace:*","@itwin/core-bentley":"workspace:*","@itwin/core-common":"workspace:*","@itwin/core-geometry":"workspace:*","@itwin/core-orbitgt":"workspace:*","@itwin/core-quantity":"workspace:*","@itwin/eslint-plugin":"5.0.0-dev.1","@types/chai-as-promised":"^7","@vitest/browser":"^2.1.0","@vitest/coverage-v8":"^2.1.0","babel-loader":"~8.2.5","babel-plugin-istanbul":"~6.1.1","cpx2":"^3.0.0","eslint":"^9.13.0","glob":"^10.3.12","playwright":"~1.47.1","rimraf":"^3.0.2","source-map-loader":"^4.0.0","typescript":"~5.6.2","typemoq":"^2.1.0","vitest":"^2.1.0","vite-multiple-assets":"^1.3.1","vite-plugin-static-copy":"1.0.6","webpack":"^5.97.1"},"//dependencies":["NOTE: these dependencies should be only for things that DO NOT APPEAR IN THE API","NOTE: core-frontend should remain UI technology agnostic, so no react/angular dependencies are allowed"],"dependencies":{"@itwin/cloud-agnostic-core":"^2.2.4","@itwin/object-storage-core":"^2.2.5","@itwin/core-i18n":"workspace:*","@itwin/core-telemetry":"workspace:*","@itwin/webgl-compatibility":"workspace:*","@loaders.gl/core":"^3.1.6","@loaders.gl/draco":"^3.1.6","fuse.js":"^3.3.0","wms-capabilities":"0.4.0"}}');
+module.exports = /*#__PURE__*/JSON.parse('{"name":"@itwin/core-frontend","version":"5.0.0-dev.25","description":"iTwin.js frontend components","main":"lib/cjs/core-frontend.js","module":"lib/esm/core-frontend.js","typings":"lib/cjs/core-frontend","license":"MIT","scripts":{"build":"npm run -s copy:public && npm run -s build:cjs && npm run -s build:esm && npm run -s webpackWorkers && npm run -s copy:workers","build:cjs":"npm run -s copy:js:cjs && tsc 1>&2 --outDir lib/cjs","build:esm":"npm run -s copy:js:esm && tsc 1>&2 --module ES2020 --outDir lib/esm","clean":"rimraf lib .rush/temp/package-deps*.json","copy:public":"cpx \\"./src/public/**/*\\" ./lib/public","copy:js:cjs":"cpx \\"./src/**/*.js\\" ./lib/cjs","copy:js:esm":"cpx \\"./src/**/*.js\\" ./lib/esm","copy:workers":"cpx \\"./lib/workers/webpack/parse-imdl-worker.js\\" ./lib/public/scripts","docs":"betools docs --json=../../generated-docs/core/core-frontend/file.json --tsIndexFile=./core-frontend.ts --onlyJson --excludes=webgl/**/*,**/map/*.d.ts,**/tile/*.d.ts,**/*-css.ts","extract-api":"betools extract-api --entry=core-frontend && npm run extract-extension-api","extract-extension-api":"eslint --no-inline-config -c extraction.eslint.config.js  \\"./src/**/*.ts\\" 1>&2","lint":"eslint \\"./src/**/*.ts\\" 1>&2","lint-fix":"eslint --fix -f visualstudio \\"./src/**/*.ts\\" 1>&2","pseudolocalize":"betools pseudolocalize --englishDir ./src/public/locales/en --out ./public/locales/en-PSEUDO","test":"npm run webpackTestWorker && vitest --run","cover":"npm run webpackTestWorker && vitest --run --coverage","test:debug":"vitest --run","webpackTests":"webpack --config ./src/test/utils/webpack.config.js 1>&2 && npm run -s webpackTestWorker","webpackTestWorker":"webpack --config ./src/test/worker/webpack.config.js 1>&2 && cpx \\"./lib/test/test-worker.js\\" ./lib/test","webpackWorkers":"webpack --config ./src/workers/ImdlParser/webpack.config.js 1>&2"},"repository":{"type":"git","url":"https://github.com/iTwin/itwinjs-core.git","directory":"core/frontend"},"keywords":["Bentley","BIM","iModel","digital-twin","iTwin"],"author":{"name":"Bentley Systems, Inc.","url":"http://www.bentley.com"},"peerDependencies":{"@itwin/appui-abstract":"workspace:*","@itwin/core-bentley":"workspace:*","@itwin/core-common":"workspace:*","@itwin/core-geometry":"workspace:*","@itwin/core-orbitgt":"workspace:*","@itwin/core-quantity":"workspace:*"},"//devDependencies":["NOTE: All peerDependencies should also be listed as devDependencies since peerDependencies are not considered by npm install","NOTE: All tools used by scripts in this package must be listed as devDependencies"],"devDependencies":{"@itwin/appui-abstract":"workspace:*","@itwin/build-tools":"workspace:*","@itwin/core-bentley":"workspace:*","@itwin/core-common":"workspace:*","@itwin/core-geometry":"workspace:*","@itwin/core-orbitgt":"workspace:*","@itwin/core-quantity":"workspace:*","@itwin/eslint-plugin":"5.0.0-dev.1","@types/chai-as-promised":"^7","@vitest/browser":"^2.1.0","@vitest/coverage-v8":"^2.1.0","babel-loader":"~8.2.5","babel-plugin-istanbul":"~6.1.1","cpx2":"^3.0.0","eslint":"^9.13.0","glob":"^10.3.12","playwright":"~1.47.1","rimraf":"^3.0.2","source-map-loader":"^4.0.0","typescript":"~5.6.2","typemoq":"^2.1.0","vitest":"^2.1.0","vite-multiple-assets":"^1.3.1","vite-plugin-static-copy":"1.0.6","webpack":"^5.97.1"},"//dependencies":["NOTE: these dependencies should be only for things that DO NOT APPEAR IN THE API","NOTE: core-frontend should remain UI technology agnostic, so no react/angular dependencies are allowed"],"dependencies":{"@itwin/cloud-agnostic-core":"^2.2.4","@itwin/object-storage-core":"^2.2.5","@itwin/core-i18n":"workspace:*","@itwin/core-telemetry":"workspace:*","@itwin/webgl-compatibility":"workspace:*","@loaders.gl/core":"^3.1.6","@loaders.gl/draco":"^3.1.6","fuse.js":"^3.3.0","wms-capabilities":"0.4.0"}}');
 
 /***/ })