@itwin/editor-frontend 3.0.0-dev.166 → 3.0.0-dev.170

package/lib/esm/SketchTools.js

@@ -927,70 +927,28 @@ export class CreateArcTool extends CreateOrContinuePathTool {
                 return;
         }
         const syncData = [];
-        if (!this.useRadius) {
-            this.radiusProperty.displayValue = this.radiusProperty.description.format(this.radius);
-            this.radiusProperty.isDisabled = !this.useRadius;
+        if (!this.useRadius)
             syncData.push(this.radiusProperty.syncItem);
-        }
-        if (!this.useSweep) {
-            this.sweepProperty.displayValue = this.sweepProperty.description.format(this.sweep);
-            this.sweepProperty.isDisabled = !this.useSweep;
+        if (!this.useSweep)
             syncData.push(this.sweepProperty.syncItem);
-        }
         if (0 !== syncData.length)
             this.syncToolSettingsProperties(syncData);
     }
-    syncRadiusState() {
-        this.radiusProperty.displayValue = this.radiusProperty.description.format(this.radius);
-        this.radiusProperty.isDisabled = !this.useRadius;
-        this.syncToolSettingsProperties([this.radiusProperty.syncItem]);
-    }
-    syncSweepState() {
-        this.sweepProperty.displayValue = this.sweepProperty.description.format(this.sweep);
-        this.sweepProperty.isDisabled = !this.useSweep;
-        this.syncToolSettingsProperties([this.sweepProperty.syncItem]);
+    getToolSettingPropertyLocked(property) {
+        if (property === this.useRadiusProperty)
+            return this.radiusProperty;
+        else if (property === this.useSweepProperty)
+            return this.sweepProperty;
+        return undefined;
     }
     async applyToolSettingPropertyChange(updatedValue) {
-        if (this.methodProperty.name === updatedValue.propertyName) {
-            this.methodProperty.value = updatedValue.value.value;
-            IModelApp.toolAdmin.toolSettingsState.saveToolSettingProperty(this.toolId, this.methodProperty.item);
+        if (!this.changeToolSettingPropertyValue(updatedValue))
+            return false;
+        if (this.methodProperty.name === updatedValue.propertyName)
             await this.onReinitialize();
-            return true;
-        }
-        else if (updatedValue.propertyName === this.useRadiusProperty.name) {
-            this.useRadius = updatedValue.value.value;
-            IModelApp.toolAdmin.toolSettingsState.saveToolSettingProperty(this.toolId, this.useRadiusProperty.item);
-            this.syncRadiusState();
-            return true;
-        }
-        else if (updatedValue.propertyName === this.useSweepProperty.name) {
-            this.useSweep = updatedValue.value.value;
-            IModelApp.toolAdmin.toolSettingsState.saveToolSettingProperty(this.toolId, this.useSweepProperty.item);
-            this.syncSweepState();
-            return true;
-        }
-        else if (updatedValue.propertyName === this.radiusProperty.name) {
-            if (!updatedValue.value.value) {
-                this.syncRadiusState(); // force UI to redisplay last valid value
-                return false;
-            }
-            this.radius = updatedValue.value.value;
-            IModelApp.toolAdmin.toolSettingsState.saveToolSettingProperty(this.toolId, this.radiusProperty.item);
-            // If radius is changed when creating arc by start/center after center has been defined, back up a step to defined a new center point...
-            if (ArcMethod.StartCenter === this.method && this.useRadius && 2 === this.accepted.length)
-                await this.onUndoPreviousStep();
-            return true;
-        }
-        else if (updatedValue.propertyName === this.sweepProperty.name) {
-            if (!updatedValue.value.value) {
-                this.syncSweepState(); // force UI to redisplay last valid value
-                return false;
-            }
-            this.sweep = updatedValue.value.value;
-            IModelApp.toolAdmin.toolSettingsState.saveToolSettingProperty(this.toolId, this.sweepProperty.item);
-            return true;
-        }
-        return false;
+        else if (updatedValue.propertyName === this.radiusProperty.name && ArcMethod.StartCenter === this.method && this.useRadius && 2 === this.accepted.length)
+            await this.onUndoPreviousStep(); // If radius is changed when creating arc by start/center after center has been defined, back up a step to defined a new center point...
+        return true;
     }
     supplyToolSettingsProperties() {
         const toolSettings = new Array();
@@ -1015,23 +973,9 @@ export class CreateArcTool extends CreateOrContinuePathTool {
         if (!await super.onInstall())
             return false;
         // Setup initial values here instead of supplyToolSettingsProperties to support keyin args w/o appui-react...
-        const methodValue = IModelApp.toolAdmin.toolSettingsState.getInitialToolSettingValue(this.toolId, this.methodProperty.name);
-        if (undefined !== methodValue)
-            this.methodProperty.dialogItemValue = methodValue;
-        const radiusValue = IModelApp.toolAdmin.toolSettingsState.getInitialToolSettingValue(this.toolId, this.radiusProperty.name);
-        if (undefined !== radiusValue)
-            this.radiusProperty.dialogItemValue = radiusValue;
-        const useRadiusValue = IModelApp.toolAdmin.toolSettingsState.getInitialToolSettingValue(this.toolId, this.useRadiusProperty.name);
-        if (undefined !== useRadiusValue)
-            this.useRadiusProperty.dialogItemValue = useRadiusValue;
+        this.initializeToolSettingPropertyValues([this.methodProperty, this.radiusProperty, this.useRadiusProperty, this.sweepProperty, this.useSweepProperty]);
         if (!this.radius)
             this.useRadius = false;
-        const useSweepValue = IModelApp.toolAdmin.toolSettingsState.getInitialToolSettingValue(this.toolId, this.useSweepProperty.name);
-        if (undefined !== useSweepValue)
-            this.useSweepProperty.dialogItemValue = useSweepValue;
-        const sweepValue = IModelApp.toolAdmin.toolSettingsState.getInitialToolSettingValue(this.toolId, this.sweepProperty.name);
-        if (undefined !== sweepValue)
-            this.sweepProperty.dialogItemValue = sweepValue;
         if (!this.sweep)
             this.useSweep = false;
         return true;
@@ -1083,16 +1027,16 @@ export class CreateArcTool extends CreateOrContinuePathTool {
         }
         // Update current session values so keyin args are picked up for tool settings/restart...
         if (undefined !== arcMethod)
-            IModelApp.toolAdmin.toolSettingsState.saveToolSettingProperty(this.toolId, { propertyName: this.methodProperty.name, value: { value: arcMethod } });
+            this.saveToolSettingPropertyValue(this.methodProperty, { value: arcMethod });
         if (undefined !== arcRadius) {
             if (0.0 !== arcRadius)
-                IModelApp.toolAdmin.toolSettingsState.saveToolSettingProperty(this.toolId, { propertyName: this.radiusProperty.name, value: { value: arcRadius } });
-            IModelApp.toolAdmin.toolSettingsState.saveToolSettingProperty(this.toolId, { propertyName: this.useRadiusProperty.name, value: { value: 0.0 !== arcRadius } });
+                this.saveToolSettingPropertyValue(this.radiusProperty, { value: arcRadius });
+            this.saveToolSettingPropertyValue(this.useRadiusProperty, { value: 0.0 !== arcRadius });
         }
         if (undefined !== arcSweep) {
             if (0.0 !== arcSweep)
-                IModelApp.toolAdmin.toolSettingsState.saveToolSettingProperty(this.toolId, { propertyName: this.sweepProperty.name, value: { value: arcSweep } });
-            IModelApp.toolAdmin.toolSettingsState.saveToolSettingProperty(this.toolId, { propertyName: this.useSweepProperty.name, value: { value: 0.0 !== arcSweep } });
+                this.saveToolSettingPropertyValue(this.sweepProperty, { value: arcSweep });
+            this.saveToolSettingPropertyValue(this.useSweepProperty, { value: 0.0 !== arcSweep });
         }
         return this.run();
     }
@@ -1213,45 +1157,19 @@ export class CreateCircleTool extends CreateOrContinuePathTool {
     syncToolSettingsRadius() {
         if (this.useRadius)
             return;
-        const syncData = [];
-        if (!this.useRadius) {
-            this.radiusProperty.displayValue = this.radiusProperty.description.format(this.radius);
-            this.radiusProperty.isDisabled = !this.useRadius;
-            syncData.push(this.radiusProperty.syncItem);
-        }
-        if (0 !== syncData.length)
-            this.syncToolSettingsProperties(syncData);
-    }
-    syncRadiusState() {
-        this.radiusProperty.displayValue = this.radiusProperty.description.format(this.radius);
-        this.radiusProperty.isDisabled = !this.useRadius;
         this.syncToolSettingsProperties([this.radiusProperty.syncItem]);
     }
+    getToolSettingPropertyLocked(property) {
+        return (property === this.useRadiusProperty ? this.radiusProperty : undefined);
+    }
     async applyToolSettingPropertyChange(updatedValue) {
-        if (this.methodProperty.name === updatedValue.propertyName) {
-            this.methodProperty.value = updatedValue.value.value;
-            IModelApp.toolAdmin.toolSettingsState.saveToolSettingProperty(this.toolId, this.methodProperty.item);
+        if (!this.changeToolSettingPropertyValue(updatedValue))
+            return false;
+        if (this.methodProperty.name === updatedValue.propertyName)
             await this.onReinitialize();
-            return true;
-        }
-        else if (updatedValue.propertyName === this.useRadiusProperty.name) {
-            this.useRadius = updatedValue.value.value;
-            IModelApp.toolAdmin.toolSettingsState.saveToolSettingProperty(this.toolId, this.useRadiusProperty.item);
-            this.syncRadiusState();
-            if (CircleMethod.Center === this.method && this.useRadius && 0 === this.accepted.length)
-                await this.onReinitialize();
-            return true;
-        }
-        else if (updatedValue.propertyName === this.radiusProperty.name) {
-            if (!updatedValue.value.value) {
-                this.syncRadiusState(); // force UI to redisplay last valid value
-                return false;
-            }
-            this.radius = updatedValue.value.value;
-            IModelApp.toolAdmin.toolSettingsState.saveToolSettingProperty(this.toolId, this.radiusProperty.item);
-            return true;
-        }
-        return false;
+        else if (updatedValue.propertyName === this.useRadiusProperty.name && CircleMethod.Center === this.method && this.useRadius && 0 === this.accepted.length)
+            await this.onReinitialize();
+        return true;
     }
     supplyToolSettingsProperties() {
         const toolSettings = new Array();
@@ -1291,15 +1209,7 @@ export class CreateCircleTool extends CreateOrContinuePathTool {
         if (!await super.onInstall())
             return false;
         // Setup initial values here instead of supplyToolSettingsProperties to support keyin args w/o appui-react...
-        const methodValue = IModelApp.toolAdmin.toolSettingsState.getInitialToolSettingValue(this.toolId, this.methodProperty.name);
-        if (undefined !== methodValue)
-            this.methodProperty.dialogItemValue = methodValue;
-        const radiusValue = IModelApp.toolAdmin.toolSettingsState.getInitialToolSettingValue(this.toolId, this.radiusProperty.name);
-        if (undefined !== radiusValue)
-            this.radiusProperty.dialogItemValue = radiusValue;
-        const useRadiusValue = IModelApp.toolAdmin.toolSettingsState.getInitialToolSettingValue(this.toolId, this.useRadiusProperty.name);
-        if (undefined !== useRadiusValue)
-            this.useRadiusProperty.dialogItemValue = useRadiusValue;
+        this.initializeToolSettingPropertyValues([this.methodProperty, this.radiusProperty, this.useRadiusProperty]);
         if (!this.radius)
             this.useRadius = false;
         return true;
@@ -1337,11 +1247,11 @@ export class CreateCircleTool extends CreateOrContinuePathTool {
         }
         // Update current session values so keyin args are picked up for tool settings/restart...
         if (undefined !== circleMethod)
-            IModelApp.toolAdmin.toolSettingsState.saveToolSettingProperty(this.toolId, { propertyName: this.methodProperty.name, value: { value: circleMethod } });
+            this.saveToolSettingPropertyValue(this.methodProperty, { value: circleMethod });
         if (undefined !== circleRadius) {
             if (0.0 !== circleRadius)
-                IModelApp.toolAdmin.toolSettingsState.saveToolSettingProperty(this.toolId, { propertyName: this.radiusProperty.name, value: { value: circleRadius } });
-            IModelApp.toolAdmin.toolSettingsState.saveToolSettingProperty(this.toolId, { propertyName: this.useRadiusProperty.name, value: { value: 0.0 !== circleRadius } });
+                this.saveToolSettingPropertyValue(this.radiusProperty, { value: circleRadius });
+            this.saveToolSettingPropertyValue(this.useRadiusProperty, { value: 0.0 !== circleRadius });
         }
         return this.run();
     }
@@ -1494,27 +1404,11 @@ export class CreateRectangleTool extends CreateOrContinuePathTool {
             return;
         return { format: "flatbuffer", data: builder.entries };
     }
-    syncRadiusState() {
-        this.radiusProperty.displayValue = this.radiusProperty.description.format(this.radius);
-        this.radiusProperty.isDisabled = !this.useRadius;
-        this.syncToolSettingsProperties([this.radiusProperty.syncItem]);
+    getToolSettingPropertyLocked(property) {
+        return (property === this.useRadiusProperty ? this.radiusProperty : undefined);
     }
     async applyToolSettingPropertyChange(updatedValue) {
-        if (updatedValue.propertyName === this.useRadiusProperty.name) {
-            this.useRadius = updatedValue.value.value;
-            IModelApp.toolAdmin.toolSettingsState.saveToolSettingProperty(this.toolId, this.useRadiusProperty.item);
-            this.syncRadiusState();
-        }
-        else if (updatedValue.propertyName === this.radiusProperty.name) {
-            if (!updatedValue.value.value) {
-                this.syncRadiusState(); // force UI to redisplay last valid value
-                return false;
-            }
-            this.radius = updatedValue.value.value;
-            IModelApp.toolAdmin.toolSettingsState.saveToolSettingProperty(this.toolId, this.radiusProperty.item);
-            return true;
-        }
-        return false;
+        return this.changeToolSettingPropertyValue(updatedValue);
     }
     supplyToolSettingsProperties() {
         const toolSettings = new Array();
@@ -1533,12 +1427,7 @@ export class CreateRectangleTool extends CreateOrContinuePathTool {
         if (!await super.onInstall())
             return false;
         // Setup initial values here instead of supplyToolSettingsProperties to support keyin args w/o appui-react...
-        const radiusValue = IModelApp.toolAdmin.toolSettingsState.getInitialToolSettingValue(this.toolId, this.radiusProperty.name);
-        if (undefined !== radiusValue)
-            this.radiusProperty.dialogItemValue = radiusValue;
-        const useRadiusValue = IModelApp.toolAdmin.toolSettingsState.getInitialToolSettingValue(this.toolId, this.useRadiusProperty.name);
-        if (undefined !== useRadiusValue)
-            this.useRadiusProperty.dialogItemValue = useRadiusValue;
+        this.initializeToolSettingPropertyValues([this.radiusProperty, this.useRadiusProperty]);
         if (!this.radius)
             this.useRadius = false;
         return true;
@@ -1562,8 +1451,8 @@ export class CreateRectangleTool extends CreateOrContinuePathTool {
         // Update current session values so keyin args are picked up for tool settings/restart...
         if (undefined !== cornerRadius) {
             if (0.0 !== cornerRadius)
-                IModelApp.toolAdmin.toolSettingsState.saveToolSettingProperty(this.toolId, { propertyName: this.radiusProperty.name, value: { value: cornerRadius } });
-            IModelApp.toolAdmin.toolSettingsState.saveToolSettingProperty(this.toolId, { propertyName: this.useRadiusProperty.name, value: { value: 0.0 !== cornerRadius } });
+                this.saveToolSettingPropertyValue(this.radiusProperty, { value: cornerRadius });
+            this.saveToolSettingPropertyValue(this.useRadiusProperty, { value: 0.0 !== cornerRadius });
         }
         return this.run();
     }
@@ -1589,9 +1478,13 @@ export class CreateBCurveTool extends CreateOrContinuePathTool {
     get showCurveConstructions() { return true; } // Display control polygon or through points...
     provideToolAssistance(_mainInstrText, _additionalInstr) {
         const nPts = this.accepted.length;
-        const mainMsg = CoreTools.translate(0 === nPts ? "ElementSet.Prompts.StartPoint" : (1 === nPts ? "ElementSet.Prompts.EndPoint" : "ElementSet.Inputs.AdditionalPoint"));
+        let mainMsg;
+        if (CreateCurvePhase.DefineOther === this._tangentPhase)
+            mainMsg = CoreTools.translate(0 === nPts ? "ElementSet.Prompts.StartPoint" : "ElementSet.Inputs.AdditionalPoint");
+        else
+            mainMsg = EditTools.translate(CreateCurvePhase.DefineStart === this._tangentPhase ? "CreateBCurve.Prompts.StartTangent" : "CreateBCurve.Prompts.EndTangent");
         const leftMsg = CoreTools.translate("ElementSet.Inputs.AcceptPoint");
-        const rightMsg = CoreTools.translate(nPts > 1 ? "ElementSet.Inputs.Complete" : "ElementSet.Inputs.Cancel");
+        const rightMsg = CoreTools.translate(CreateCurvePhase.DefineOther === this._tangentPhase && nPts >= this.requiredPointCount ? "ElementSet.Inputs.Complete" : "ElementSet.Inputs.Cancel");
         const mouseInstructions = [];
         const touchInstructions = [];
         if (!ToolAssistance.createTouchCursorInstructions(touchInstructions))
@@ -1745,11 +1638,13 @@ export class CreateBCurveTool extends CreateOrContinuePathTool {
                         await this.updateCurveAndContinuationData(ev, false, CreateCurvePhase.DefineEnd);
                         this._tangentPhase = (undefined === fitCurve.options.startTangent ? CreateCurvePhase.DefineStart : CreateCurvePhase.DefineEnd);
                         IModelApp.toolAdmin.updateDynamics();
+                        this.setupAndPromptForNextAction();
                         return false;
                     case CreateCurvePhase.DefineStart:
                         fitCurve.options.startTangent = undefined; // Not accepted, compute default start tangent...
                         this._tangentPhase = CreateCurvePhase.DefineEnd;
                         IModelApp.toolAdmin.updateDynamics();
+                        this.setupAndPromptForNextAction();
                         return false;
                     case CreateCurvePhase.DefineEnd:
                         fitCurve.options.endTangent = undefined; // Not accepted, compute default end tangent...
@@ -1762,32 +1657,12 @@ export class CreateBCurveTool extends CreateOrContinuePathTool {
         }
         return true;
     }
-    syncOrderState() {
-        this.orderProperty.displayValue = this.orderProperty.description.format(this.order);
-        this.syncToolSettingsProperties([this.orderProperty.syncItem]);
-    }
     async applyToolSettingPropertyChange(updatedValue) {
-        if (this.methodProperty.name === updatedValue.propertyName) {
-            this.methodProperty.value = updatedValue.value.value;
-            IModelApp.toolAdmin.toolSettingsState.saveToolSettingProperty(this.toolId, this.methodProperty.item);
+        if (!this.changeToolSettingPropertyValue(updatedValue))
+            return false;
+        if (this.methodProperty.name === updatedValue.propertyName)
             await this.onReinitialize();
-            return true;
-        }
-        else if (updatedValue.propertyName === this.orderProperty.name) {
-            if (!updatedValue.value.value) {
-                this.syncOrderState(); // force UI to redisplay last valid value
-                return false;
-            }
-            this.order = updatedValue.value.value;
-            IModelApp.toolAdmin.toolSettingsState.saveToolSettingProperty(this.toolId, this.orderProperty.item);
-            return true;
-        }
-        else if (updatedValue.propertyName === this.tangentsProperty.name) {
-            this.tangents = updatedValue.value.value;
-            IModelApp.toolAdmin.toolSettingsState.saveToolSettingProperty(this.toolId, this.tangentsProperty.item);
-            return true;
-        }
-        return false;
+        return true;
     }
     supplyToolSettingsProperties() {
         const toolSettings = new Array();
@@ -1807,15 +1682,7 @@ export class CreateBCurveTool extends CreateOrContinuePathTool {
         if (!await super.onInstall())
             return false;
         // Setup initial values here instead of supplyToolSettingsProperties to support keyin args w/o appui-react...
-        const methodValue = IModelApp.toolAdmin.toolSettingsState.getInitialToolSettingValue(this.toolId, this.methodProperty.name);
-        if (undefined !== methodValue)
-            this.methodProperty.dialogItemValue = methodValue;
-        const orderValue = IModelApp.toolAdmin.toolSettingsState.getInitialToolSettingValue(this.toolId, this.orderProperty.name);
-        if (undefined !== orderValue)
-            this.orderProperty.dialogItemValue = orderValue;
-        const tangentsValue = IModelApp.toolAdmin.toolSettingsState.getInitialToolSettingValue(this.toolId, this.tangentsProperty.name);
-        if (undefined !== tangentsValue)
-            this.tangentsProperty.dialogItemValue = tangentsValue;
+        this.initializeToolSettingPropertyValues([this.methodProperty, this.orderProperty, this.tangentsProperty]);
         return true;
     }
     /** The keyin takes the following arguments, all of which are optional:
@@ -1857,11 +1724,11 @@ export class CreateBCurveTool extends CreateOrContinuePathTool {
         }
         // Update current session values so keyin args are picked up for tool settings/restart...
         if (undefined !== bcurveMethod)
-            IModelApp.toolAdmin.toolSettingsState.saveToolSettingProperty(this.toolId, { propertyName: this.methodProperty.name, value: { value: bcurveMethod } });
+            this.saveToolSettingPropertyValue(this.methodProperty, { value: bcurveMethod });
         if (undefined !== bcurveOrder)
-            IModelApp.toolAdmin.toolSettingsState.saveToolSettingProperty(this.toolId, { propertyName: this.orderProperty.name, value: { value: bcurveOrder } });
+            this.saveToolSettingPropertyValue(this.orderProperty, { value: bcurveOrder });
         if (undefined !== bcurveTangents)
-            IModelApp.toolAdmin.toolSettingsState.saveToolSettingProperty(this.toolId, { propertyName: this.tangentsProperty.name, value: { value: bcurveTangents } });
+            this.saveToolSettingPropertyValue(this.tangentsProperty, { value: bcurveTangents });
         return this.run();
     }
 }