@itwin/core-geometry 5.0.0-dev.2 → 5.0.0-dev.22

package/lib/esm/polyface/PolyfaceBuilder.js

@@ -2,11 +2,14 @@
 * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
 * See LICENSE.md in the project root for license terms and full copyright notice.
 *--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Polyface
+ */
+import { Arc3d } from "../curve/Arc3d";
 import { ConstructCurveBetweenCurves } from "../curve/ConstructCurveBetweenCurves";
 import { CurveChain, CurveCollection } from "../curve/CurveCollection";
 import { CurveFactory } from "../curve/CurveFactory";
 import { CurvePrimitive } from "../curve/CurvePrimitive";
-import { GeometryQuery } from "../curve/GeometryQuery";
 import { LineString3d } from "../curve/LineString3d";
 import { ParityRegion } from "../curve/ParityRegion";
 import { CylindricalRangeQuery } from "../curve/Query/CylindricalRange";
@@ -20,7 +23,6 @@ import { NullGeometryHandler } from "../geometry3d/GeometryHandler";
 import { GrowableFloat64Array } from "../geometry3d/GrowableFloat64Array";
 import { GrowableXYArray } from "../geometry3d/GrowableXYArray";
 import { GrowableXYZArray } from "../geometry3d/GrowableXYZArray";
-import { IndexedXYZCollection } from "../geometry3d/IndexedXYZCollection";
 import { Matrix3d } from "../geometry3d/Matrix3d";
 import { Plane3dByOriginAndVectors } from "../geometry3d/Plane3dByOriginAndVectors";
 import { Point2d } from "../geometry3d/Point2dVector2d";
