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

package/lib/esm/tools/ViewTool.js

@@ -351,7 +351,15 @@ export 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);
@@ -361,6 +369,9 @@ export 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.
@@ -498,7 +509,6 @@ export class ViewManip extends ViewTool {
         await super.onPostInstall();
         await this.onReinitialize(); // Call onReinitialize now that tool is installed.
     }
-    /** @beta */
     provideToolAssistance(mainInstrKey, additionalInstr) {
         const mainInstruction = ToolAssistance.createInstruction(this.iconSpec, ViewTool.translate(mainInstrKey));
         const mouseInstructions = [];
@@ -523,6 +533,8 @@ export class ViewManip extends ViewTool {
         const instructions = ToolAssistance.createInstructions(mainInstruction, sections);
         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) {
@@ -2463,10 +2475,8 @@ export 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"); }
 }
 /** A tool that performs a Rotate view operation
  * @public
@@ -2477,10 +2487,8 @@ export 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"); }
 }
 /** A tool that performs the look operation
  * @public
@@ -2491,10 +2499,8 @@ export 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"); }
 }
 /** A tool that performs the scroll operation
  * @public
@@ -2505,10 +2511,8 @@ export 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"); }
 }
 /** A tool that performs the zoom operation
  * @public
@@ -2519,10 +2523,8 @@ export 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"); }
 }
 /** A tool that performs the walk operation using mouse+keyboard or touch controls.
  * Keyboard and mouse controls are similar to those used by many video games:
@@ -2539,11 +2541,8 @@ export class LookAndMoveTool extends ViewManip {
         const viewport = (undefined === vp ? 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.createInstruction(this.iconSpec, ViewTool.translate(mainInstrKey));
         const mouseInstructions = [];
@@ -2582,11 +2581,8 @@ export class WalkViewTool extends ViewManip {
         const viewport = (undefined === vp ? 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.createModifierKeyInstruction(ToolAssistance.shiftKey, ToolAssistanceImage.LeftClickDrag, ViewTool.translate("Pan.flyover"), false, ToolAssistanceInputMethod.Mouse));
@@ -2603,11 +2599,8 @@ export 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.createModifierKeyInstruction(ToolAssistance.shiftKey, ToolAssistanceImage.LeftClickDrag, ViewTool.translate("Pan.flyover"), false, ToolAssistanceInputMethod.Mouse));
@@ -2631,7 +2624,6 @@ export class FitViewTool extends ViewTool {
         this.doAnimate = doAnimate;
         this.isolatedOnly = isolatedOnly;
     }
-    /** @beta */
     provideToolAssistance() {
         const mainInstruction = ToolAssistance.createInstruction(this.iconSpec, ViewTool.translate("Fit.Prompts.FirstPoint"));
         const mouseInstructions = [];
@@ -2943,7 +2935,6 @@ export class WindowAreaTool extends ViewTool {
         }
         return super.onResetButtonUp(ev);
     }
-    /** @beta */
     provideToolAssistance() {
         const mainInstruction = ToolAssistance.createInstruction(this.iconSpec, ViewTool.translate(this._haveFirstPoint ? "WindowArea.Prompts.NextPoint" : "WindowArea.Prompts.FirstPoint"));
         const mouseInstructions = [];
@@ -3446,7 +3437,6 @@ export class SetupCameraTool extends PrimitiveTool {
             await this.exitTool();
         return EventHandled.Yes;
     }
-    /** @beta */
     provideToolAssistance() {
         const mainInstruction = ToolAssistance.createInstruction(this.iconSpec, ViewTool.translate(this._haveEyePt ? "SetupCamera.Prompts.NextPoint" : "SetupCamera.Prompts.FirstPoint"));
         const mouseInstructions = [];
@@ -3706,7 +3696,6 @@ export class SetupWalkCameraTool extends PrimitiveTool {
             await this.exitTool();
         return EventHandled.Yes;
     }
-    /** @beta */
     provideToolAssistance() {
         const mainInstruction = ToolAssistance.createInstruction(this.iconSpec, ViewTool.translate(this._haveEyePt ? "SetupWalkCamera.Prompts.NextPoint" : "SetupWalkCamera.Prompts.FirstPoint"));
         const mouseInstructions = [];