@itwin/core-frontend 5.12.0-dev.6 → 5.12.0-dev.8

package/lib/esm/tools/AccuDrawTool.js

@@ -6,13 +6,14 @@
  * @module Tools
  */
 import { BentleyStatus } from "@itwin/core-bentley";
-import { Geometry, Matrix3d, Point3d, Transform, Vector3d } from "@itwin/core-geometry";
+import { AxisOrder, Geometry, Matrix3d, Plane3dByOriginAndUnitNormal, Point3d, Transform, Vector3d } from "@itwin/core-geometry";
 import { AccuDraw, AccuDrawFlags, CompassMode, ContextMode, ItemField, KeyinStatus, LockedStates, RotationMode, ThreeAxes } from "../AccuDraw";
 import { TentativeOrAccuSnap } from "../AccuSnap";
 import { ACSDisplayOptions } from "../AuxCoordSys";
 import { IModelApp } from "../IModelApp";
 import { BeButtonEvent, CoreTools, Tool } from "./Tool";
 import { AccuDrawShortcutImplementation, AccuDrawShortcutTool } from "./AccuDrawShortcutTool";
+import { GraphicType } from "../common/render/GraphicType";
 // cSpell:ignore dont unlockedz
 function normalizedDifference(point1, point2, out) {
     return point2.vectorTo(point1).normalizeWithLength(out).mag;
@@ -75,15 +76,13 @@ export class AccuDrawShortcuts {
     }
     static updateACSByPoints(acs, vp, points, isDynamics) {
         const accudraw = IModelApp.accuDraw;
-        if (!accudraw.isEnabled)
-            return false;
         let accept = false;
         const vec = [new Vector3d(), new Vector3d(), new Vector3d()];
         acs.setOrigin(points[0]);
         switch (points.length) {
             case 1:
                 acs.setRotation(vp.rotation);
-                if (!isDynamics) {
+                if (!isDynamics && accudraw.isEnabled) {
                     accudraw.published.origin.setFrom(points[0]);
                     accudraw.published.flags = AccuDrawFlags.SetOrigin;
                     accudraw.flags.fixedOrg = true;
@@ -95,7 +94,7 @@ export class AccuDrawShortcuts {
                     break;
                 }
                 if (vp.view.is3d()) {
-                    if (normalizedCrossProduct(accudraw.axes.y, vec[0], vec[1]) < 0.00001) {
+                    if (accudraw.isEnabled && normalizedCrossProduct(accudraw.axes.y, vec[0], vec[1]) < 0.00001) {
                         vec[2].set(0.0, 0.0, 1.0);
                         if (normalizedCrossProduct(vec[2], vec[0], vec[1]) < 0.00001) {
                             vec[2].set(0.0, 1.0, 0.0);
@@ -104,7 +103,7 @@ export class AccuDrawShortcuts {
                     }
                     normalizedCrossProduct(vec[0], vec[1], vec[2]);
                     acs.setRotation(Matrix3d.createRows(vec[0], vec[1], vec[2]));
-                    if (!isDynamics) {
+                    if (!isDynamics && accudraw.isEnabled) {
                         accudraw.published.origin.setFrom(points[0]);
                         accudraw.published.flags = AccuDrawFlags.SetOrigin | AccuDrawFlags.SetNormal;
                         accudraw.published.vector.setFrom(vec[0]);
@@ -825,7 +824,11 @@ export class AccuDrawShortcuts {
             accudraw.unlockAllFields();
     }
 }
-/** @beta */
+/**
+ * Immediate tool to toggle AccuDraw's availability for the current session.
+ * @note AccuDraw is enabled by default
+ * @beta
+ */
 export class AccuDrawSessionToggleTool extends Tool {
     static toolId = "AccuDraw.SessionToggle";
     async run() {
@@ -833,7 +836,11 @@ export class AccuDrawSessionToggleTool extends Tool {
         return true;
     }
 }
-/** @beta */
+/**
+ * Immediate tool to toggle AccuDraw on/off temporarily for the current interactive tool.
+ * @note Typically used to disable AccuDraw for a single data button.
+ * @beta
+ */
 export class AccuDrawSuspendToggleTool extends Tool {
     static toolId = "AccuDraw.SuspendToggle";
     async run() {
@@ -841,7 +848,11 @@ export class AccuDrawSuspendToggleTool extends Tool {
         return true;
     }
 }
-/** @beta */
+/**
+ * Immediate tool to enable AccuDraw and position it at the current AccuSnap or Tentative snap location.
+ * @note When not snapped, AccuDraw is activated at the last data button location when inactive, or moved to the current cursor location when active.
+ * @beta
+ */
 export class AccuDrawSetOriginTool extends Tool {
     static toolId = "AccuDraw.SetOrigin";
     async run() {
@@ -849,7 +860,11 @@ export class AccuDrawSetOriginTool extends Tool {
         return true;
     }
 }
-/** @beta */
+/**
+ * Immediate tool to lock the closer of the x or y axis based on the current cursor location.
+ * @note When an axis is locked, points are projected onto the axis line.
+ * @beta
+ */
 export class AccuDrawSetLockSmartTool extends Tool {
     static toolId = "AccuDraw.LockSmart";
     async run() {
@@ -857,7 +872,10 @@ export class AccuDrawSetLockSmartTool extends Tool {
         return true;
     }
 }
-/** @beta */
+/**
+ * Immediate tool to toggle the locked state of an indexed axis of the AccuDraw compass.
+ * @beta
+ */
 export class AccuDrawSetLockIndexTool extends Tool {
     static toolId = "AccuDraw.LockIndex";
     async run() {
@@ -865,7 +883,10 @@ export class AccuDrawSetLockIndexTool extends Tool {
         return true;
     }
 }
-/** @beta */
+/**
+ * Immediate tool to toggle the locked state of the X text field.
+ * @beta
+ */
 export class AccuDrawSetLockXTool extends Tool {
     static toolId = "AccuDraw.LockX";
     async run() {
@@ -873,7 +894,10 @@ export class AccuDrawSetLockXTool extends Tool {
         return true;
     }
 }
-/** @beta */
+/**
+ * Immediate tool to toggle the locked state of the Y text field.
+ * @beta
+ */
 export class AccuDrawSetLockYTool extends Tool {
     static toolId = "AccuDraw.LockY";
     async run() {
@@ -881,7 +905,10 @@ export class AccuDrawSetLockYTool extends Tool {
         return true;
     }
 }
-/** @beta */
+/**
+ * Immediate tool to toggle the locked state of the Z text field.
+ * @beta
+ */
 export class AccuDrawSetLockZTool extends Tool {
     static toolId = "AccuDraw.LockZ";
     async run() {
@@ -889,7 +916,10 @@ export class AccuDrawSetLockZTool extends Tool {
         return true;
     }
 }
-/** @beta */
+/**
+ * Immediate tool to toggle the locked state of the Distance text field.
+ * @beta
+ */
 export class AccuDrawSetLockDistanceTool extends Tool {
     static toolId = "AccuDraw.LockDistance";
     async run() {
@@ -897,7 +927,10 @@ export class AccuDrawSetLockDistanceTool extends Tool {
         return true;
     }
 }
-/** @beta */
+/**
+ * Immediate tool to toggle the locked state of the Angle text field.
+ * @beta
+ */
 export class AccuDrawSetLockAngleTool extends Tool {
     static toolId = "AccuDraw.LockAngle";
     async run() {
@@ -905,7 +938,10 @@ export class AccuDrawSetLockAngleTool extends Tool {
         return true;
     }
 }
-/** @beta */
+/**
+ * Immediate tool to toggle between polar and rectangular compass modes.
+ * @beta
+ */
 export class AccuDrawChangeModeTool extends Tool {
     static toolId = "AccuDraw.ChangeMode";
     async run() {
@@ -913,7 +949,10 @@ export class AccuDrawChangeModeTool extends Tool {
         return true;
     }
 }
-/** @beta */
+/**
+ * Immediate tool to cycle between XY, XZ, and YZ planes for the current AccuDraw rotation.
+ * @beta
+ */
 export class AccuDrawRotateCycleTool extends Tool {
     static toolId = "AccuDraw.RotateCycle";
     async run() {
@@ -921,7 +960,11 @@ export class AccuDrawRotateCycleTool extends Tool {
         return true;
     }
 }
-/** @beta */
+/**
+ * Immediate tool to set the AccuDraw rotation to a standard Top view.
+ * @note When IModelApp.toolAdmin.acsContextLock is true, rotation is set relative to the view's ACS.
+ * @beta
+ */
 export class AccuDrawRotateTopTool extends Tool {
     static toolId = "AccuDraw.RotateTop";
     async run() {
@@ -929,7 +972,11 @@ export class AccuDrawRotateTopTool extends Tool {
         return true;
     }
 }
-/** @beta */
+/**
+ * Immediate tool to set the AccuDraw rotation to a standard Front view.
+ * @note When IModelApp.toolAdmin.acsContextLock is true, rotation is set relative to the view's ACS.
+ * @beta
+ */
 export class AccuDrawRotateFrontTool extends Tool {
     static toolId = "AccuDraw.RotateFront";
     async run() {
@@ -937,7 +984,11 @@ export class AccuDrawRotateFrontTool extends Tool {
         return true;
     }
 }
-/** @beta */
+/**
+ * Immediate tool to set the AccuDraw rotation to a standard Side view.
+ * @note When IModelApp.toolAdmin.acsContextLock is true, rotation is set relative to the view's ACS.
+ * @beta
+ */
 export class AccuDrawRotateSideTool extends Tool {
     static toolId = "AccuDraw.RotateSide";
     async run() {
@@ -945,7 +996,10 @@ export class AccuDrawRotateSideTool extends Tool {
         return true;
     }
 }
-/** @beta */
+/**
+ * Immediate tool to set the AccuDraw rotation to match the rotation of the current view.
+ * @beta
+ */
 export class AccuDrawRotateViewTool extends Tool {
     static toolId = "AccuDraw.RotateView";
     async run() {
@@ -953,7 +1007,10 @@ export class AccuDrawRotateViewTool extends Tool {
         return true;
     }
 }
-/** @beta */
+/**
+ * Immediate tool to set the AccuDraw rotation to be a 90 degree rotation about the current x axis.
+ * @beta
+ */
 export class AccuDrawRotate90AboutXTool extends Tool {
     static toolId = "AccuDraw.Rotate90AboutX";
     async run() {
@@ -961,7 +1018,10 @@ export class AccuDrawRotate90AboutXTool extends Tool {
         return true;
     }
 }
-/** @beta */
+/**
+ * Immediate tool to set the AccuDraw rotation to be a 90 degree rotation about the current y axis.
+ * @beta
+ */
 export class AccuDrawRotate90AboutYTool extends Tool {
     static toolId = "AccuDraw.Rotate90AboutY";
     async run() {
@@ -969,7 +1029,10 @@ export class AccuDrawRotate90AboutYTool extends Tool {
         return true;
     }
 }
-/** @beta */
+/**
+ * Immediate tool to set the AccuDraw rotation to be a 90 degree rotation about the current z axis.
+ * @beta
+ */
 export class AccuDrawRotate90AboutZTool extends Tool {
     static toolId = "AccuDraw.Rotate90AboutZ";
     async run() {
@@ -1015,7 +1078,11 @@ class RotateAxesImplementation extends AccuDrawShortcutImplementation {
         return true;
     }
 }
-/** @beta */
+/**
+ * Interactive tool to set the AccuDraw rotation by rotating about the current z axis to a point on the x axis.
+ * @note When AccuSnap or Tentative snap is active, the snap point is immediately used to define the x axis and not further input is required.
+ * @beta
+ */
 export class AccuDrawRotateAxesTool extends AccuDrawShortcutTool {
     aboutCurrentZ;
     static toolId = "AccuDraw.RotateAxes";
@@ -1080,7 +1147,10 @@ class RotateElementImplementation extends AccuDrawShortcutImplementation {
         return true;
     }
 }
-/** @beta */
+/**
+ * Interactive tool to set the AccuDraw rotation using the snapped to geometry under the cursor.
+ * @beta
+ */
 export class AccuDrawRotateElementTool extends AccuDrawShortcutTool {
     static toolId = "AccuDraw.RotateElement";
     /** @internal */
@@ -1089,6 +1159,124 @@ export class AccuDrawRotateElementTool extends AccuDrawShortcutTool {
     }
 }
 /** @internal */
+class RotatePointsImplementation extends AccuDrawShortcutImplementation {
+    _points = [];
+    _origin = IModelApp.tentativePoint.isActive ? IModelApp.tentativePoint.getPoint().clone() : undefined;
+    _moveOrigin = !IModelApp.accuDraw.isActive || IModelApp.tentativePoint.isActive; // Preserve current origin if AccuDraw already active and not tentative snap...
+    _lastPoint;
+    onProvideToolAssistance() {
+        switch (this._points.length) {
+            case 0:
+                CoreTools.outputPromptByKey("AccuDraw.RotatePoints.Prompts.FirstPoint");
+                break;
+            case 1:
+                CoreTools.outputPromptByKey("AccuDraw.RotatePoints.Prompts.SecondPoint");
+                break;
+            default:
+                CoreTools.outputPromptByKey("AccuDraw.RotatePoints.Prompts.NextPoint");
+                break;
+        }
+    }
+    onInitialize() {
+        if (undefined === this._origin)
+            return;
+        this._points.push(this._origin);
+        IModelApp.tentativePoint.clear(true); // Necessary when installed as an InputCollector...
+        IModelApp.accuDraw.activate();
+        IModelApp.accuDraw.setContext(AccuDrawFlags.SetOrigin | AccuDrawFlags.FixedOrigin, this._origin);
+        IModelApp.accuDraw.refreshDecorationsAndDynamics();
+    }
+    onComplete() {
+        let ignoreFlags = AccuDrawFlags.SetRMatrix | AccuDrawFlags.Disable; // If AccuDraw wasn't active when the shortcut started, let it remain active for suspended tool when shortcut completes...
+        if (this._moveOrigin)
+            ignoreFlags |= AccuDrawFlags.SetOrigin;
+        return ignoreFlags;
+    }
+    doManipulation(ev, isMotion) {
+        if (!ev || !ev.viewport)
+            return false;
+        IModelApp.viewManager.invalidateDecorationsAllViews();
+        if (isMotion) {
+            this._lastPoint = ev.point.clone();
+            return false;
+        }
+        const accuDraw = IModelApp.accuDraw;
+        accuDraw.activate();
+        switch (this._points.length) {
+            case 0: {
+                this._points.push(ev.point.clone());
+                accuDraw.setContext(AccuDrawFlags.SetOrigin | AccuDrawFlags.FixedOrigin, this._points[0]);
+                break;
+            }
+            case 1: {
+                const xVec = Vector3d.createNormalizedStartEnd(this._points[0], ev.point);
+                if (undefined === xVec)
+                    return false;
+                if (!ev.viewport.view.is3d() || !ev.viewport.view.allow3dManipulations()) {
+                    accuDraw.setContext(AccuDrawFlags.SetOrigin | AccuDrawFlags.SetXAxis, this._points[0], xVec);
+                    return true; // Complete
+                }
+                this._points.push(ev.point.clone());
+                accuDraw.setContext(AccuDrawFlags.SetOrigin | AccuDrawFlags.FixedOrigin | AccuDrawFlags.SetNormal, this._points[0], xVec);
+                break;
+            }
+            case 2: {
+                const xVec = Vector3d.createNormalizedStartEnd(this._points[0], this._points[1]);
+                if (undefined === xVec)
+                    return false;
+                const yVec = Vector3d.createNormalizedStartEnd(this._points[0], ev.point);
+                if (undefined === yVec)
+                    return false;
+                const matrix = Matrix3d.createRigidFromColumns(xVec, yVec, AxisOrder.XYZ);
+                if (undefined === matrix)
+                    return false;
+                const invMatrix = matrix.inverse();
+                if (undefined === invMatrix)
+                    return false;
+                accuDraw.setContext(AccuDrawFlags.SetOrigin | AccuDrawFlags.SetRMatrix, this._points[0], invMatrix);
+                return true; // Complete
+            }
+        }
+        this.onProvideToolAssistance();
+        return false;
+    }
+    doDecorate(context) {
+        if (0 === this._points.length)
+            return;
+        const currentPoint = this._lastPoint;
+        if (undefined === currentPoint)
+            return;
+        if (2 === this._points.length) {
+            const xVec = Vector3d.createNormalizedStartEnd(this._points[0], this._points[1]);
+            if (undefined === xVec)
+                return;
+            const plane = Plane3dByOriginAndUnitNormal.create(this._points[0], xVec);
+            if (undefined === plane)
+                return;
+            plane.projectPointToPlane(currentPoint, currentPoint);
+        }
+        const tmpPoints = this._points.slice(0, 1);
+        tmpPoints.push(currentPoint);
+        const vp = context.viewport;
+        const color = vp.getContrastToBackgroundColor();
+        const builder = context.createGraphicBuilder(GraphicType.WorldOverlay);
+        builder.setSymbology(color, color, 2);
+        builder.addLineString(tmpPoints);
+        context.addDecorationFromBuilder(builder);
+    }
+}
+/**
+ * Interactive tool to set the AccuDraw rotation by 3 points: x axis origin, x axis direction, and y axis direction.
+ * @beta
+ */
+export class AccuDrawRotatePointsTool extends AccuDrawShortcutTool {
+    static toolId = "AccuDraw.RotatePoints";
+    /** @internal */
+    createImplementation() {
+        return new RotatePointsImplementation();
+    }
+}
+/** @internal */
 class DefineACSByElementImplementation extends AccuDrawShortcutImplementation {
     _origin = Point3d.create();
     _rMatrix = Matrix3d.createIdentity();
@@ -1131,7 +1319,10 @@ class DefineACSByElementImplementation extends AccuDrawShortcutImplementation {
         this._acs.display(context, ACSDisplayOptions.Active | ACSDisplayOptions.Dynamics);
     }
 }
-/** @beta */
+/**
+ * Interactive tool to set the view's ACS rotation by 3 points: x axis origin, x axis direction, and y axis direction/
+ * @beta
+ */
 export class DefineACSByElementTool extends AccuDrawShortcutTool {
     static toolId = "AccuDraw.DefineACSByElement";
     /** @internal */
@@ -1144,6 +1335,7 @@ class DefineACSByPointsImplementation extends AccuDrawShortcutImplementation {
     _points = [];
     _acs;
     _origin = IModelApp.tentativePoint.isActive ? IModelApp.tentativePoint.getPoint().clone() : undefined;
+    _lastPoint;
     onProvideToolAssistance() {
         switch (this._points.length) {
             case 0:
@@ -1160,16 +1352,20 @@ class DefineACSByPointsImplementation extends AccuDrawShortcutImplementation {
     onInitialize() {
         if (undefined === this._origin)
             return;
-        IModelApp.accuDraw.setContext(AccuDrawFlags.SetOrigin | AccuDrawFlags.FixedOrigin, this._origin);
         this._points.push(this._origin);
         IModelApp.tentativePoint.clear(true); // Necessary when installed as an InputCollector...
+        IModelApp.accuDraw.activate();
+        IModelApp.accuDraw.setContext(AccuDrawFlags.SetOrigin | AccuDrawFlags.FixedOrigin, this._origin);
+        IModelApp.accuDraw.refreshDecorationsAndDynamics();
     }
     doManipulation(ev, isMotion) {
         if (!ev || !ev.viewport)
             return false;
         IModelApp.viewManager.invalidateDecorationsAllViews();
-        if (isMotion)
+        if (isMotion) {
+            this._lastPoint = ev.point.clone();
             return false;
+        }
         IModelApp.accuDraw.activate();
         this._points.push(ev.point.clone());
         const vp = ev.viewport;
@@ -1184,11 +1380,11 @@ class DefineACSByPointsImplementation extends AccuDrawShortcutImplementation {
         return false;
     }
     doDecorate(context) {
+        if (undefined === this._lastPoint)
+            return;
         const tmpPoints = [];
         this._points.forEach((pt) => tmpPoints.push(pt));
-        const ev = new BeButtonEvent();
-        IModelApp.toolAdmin.fillEventFromCursorLocation(ev);
-        tmpPoints.push(ev.point);
+        tmpPoints.push(this._lastPoint);
         const vp = context.viewport;
         if (!this._acs)
             this._acs = vp.view.auxiliaryCoordinateSystem.clone();
@@ -1196,7 +1392,10 @@ class DefineACSByPointsImplementation extends AccuDrawShortcutImplementation {
         this._acs.display(context, ACSDisplayOptions.Active | ACSDisplayOptions.Dynamics);
     }
 }
-/** @beta */
+/**
+ * Interactive tool to set the view's ACS rotation by 3 points: x axis origin, x axis direction, and y axis direction.
+ * @beta
+ */
 export class DefineACSByPointsTool extends AccuDrawShortcutTool {
     static toolId = "AccuDraw.DefineACSByPoints";
     /** @internal */