@itwin/core-frontend 5.0.0-dev.99 → 5.1.0-dev.1

package/lib/cjs/tools/ViewTool.js

@@ -357,7 +357,15 @@ class ViewManip extends ViewTool {
             this._depthPreview = { testPoint: ev.rawPoint, pickRadius: pickRadiusPixels, plane: result.plane, source: result.source, isDefaultDepth: !isValidDepth, sourceId: result.sourceId };
         return (isValidDepth || isPreview ? result.plane.getOriginRef() : undefined);
     }
+    /** In addition to the onReinitialize calls after a tool installs or restarts, it is also
+     * called from the mouseover event to cancel a drag operation if the up event occurred outside the view.
+     * When operating in one shot mode and also requiring dragging, the tool should exit and not restart in ths situation.
+     * A tool must opt in to allowing [[ViewTool.exitTool]] to be called from [[ViewManip.onReinitialize]] by
+     * overriding this method to return true.
+     */
+    get isExitAllowedOnReinitialize() { return false; }
     async onReinitialize() {
+        const shouldExit = (this.oneShot && this.isDraggingRequired && this.isDragging && 0 !== this.nPts);
         if (undefined !== this.viewport) {
             this.viewport.synchWithView(); // make sure we store any changes in view undo buffer.
             this.viewHandles.setFocus(-1);
@@ -367,6 +375,9 @@ class ViewManip extends ViewTool {
         this.inDynamicUpdate = false;
         this._startPose = undefined;
         this.viewHandles.onReinitialize();
+        if (shouldExit && this.isExitAllowedOnReinitialize)
+            return this.exitTool();
+        this.provideInitialToolAssistance();
     }
     async onDataButtonDown(ev) {
         // Tool was started in "drag required" mode, don't advance tool state and wait to see if we get the start drag event.
@@ -504,7 +515,6 @@ class ViewManip extends ViewTool {
         await super.onPostInstall();
         await this.onReinitialize(); // Call onReinitialize now that tool is installed.
     }
-    /** @beta */
     provideToolAssistance(mainInstrKey, additionalInstr) {
         const mainInstruction = ToolAssistance_1.ToolAssistance.createInstruction(this.iconSpec, ViewTool.translate(mainInstrKey));
         const mouseInstructions = [];
@@ -529,6 +539,8 @@ class ViewManip extends ViewTool {
         const instructions = ToolAssistance_1.ToolAssistance.createInstructions(mainInstruction, sections);
         IModelApp_1.IModelApp.notifications.setToolAssistance(instructions);
     }
+    /** Called from [[ViewManip.onReinitialize]] to allow tools to establish the tool assistance for the first point. */
+    provideInitialToolAssistance() { }
     async onCleanup() {
         let restorePrevious = false;
         if (this.inDynamicUpdate) {
@@ -2470,10 +2482,8 @@ class PanViewTool extends ViewManip {
     constructor(vp, oneShot = false, isDraggingRequired = false) {
         super(vp, ViewHandleType.Pan, oneShot, isDraggingRequired);
     }
-    async onReinitialize() {
-        await super.onReinitialize();
-        this.provideToolAssistance("Pan.Prompts.FirstPoint");
-    }
+    get isExitAllowedOnReinitialize() { return true; }
+    provideInitialToolAssistance() { this.provideToolAssistance("Pan.Prompts.FirstPoint"); }
 }
 exports.PanViewTool = PanViewTool;
 /** A tool that performs a Rotate view operation
@@ -2485,10 +2495,8 @@ class RotateViewTool extends ViewManip {
     constructor(vp, oneShot = false, isDraggingRequired = false) {
         super(vp, ViewHandleType.Rotate | ViewHandleType.Pan | ViewHandleType.TargetCenter, oneShot, isDraggingRequired);
     }
-    async onReinitialize() {
-        await super.onReinitialize();
-        this.provideToolAssistance("Rotate.Prompts.FirstPoint");
-    }
+    get isExitAllowedOnReinitialize() { return true; }
+    provideInitialToolAssistance() { this.provideToolAssistance("Rotate.Prompts.FirstPoint"); }
 }
 exports.RotateViewTool = RotateViewTool;
 /** A tool that performs the look operation
@@ -2500,10 +2508,8 @@ class LookViewTool extends ViewManip {
     constructor(vp, oneShot = false, isDraggingRequired = false) {
         super(vp, ViewHandleType.Look | ViewHandleType.Pan, oneShot, isDraggingRequired);
     }
-    async onReinitialize() {
-        await super.onReinitialize();
-        this.provideToolAssistance("Look.Prompts.FirstPoint");
-    }
+    get isExitAllowedOnReinitialize() { return true; }
+    provideInitialToolAssistance() { this.provideToolAssistance("Look.Prompts.FirstPoint"); }
 }
 exports.LookViewTool = LookViewTool;
 /** A tool that performs the scroll operation
@@ -2515,10 +2521,8 @@ class ScrollViewTool extends ViewManip {
     constructor(vp, oneShot = false, isDraggingRequired = false) {
         super(vp, ViewHandleType.Scroll, oneShot, isDraggingRequired);
     }
-    async onReinitialize() {
-        await super.onReinitialize();
-        this.provideToolAssistance("Scroll.Prompts.FirstPoint");
-    }
+    get isExitAllowedOnReinitialize() { return true; }
+    provideInitialToolAssistance() { this.provideToolAssistance("Scroll.Prompts.FirstPoint"); }
 }
 exports.ScrollViewTool = ScrollViewTool;
 /** A tool that performs the zoom operation
@@ -2530,10 +2534,8 @@ class ZoomViewTool extends ViewManip {
     constructor(vp, oneShot = false, isDraggingRequired = false) {
         super(vp, ViewHandleType.Zoom | ViewHandleType.Pan, oneShot, isDraggingRequired);
     }
-    async onReinitialize() {
-        await super.onReinitialize();
-        this.provideToolAssistance("Zoom.Prompts.FirstPoint");
-    }
+    get isExitAllowedOnReinitialize() { return true; }
+    provideInitialToolAssistance() { this.provideToolAssistance("Zoom.Prompts.FirstPoint"); }
 }
 exports.ZoomViewTool = ZoomViewTool;
 /** A tool that performs the walk operation using mouse+keyboard or touch controls.
@@ -2551,11 +2553,8 @@ class LookAndMoveTool extends ViewManip {
         const viewport = (undefined === vp ? IModelApp_1.IModelApp.viewManager.selectedView : vp); // Need vp to enable camera/check lens in onReinitialize...
         super(viewport, ViewHandleType.LookAndMove | ViewHandleType.Pan, oneShot, isDraggingRequired);
     }
-    async onReinitialize() {
-        await super.onReinitialize();
-        this.provideToolAssistance("LookAndMove.Prompts.FirstPoint");
-    }
-    /** @beta */
+    get isExitAllowedOnReinitialize() { return true; }
+    provideInitialToolAssistance() { this.provideToolAssistance("LookAndMove.Prompts.FirstPoint"); }
     provideToolAssistance(mainInstrKey) {
         const mainInstruction = ToolAssistance_1.ToolAssistance.createInstruction(this.iconSpec, ViewTool.translate(mainInstrKey));
         const mouseInstructions = [];
@@ -2595,11 +2594,8 @@ class WalkViewTool extends ViewManip {
         const viewport = (undefined === vp ? IModelApp_1.IModelApp.viewManager.selectedView : vp); // Need vp to enable camera/check lens in onReinitialize...
         super(viewport, ViewHandleType.Walk | ViewHandleType.Pan, oneShot, isDraggingRequired);
     }
-    async onReinitialize() {
-        await super.onReinitialize();
-        this.provideToolAssistance("Walk.Prompts.FirstPoint");
-    }
-    /** @beta */
+    get isExitAllowedOnReinitialize() { return true; }
+    provideInitialToolAssistance() { this.provideToolAssistance("Walk.Prompts.FirstPoint"); }
     provideToolAssistance(mainInstrKey) {
         const walkInstructions = [];
         walkInstructions.push(ToolAssistance_1.ToolAssistance.createModifierKeyInstruction(ToolAssistance_1.ToolAssistance.shiftKey, ToolAssistance_1.ToolAssistanceImage.LeftClickDrag, ViewTool.translate("Pan.flyover"), false, ToolAssistance_1.ToolAssistanceInputMethod.Mouse));
@@ -2617,11 +2613,8 @@ class FlyViewTool extends ViewManip {
     constructor(vp, oneShot = false, isDraggingRequired = false) {
         super(vp, ViewHandleType.Fly | ViewHandleType.Pan, oneShot, isDraggingRequired);
     }
-    async onReinitialize() {
-        await super.onReinitialize();
-        this.provideToolAssistance("Fly.Prompts.FirstPoint");
-    }
-    /** @beta */
+    get isExitAllowedOnReinitialize() { return true; }
+    provideInitialToolAssistance() { this.provideToolAssistance("Fly.Prompts.FirstPoint"); }
     provideToolAssistance(mainInstrKey) {
         const flyInstructions = [];
         flyInstructions.push(ToolAssistance_1.ToolAssistance.createModifierKeyInstruction(ToolAssistance_1.ToolAssistance.shiftKey, ToolAssistance_1.ToolAssistanceImage.LeftClickDrag, ViewTool.translate("Pan.flyover"), false, ToolAssistance_1.ToolAssistanceInputMethod.Mouse));
@@ -2646,7 +2639,6 @@ class FitViewTool extends ViewTool {
         this.doAnimate = doAnimate;
         this.isolatedOnly = isolatedOnly;
     }
-    /** @beta */
     provideToolAssistance() {
         const mainInstruction = ToolAssistance_1.ToolAssistance.createInstruction(this.iconSpec, ViewTool.translate("Fit.Prompts.FirstPoint"));
         const mouseInstructions = [];
@@ -2964,7 +2956,6 @@ class WindowAreaTool extends ViewTool {
         }
         return super.onResetButtonUp(ev);
     }
-    /** @beta */
     provideToolAssistance() {
         const mainInstruction = ToolAssistance_1.ToolAssistance.createInstruction(this.iconSpec, ViewTool.translate(this._haveFirstPoint ? "WindowArea.Prompts.NextPoint" : "WindowArea.Prompts.FirstPoint"));
         const mouseInstructions = [];
@@ -3472,7 +3463,6 @@ class SetupCameraTool extends PrimitiveTool_1.PrimitiveTool {
             await this.exitTool();
         return Tool_1.EventHandled.Yes;
     }
-    /** @beta */
     provideToolAssistance() {
         const mainInstruction = ToolAssistance_1.ToolAssistance.createInstruction(this.iconSpec, ViewTool.translate(this._haveEyePt ? "SetupCamera.Prompts.NextPoint" : "SetupCamera.Prompts.FirstPoint"));
         const mouseInstructions = [];
@@ -3733,7 +3723,6 @@ class SetupWalkCameraTool extends PrimitiveTool_1.PrimitiveTool {
             await this.exitTool();
         return Tool_1.EventHandled.Yes;
     }
-    /** @beta */
     provideToolAssistance() {
         const mainInstruction = ToolAssistance_1.ToolAssistance.createInstruction(this.iconSpec, ViewTool.translate(this._haveEyePt ? "SetupWalkCamera.Prompts.NextPoint" : "SetupWalkCamera.Prompts.FirstPoint"));
         const mouseInstructions = [];