@itwin/editor-frontend 3.3.0-dev.30 → 3.3.0-dev.33

package/lib/cjs/SketchTools.js

@@ -30,9 +30,10 @@ var CreateCurvePhase;
     CreateCurvePhase[CreateCurvePhase["DefineOther"] = 2] = "DefineOther";
 })(CreateCurvePhase = exports.CreateCurvePhase || (exports.CreateCurvePhase = {}));
 /** @alpha Base class for creating open and closed paths. */
-class CreateOrContinuePathTool extends CreateElementTool_1.CreateElementTool {
+class CreateOrContinuePathTool extends CreateElementTool_1.CreateElementWithDynamicsTool {
     constructor() {
         super(...arguments);
+        this._createCurvePhase = CreateCurvePhase.DefineOther;
         this.accepted = [];
         this.isClosed = false;
         this.isConstruction = false; // Sub-classes can set in createNewCurvePrimitive to bypass creating element graphics...
@@ -45,8 +46,6 @@ class CreateOrContinuePathTool extends CreateElementTool_1.CreateElementTool {
     static callCommand(method, ...args) {
         return EditTool_1.EditTools.callCommand(method, ...args);
     }
-    get wantAccuSnap() { return true; }
-    get wantDynamics() { return true; }
     get allowJoin() { return this.isControlDown; }
     get allowClosure() { return this.isControlDown; }
     get allowSimplify() { return true; }
@@ -58,10 +57,9 @@ class CreateOrContinuePathTool extends CreateElementTool_1.CreateElementTool {
     get showCurveConstructions() { return false; }
     get showJoin() { return this.isContinueExistingPath && CreateCurvePhase.DefineStart === this.createCurvePhase; }
     get showClosure() { return this.isClosed && CreateCurvePhase.DefineEnd === this.createCurvePhase; }
-    /** Sub-classes should override unless first point changes startPoint and last point changes endPoint. */
-    get createCurvePhase() {
-        return (0 === this.accepted.length ? CreateCurvePhase.DefineStart : CreateCurvePhase.DefineEnd);
-    }
+    get createCurvePhase() { return this._createCurvePhase; }
+    /** Sub-classes should override unless they don't support join or closure. */
+    updateCurvePhase() { }
     getCurrentRotation(ev) {
         const matrix = (undefined !== ev.viewport ? core_frontend_1.AccuDrawHintBuilder.getCurrentRotation(ev.viewport, true, true) : undefined);
         return (undefined !== matrix ? matrix : core_geometry_1.Matrix3d.createIdentity());
@@ -69,14 +67,27 @@ class CreateOrContinuePathTool extends CreateElementTool_1.CreateElementTool {
     getUpVector(ev) {
         return this.getCurrentRotation(ev).getColumn(2);
     }
-    async updateCurveAndContinuationData(ev, isDynamics, phase) {
+    async updateCurveAndContinuationData(ev, isDynamics) {
         this.isConstruction = false;
         this.current = this.createNewCurvePrimitive(ev, isDynamics);
-        if (CreateCurvePhase.DefineStart === phase)
+        if (CreateCurvePhase.DefineStart === this.createCurvePhase)
             await this.isValidForJoin(); // Updates this.continuationData...
-        else if (CreateCurvePhase.DefineEnd === phase)
+        else if (CreateCurvePhase.DefineEnd === this.createCurvePhase)
             await this.isValidForClosure(); // Updates this.isClosed...
     }
+    async updateElementData(ev, isDynamics) {
+        if (!isDynamics)
+            this.accepted.push(ev.point.clone());
+        await this.updateCurveAndContinuationData(ev, isDynamics);
+        if (!isDynamics)
+            this.updateCurvePhase();
+    }
+    async updateDynamicData(ev) {
+        // Need to update continuation data for first data point before dynamics has started...
+        await this.updateCurveAndContinuationData(ev, true);
+        // Don't need to create graphic if dynamics aren't yet active or showing construction geometry...
+        return (core_frontend_1.IModelApp.viewManager.inDynamicsMode && !this.isConstruction);
+    }
     get isContinueExistingPath() { return undefined !== this.continuationData; }
     async isValidForContinue(snap) {
         if (!snap.isElementHit)
@@ -208,29 +219,6 @@ class CreateOrContinuePathTool extends CreateElementTool_1.CreateElementTool {
         }
         return true;
     }
-    clearGraphics() {
-        if (undefined === this._graphicsProvider)
-            return;
-        this._graphicsProvider.cleanupGraphic();
-        this._graphicsProvider = undefined;
-    }
-    async createGraphics(ev) {
-        await this.updateCurveAndContinuationData(ev, true, this.createCurvePhase);
-        if (!core_frontend_1.IModelApp.viewManager.inDynamicsMode || this.isConstruction)
-            return; // Don't need to create graphic if dynamics aren't yet active...
-        const placement = this.getPlacementProps();
-        if (undefined === placement)
-            return;
-        const geometry = this.getGeometryProps(placement);
-        if (undefined === geometry)
-            return;
-        if (undefined === this._graphicsProvider)
-            this._graphicsProvider = new CreateElementTool_1.DynamicGraphicsProvider(this.iModel, this.toolId);
-        // Set chord tolerance for non-linear curve primitives...
-        if (ev.viewport)
-            this._graphicsProvider.chordTolerance = (0, CreateElementTool_1.computeChordToleranceFromPoint)(ev.viewport, ev.point);
-        await this._graphicsProvider.createGraphic(this.targetCategory, placement, geometry);
-    }
     addConstructionGraphics(curve, showCurve, context) {
         if (!showCurve) {
             switch (curve.curvePrimitiveType) {
@@ -296,11 +284,7 @@ class CreateOrContinuePathTool extends CreateElementTool_1.CreateElementTool {
     onDynamicFrame(ev, context) {
         if (this.showConstructionGraphics(ev, context))
             return; // Don't display element graphics...
-        if (undefined !== this._graphicsProvider)
-            this._graphicsProvider.addGraphic(context);
-    }
-    async onMouseMotion(ev) {
-        return this.createGraphics(ev);
+        super.onDynamicFrame(ev, context);
     }
     showJoinIndicator(context, pt) {
         const lengthX = Math.floor(context.viewport.pixelsFromInches(0.08)) + 0.5;
@@ -511,30 +495,13 @@ class CreateOrContinuePathTool extends CreateElementTool_1.CreateElementTool {
             return { classFullName: "Generic:PhysicalObject", model, category, code: core_common_1.Code.createEmpty(), placement };
         return { classFullName: "BisCore:DrawingGraphic", model, category, code: core_common_1.Code.createEmpty(), placement };
     }
-    async createElement() {
-        const placement = this.getPlacementProps();
-        if (undefined === placement)
-            return;
-        const geometry = this.getGeometryProps(placement);
-        if (undefined === geometry)
-            return;
-        const elemProps = this.getElementProps(placement);
-        if (undefined === elemProps)
-            return;
-        let data;
-        if ("flatbuffer" === geometry.format) {
-            data = { entryArray: geometry.data };
-            delete elemProps.geom; // Leave unchanged until replaced by flatbuffer geometry...
-        }
-        else {
-            elemProps.geom = geometry.data;
-        }
+    async doCreateElement(props, data) {
         try {
             this._startedCmd = await this.startCommand();
-            if (undefined === elemProps.id)
-                await CreateOrContinuePathTool.callCommand("insertGeometricElement", elemProps, data);
+            if (undefined === props.id)
+                await CreateOrContinuePathTool.callCommand("insertGeometricElement", props, data);
             else
-                await CreateOrContinuePathTool.callCommand("updateGeometricElement", elemProps, data);
+                await CreateOrContinuePathTool.callCommand("updateGeometricElement", props, data);
             await this.saveChanges();
         }
         catch (err) {
@@ -554,40 +521,22 @@ class CreateOrContinuePathTool extends CreateElementTool_1.CreateElementTool {
         hints.setOrigin(this.accepted[nPts - 1]);
         hints.sendHints();
     }
-    setupAndPromptForNextAction() {
-        this.setupAccuDraw();
-        super.setupAndPromptForNextAction();
-    }
-    async acceptPoint(ev) {
-        const phase = this.createCurvePhase;
-        this.accepted.push(ev.point.clone());
-        await this.updateCurveAndContinuationData(ev, false, phase);
-        return true;
-    }
-    async cancelPoint(_ev) { return true; }
-    async onDataButtonDown(ev) {
-        if (!await this.acceptPoint(ev))
-            return core_frontend_1.EventHandled.Yes;
-        return super.onDataButtonDown(ev);
-    }
-    async onResetButtonUp(ev) {
-        if (!await this.cancelPoint(ev))
-            return core_frontend_1.EventHandled.Yes;
-        return super.onResetButtonUp(ev);
-    }
     async onUndoPreviousStep() {
         if (0 === this.accepted.length)
             return false;
         this.accepted.pop();
-        if (0 === this.accepted.length)
+        if (0 === this.accepted.length) {
             await this.onReinitialize();
-        else
+        }
+        else {
+            this.updateCurvePhase();
             this.setupAndPromptForNextAction();
+        }
         return true;
     }
-    async onCleanup() {
-        this.clearGraphics();
-        return super.onCleanup();
+    async onPostInstall() {
+        await super.onPostInstall();
+        this.updateCurvePhase();
     }
 }
 exports.CreateOrContinuePathTool = CreateOrContinuePathTool;
@@ -617,6 +566,10 @@ class CreateLineStringTool extends CreateOrContinuePathTool {
         // A linestring can support physical closure when creating a new path...
         return this.allowClosure;
     }
+    updateCurvePhase() {
+        // The first point changes startPoint and last point changes endPoint.
+        this._createCurvePhase = (0 === this.accepted.length ? CreateCurvePhase.DefineStart : CreateCurvePhase.DefineEnd);
+    }
     isComplete(ev) {
         // Accept on reset with at least 2 points...
         if (core_frontend_1.BeButton.Reset === ev.button)
@@ -637,7 +590,8 @@ class CreateLineStringTool extends CreateOrContinuePathTool {
     async cancelPoint(ev) {
         // NOTE: Starting another tool will not create element...require reset or closure...
         if (this.isComplete(ev)) {
-            await this.updateCurveAndContinuationData(ev, false, CreateCurvePhase.DefineEnd);
+            this._createCurvePhase = CreateCurvePhase.DefineEnd;
+            await this.updateCurveAndContinuationData(ev, false);
             await this.createElement();
         }
         return true;
@@ -763,19 +717,22 @@ class CreateArcTool extends CreateOrContinuePathTool {
     isComplete(_ev) {
         return (3 === this.accepted.length);
     }
-    get createCurvePhase() {
+    updateCurvePhase() {
         switch (this.accepted.length) {
             case 0:
-                return ArcMethod.CenterStart === this.method ? CreateCurvePhase.DefineOther : CreateCurvePhase.DefineStart;
+                this._createCurvePhase = ArcMethod.CenterStart === this.method ? CreateCurvePhase.DefineOther : CreateCurvePhase.DefineStart;
+                break;
             case 1:
                 if (ArcMethod.CenterStart === this.method)
-                    return CreateCurvePhase.DefineStart;
+                    this._createCurvePhase = CreateCurvePhase.DefineStart;
                 else if (ArcMethod.StartEndMid === this.method)
-                    return CreateCurvePhase.DefineEnd;
+                    this._createCurvePhase = CreateCurvePhase.DefineEnd;
                 else
-                    return CreateCurvePhase.DefineOther;
+                    this._createCurvePhase = CreateCurvePhase.DefineOther;
+                break;
             default:
-                return ArcMethod.StartEndMid === this.method ? CreateCurvePhase.DefineOther : CreateCurvePhase.DefineEnd;
+                this._createCurvePhase = ArcMethod.StartEndMid === this.method ? CreateCurvePhase.DefineOther : CreateCurvePhase.DefineEnd;
+                break;
         }
     }
     createConstructionCurve(ev, isDynamics) {
@@ -1068,7 +1025,6 @@ class CreateCircleTool extends CreateOrContinuePathTool {
     static get minArgs() { return 0; }
     static get maxArgs() { return 2; } // method, radius - zero value unlocks associated "use" toggle...
     get showCurveConstructions() { return !(CircleMethod.Center === this.method && this.useRadius); }
-    get createCurvePhase() { return CreateCurvePhase.DefineOther; } // No join or closure checks...
     provideToolAssistance(mainInstrText, additionalInstr) {
         const nPts = this.accepted.length;
         switch (this.method) {
@@ -1146,7 +1102,7 @@ class CreateCircleTool extends CreateOrContinuePathTool {
         }
         else {
             this.radius = radius;
-            this.syncToolSettingsRadius();
+            this.syncToolSettingPropertyValue(this.radiusProperty);
         }
         vector0.scaleToLength(radius, vector0);
         vector90.scaleToLength(radius, vector90);
@@ -1160,11 +1116,6 @@ class CreateCircleTool extends CreateOrContinuePathTool {
         }
         return true;
     }
-    syncToolSettingsRadius() {
-        if (this.useRadius)
-            return;
-        this.syncToolSettingsProperties([this.radiusProperty.syncItem]);
-    }
     getToolSettingPropertyLocked(property) {
         return (property === this.useRadiusProperty ? this.radiusProperty : undefined);
     }
@@ -1276,7 +1227,6 @@ class CreateEllipseTool extends CreateOrContinuePathTool {
     isComplete(_ev) {
         return (3 === this.accepted.length);
     }
-    get createCurvePhase() { return CreateCurvePhase.DefineOther; } // No join or closure checks...
     provideToolAssistance(mainInstrText, additionalInstr) {
         const nPts = this.accepted.length;
         switch (nPts) {
@@ -1378,7 +1328,6 @@ class CreateRectangleTool extends CreateOrContinuePathTool {
     isComplete(_ev) {
         return (2 === this.accepted.length);
     }
-    get createCurvePhase() { return CreateCurvePhase.DefineOther; } // No join or closure checks...
     createNewCurvePrimitive(ev, isDynamics) {
         const numRequired = (isDynamics ? 1 : 2);
         if (this.accepted.length < numRequired)
@@ -1546,6 +1495,10 @@ class CreateBCurveTool extends CreateOrContinuePathTool {
             return CreateCurvePhase.DefineOther;
         return super.createCurvePhase;
     }
+    updateCurvePhase() {
+        // The first point changes startPoint and last point changes endPoint.
+        this._createCurvePhase = (0 === this.accepted.length ? CreateCurvePhase.DefineStart : CreateCurvePhase.DefineEnd);
+    }
     isComplete(ev) {
         // Accept on reset with sufficient points...
         if (core_frontend_1.BeButton.Reset === ev.button)
@@ -1634,7 +1587,7 @@ class CreateBCurveTool extends CreateOrContinuePathTool {
                 this._isPhysicallyClosedOrComplete = true;
                 break;
         }
-        await this.updateCurveAndContinuationData(ev, false, CreateCurvePhase.DefineOther);
+        await this.updateCurveAndContinuationData(ev, false);
         return true;
     }
     async cancelPoint(ev) {
@@ -1644,7 +1597,8 @@ class CreateBCurveTool extends CreateOrContinuePathTool {
                 const fitCurve = this.current;
                 switch (this._tangentPhase) {
                     case CreateCurvePhase.DefineOther:
-                        await this.updateCurveAndContinuationData(ev, false, CreateCurvePhase.DefineEnd);
+                        this._createCurvePhase = CreateCurvePhase.DefineEnd;
+                        await this.updateCurveAndContinuationData(ev, false);
                         this._tangentPhase = (undefined === fitCurve.options.startTangent ? CreateCurvePhase.DefineStart : CreateCurvePhase.DefineEnd);
                         core_frontend_1.IModelApp.toolAdmin.updateDynamics();
                         this.setupAndPromptForNextAction();
@@ -1661,7 +1615,8 @@ class CreateBCurveTool extends CreateOrContinuePathTool {
                         return true;
                 }
             }
-            await this.updateCurveAndContinuationData(ev, false, CreateCurvePhase.DefineEnd);
+            this._createCurvePhase = CreateCurvePhase.DefineEnd;
+            await this.updateCurveAndContinuationData(ev, false);
             await this.createElement();
         }
         return true;