@itwin/editor-frontend 3.5.0-dev.5 → 3.5.0-dev.52

package/lib/cjs/ModifyCurveTools.js

@@ -1,18 +1,18 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExtendCurveTool = exports.BreakCurveTool = exports.OffsetCurveTool = exports.ModifyCurveTool = exports.CurveData = void 0;
 /*---------------------------------------------------------------------------------------------
 * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
 * See LICENSE.md in the project root for license terms and full copyright notice.
 *--------------------------------------------------------------------------------------------*/
-const core_frontend_1 = require("@itwin/core-frontend");
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExtendCurveTool = exports.BreakCurveTool = exports.OffsetCurveTool = exports.ModifyCurveTool = exports.CurveData = void 0;
+const appui_abstract_1 = require("@itwin/appui-abstract");
 const core_common_1 = require("@itwin/core-common");
-const EditTool_1 = require("./EditTool");
+const core_frontend_1 = require("@itwin/core-frontend");
 const core_geometry_1 = require("@itwin/core-geometry");
 const editor_common_1 = require("@itwin/editor-common");
-const CreateElementTool_1 = require("./CreateElementTool");
-const appui_abstract_1 = require("@itwin/appui-abstract");
-const core_bentley_1 = require("@itwin/core-bentley");
+const EditTool_1 = require("./EditTool");
+const EditToolIpc_1 = require("./EditToolIpc");
+const ModifyElementTool_1 = require("./ModifyElementTool");
 /** @alpha */
 class CurveData {
     constructor(props, params, geom) {
@@ -22,79 +22,13 @@ class CurveData {
     }
 }
 exports.CurveData = CurveData;
-/** @alpha Base class for applying an offset to path and loops. */
-class ModifyCurveTool extends core_frontend_1.ElementSetTool {
-    constructor() {
-        super(...arguments);
-        this._checkedIds = new Map();
-        this._firstResult = true;
-    }
-    allowView(_vp) { return true; }
-    isCompatibleViewport(vp, isSelectedViewChange) { return (super.isCompatibleViewport(vp, isSelectedViewChange) && undefined !== vp && this.allowView(vp)); }
+/** @alpha Base class for modifying all types of curve geometry. */
+class ModifyCurveTool extends ModifyElementTool_1.ModifyElementWithDynamicsTool {
     async startCommand() {
         if (undefined !== this._startedCmd)
             return this._startedCmd;
         return EditTool_1.EditTools.startCommand(editor_common_1.editorBuiltInCmdIds.cmdBasicManipulation, this.iModel.key);
     }
-    static callCommand(method, ...args) {
-        return EditTool_1.EditTools.callCommand(method, ...args);
-    }
-    agendaAppearance(isDynamics) {
-        if (isDynamics) {
-            if (undefined === this._agendaAppearanceDynamic)
-                this._agendaAppearanceDynamic = core_common_1.FeatureAppearance.fromTransparency(0.0);
-            return this._agendaAppearanceDynamic;
-        }
-        if (undefined === this._agendaAppearanceDefault)
-            this._agendaAppearanceDefault = core_common_1.FeatureAppearance.fromTransparency(0.9);
-        return this._agendaAppearanceDefault;
-    }
-    get wantAgendaAppearanceOverride() { return false; }
-    addFeatureOverrides(overrides, _vp) {
-        if (this.agenda.isEmpty)
-            return;
-        const appearance = this.agendaAppearance(false);
-        this.agenda.elements.forEach((elementId) => overrides.override({ elementId, appearance }));
-    }
-    updateAgendaAppearanceProvider(drop) {
-        if (!this.wantAgendaAppearanceOverride)
-            return;
-        for (const vp of core_frontend_1.IModelApp.viewManager) {
-            if (!this.allowView(vp))
-                continue;
-            if (drop || this.agenda.isEmpty)
-                vp.dropFeatureOverrideProvider(this);
-            else if (!vp.addFeatureOverrideProvider(this))
-                vp.setFeatureOverrideProviderChanged();
-        }
-    }
-    clearGraphics() {
-        if (undefined === this._graphicsProvider)
-            return;
-        this._graphicsProvider.cleanupGraphic();
-        this._graphicsProvider = undefined;
-    }
-    async createGraphics(ev) {
-        if (!core_frontend_1.IModelApp.viewManager.inDynamicsMode)
-            return; // Don't need to create graphic if dynamics aren't yet active...
-        const geometry = this.getGeometryProps(ev, false);
-        if (undefined === geometry)
-            return;
-        const elemProps = this.getElementProps(ev);
-        if (undefined === (elemProps === null || elemProps === void 0 ? void 0 : elemProps.placement))
-            return;
-        if (undefined === this._graphicsProvider) {
-            if (this._firstResult) {
-                this.updateAgendaAppearanceProvider();
-                this._firstResult = false;
-            }
-            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(elemProps.category, elemProps.placement, geometry);
-    }
     static isSingleCurve(info) {
         const it = new core_common_1.ElementGeometry.Iterator(info);
         it.requestWorldCoordinates();
@@ -118,7 +52,7 @@ class ModifyCurveTool extends core_frontend_1.ElementSetTool {
         try {
             this._startedCmd = await this.startCommand();
             const reject = [core_common_1.ElementGeometryOpcode.Polyface, core_common_1.ElementGeometryOpcode.SolidPrimitive, core_common_1.ElementGeometryOpcode.BsplineSurface, core_common_1.ElementGeometryOpcode.BRep];
-            const info = await ModifyCurveTool.callCommand("requestElementGeometry", id, { maxDisplayable: 1, reject, geometry: { curves: true, surfaces: true, solids: false } });
+            const info = await EditToolIpc_1.basicManipulationIpc.requestElementGeometry(id, { maxDisplayable: 1, reject, geometry: { curves: true, surfaces: true, solids: false } });
             if (undefined === info)
                 return undefined;
             const data = ModifyCurveTool.isSingleCurve(info);
@@ -136,23 +70,8 @@ class ModifyCurveTool extends core_frontend_1.ElementSetTool {
             return undefined;
         }
     }
-    onGeometryFilterChanged() { this._checkedIds.clear(); }
-    async acceptElementForOperation(id) {
-        if (core_bentley_1.Id64.isInvalid(id) || core_bentley_1.Id64.isTransient(id))
-            return false;
-        let accept = this._checkedIds.get(id);
-        if (undefined === accept) {
-            if (this.agenda.isEmpty && this._checkedIds.size > 1000)
-                this._checkedIds.clear(); // Limit auto-locate cache size to something reasonable...
-            accept = (undefined !== await this.getCurveData(id));
-            this._checkedIds.set(id, accept);
-        }
-        return accept;
-    }
-    async isElementValidForOperation(hit, out) {
-        if (!await super.isElementValidForOperation(hit, out))
-            return false;
-        return this.acceptElementForOperation(hit.sourceId);
+    async doAcceptElementForOperation(id) {
+        return (undefined !== await this.getCurveData(id));
     }
     async onAgendaModified() {
         this.curveData = undefined;
@@ -161,33 +80,22 @@ class ModifyCurveTool extends core_frontend_1.ElementSetTool {
         const id = this.agenda.elements[this.agenda.length - 1];
         this.curveData = await this.getCurveData(id);
     }
-    onDynamicFrame(_ev, context) {
-        if (undefined !== this._graphicsProvider)
-            this._graphicsProvider.addGraphic(context);
-    }
-    async onMouseMotion(ev) {
-        return this.createGraphics(ev);
-    }
     setupAccuDraw() {
         const hints = new core_frontend_1.AccuDrawHintBuilder();
         hints.enableSmartRotation = true;
         hints.sendHints(false);
     }
-    setupAndPromptForNextAction() {
-        this.setupAccuDraw();
-        super.setupAndPromptForNextAction();
-    }
     getGeometryProps(ev, isAccept) {
         if (undefined === this.curveData)
             return;
-        const offset = this.modifyCurve(ev, isAccept);
-        if (undefined === offset)
+        const geom = this.modifyCurve(ev, isAccept);
+        if (undefined === geom)
             return;
         const builder = new core_common_1.ElementGeometry.Builder();
         builder.setLocalToWorldFromPlacement(this.curveData.props.placement);
         if (!builder.appendGeometryParamsChange(this.curveData.params))
             return;
-        if (!builder.appendGeometryQuery(offset))
+        if (!builder.appendGeometryQuery(geom))
             return;
         return { format: "flatbuffer", data: builder.entries };
     }
@@ -202,29 +110,19 @@ class ModifyCurveTool extends core_frontend_1.ElementSetTool {
         }
         return this.curveData.props;
     }
-    async applyAgendaOperation(ev) {
-        const geometry = this.getGeometryProps(ev, true);
-        if (undefined === geometry)
-            return false;
-        const elemProps = this.getElementProps(ev);
-        if (undefined === elemProps)
-            return false;
-        if ("flatbuffer" === geometry.format)
-            elemProps.elementGeometryBuilderParams = { entryArray: geometry.data };
-        else
-            elemProps.geom = geometry.data;
+    async doUpdateElement(elemProps) {
         try {
             this._startedCmd = await this.startCommand();
             if (undefined === elemProps.id) {
                 const repeatOperation = this.wantContinueWithPreviousResult;
                 if (repeatOperation)
                     this.agenda.clear();
-                const newId = await ModifyCurveTool.callCommand("insertGeometricElement", elemProps);
+                const newId = await EditToolIpc_1.basicManipulationIpc.insertGeometricElement(elemProps);
                 if (repeatOperation && this.agenda.add(newId))
                     await this.onAgendaModified();
             }
             else {
-                await ModifyCurveTool.callCommand("updateGeometricElement", elemProps);
+                await EditToolIpc_1.basicManipulationIpc.updateGeometricElement(elemProps);
             }
             return true;
         }
@@ -233,10 +131,6 @@ class ModifyCurveTool extends core_frontend_1.ElementSetTool {
             return false;
         }
     }
-    async processAgenda(ev) {
-        if (await this.applyAgendaOperation(ev))
-            return this.saveChanges();
-    }
     get wantModifyOriginal() { return true; }
     get wantContinueWithPreviousResult() { return false; }
     async onProcessComplete() {
@@ -245,32 +139,10 @@ class ModifyCurveTool extends core_frontend_1.ElementSetTool {
             return;
         return super.onProcessComplete();
     }
-    async onUnsuspend() {
-        if (!this._firstResult)
-            this.updateAgendaAppearanceProvider();
-        return super.onUnsuspend();
-    }
-    async onSuspend() {
-        if (!this._firstResult)
-            this.updateAgendaAppearanceProvider(true);
-        return super.onSuspend();
-    }
-    async onPostInstall() {
-        await super.onPostInstall();
-        if (this.wantAgendaAppearanceOverride)
-            this.agenda.manageHiliteState = false;
-    }
-    async onCleanup() {
-        this.clearGraphics();
-        this.updateAgendaAppearanceProvider(true);
-        return super.onCleanup();
-    }
 }
 exports.ModifyCurveTool = ModifyCurveTool;
 /** @alpha Tool for applying an offset to paths and loops. */
 class OffsetCurveTool extends ModifyCurveTool {
-    get wantAccuSnap() { return true; }
-    get wantDynamics() { return true; }
     get useDistanceProperty() {
         if (!this._useDistanceProperty)
             this._useDistanceProperty = new appui_abstract_1.DialogProperty(appui_abstract_1.PropertyDescriptionHelper.buildLockPropertyDescription("useOffsetDistance"), false);
@@ -435,7 +307,7 @@ class BreakCurveTool extends ModifyCurveTool {
         super(...arguments);
         this.modifyOriginal = true;
     }
-    get wantAccuSnap() { return true; }
+    get wantDynamics() { return false; }
     get wantModifyOriginal() { return this.modifyOriginal; }
     acceptCurve(curve) {
         if ("curvePrimitive" === curve.geometryCategory)
@@ -563,34 +435,16 @@ class BreakCurveTool extends ModifyCurveTool {
 exports.BreakCurveTool = BreakCurveTool;
 BreakCurveTool.toolId = "BreakCurve";
 BreakCurveTool.iconSpec = "icon-scale"; // Need better icon...
-/** @alpha Tool for extending/shortening curves. */
+/** @alpha Tool to extend or trim a path or open curve */
 class ExtendCurveTool extends ModifyCurveTool {
-    get wantAccuSnap() { return true; }
-    get wantDynamics() { return true; }
     get wantAgendaAppearanceOverride() { return true; }
     acceptCurve(curve) {
-        if ("curvePrimitive" !== curve.geometryCategory)
-            return false;
-        return curve.isExtensibleFractionSpace;
+        if ("curvePrimitive" === curve.geometryCategory)
+            return curve.isExtensibleFractionSpace;
+        return ("path" === curve.curveCollectionType);
     }
-    modifyCurve(ev, _isAccept) {
-        var _a;
-        if (undefined === ev.viewport || undefined === this.anchorPoint)
-            return undefined;
-        const geom = (_a = this.curveData) === null || _a === void 0 ? void 0 : _a.geom;
-        if (undefined === geom)
-            return undefined;
-        const matrix = core_frontend_1.AccuDrawHintBuilder.getCurrentRotation(ev.viewport, true, true);
-        const localToWorld = core_geometry_1.FrameBuilder.createRightHandedFrame(matrix === null || matrix === void 0 ? void 0 : matrix.getColumn(2), geom);
-        if (undefined === localToWorld)
-            return undefined;
-        const worldToLocal = localToWorld.inverse();
-        if (undefined === worldToLocal)
-            return undefined;
-        const spacePoint = core_frontend_1.AccuDrawHintBuilder.projectPointToPlaneInView(ev.point, localToWorld.getOrigin(), localToWorld.matrix.getColumn(2), ev.viewport);
-        if (undefined === spacePoint)
-            return undefined;
-        const pickDetail = geom.closestPoint(this.anchorPoint, false);
+    extendCurve(geom, pickPoint, spacePoint) {
+        const pickDetail = geom.closestPoint(pickPoint, false);
         if (undefined === (pickDetail === null || pickDetail === void 0 ? void 0 : pickDetail.curve))
             return undefined;
         const closeDetail = geom.closestPoint(spacePoint, true);
@@ -613,41 +467,126 @@ class ExtendCurveTool extends ModifyCurveTool {
                 return fullArc;
             }
         }
-        return closeDetail.curve.clonePartialCurve(pickDetail.fraction > 0.5 ? 0.0 : 1.0, closeDetail.fraction);
+        return geom.clonePartialCurve(pickDetail.fraction > 0.5 ? 0.0 : 1.0, closeDetail.fraction);
     }
-    setupAccuDraw() {
+    extendPathEnd(geom, closeDetail, isStart) {
+        if (undefined === closeDetail.curve)
+            return undefined;
+        const curve = closeDetail.curve.clonePartialCurve(isStart ? closeDetail.fraction : 0.0, isStart ? 1.0 : closeDetail.fraction);
+        if (undefined === curve)
+            return undefined;
+        if (curve instanceof core_geometry_1.Arc3d && closeDetail.curve instanceof core_geometry_1.Arc3d && (curve.sweep.isCCW !== closeDetail.curve.sweep.isCCW))
+            curve.sweep.cloneComplement(true, curve.sweep); // Preserve current sweep direction...
+        const result = geom.clone();
+        result.children[isStart ? 0 : geom.children.length - 1] = curve;
+        return result;
+    }
+    extendPath(geom, pickPoint, spacePoint) {
+        var _a;
+        if (geom.children.length < 2)
+            return this.extendCurve(geom.children[0], pickPoint, spacePoint);
+        const pathAsPrimitive = core_geometry_1.CurveChainWithDistanceIndex.createCapture(geom);
+        const closeDetail = pathAsPrimitive.closestPoint(spacePoint, true);
+        if (undefined === (closeDetail === null || closeDetail === void 0 ? void 0 : closeDetail.curve) || undefined === ((_a = closeDetail.childDetail) === null || _a === void 0 ? void 0 : _a.curve))
+            return undefined;
+        if (undefined !== this.modifyingEnd) {
+            if (closeDetail.childDetail.curve === this.modifyingEnd) {
+                this.modifyingEnd = undefined; // Ok to unlock extending first/last curve in path...
+            }
+            else {
+                const pathEndDetail = this.modifyingEnd.closestPoint(spacePoint, true);
+                if (undefined === (pathEndDetail === null || pathEndDetail === void 0 ? void 0 : pathEndDetail.curve))
+                    return undefined;
+                return this.extendPathEnd(geom, pathEndDetail, (pathEndDetail.curve === geom.children[0]));
+            }
+        }
+        // NOTE: Special case extend instead of using CurveChainWithDistanceIndex.clonePartialCurve...
+        if (closeDetail.fraction < 0.0) {
+            this.modifyingEnd = closeDetail.childDetail.curve;
+            return this.extendPathEnd(geom, closeDetail.childDetail, true);
+        }
+        else if (closeDetail.fraction > 1.0) {
+            this.modifyingEnd = closeDetail.childDetail.curve;
+            return this.extendPathEnd(geom, closeDetail.childDetail, false);
+        }
+        const pickDetail = pathAsPrimitive.closestPoint(pickPoint, false);
+        if (undefined === (pickDetail === null || pickDetail === void 0 ? void 0 : pickDetail.curve))
+            return undefined;
+        const result = pathAsPrimitive.clonePartialCurve(pickDetail.fraction > 0.5 ? 0.0 : 1.0, closeDetail.fraction);
+        if (undefined === result)
+            return undefined;
+        return core_geometry_1.Path.create(...result.path.children);
+    }
+    modifyCurve(ev, _isAccept) {
         var _a;
+        if (undefined === ev.viewport || undefined === this.anchorPoint)
+            return undefined;
+        const geom = (_a = this.curveData) === null || _a === void 0 ? void 0 : _a.geom;
+        if (undefined === geom)
+            return undefined;
+        const matrix = core_frontend_1.AccuDrawHintBuilder.getCurrentRotation(ev.viewport, true, true);
+        const localToWorld = core_geometry_1.FrameBuilder.createRightHandedFrame(matrix === null || matrix === void 0 ? void 0 : matrix.getColumn(2), geom);
+        if (undefined === localToWorld)
+            return undefined;
+        const worldToLocal = localToWorld.inverse();
+        if (undefined === worldToLocal)
+            return undefined;
+        const spacePoint = core_frontend_1.AccuDrawHintBuilder.projectPointToPlaneInView(ev.point, localToWorld.getOrigin(), localToWorld.matrix.getColumn(2), ev.viewport);
+        if (undefined === spacePoint)
+            return undefined;
+        if (geom instanceof core_geometry_1.CurvePrimitive)
+            return this.extendCurve(geom, this.anchorPoint, spacePoint);
+        else if (geom instanceof core_geometry_1.Path)
+            return this.extendPath(geom, this.anchorPoint, spacePoint);
+        return undefined;
+    }
+    async onAgendaModified() {
+        core_frontend_1.IModelApp.accuSnap.neverFlash(this.agenda.elements); // Don't flash snapped segment for better preview when trimming curve/path...
+        return super.onAgendaModified();
+    }
+    setupAccuDraw() {
+        var _a, _b, _c;
         const hints = new core_frontend_1.AccuDrawHintBuilder();
         if (this.agenda.isEmpty) {
             hints.enableSmartRotation = true;
         }
         else {
             const geom = (_a = this.curveData) === null || _a === void 0 ? void 0 : _a.geom;
-            if (undefined === geom || "curvePrimitive" !== geom.geometryCategory)
+            if (undefined === geom || undefined === this.anchorPoint)
+                return;
+            let pickDetail;
+            if (geom instanceof core_geometry_1.CurvePrimitive)
+                pickDetail = geom.closestPoint(this.anchorPoint, false);
+            else if (geom instanceof core_geometry_1.Path)
+                pickDetail = core_geometry_1.CurveChainWithDistanceIndex.createCapture(geom).closestPoint(this.anchorPoint, false);
+            if (undefined === (pickDetail === null || pickDetail === void 0 ? void 0 : pickDetail.curve))
                 return;
-            if (geom instanceof core_geometry_1.Arc3d) {
-                const matrix = geom.matrixClone();
+            const curve = (undefined !== ((_b = pickDetail.childDetail) === null || _b === void 0 ? void 0 : _b.curve) ? (_c = pickDetail.childDetail) === null || _c === void 0 ? void 0 : _c.curve : pickDetail.curve);
+            if (curve instanceof core_geometry_1.Arc3d) {
+                const matrix = curve.matrixClone();
                 matrix.normalizeColumnsInPlace();
-                hints.setOrigin(geom.center);
+                hints.setOrigin(curve.center);
                 hints.setMatrix(matrix);
                 hints.setModePolar();
             }
-            else if (geom instanceof core_geometry_1.LineSegment3d) {
-                const pickDetail = (undefined !== this.anchorPoint ? geom.closestPoint(this.anchorPoint, false) : undefined);
-                if (undefined !== (pickDetail === null || pickDetail === void 0 ? void 0 : pickDetail.curve)) {
-                    hints.setOrigin(pickDetail.fraction > 0.5 ? geom.point0Ref : geom.point1Ref);
-                    hints.setXAxis(core_geometry_1.Vector3d.createStartEnd(pickDetail.fraction > 0.5 ? geom.point0Ref : geom.point1Ref, pickDetail.fraction > 0.5 ? geom.point1Ref : geom.point0Ref));
-                }
+            else if (curve instanceof core_geometry_1.LineSegment3d) {
+                hints.setOrigin(pickDetail.fraction > 0.5 ? curve.point0Ref : curve.point1Ref);
+                hints.setXAxis(core_geometry_1.Vector3d.createStartEnd(pickDetail.fraction > 0.5 ? curve.point0Ref : curve.point1Ref, pickDetail.fraction > 0.5 ? curve.point1Ref : curve.point0Ref));
                 hints.setModeRectangular();
             }
-            else if (geom instanceof core_geometry_1.LineString3d) {
-                const pickDetail = (undefined !== this.anchorPoint ? geom.closestPoint(this.anchorPoint, false) : undefined);
-                if (undefined !== (pickDetail === null || pickDetail === void 0 ? void 0 : pickDetail.curve) && geom.numPoints() > 1) {
-                    hints.setOrigin(geom.packedPoints.getPoint3dAtUncheckedPointIndex(pickDetail.fraction > 0.5 ? geom.numPoints() - 2 : 1));
-                    hints.setXAxis(core_geometry_1.Vector3d.createStartEnd(geom.packedPoints.getPoint3dAtUncheckedPointIndex(pickDetail.fraction > 0.5 ? geom.numPoints() - 2 : 1), geom.packedPoints.getPoint3dAtUncheckedPointIndex(pickDetail.fraction > 0.5 ? geom.numPoints() - 1 : 0)));
+            else if (curve instanceof core_geometry_1.LineString3d) {
+                if (curve.numPoints() > 1) {
+                    hints.setOrigin(curve.packedPoints.getPoint3dAtUncheckedPointIndex(pickDetail.fraction > 0.5 ? curve.numPoints() - 2 : 1));
+                    hints.setXAxis(core_geometry_1.Vector3d.createStartEnd(curve.packedPoints.getPoint3dAtUncheckedPointIndex(pickDetail.fraction > 0.5 ? curve.numPoints() - 2 : 1), curve.packedPoints.getPoint3dAtUncheckedPointIndex(pickDetail.fraction > 0.5 ? curve.numPoints() - 1 : 0)));
                 }
                 hints.setModeRectangular();
             }
+            else {
+                const ray = curve.fractionToPointAndUnitTangent(pickDetail.fraction > 0.5 ? 0.0 : 1.0);
+                hints.setOrigin(ray.origin);
+                hints.setXAxis(ray.direction);
+                hints.setModeRectangular();
+            }
         }
         hints.sendHints(false);
     }