@itwin/editor-frontend 3.0.0-dev.135 → 3.0.0-dev.140

package/lib/esm/SolidModelingTools.js

@@ -5,10 +5,10 @@
 /** @packageDocumentation
  * @module Editing
  */
-import { BooleanMode, ChamferMode, CutDepthMode, CutDirectionMode, EmbossDirectionMode, ProfileClosure, SubEntityType } from "@itwin/editor-common";
+import { BooleanMode, BRepEntityType, ChamferMode, CutDepthMode, CutDirectionMode, EmbossDirectionMode, ProfileClosure, SubEntityType } from "@itwin/editor-common";
 import { ColorDef, ElementGeometry } from "@itwin/core-common";
-import { Angle, Geometry, LineString3d, Point3d, Vector3d } from "@itwin/core-geometry";
-import { AccuDrawHintBuilder, EventHandled, GraphicType } from "@itwin/core-frontend";
+import { Angle, Geometry, LineString3d, Matrix3d, Point3d, Vector3d } from "@itwin/core-geometry";
+import { AccuDraw, AccuDrawHintBuilder, EventHandled, GraphicType, TentativeOrAccuSnap } from "@itwin/core-frontend";
 import { computeChordToleranceFromPoint } from "./CreateElementTool";
 import { ElementGeometryCacheTool, isSameSubEntity, LocateSubEntityTool, SubEntityData } from "./ElementGeometryTool";
 /** @alpha Base class for tools that perform boolean operations on a set of elements. */
@@ -675,6 +675,7 @@ export class ImprintSolidElementsTool extends LocateSubEntityTool {
                 this.points.push(ev.point.clone());
                 if (!ev.isControlKey)
                     break;
+                this.setupAndPromptForNextAction();
                 return EventHandled.No;
             }
             default:
@@ -715,7 +716,7 @@ export class ImprintSolidElementsTool extends LocateSubEntityTool {
 }
 ImprintSolidElementsTool.toolId = "ImprintSolids";
 ImprintSolidElementsTool.iconSpec = "icon-move"; // TODO: Need better icon...