@@ -1077,17 +1079,28 @@ export class PolyfaceBuilder extends NullGeometryHandler {
     }
     /** Construct facets for a rotational sweep. */
     addRotationalSweep(surface) {
-        const contour = surface.getCurves();
-        const section0 = StrokeCountSection.createForParityRegionOrChain(contour, this._options);
+        const contour = surface.getSweepContourRef();
+        const section0 = StrokeCountSection.createForParityRegionOrChain(contour.getCurves(), this._options);
         const baseStrokes = section0.getStrokes();
+        // ensure sweep is positive for buildRotationalNormalsInLineStrings
         const axis = surface.cloneAxisRay();
+        const sweepAngle = surface.getSweep();
+        if (sweepAngle.radians < 0.0) {
+            axis.direction.scaleInPlace(-1);
+            sweepAngle.setRadians(-sweepAngle.radians);
+        }
+        // swingVector points in the direction of positive sweep
         const perpendicularVector = CylindricalRangeQuery.computeMaxVectorFromRay(axis, baseStrokes);
         const swingVector = axis.direction.crossProduct(perpendicularVector);
+        // ensure contour computed normal is aligned with swingVector for buildRotationalNormalsInLineStrings
+        const contourNormalAgreesWithSwingDir = contour.localToWorld.matrix.dotColumnZ(swingVector) > 0;
+        if (!contourNormalAgreesWithSwingDir)
+            baseStrokes.reverseInPlace();
         if (this._options.needNormals)
             CylindricalRangeQuery.buildRotationalNormalsInLineStrings(baseStrokes, axis, swingVector);
         const maxDistance = perpendicularVector.magnitude();
-        const maxPath = Math.abs(maxDistance * surface.getSweep().radians);
-        let numStep = StrokeOptions.applyAngleTol(this._options, 1, surface.getSweep().radians, undefined);
+        const maxPath = Math.abs(maxDistance * sweepAngle.radians);
+        let numStep = StrokeOptions.applyAngleTol(this._options, 1, sweepAngle.radians, undefined);
         numStep = StrokeOptions.applyMaxEdgeLength(this._options, numStep, maxPath);
         for (let i = 1; i <= numStep; i++) {
             const transformA = surface.getFractionalRotationTransform((i - 1) / numStep);
@@ -1095,11 +1108,10 @@ export class PolyfaceBuilder extends NullGeometryHandler {
             this.addBetweenRotatedStrokeSets(baseStrokes, transformA, i - 1, transformB, i);
         }
         if (surface.capped) {
-            const capContour = surface.getSweepContourRef();
-            capContour.purgeFacets();
-            capContour.emitFacets(this, true, undefined);
-            // final loop pass left transformA at end
-            capContour.emitFacets(this, false, surface.getFractionalRotationTransform(1.0));
+            contour.purgeFacets();
+            const reverseNearCap = contourNormalAgreesWithSwingDir;
+            contour.emitFacets(this, reverseNearCap, undefined);
+            contour.emitFacets(this, !reverseNearCap, surface.getFractionalRotationTransform(1.0));
         }
     }
     /** Construct facets for any planar region. */
@@ -1163,9 +1175,9 @@ export class PolyfaceBuilder extends NullGeometryHandler {
             const normalIndices = ls.ensureEmptyNormalIndices();
             const normalIndex0 = this.findOrAddNormalInLineString(ls, 0, transform);
             normalIndices.push(normalIndex0);
-            let normalIndexA = normalIndex0;
-            let normalIndexB;
             if (n > 1) {
+                let normalIndexA = normalIndex0;
+                let normalIndexB;
                 for (let i = 1; i + 1 < n; i++) {
                     normalIndexB = this.findOrAddNormalInLineString(ls, i, transform, normalIndexA);
                     normalIndices.push(normalIndexB);
@@ -1180,9 +1192,9 @@ export class PolyfaceBuilder extends NullGeometryHandler {
             const uvIndices = ls.ensureEmptyUVIndices();
             const uvIndex0 = this.findOrAddParamInLineString(ls, 0, vParam);
             uvIndices.push(uvIndex0);
-            let uvIndexA = uvIndex0;
-            let uvIndexB;
             if (n > 1) {
+                let uvIndexA = uvIndex0;
+                let uvIndexB;
                 for (let i = 1; i + 1 < n; i++) {
                     uvIndexB = this.findOrAddParamInLineString(ls, i, vParam, uvIndexA);
                     uvIndices.push(uvIndexB);
@@ -1817,16 +1829,25 @@ export class PolyfaceBuilder extends NullGeometryHandler {
         const context = GreedyTriangulationBetweenLineStrings.createContext();
         context.emitTriangles(resolveToIndexedXYZCollectionOrCarrier(pointsA), resolveToIndexedXYZCollectionOrCarrier(pointsB), (triangle) => { this.addTriangleFacet(triangle.points); });
     }
-    addMiteredPipesFromPoints(centerline, sectionData, numFacetAround = 12) {
+    /** Doc is same as `addMiteredPipes` doc. */
+    addMiteredPipesFromPoints(centerline, sectionData, numFacetAround = 12, capped = false) {
         const sections = CurveFactory.createMiteredPipeSections(centerline, sectionData);
         const pointA0 = Point3d.create();
         const pointA1 = Point3d.create();
         const pointB0 = Point3d.create();
         const pointB1 = Point3d.create();
+        const wantCaps = capped && (!(sectionData instanceof Arc3d) || sectionData.sweep.isFullCircle);
         if (numFacetAround < 3)
             numFacetAround = 3;
         const df = 1.0 / numFacetAround;
-        for (let i = 1; i < sections.length; i++) {
+        if (wantCaps) { // start cap facets
+            const startLineString = LineString3d.create();
+            for (let i = 0; i < numFacetAround; i++)
+                startLineString.addPoint(sections[0].fractionToPoint(i * df));
+            this.addTrianglesInUncheckedConvexPolygon(startLineString, true);
+            this.endFace();
+        }
+        for (let i = 1; i < sections.length; i++) { // side facets
             const arcA = sections[i - 1];
             const arcB = sections[i];
             arcA.fractionToPoint(0.0, pointA0);
@@ -1835,38 +1856,44 @@ export class PolyfaceBuilder extends NullGeometryHandler {
                 const f = k * df;
                 arcA.fractionToPoint(f, pointA1);
                 arcB.fractionToPoint(f, pointB1);
-                this.addQuadFacet([pointA0, pointB0, pointB1, pointA1]);
+                this.addQuadFacet([pointA0, pointA1, pointB1, pointB0]); // ASSUME: CCW section traversal wrt rail tangent
             }
         }
+        if (wantCaps) { // end cap facets
+            const endLineString = LineString3d.create();
+            for (let i = 0; i < numFacetAround; i++)
+                endLineString.addPoint(sections[sections.length - 1].fractionToPoint(i * df));
+            this.addTrianglesInUncheckedConvexPolygon(endLineString, false);
+            this.endFace();
+        }
     }
     /**
      * Add quad facets along a mitered pipe that follows a centerline curve.
+     * * At the end of each pipe segment, the pipe is mitered by the plane that bisects the angle between successive
+     * centerline segments.
      * * Circular or elliptical pipe cross sections can be specified by supplying either a radius, a pair of semi-axis
-     * lengths, or a full Arc3d:
-     *    * For semi-axis length input, x corresponds to an ellipse local axis nominally situated parallel to the xy-plane.
-     *    * For Arc3d input, the center is translated to the centerline start point to act as initial cross section.
-     * @param centerline centerline of pipe. If curved, it will be stroked using the builder's StrokeOptions.
-     * @param sectionData circle radius, ellipse semi-axis lengths, or full Arc3d.
+     * lengths, or an Arc3d:
+     *    * For semi-axis length input, x and y correspond to ellipse local axes perpendicular to each other and to the
+     * start tangent.
+     *    * For Arc3d input, the center is translated to the centerline start point, but otherwise the arc is used as-is
+     * for the first section. For best results, the arc should be perpendicular to the centerline start tangent.
+     * @param centerline centerline of pipe. If curved, it will be stroked using the builder's StrokeOptions, otherwise
+     * for best results, ensure no successive duplicate points with e.g., [[GrowableXYZArray.createCompressed]].
+     * @param sectionData circle radius, ellipse semi-axis lengths, or Arc3d.
      * @param numFacetAround how many equal parameter-space chords around each section.
+     * @param capped if `true`, add a cap at each end of the pipe; defaults to `false`.
      */
-    addMiteredPipes(centerline, sectionData, numFacetAround = 12) {
-        if (Array.isArray(centerline)) {
-            this.addMiteredPipesFromPoints(new Point3dArrayCarrier(centerline), sectionData, numFacetAround);
-        }
-        else if (centerline instanceof GrowableXYZArray) {
-            this.addMiteredPipesFromPoints(centerline, sectionData, numFacetAround);
-        }
-        else if (centerline instanceof IndexedXYZCollection) {
-            this.addMiteredPipesFromPoints(centerline, sectionData, numFacetAround);
-        }
-        else if (centerline instanceof LineString3d) {
-            this.addMiteredPipesFromPoints(centerline.packedPoints, sectionData, numFacetAround);
-        }
-        else if (centerline instanceof GeometryQuery) {
+    addMiteredPipes(centerline, sectionData, numFacetAround = 12, capped = false) {
+        if (Array.isArray(centerline))
+            centerline = new Point3dArrayCarrier(centerline);
+        else if (centerline instanceof LineString3d)
+            centerline = centerline.packedPoints;
+        else if (centerline instanceof CurvePrimitive) {
             const linestring = LineString3d.create();
             centerline.emitStrokes(linestring, this._options);
-            this.addMiteredPipesFromPoints(linestring.packedPoints, sectionData, numFacetAround);
+            centerline = linestring.packedPoints;
         }
+        this.addMiteredPipesFromPoints(centerline, sectionData, numFacetAround, capped);
     }
     /** Return the polyface index array indices corresponding to the given edge, or `undefined` if error. */
     getEdgeIndices(edge) {