@itwin/core-frontend 5.1.0-dev.9 → 5.2.0-dev.1

package/lib/esm/tools/MeasureTool.js

@@ -14,7 +14,6 @@ import { HitGeomType } from "../HitDetail";
 import { IModelApp } from "../IModelApp";
 import { Marker } from "../Marker";
 import { NotifyMessageDetails, OutputMessagePriority, OutputMessageType } from "../NotificationManager";
-import { QuantityType } from "../quantity-formatting/QuantityFormatter";
 import { PrimitiveTool } from "./PrimitiveTool";
 import { BeModifierKeys, CoreTools, EventHandled, InputSource } from "./Tool";
 import { ToolAssistance, ToolAssistanceImage, ToolAssistanceInputMethod } from "./ToolAssistance";
@@ -22,6 +21,16 @@ import { GraphicType } from "../common/render/GraphicType";
 function translateBold(key) {
     return `<b>${CoreTools.translate(`Measure.Labels.${key}`)}:</b> `;
 }
+async function getFormatterSpecByKoQAndPersistenceUnit(koq, persistenceUnitName) {
+    const formatProps = await IModelApp.formatsProvider.getFormat(koq);
+    if (undefined === formatProps)
+        return undefined;
+    return IModelApp.quantityFormatter.createFormatterSpec({
+        persistenceUnitName,
+        formatProps,
+        formatName: koq
+    });
+}
 /** @internal */
 class MeasureLabel {
     worldLocation = new Point3d();
@@ -139,6 +148,12 @@ export class MeasureDistanceTool extends PrimitiveTool {
     /** @internal */
     _lastMotionAdjustedPt;
     /** @internal */
+    _lengthFormatterSpec;
+    /** @internal */
+    _angleFormatterSpec;
+    /** @internal */
+    _removeFormatterListener;
+    /** @internal */
     allowView(vp) { return vp.view.isSpatialView() || vp.view.isDrawingView(); }
     /** @internal */
     isCompatibleViewport(vp, isSelectedViewChange) { return (super.isCompatibleViewport(vp, isSelectedViewChange) && undefined !== vp && this.allowView(vp)); }
@@ -149,9 +164,25 @@ export class MeasureDistanceTool extends PrimitiveTool {
     /** @internal */
     async onPostInstall() {
         await super.onPostInstall();
+        this._lengthFormatterSpec = await getFormatterSpecByKoQAndPersistenceUnit("AecUnits.LENGTH", "Units.M");
+        this._angleFormatterSpec = await getFormatterSpecByKoQAndPersistenceUnit("AecUnits.ANGLE", "Units.RAD");
+        this._removeFormatterListener = IModelApp.formatsProvider.onFormatsChanged.addListener(async (args) => {
+            if (args.formatsChanged === "all" || args.formatsChanged.includes("AecUnits.LENGTH"))
+                this._lengthFormatterSpec = await getFormatterSpecByKoQAndPersistenceUnit("AecUnits.LENGTH", "Units.M");
+            if (args.formatsChanged === "all" || args.formatsChanged.includes("AecUnits.ANGLE"))
+                this._angleFormatterSpec = await getFormatterSpecByKoQAndPersistenceUnit("AecUnits.ANGLE", "Units.RAD");
+        });
         this.setupAndPromptForNextAction();
     }
     /** @internal */
+    async onCleanup() {
+        if (this._removeFormatterListener) {
+            this._removeFormatterListener();
+            this._removeFormatterListener = undefined;
+        }
+        await super.onCleanup();
+    }
+    /** @internal */
     async onUnsuspend() { this.showPrompt(); }
     /** @internal */
     showPrompt() {
@@ -222,8 +253,8 @@ export class MeasureDistanceTool extends PrimitiveTool {
             totalDistance += adjustedPoints[i].distance(adjustedPoints[i + 1]);
         if (0.0 === totalDistance)
             return;
-        const formatterSpec = IModelApp.quantityFormatter.findFormatterSpecByQuantityType(QuantityType.Length);
-        if (undefined === formatterSpec)
+        const formatterSpec = this._lengthFormatterSpec;
+        if (formatterSpec === undefined)
             return;
         const formattedTotalDistance = IModelApp.quantityFormatter.formatQuantity(totalDistance, formatterSpec);
         const distDyn = new MeasureLabel(points[points.length - 1], formattedTotalDistance);
@@ -360,7 +391,7 @@ export class MeasureDistanceTool extends PrimitiveTool {
             this._totalDistance += seg.distance;
         if (0.0 === this._totalDistance)
             return;
-        const formatterSpec = await IModelApp.quantityFormatter.getFormatterSpecByQuantityType(QuantityType.Length);
+        const formatterSpec = this._lengthFormatterSpec;
         if (undefined === formatterSpec)
             return;
         const formattedTotalDistance = IModelApp.quantityFormatter.formatQuantity(this._totalDistance, formatterSpec);
@@ -371,20 +402,20 @@ export class MeasureDistanceTool extends PrimitiveTool {
         const is3d = (undefined === this.targetView || this.targetView.view.is3d());
         const isSpatial = (undefined !== this.targetView && this.targetView.view.isSpatialView());
         const toolTip = document.createElement("div");
-        const distanceFormatterSpec = await IModelApp.quantityFormatter.getFormatterSpecByQuantityType(QuantityType.Length);
+        const distanceFormatterSpec = this._lengthFormatterSpec;
         if (undefined === distanceFormatterSpec)
             return toolTip;
         let toolTipHtml = "";
         const formattedDistance = IModelApp.quantityFormatter.formatQuantity(distance, distanceFormatterSpec);
         toolTipHtml += `${translateBold("Distance") + formattedDistance}<br>`;
         if (is3d) {
-            const angleFormatterSpec = await IModelApp.quantityFormatter.getFormatterSpecByQuantityType(QuantityType.Angle);
+            const angleFormatterSpec = this._angleFormatterSpec;
             if (undefined !== angleFormatterSpec) {
                 const formattedSlope = IModelApp.quantityFormatter.formatQuantity(slope, angleFormatterSpec);
                 toolTipHtml += `${translateBold("Slope") + formattedSlope}<br>`;
             }
         }
-        const coordFormatterSpec = await IModelApp.quantityFormatter.getFormatterSpecByQuantityType(QuantityType.Coordinate);
+        const coordFormatterSpec = this._lengthFormatterSpec;
         if (undefined !== coordFormatterSpec) {
             let startAdjusted = start;
             let endAdjusted = end;
@@ -498,7 +529,8 @@ export class MeasureDistanceTool extends PrimitiveTool {
         if (undefined !== snap) {
             if (undefined !== snap.primitive) {
                 const locDetail = snap.primitive.closestPoint(point, false);
-                if (undefined !== locDetail && (HitGeomType.Segment === snap.geomType || snap.primitive.isInPlane(Plane3dByOriginAndUnitNormal.create(point, undefined !== snap.normal ? snap.normal : normal)))) {
+                const snapPlane = Plane3dByOriginAndUnitNormal.create(point, undefined !== snap.normal ? snap.normal : normal);
+                if (undefined !== locDetail && (HitGeomType.Segment === snap.geomType || (snapPlane && snap.primitive.isInPlane(snapPlane)))) {
                     const locRay = snap.primitive.fractionToPointAndUnitTangent(locDetail.fraction);
                     tangent.setFrom(locRay.direction);
                     if (undefined !== snap.normal)
@@ -620,7 +652,7 @@ export class MeasureLocationTool extends PrimitiveTool {
         const isSpatial = (undefined !== this.targetView && this.targetView.view.isSpatialView());
         const toolTip = document.createElement("div");
         let toolTipHtml = "";
-        const coordFormatterSpec = await IModelApp.quantityFormatter.getFormatterSpecByQuantityType(QuantityType.Coordinate);
+        const coordFormatterSpec = await getFormatterSpecByKoQAndPersistenceUnit("AecUnits.LENGTH", "Units.M");
         if (undefined !== coordFormatterSpec) {
             let pointAdjusted = point;
             if (isSpatial) {
@@ -636,7 +668,7 @@ export class MeasureLocationTool extends PrimitiveTool {
             toolTipHtml += "<br>";
         }
         if (isSpatial) {
-            const latLongFormatterSpec = await IModelApp.quantityFormatter.getFormatterSpecByQuantityType(QuantityType.LatLong);
+            const latLongFormatterSpec = await getFormatterSpecByKoQAndPersistenceUnit("AecUnits.ANGLE", "Units.RAD");
             if (undefined !== latLongFormatterSpec && undefined !== coordFormatterSpec) {
                 try {
                     const cartographic = await this.iModel.spatialToCartographic(point);
@@ -940,17 +972,17 @@ export class MeasureAreaByPointsTool extends PrimitiveTool {
         const isSpatial = (undefined !== this.targetView && this.targetView.view.isSpatialView());
         const toolTip = document.createElement("div");
         let toolTipHtml = "";
-        const areaFormatterSpec = await IModelApp.quantityFormatter.getFormatterSpecByQuantityType(QuantityType.Area);
+        const areaFormatterSpec = await getFormatterSpecByKoQAndPersistenceUnit("AecUnits.AREA", "Units.SQ_M");
         if (undefined !== areaFormatterSpec) {
             const formattedArea = IModelApp.quantityFormatter.formatQuantity(this._area, areaFormatterSpec);
             toolTipHtml += `${translateBold("Area") + formattedArea}<br>`;
         }
-        const perimeterFormatterSpec = await IModelApp.quantityFormatter.getFormatterSpecByQuantityType(QuantityType.Length);
+        const perimeterFormatterSpec = await getFormatterSpecByKoQAndPersistenceUnit("AecUnits.LENGTH", "Units.M");
         if (undefined !== perimeterFormatterSpec) {
             const formattedPerimeter = IModelApp.quantityFormatter.formatQuantity(this._perimeter, perimeterFormatterSpec);
             toolTipHtml += `${translateBold("Perimeter") + formattedPerimeter}<br>`;
         }
-        const coordFormatterSpec = await IModelApp.quantityFormatter.getFormatterSpecByQuantityType(QuantityType.Coordinate);
+        const coordFormatterSpec = await getFormatterSpecByKoQAndPersistenceUnit("AecUnits.LENGTH", "Units.M");
         if (undefined !== coordFormatterSpec) {
             let pointAdjusted = this._centroid.clone();
             if (isSpatial) {
@@ -989,7 +1021,7 @@ export class MeasureAreaByPointsTool extends PrimitiveTool {
         const toolTip = await this.getMarkerToolTip();
         this._acceptedMeasurement = new MeasureMarker("1", toolTip, this._centroid, Point2d.create(25, 25));
         this._marker = undefined;
-        const areaFormatterSpec = await IModelApp.quantityFormatter.getFormatterSpecByQuantityType(QuantityType.Area);
+        const areaFormatterSpec = await getFormatterSpecByKoQAndPersistenceUnit("AecUnits.AREA", "Units.SQ_M");
         if (undefined === areaFormatterSpec)
             return;
         const formattedTotalArea = IModelApp.quantityFormatter.formatQuantity(this._area, areaFormatterSpec);
@@ -1018,7 +1050,8 @@ export class MeasureAreaByPointsTool extends PrimitiveTool {
             return EventHandled.No;
         const currPt = ev.point.clone();
         if (this._points.length > 0) {
-            const planePt = AccuDrawHintBuilder.projectPointToPlaneInView(currPt, this._points[0], this._matrix.getColumn(2), ev.viewport, true);
+            const vp = ev.viewport;
+            const planePt = (vp ? AccuDrawHintBuilder.projectPointToPlaneInView(currPt, this._points[0], this._matrix.getColumn(2), vp, true) : undefined);
             if (undefined !== planePt)
                 currPt.setFrom(planePt);
         }
@@ -1171,7 +1204,7 @@ export class MeasureElementTool extends PrimitiveTool {
         let toolTipHtml = "";
         switch (this.getOperation()) {
             case MassPropertiesOperation.AccumulateLengths: {
-                const distanceFormatterSpec = await IModelApp.quantityFormatter.getFormatterSpecByQuantityType(QuantityType.Length);
+                const distanceFormatterSpec = await getFormatterSpecByKoQAndPersistenceUnit("AecUnits.LENGTH", "Units.M");
                 if (undefined !== distanceFormatterSpec) {
                     const formattedLength = IModelApp.quantityFormatter.formatQuantity(responseProps.length ? responseProps.length : 0, distanceFormatterSpec);
                     toolTipHtml += `${translateBold("Length") + formattedLength}<br>`;
@@ -1179,13 +1212,13 @@ export class MeasureElementTool extends PrimitiveTool {
                 break;
             }
             case MassPropertiesOperation.AccumulateAreas: {
-                const areaFormatterSpec = await IModelApp.quantityFormatter.getFormatterSpecByQuantityType(QuantityType.Area);
+                const areaFormatterSpec = await getFormatterSpecByKoQAndPersistenceUnit("AecUnits.AREA", "Units.SQ_M");
                 if (undefined !== areaFormatterSpec) {
                     const formattedArea = IModelApp.quantityFormatter.formatQuantity(responseProps.area ? responseProps.area : 0, areaFormatterSpec);
                     toolTipHtml += `${translateBold("Area") + formattedArea}<br>`;
                 }
                 if (responseProps.perimeter) {
-                    const perimeterFormatterSpec = await IModelApp.quantityFormatter.getFormatterSpecByQuantityType(QuantityType.Length);
+                    const perimeterFormatterSpec = await getFormatterSpecByKoQAndPersistenceUnit("AecUnits.LENGTH", "Units.M");
                     if (undefined !== perimeterFormatterSpec) {
                         const formattedPerimeter = IModelApp.quantityFormatter.formatQuantity(responseProps.perimeter, perimeterFormatterSpec);
                         toolTipHtml += `${translateBold("Perimeter") + formattedPerimeter}<br>`;
@@ -1194,13 +1227,13 @@ export class MeasureElementTool extends PrimitiveTool {
                 break;
             }
             case MassPropertiesOperation.AccumulateVolumes: {
-                const volumeFormatterSpec = await IModelApp.quantityFormatter.getFormatterSpecByQuantityType(QuantityType.Volume);
+                const volumeFormatterSpec = await getFormatterSpecByKoQAndPersistenceUnit("AecUnits.VOLUME", "Units.CUB_M");
                 if (undefined !== volumeFormatterSpec) {
                     const formattedVolume = IModelApp.quantityFormatter.formatQuantity(responseProps.volume ? responseProps.volume : 0, volumeFormatterSpec);
                     toolTipHtml += `${translateBold("Volume") + formattedVolume}<br>`;
                 }
                 if (responseProps.area) {
-                    const areaFormatterSpec = await IModelApp.quantityFormatter.getFormatterSpecByQuantityType(QuantityType.Area);
+                    const areaFormatterSpec = await getFormatterSpecByKoQAndPersistenceUnit("AecUnits.AREA", "Units.SQ_M");
                     if (undefined !== areaFormatterSpec) {
                         const formattedArea = IModelApp.quantityFormatter.formatQuantity(responseProps.area, areaFormatterSpec);
                         toolTipHtml += `${translateBold("Area") + formattedArea}<br>`;
@@ -1210,7 +1243,7 @@ export class MeasureElementTool extends PrimitiveTool {
             }
         }
         if (responseProps.centroid) {
-            const coordFormatterSpec = await IModelApp.quantityFormatter.getFormatterSpecByQuantityType(QuantityType.Coordinate);
+            const coordFormatterSpec = await getFormatterSpecByKoQAndPersistenceUnit("AecUnits.LENGTH", "Units.M");
             if (undefined !== coordFormatterSpec) {
                 let pointAdjusted = Point3d.fromJSON(responseProps.centroid);
                 if (isSpatial) {
@@ -1261,21 +1294,21 @@ export class MeasureElementTool extends PrimitiveTool {
             return;
         switch (operation) {
             case MassPropertiesOperation.AccumulateLengths:
-                const distanceFormatterSpec = await IModelApp.quantityFormatter.getFormatterSpecByQuantityType(QuantityType.Length);
+                const distanceFormatterSpec = await getFormatterSpecByKoQAndPersistenceUnit("AecUnits.LENGTH", "Units.M");
                 if (undefined === distanceFormatterSpec)
                     return;
                 const formattedTotalDistance = IModelApp.quantityFormatter.formatQuantity(this._totalValue, distanceFormatterSpec);
                 this._totalMarker = new MeasureLabel(labelPt, formattedTotalDistance);
                 break;
             case MassPropertiesOperation.AccumulateAreas:
-                const areaFormatterSpec = await IModelApp.quantityFormatter.getFormatterSpecByQuantityType(QuantityType.Area);
+                const areaFormatterSpec = await getFormatterSpecByKoQAndPersistenceUnit("AecUnits.AREA", "Units.SQ_M");
                 if (undefined === areaFormatterSpec)
                     return;
                 const formattedTotalArea = IModelApp.quantityFormatter.formatQuantity(this._totalValue, areaFormatterSpec);
                 this._totalMarker = new MeasureLabel(labelPt, formattedTotalArea);
                 break;
             case MassPropertiesOperation.AccumulateVolumes:
-                const volumeFormatterSpec = await IModelApp.quantityFormatter.getFormatterSpecByQuantityType(QuantityType.Volume);
+                const volumeFormatterSpec = await getFormatterSpecByKoQAndPersistenceUnit("AecUnits.VOLUME", "Units.CUB_M");
                 if (undefined === volumeFormatterSpec)
                     return;
                 const formattedTotalVolume = IModelApp.quantityFormatter.formatQuantity(this._totalValue, volumeFormatterSpec);