-/** @alpha Identify edges of solids and surfaces to apply blend to. */
+/** @alpha Base class for tools to identify edges of solids and surfaces and apply blends. */
 export class BlendEdgesTool extends LocateSubEntityTool {
     constructor() {
         super(...arguments);
@@ -862,39 +863,81 @@ export class ChamferEdgesTool extends BlendEdgesTool {
 }
 ChamferEdgesTool.toolId = "ChamferEdges";
 ChamferEdgesTool.iconSpec = "icon-move"; // TODO: Need better icon...
-/** @alpha Identify faces of solids and surfaces to translate. */
-export class SweepFacesTool extends LocateSubEntityTool {
-    constructor() {
-        super(...arguments);
-        // TODO: Tool settings for sweep distance...
-        this.useDistance = false;
-        this.distance = 0.1;
-        this.addSmoothFaces = false;
+/** @alpha */
+export class ProfileLocationData {
+    constructor(point, orientation) {
+        this.point = point;
+        this.orientation = orientation;
+    }
+}
+/** @alpha Base class for picking profiles (open paths and regions) or faces of solids. */
+export class LocateFaceOrProfileTool extends LocateSubEntityTool {
+    get wantGeometrySummary() { return true; }
+    wantSubEntityType(type) {
+        switch (type) {
+            case SubEntityType.Face:
+            case SubEntityType.Edge:
+                // Choose all faces or all edges...
+                return (0 === this._acceptedSubEntities.length || this._acceptedSubEntities[0].props.type === type);
+            default:
+                return false;
+        }
     }
-    get wantDynamics() { return true; }
-    get wantAccuSnap() { return this.isDynamicsStarted; }
-    // TODO: Sweep open path to surface, sweep surface to solid...
     get geometryCacheFilter() {
-        return { parts: true, curves: false, surfaces: true, solids: true, other: false };
+        return { parts: true, curves: true, surfaces: true, solids: true, other: false };
+    }
+    async doPickSubEntities(id, ev) {
+        const hits = await super.doPickSubEntities(id, ev);
+        if (undefined === hits)
+            return hits;
+        // Only want edges from wire bodies...
+        const accept = (BRepEntityType.Wire === this.getBRepEntityTypeForSubEntity(id, hits[0].subEntity) ? SubEntityType.Edge : SubEntityType.Face);
+        return hits.filter((hit) => { return accept === hit.subEntity.type; });
     }
     async createSubEntityData(id, hit) {
         const data = await super.createSubEntityData(id, hit);
-        if (undefined !== hit.point && undefined !== hit.normal)
-            data.toolData = FaceLocationData.create(hit.point, hit.normal);
+        // Prefer orientation from snap to take entire path curve as well as placement z into account...
+        const snap = TentativeOrAccuSnap.getCurrentSnap(false);
+        const point = (id === (snap === null || snap === void 0 ? void 0 : snap.sourceId) && snap.isHot ? snap.snapPoint : Point3d.fromJSON(hit.point));
+        const matrix = (id === (snap === null || snap === void 0 ? void 0 : snap.sourceId) ? AccuDraw.getSnapRotation(snap, undefined) : undefined);
+        const invMatrix = matrix === null || matrix === void 0 ? void 0 : matrix.inverse(); // getSnapRotation returns row matrix...
+        if (undefined !== invMatrix)
+            data.toolData = new ProfileLocationData(point, invMatrix);
+        else
+            data.toolData = new ProfileLocationData(point, undefined !== hit.normal ? Vector3d.fromJSON(hit.normal) : Vector3d.unitZ());
         return data;
     }
+    drawSubEntity(context, subEntity, accepted) {
+        const id = this.getCurrentElement();
+        if (undefined !== id && BRepEntityType.Solid !== this.getBRepEntityTypeForSubEntity(id, subEntity.props))
+            return; // Operation will be applied to wire or sheet body, don't display sub-entity...
+        super.drawSubEntity(context, subEntity, accepted);
+    }
     drawAcceptedSubEntities(context) {
         var _a;
         super.drawAcceptedSubEntities(context);
-        // Show pick point on last identified face, offset direction/distance will be computed from this location...
-        const faceData = (_a = this.getAcceptedSubEntityData()) === null || _a === void 0 ? void 0 : _a.toolData;
-        if (undefined === faceData)
+        // Show pick point on last identified face...
+        const profileData = (_a = this.getAcceptedSubEntityData()) === null || _a === void 0 ? void 0 : _a.toolData;
+        if (undefined === profileData)
             return;
         const builder = context.createGraphic({ type: GraphicType.WorldOverlay });
         builder.setSymbology(context.viewport.getContrastToBackgroundColor(), ColorDef.black, 10);
-        builder.addPointString([faceData.point]);
+        builder.addPointString([profileData.point]);
         context.addDecorationFromBuilder(builder);
     }
+}
+/** @alpha Identify faces of solids and surfaces to translate. */
+export class SweepFacesTool extends LocateFaceOrProfileTool {
+    constructor() {
+        super(...arguments);
+        // TODO: Tool settings for sweep distance...
+        this.useDistance = false;
+        this.distance = 0.1;
+        this.addSmoothFaces = false;
+    }
+    get wantDynamics() { return true; }
+    get wantAccuSnap() { return true; }
+    get wantSubEntitySnap() { return true; }
     async getSmoothFaces(id, face) {
         try {
             // NOTE: For sweep/translation, it makes sense to limit smooth to immediately adjacent...
@@ -908,10 +951,10 @@ export class SweepFacesTool extends LocateSubEntityTool {
         var _a;
         if (undefined === ev.viewport || this.agenda.isEmpty || !this.haveAcceptedSubEntities)
             return undefined;
-        const faceData = (_a = this.getAcceptedSubEntityData()) === null || _a === void 0 ? void 0 : _a.toolData;
-        if (undefined === faceData)
+        const profileData = (_a = this.getAcceptedSubEntityData()) === null || _a === void 0 ? void 0 : _a.toolData;
+        if (undefined === profileData)
             return undefined;
-        const path = Vector3d.createStartEnd(faceData.point, ev.point);
+        const path = Vector3d.createStartEnd(profileData.point, ev.point);
         if (this.useDistance && undefined === path.scaleToLength(this.distance, path))
             return undefined;
         if (path.magnitude() < Geometry.smallMetricDistance)
@@ -925,20 +968,24 @@ export class SweepFacesTool extends LocateSubEntityTool {
                 requestId: `${this.toolId}:${id}`,
                 writeChanges: isAccept ? true : undefined,
             };
-            const faces = this.getAcceptedSubEntities();
+            const subEntities = this.getAcceptedSubEntities();
+            const params = { path };
+            if (SubEntityType.Edge === subEntities[0].type || BRepEntityType.Solid !== this.getBRepEntityTypeForSubEntity(id, subEntities[0])) {
+                return await ElementGeometryCacheTool.callCommand("sweepFaces", id, params, opts);
+            }
             if (this.addSmoothFaces) {
                 const allSmoothFaces = [];
-                for (const face of faces) {
+                for (const face of subEntities) {
                     const smoothFaces = await this.getSmoothFaces(id, face);
                     if (undefined !== smoothFaces)
                         allSmoothFaces.push(...smoothFaces);
                 }
                 for (const smooth of allSmoothFaces) {
-                    if (undefined === faces.find((selected) => isSameSubEntity(selected, smooth)))
-                        faces.unshift(smooth); // Preserve last selected entry as reference face...
+                    if (undefined === subEntities.find((selected) => isSameSubEntity(selected, smooth)))
+                        subEntities.unshift(smooth); // Preserve last selected entry as reference face...
                 }
             }
-            const params = { faces, path };
+            params.faces = subEntities;
             return await ElementGeometryCacheTool.callCommand("sweepFaces", id, params, opts);
         }
         catch (err) {
@@ -949,16 +996,16 @@ export class SweepFacesTool extends LocateSubEntityTool {
         var _a;
         if (!this.haveAcceptedSubEntities)
             return;
-        const faceData = (_a = this.getAcceptedSubEntityData()) === null || _a === void 0 ? void 0 : _a.toolData;
-        if (undefined === faceData)
+        const profileData = (_a = this.getAcceptedSubEntityData()) === null || _a === void 0 ? void 0 : _a.toolData;
+        if (undefined === profileData)
             return;
         const hints = new AccuDrawHintBuilder();
         hints.setOriginFixed = true;
         hints.setLockY = true;
         hints.setLockZ = true;
         hints.setModeRectangular();
-        hints.setOrigin(faceData.point);
-        hints.setXAxis2(faceData.normal);
+        hints.setOrigin(profileData.point);
+        hints.setXAxis2(profileData.orientation instanceof Matrix3d ? profileData.orientation.getColumn(2) : profileData.orientation);
         hints.sendHints(false);
     }
     async onRestartTool() {
@@ -970,28 +1017,16 @@ export class SweepFacesTool extends LocateSubEntityTool {
 SweepFacesTool.toolId = "SweepFaces";
 SweepFacesTool.iconSpec = "icon-move"; // TODO: Need better icon...
 /** @alpha Identify faces of solids and surfaces to revolve. */
-export class SpinFacesTool extends LocateSubEntityTool {
+export class SpinFacesTool extends LocateFaceOrProfileTool {
     constructor() {
         super(...arguments);
-        this.points = [];
         // TODO: Tool settings for sweep angle...
         this.sweep = Angle.piOver2Radians;
+        this.points = [];
     }
     get wantDynamics() { return true; }
-    get wantAccuSnap() { return this.isDynamicsStarted || (this.haveAcceptedSubEntities && !this.isControlDown); }
-    // TODO: Spin open path to surface, spin surface to solid...
-    get geometryCacheFilter() {
-        return { parts: true, curves: false, surfaces: true, solids: true, other: false };
-    }
-    getSubEntityFilter() {
-        return { nonPlanarFaces: true };
-    }
-    async createSubEntityData(id, hit) {
-        const data = await super.createSubEntityData(id, hit);
-        if (undefined !== hit.point && undefined !== hit.normal)
-            data.toolData = FaceLocationData.create(hit.point, hit.normal);
-        return data;
-    }
+    get wantAccuSnap() { return true; }
+    get wantSubEntitySnap() { return true; }
     async applyAgendaOperation(ev, isAccept) {
         if (undefined === ev.viewport || this.agenda.isEmpty || !this.haveAcceptedSubEntities || this.points.length < (isAccept ? 2 : 1))
             return undefined;
@@ -1009,8 +1044,12 @@ export class SpinFacesTool extends LocateSubEntityTool {
                 requestId: `${this.toolId}:${id}`,
                 writeChanges: isAccept ? true : undefined,
             };
-            const faces = this.getAcceptedSubEntities();
-            const params = { faces, origin, direction, angle };
+            const subEntities = this.getAcceptedSubEntities();
+            const params = { origin, direction, angle };
+            if (SubEntityType.Edge === subEntities[0].type || BRepEntityType.Solid !== this.getBRepEntityTypeForSubEntity(id, subEntities[0])) {
+                return await ElementGeometryCacheTool.callCommand("spinFaces", id, params, opts);
+            }
+            params.faces = subEntities;
             let result = await ElementGeometryCacheTool.callCommand("spinFaces", id, params, opts);
             // Spun face can be used to create a pocket...retry with negative sweep...
             if (undefined === result) {
@@ -1035,7 +1074,7 @@ export class SpinFacesTool extends LocateSubEntityTool {
         super.onDynamicFrame(ev, context);
     }
     async gatherInput(ev) {
-        if (this.haveAcceptedSubEntities)
+        if (!this.wantAdditionalSubEntities)
             this.points.push(ev.point.clone());
         return super.gatherInput(ev);
     }
@@ -1046,13 +1085,16 @@ export class SpinFacesTool extends LocateSubEntityTool {
         var _a;
         if (!this.haveAcceptedSubEntities || 0 !== this.points.length)
             return;
-        const faceData = (_a = this.getAcceptedSubEntityData()) === null || _a === void 0 ? void 0 : _a.toolData;
-        if (undefined === faceData)
+        const profileData = (_a = this.getAcceptedSubEntityData()) === null || _a === void 0 ? void 0 : _a.toolData;
+        if (undefined === profileData)
             return;
         const hints = new AccuDrawHintBuilder();
         hints.setModeRectangular();
-        hints.setOrigin(faceData.point);
-        hints.setNormal(faceData.normal);
+        hints.setOrigin(profileData.point);
+        if (profileData.orientation instanceof Matrix3d)
+            hints.setMatrix(profileData.orientation);
+        else
+            hints.setNormal(profileData.orientation);
         hints.sendHints(false);
     }
     async onRestartTool() {