@itwin/core-geometry 5.0.0-dev.14 → 5.0.0-dev.16

package/lib/esm/curve/CurveFactory.d.ts

@@ -23,13 +23,14 @@ import { Path } from "./Path";
 import { IntegratedSpiralTypeName } from "./spiral/TransitionSpiral3d";
 import { StrokeOptions } from "./StrokeOptions";
 /**
- * Interface to carry parallel arrays of planes and sections, and optional geometry assembled from them, as returned by [CurveFactory.createMiteredSweepSections].
+ * Interface to carry parallel arrays of planes and sections, and optional geometry assembled from them,
+ * as returned by [CurveFactory.createMiteredSweepSections].
  * @public
  */
 export interface SectionSequenceWithPlanes {
-    /** the plane of each section */
+    /** The plane of each section. */
     planes: Plane3dByOriginAndUnitNormal[];
-    /** section curve projected onto the corresponding plane */
+    /** Section curve projected onto the corresponding plane. */
     sections: AnyCurve[];
     /**
      * Optional `RuledSweep` generated from the sections.
@@ -64,13 +65,25 @@ export interface MiteredSweepOptions {
     strokeOptions?: StrokeOptions;
     /** Whether to cap the ruled sweep if outputting a ruled sweep or mesh. Default value is `false`. */
     capped?: boolean;
+    /**
+     * If the centerline is not physically closed, the first section's normal is aligned to this vector (typically points
+     * toward the swept geometry). If the centerline is physically closed, the first section's normal is aligned to this
+     * vector if and only if endTangent is provided and is equal to startTangent.
+     */
+    startTangent?: Vector3d;
+    /**
+     * If the centerline is not physically closed, the last section's normal is aligned to this vector (typically points
+     * away from the swept geometry). If the centerline is physically closed, the last section's normal is aligned to this
+     * vector if and only if startTangent is provided and is equal to endTangent.
+     */
+    endTangent?: Vector3d;
 }
 /**
  * The `CurveFactory` class contains methods for specialized curve constructions.
  * @public
  */
 export declare class CurveFactory {
-    /** (cautiously) construct and save a line segment between fractional positions. */
+    /** (Cautiously) construct and save a line segment between fractional positions. */
     private static addPartialSegment;
     /**
      * Create a circular arc defined by start point, tangent at start point, and end point.
@@ -89,23 +102,25 @@ export declare class CurveFactory {
      * @param allowBackupAlongEdge true to allow edges to be created going "backwards" along edges if needed to create the blend.
      */
     static createFilletsInLineString(points: LineString3d | IndexedXYZCollection | Point3d[], radius: number | number[], allowBackupAlongEdge?: boolean): Path | undefined;
-    /** Create a `Loop` with given xy corners and fixed z.
+    /**
+     * Create a `Loop` with given xy corners and fixed z.
      * * The corners always proceed counter clockwise from lower left.
      * * If the radius is too large for the outer rectangle size, it is reduced to half of the the smaller x or y size.
-    */
+     */
     static createRectangleXY(x0: number, y0: number, x1: number, y1: number, z?: number, filletRadius?: number): Loop;
     /**
      * If `arcB` is a continuation of `arcA`, extend `arcA` (in place) to include the range of `arcB`
      * * This only succeeds if the two arcs are part of identical complete arcs and end of `arcA` matches the beginning of `arcB`.
-     * @param arcA first arc, modified in place
-     * @param arcB second arc, unmodified
-     * @param allowReversed whether to consolidate even when second arc is reversed
-     * @returns whether `arcA` was modified
+     * @param arcA first arc, modified in place.
+     * @param arcB second arc, unmodified.
+     * @param allowReversed whether to consolidate even when second arc is reversed.
+     * @returns whether `arcA` was modified.
      */
     static appendToArcInPlace(arcA: Arc3d, arcB: Arc3d, allowReverse?: boolean): boolean;
     /**
      * Return a `Path` containing arcs are on the surface of an ellipsoid and pass through a sequence of points.
-     * * Each arc passes through the two given endpoints and in the plane containing the true surface normal at given `fractionForIntermediateNormal`
+     * * Each arc passes through the two given endpoints and in the plane containing the true surface normal at
+     * given `fractionForIntermediateNormal`
      * @param ellipsoid
      * @param pathPoints
      * @param fractionForIntermediateNormal fractional position for surface normal used to create the section plane.
@@ -114,36 +129,47 @@ export declare class CurveFactory {
     private static appendGeometryQueryArray;
     /**
      * Create solid primitives for pipe segments (e.g. Cone or TorusPipe) around line and arc primitives.
-     * @param centerline centerline geometry/
+     * @param centerline centerline geometry.
      * @param pipeRadius radius of pipe.
      */
     static createPipeSegments(centerline: CurvePrimitive | CurveChain, pipeRadius: number): GeometryQuery | GeometryQuery[] | undefined;
     /**
-     * * Create section arcs for mitered pipe.
-     * * At each end of each pipe, the pipe is cut by the plane that bisects the angle between successive pipe centerlines.
-     * * The arc definitions are constructed so that lines between corresponding fractional positions on the arcs are
-     *     axial lines on the pipes.
-     * * This means that each arc definition axes (aka vector0 and vector90) are _not_ perpendicular to each other.
-     * * 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.
-     *    * The center of Arc3d input is translated to the centerline start point to act as initial cross section.
-     * @param centerline centerline of pipe
-     * @param sectionData circle radius, ellipse semi-axis lengths, or full Arc3d
+     * Create section arcs for mitered pipe.
+     * * At the end of each pipe segment, the pipe is mitered by the plane that bisects the angle between successive
+     * centerline segments.
+     * * The section arcs are constructed so that lines between corresponding fractional positions on the arcs are
+     *   axial lines on the pipes.
+     * * This means that the initial arc's vector0 and vector90 lengths and angular separation are _not_ preserved in
+     * the section arcs.
+     * * Circular or elliptical pipe cross sections can be specified by supplying either a radius, a pair of semi-axis
+     * 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. For best results, ensure no successive duplicate points with e.g.,
+     * [[GrowableXYZArray.createCompressed]].
+     * @param sectionData circle radius, ellipse semi-axis lengths, or full Arc3d (if not full, function makes it full).
      */
     static createMiteredPipeSections(centerline: IndexedXYZCollection, sectionData: number | XAndY | Arc3d): Arc3d[];
     /**
      * Sweep the initialSection along each segment of the centerLine until it hits the bisector plane at the next vertex.
      * * The caller should place the initialSection on a plane perpendicular to the first edge.
      *   * This plane is commonly (but not necessarily) through the start point itself.
-     *   * If the geometry is not "on a perpendicular plane", the output geometry will still be flattened onto the various planes.
-     * * In the "open path" case (i.e when wrapIfPhysicallyClosed is false or the path does not have matched first and last points)
-     *       the first/last output plane will be at the start/end of the first/last edge and on a perpendicular plane.
-     * * In the "closed path" case, the output plane for the first and last point is the bisector of the start and end planes from the "open path" case,
-     *    and the first/last section geometry may be different from `initialSection`.
-     * * The centerline path does NOT have to be planar, however twisting effects effects will appear in the various bisector planes.
-     * @param centerline sweep path, e.g., as stroked from a smooth centerline curve
-     * @param initialSection profile curve to be swept. As noted above, this should be on a plane perpendicular to the first segment of the centerline.
-     * @param options options for computation and output
+     *   * If the initialSection is not "on a perpendicular plane", the output geometry will still be flattened onto the
+     *     various planes.
+     * * In the "open path" case (i.e when `wrapIfPhysicallyClosed` is false or the path does not have matched first and
+     *   last points), the first/last output plane will be at the start/end of the first/last edge and on a perpendicular
+     *   plane.
+     * * In the "closed path" case, if start/edn tangents are not provided in the `options`, then the output plane for the
+     *   first and last point is the bisector of the start and end planes from the "open path" case, and the first/last
+     *   section geometry may be different from `initialSection`.
+     * * The centerline path does NOT have to be planar, however twisting effects effects will appear in the various bisector
+     *   planes.
+     * @param centerline sweep path, e.g., as stroked from a smooth centerline curve.
+     * @param initialSection profile curve to be swept. As noted above, this should be on a plane perpendicular to the
+     * first segment of the centerline.
+     * @param options options for computation and output.
      * @return array of sections, starting with `initialSection` projected along the first edge to the first plane.
      */
     static createMiteredSweepSections(centerline: IndexedXYZCollection | Point3d[], initialSection: AnyCurve, options: MiteredSweepOptions): SectionSequenceWithPlanes | undefined;
@@ -160,11 +186,11 @@ export declare class CurveFactory {
     /**
      * Compute 2 spirals (all in XY) for a symmetric line-to-line transition.
      * * First spiral begins at given start point.
-     * * first tangent aims at shoulder
+     * * first tangent aims at shoulder.
      * * outbound spiral joins line from shoulder to target.
-     * @param spiralType name of spiral type.  THIS MUST BE AN "Integrated" SPIRAL TYPE
+     * @param spiralType name of spiral type. THIS MUST BE AN "Integrated" SPIRAL TYPE.
      * @param startPoint inbound start point.
-     * @param shoulder point target point for (both) spiral-to-line tangencies
+     * @param shoulder point target point for (both) spiral-to-line tangencies.
      * @return array with the computed spirals, or undefined if failure.
      */
     static createLineSpiralSpiralLine(spiralType: IntegratedSpiralTypeName, startPoint: Point3d, shoulderPoint: Point3d, targetPoint: Point3d): GeometryQuery[] | undefined;
@@ -172,30 +198,25 @@ export declare class CurveFactory {
      * Compute 2 spirals (all in XY) for a symmetric line-to-line transition.
      * * Spiral length is given.
      * * tangency points float on both lines.
-     * @param spiralType name of spiral type.  THIS MUST BE AN "Integrated" SPIRAL TYPE
+     * @param spiralType name of spiral type.  THIS MUST BE AN "Integrated" SPIRAL TYPE.
      * @param pointA inbound start point.
-     * @param shoulder point target point for (both) spiral-to-line tangencies
+     * @param shoulder point target point for (both) spiral-to-line tangencies.
      * @param spiralLength for each part of the spiral pair.
      * @return array with the computed spirals, or undefined if failure.
      */
     static createLineSpiralSpiralLineWithSpiralLength(spiralType: IntegratedSpiralTypeName, pointA: Point3d, pointB: Point3d, pointC: Point3d, spiralLength: number): GeometryQuery[] | undefined;
     /**
      * Compute 2 spirals and an arc (all in XY) for a symmetric line-to-line transition.
-     * Spiral lengths and arc radius are given.   (e.g. from design speed standards.)
-     * @param spiralType name of spiral type.  THIS MUST BE AN "Integrated" SPIRAL TYPE
+     * Spiral lengths and arc radius are given (e.g., from design speed standards).
+     * @param spiralType name of spiral type. THIS MUST BE AN "Integrated" SPIRAL TYPE.
      * @param pointA inbound start point.
-     * @param pointB shoulder (target)  point for (both) spiral-to-line tangencies
-     * @param lengthA inbound spiral length
-     * @param lengthB outbound spiral length
+     * @param pointB shoulder (target)  point for (both) spiral-to-line tangencies.
+     * @param lengthA inbound spiral length.
+     * @param lengthB outbound spiral length.
      * @return array with the computed spirals, or undefined if failure.
      */
     static createLineSpiralArcSpiralLine(spiralType: IntegratedSpiralTypeName, pointA: Point3d, pointB: Point3d, pointC: Point3d, lengthA: number, lengthB: number, arcRadius: number): GeometryQuery[] | undefined;
-    /**
-     * Return the intersection point of 3 planes.
-     * @param planeA
-     * @param planeB
-     * @param planeC
-     */
+    /** Return the intersection point of 3 planes. */
     static planePlaneIntersectionRay(planeA: PlaneAltitudeEvaluator, planeB: PlaneAltitudeEvaluator): Ray3d | undefined;
 }
 //# sourceMappingURL=CurveFactory.d.ts.map

package/lib/esm/curve/CurveFactory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CurveFactory.d.ts","sourceRoot":"","sources":["../../../src/curve/CurveFactory.ts"],"names":[],"mappings":"AAKA;;GAEG;AAIH,OAAO,EAAkC,sBAAsB,EAAE,MAAM,aAAa,CAAC;AACrF,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AACvE,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAE1E,OAAO,EAAE,4BAA4B,EAAE,MAAM,4CAA4C,CAAC;AAG1F,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AAElE,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAG5C,OAAO,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAC;AAE/C,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAGvD,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD,OAAO,EAAE,KAAK,EAAgB,MAAM,SAAS,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACxC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B,OAAO,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAC;AACvE,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAIhD;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,gCAAgC;IAChC,MAAM,EAAE,4BAA4B,EAAE,CAAC;IACvC,2DAA2D;IAC3D,QAAQ,EAAE,QAAQ,EAAE,CAAC;IACrB;;;OAGG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,iFAAiF;IACjF,IAAI,CAAC,EAAE,eAAe,CAAC;CACxB;AAED;;;GAGG;AACH,oBAAY,wBAAwB;IAClC,8DAA8D;IAC9D,QAAQ,IAAI;IACZ,wEAAwE;IACxE,cAAc,IAAI;IAClB,6FAA6F;IAC7F,QAAQ,IAAI;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,iIAAiI;IACjI,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,uJAAuJ;IACvJ,YAAY,CAAC,EAAE,wBAAwB,CAAC;IACxC,yGAAyG;IACzG,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,oGAAoG;IACpG,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;;GAGG;AACH,qBAAa,YAAY;IACvB,mFAAmF;IACnF,OAAO,CAAC,MAAM,CAAC,iBAAiB;IAMhC;;;;OAIG;WACW,0BAA0B,CAAC,KAAK,EAAE,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,GAAG,EAAE,OAAO,GAAG,KAAK,GAAG,SAAS;IAOnH;;;;;;;;;OASG;WACW,yBAAyB,CAAC,MAAM,EAAE,YAAY,GAAG,oBAAoB,GAAG,OAAO,EAAE,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,oBAAoB,GAAE,OAAc,GAAG,IAAI,GAAG,SAAS;IAuEnL;;;MAGE;WACY,iBAAiB,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,GAAE,MAAU,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI;IAkC3H;;;;;;;OAOG;WACW,kBAAkB,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,YAAY,GAAE,OAAe,GAAG,OAAO;IA2BlG;;;;;;OAMG;WACW,2BAA2B,CAAC,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,iBAAiB,EAAE,EAAE,6BAA6B,GAAE,MAAY,GAAG,IAAI;IAYnJ,OAAO,CAAC,MAAM,CAAC,wBAAwB;IAUvC;;;;OAIG;WACW,kBAAkB,CAAC,UAAU,EAAE,cAAc,GAAG,UAAU,EAAE,UAAU,EAAE,MAAM,GAAG,aAAa,GAAG,aAAa,EAAE,GAAG,SAAS;IAoB1I;;;;;;;;;;;OAWG;WACW,yBAAyB,CAAC,UAAU,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,EAAE;IAqDvH;;;;;;;;;;;;;;OAcG;WACW,0BAA0B,CAAC,UAAU,EAAE,oBAAoB,GAAG,OAAO,EAAE,EAAE,cAAc,EAAE,QAAQ,EAAE,OAAO,EAAE,mBAAmB,GAAG,yBAAyB,GAAG,SAAS;IA2CrL;;;;;;;;OAQG;WACW,2BAA2B,CACvC,KAAK,EAAE,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,EAAE,KAAK,GAAG,UAAU,GACxG,KAAK,GAAG,SAAS;IAIpB;;;;;;;;;OASG;WACW,0BAA0B,CACtC,UAAU,EAAE,wBAAwB,EACpC,UAAU,EAAE,OAAO,EACnB,aAAa,EAAE,OAAO,EACtB,WAAW,EAAE,OAAO,GACnB,aAAa,EAAE,GAAG,SAAS;IAmC9B;;;;;;;;;OASG;WACW,0CAA0C,CACtD,UAAU,EAAE,wBAAwB,EACpC,MAAM,EAAE,OAAO,EACf,MAAM,EAAE,OAAO,EACf,MAAM,EAAE,OAAO,EACf,YAAY,EAAE,MAAM,GACnB,aAAa,EAAE,GAAG,SAAS;IAoC9B;;;;;;;;;OASG;WACW,6BAA6B,CACzC,UAAU,EAAE,wBAAwB,EACpC,MAAM,EAAE,OAAO,EACf,MAAM,EAAE,OAAO,EACf,MAAM,EAAE,OAAO,EACf,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,MAAM,GAChB,aAAa,EAAE,GAAG,SAAS;IAoD9B;;;;;OAKG;WACW,yBAAyB,CACrC,MAAM,EAAE,sBAAsB,EAAE,MAAM,EAAE,sBAAsB,GAAG,KAAK,GAAG,SAAS;CAuBrF"}
+{"version":3,"file":"CurveFactory.d.ts","sourceRoot":"","sources":["../../../src/curve/CurveFactory.ts"],"names":[],"mappings":"AAKA;;GAEG;AAIH,OAAO,EAAkC,sBAAsB,EAAE,MAAM,aAAa,CAAC;AACrF,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AACvE,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAE1E,OAAO,EAAE,4BAA4B,EAAE,MAAM,4CAA4C,CAAC;AAG1F,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AAElE,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAG5C,OAAO,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAC;AAE/C,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAGvD,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD,OAAO,EAAE,KAAK,EAAgB,MAAM,SAAS,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACxC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B,OAAO,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAC;AACvE,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAIhD;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC,iCAAiC;IACjC,MAAM,EAAE,4BAA4B,EAAE,CAAC;IACvC,4DAA4D;IAC5D,QAAQ,EAAE,QAAQ,EAAE,CAAC;IACrB;;;OAGG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,iFAAiF;IACjF,IAAI,CAAC,EAAE,eAAe,CAAC;CACxB;AAED;;;GAGG;AACH,oBAAY,wBAAwB;IAClC,8DAA8D;IAC9D,QAAQ,IAAI;IACZ,wEAAwE;IACxE,cAAc,IAAI;IAClB,6FAA6F;IAC7F,QAAQ,IAAI;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,iIAAiI;IACjI,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,uJAAuJ;IACvJ,YAAY,CAAC,EAAE,wBAAwB,CAAC;IACxC,yGAAyG;IACzG,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,oGAAoG;IACpG,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;;OAIG;IACH,YAAY,CAAC,EAAE,QAAQ,CAAC;IACxB;;;;OAIG;IACH,UAAU,CAAC,EAAE,QAAQ,CAAC;CACvB;AAED;;;GAGG;AACH,qBAAa,YAAY;IACvB,mFAAmF;IACnF,OAAO,CAAC,MAAM,CAAC,iBAAiB;IAUhC;;;;OAIG;WACW,0BAA0B,CAAC,KAAK,EAAE,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,GAAG,EAAE,OAAO,GAAG,KAAK,GAAG,SAAS;IAOnH;;;;;;;;;OASG;WACW,yBAAyB,CACrC,MAAM,EAAE,YAAY,GAAG,oBAAoB,GAAG,OAAO,EAAE,EACvD,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,EACzB,oBAAoB,GAAE,OAAc,GACnC,IAAI,GAAG,SAAS;IAuEnB;;;;OAIG;WACW,iBAAiB,CAC7B,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,GAAE,MAAU,EAAE,YAAY,CAAC,EAAE,MAAM,GACnF,IAAI;IA4CP;;;;;;;OAOG;WACW,kBAAkB,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,YAAY,GAAE,OAAe,GAAG,OAAO;IA6BlG;;;;;;;OAOG;WACW,2BAA2B,CACvC,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,iBAAiB,EAAE,EAAE,6BAA6B,GAAE,MAAY,GACjG,IAAI;IAWP,OAAO,CAAC,MAAM,CAAC,wBAAwB;IAQvC;;;;OAIG;WACW,kBAAkB,CAC9B,UAAU,EAAE,cAAc,GAAG,UAAU,EAAE,UAAU,EAAE,MAAM,GAC1D,aAAa,GAAG,aAAa,EAAE,GAAG,SAAS;IAmB9C;;;;;;;;;;;;;;;;;OAiBG;WACW,yBAAyB,CAAC,UAAU,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,EAAE;IAkDvH;;;;;;;;;;;;;;;;;;;OAmBG;WACW,0BAA0B,CACtC,UAAU,EAAE,oBAAoB,GAAG,OAAO,EAAE,EAAE,cAAc,EAAE,QAAQ,EAAE,OAAO,EAAE,mBAAmB,GACnG,yBAAyB,GAAG,SAAS;IAyDxC;;;;;;;;OAQG;WACW,2BAA2B,CACvC,KAAK,EAAE,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,EAAE,KAAK,GAAG,UAAU,GACxG,KAAK,GAAG,SAAS;IAGpB;;;;;;;;;OASG;WACW,0BAA0B,CACtC,UAAU,EAAE,wBAAwB,EACpC,UAAU,EAAE,OAAO,EACnB,aAAa,EAAE,OAAO,EACtB,WAAW,EAAE,OAAO,GACnB,aAAa,EAAE,GAAG,SAAS;IAkC9B;;;;;;;;;OASG;WACW,0CAA0C,CACtD,UAAU,EAAE,wBAAwB,EACpC,MAAM,EAAE,OAAO,EACf,MAAM,EAAE,OAAO,EACf,MAAM,EAAE,OAAO,EACf,YAAY,EAAE,MAAM,GACnB,aAAa,EAAE,GAAG,SAAS;IA4C9B;;;;;;;;;OASG;WACW,6BAA6B,CACzC,UAAU,EAAE,wBAAwB,EACpC,MAAM,EAAE,OAAO,EACf,MAAM,EAAE,OAAO,EACf,MAAM,EAAE,OAAO,EACf,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,MAAM,GAChB,aAAa,EAAE,GAAG,SAAS;IAkD9B,iDAAiD;WACnC,yBAAyB,CACrC,MAAM,EAAE,sBAAsB,EAAE,MAAM,EAAE,sBAAsB,GAAG,KAAK,GAAG,SAAS;CAsBrF"}

package/lib/esm/curve/CurveFactory.js

@@ -49,7 +49,7 @@ export var MiteredSweepOutputSelect;
  * @public
  */
 export class CurveFactory {
-    /** (cautiously) construct and save a line segment between fractional positions. */
+    /** (Cautiously) construct and save a line segment between fractional positions. */
     static addPartialSegment(path, allowBackup, pointA, pointB, fraction0, fraction1) {
         if (allowBackup || (fraction1 > fraction0)) {
             if (pointA !== undefined && pointB !== undefined && !Geometry.isAlmostEqualNumber(fraction0, fraction1))
@@ -146,10 +146,11 @@ export class CurveFactory {
         }
         return path;
     }
-    /** Create a `Loop` with given xy corners and fixed z.
+    /**
+     * Create a `Loop` with given xy corners and fixed z.
      * * The corners always proceed counter clockwise from lower left.
      * * If the radius is too large for the outer rectangle size, it is reduced to half of the the smaller x or y size.
-    */
+     */
     static createRectangleXY(x0, y0, x1, y1, z = 0, filletRadius) {
         let radius = Geometry.correctSmallMetricDistance(filletRadius);
         const xMin = Math.min(x0, x1);
@@ -158,7 +159,13 @@ export class CurveFactory {
         const yMax = Math.max(y0, y1);
         radius = Math.min(Math.abs(radius), 0.5 * (xMax - xMin), 0.5 * (yMax - yMin));
         if (radius === 0.0)
-            return Loop.createPolygon([Point3d.create(xMin, yMin, z), Point3d.create(xMax, yMin, z), Point3d.create(xMax, yMax, z), Point3d.create(xMin, yMax, z), Point3d.create(xMin, yMin, z)]);
+            return Loop.createPolygon([
+                Point3d.create(xMin, yMin, z),
+                Point3d.create(xMax, yMin, z),
+                Point3d.create(xMax, yMax, z),
+                Point3d.create(xMin, yMax, z),
+                Point3d.create(xMin, yMin, z),
+            ]);
         else {
             const vectorU = Vector3d.create(radius, 0, 0);
             const vectorV = Vector3d.create(0, radius, 0);
@@ -166,7 +173,12 @@ export class CurveFactory {
             const y0A = yMin + radius;
             const x1A = xMax - radius;
             const y1A = yMax - radius;
-            const centers = [Point3d.create(x1A, y1A, z), Point3d.create(x0A, y1A, z), Point3d.create(x0A, y0A, z), Point3d.create(x1A, y0A, z)];
+            const centers = [
+                Point3d.create(x1A, y1A, z),
+                Point3d.create(x0A, y1A, z),
+                Point3d.create(x0A, y0A, z),
+                Point3d.create(x1A, y0A, z),
+            ];
             const loop = Loop.create();
             for (let i = 0; i < 4; i++) {
                 const center = centers[i];
@@ -186,10 +198,10 @@ export class CurveFactory {
     /**
      * If `arcB` is a continuation of `arcA`, extend `arcA` (in place) to include the range of `arcB`
      * * This only succeeds if the two arcs are part of identical complete arcs and end of `arcA` matches the beginning of `arcB`.
-     * @param arcA first arc, modified in place
-     * @param arcB second arc, unmodified
-     * @param allowReversed whether to consolidate even when second arc is reversed
-     * @returns whether `arcA` was modified
+     * @param arcA first arc, modified in place.
+     * @param arcB second arc, unmodified.
+     * @param allowReversed whether to consolidate even when second arc is reversed.
+     * @returns whether `arcA` was modified.
      */
     static appendToArcInPlace(arcA, arcB, allowReverse = false) {
         if (arcA.center.isAlmostEqual(arcB.center)) {
@@ -205,7 +217,7 @@ export class CurveFactory {
                 arcA.sweep.setStartEndRadians(arcA.sweep.startRadians, arcA.sweep.startRadians + arcA.sweep.sweepRadians + sweepSign * arcB.sweep.sweepRadians);
                 return true;
             }
-            // Also ok if negated tangent . ..
+            // Also ok if negated tangent
             if (allowReverse) {
                 startB.direction.scaleInPlace(-1.0);
                 if (endA.isAlmostEqual(startB)) {
@@ -218,7 +230,8 @@ export class CurveFactory {
     }
     /**
      * Return a `Path` containing arcs are on the surface of an ellipsoid and pass through a sequence of points.
-     * * Each arc passes through the two given endpoints and in the plane containing the true surface normal at given `fractionForIntermediateNormal`
+     * * Each arc passes through the two given endpoints and in the plane containing the true surface normal at
+     * given `fractionForIntermediateNormal`
      * @param ellipsoid
      * @param pathPoints
      * @param fractionForIntermediateNormal fractional position for surface normal used to create the section plane.
@@ -241,7 +254,7 @@ export class CurveFactory {
     }
     /**
      * Create solid primitives for pipe segments (e.g. Cone or TorusPipe) around line and arc primitives.
-     * @param centerline centerline geometry/
+     * @param centerline centerline geometry.
      * @param pipeRadius radius of pipe.
      */
     static createPipeSegments(centerline, pipeRadius) {
@@ -267,16 +280,22 @@ export class CurveFactory {
         return undefined;
     }
     /**
-     * * Create section arcs for mitered pipe.
-     * * At each end of each pipe, the pipe is cut by the plane that bisects the angle between successive pipe centerlines.
-     * * The arc definitions are constructed so that lines between corresponding fractional positions on the arcs are
-     *     axial lines on the pipes.
-     * * This means that each arc definition axes (aka vector0 and vector90) are _not_ perpendicular to each other.
-     * * 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.
-     *    * The center of Arc3d input is translated to the centerline start point to act as initial cross section.
-     * @param centerline centerline of pipe
-     * @param sectionData circle radius, ellipse semi-axis lengths, or full Arc3d
+     * Create section arcs for mitered pipe.
+     * * At the end of each pipe segment, the pipe is mitered by the plane that bisects the angle between successive
+     * centerline segments.
+     * * The section arcs are constructed so that lines between corresponding fractional positions on the arcs are
+     *   axial lines on the pipes.
+     * * This means that the initial arc's vector0 and vector90 lengths and angular separation are _not_ preserved in
+     * the section arcs.
+     * * Circular or elliptical pipe cross sections can be specified by supplying either a radius, a pair of semi-axis
+     * 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. For best results, ensure no successive duplicate points with e.g.,
+     * [[GrowableXYZArray.createCompressed]].
+     * @param sectionData circle radius, ellipse semi-axis lengths, or full Arc3d (if not full, function makes it full).
      */
     static createMiteredPipeSections(centerline, sectionData) {
         const arcs = [];
@@ -285,15 +304,15 @@ export class CurveFactory {
         const vector0 = Vector3d.create();
         const vector90 = Vector3d.create();
         const vectorBC = Vector3d.create();
-        const currentCenter = Point3d.create();
-        centerline.vectorIndexIndex(0, 1, vectorBC);
-        centerline.getPoint3dAtUncheckedPointIndex(0, currentCenter);
-        let initialSection;
+        const sweep = AngleSweep.create360();
+        centerline.vectorIndexIndex(0, 1, vectorBC); // initially, the start tangent
         if (sectionData instanceof Arc3d) {
-            initialSection = sectionData.clone();
-            initialSection.center.setFrom(currentCenter);
             vector0.setFrom(sectionData.vector0);
             vector90.setFrom(sectionData.vector90);
+            sweep.setFrom(sectionData.sweep); // allow e.g., half-pipe
+            const sectionFacesForward = sectionData.matrixRef.columnDotXYZ(AxisIndex.Z, vectorBC.x, vectorBC.y, vectorBC.z) > 0;
+            if (sectionFacesForward !== sectionData.sweep.isCCW)
+                sweep.reverseInPlace();
         }
         else if (typeof sectionData === "number" || Point3d.isXAndY(sectionData)) {
             const length0 = (typeof sectionData === "number") ? sectionData : sectionData.x;
@@ -301,31 +320,31 @@ export class CurveFactory {
             const baseFrame = Matrix3d.createRigidHeadsUp(vectorBC, AxisOrder.ZXY);
             baseFrame.columnX(vector0).scaleInPlace(length0);
             baseFrame.columnY(vector90).scaleInPlace(length90);
-            initialSection = Arc3d.create(currentCenter, vector0, vector90, AngleSweep.create360());
         }
         else {
             return [];
         }
+        // ASSUME: initial section normal points toward sweep direction for subsequent facet creation
+        const initialSection = Arc3d.create(undefined, vector0, vector90, sweep);
+        centerline.getPoint3dAtUncheckedPointIndex(0, initialSection.centerRef);
         arcs.push(initialSection);
         const vectorAB = Vector3d.create();
         const bisector = Vector3d.create();
+        const center = Point3d.create();
         for (let i = 1; i < centerline.length; i++) {
             vectorAB.setFromVector3d(vectorBC);
-            centerline.getPoint3dAtUncheckedPointIndex(i, currentCenter);
-            if (i + 1 < centerline.length) {
+            centerline.getPoint3dAtUncheckedPointIndex(i, center);
+            if (i + 1 < centerline.length)
                 centerline.vectorIndexIndex(i, i + 1, vectorBC);
-            }
-            else {
+            else
                 vectorBC.setFromVector3d(vectorAB);
-            }
             if (vectorAB.normalizeInPlace() && vectorBC.normalizeInPlace()) {
                 vectorAB.interpolate(0.5, vectorBC, bisector);
-                // On the end ellipse for this pipe section. ..
-                // center comes directly from centerline[i]
-                // vector0 and vector90 are obtained by sweeping the corresponding vectors of the start ellipse to the split plane.
+                // At pipe end, the ellipse center comes directly from centerline[i], and vector0/vector90 are
+                // obtained by sweeping the corresponding vectors of the pipe start ellipse to the bisector plane.
                 moveVectorToPlane(vector0, vectorAB, bisector, vector0);
                 moveVectorToPlane(vector90, vectorAB, bisector, vector90);
-                arcs.push(Arc3d.create(currentCenter, vector0, vector90, AngleSweep.create360()));
+                arcs.push(Arc3d.create(center, vector0, vector90, sweep));
             }
         }
         return arcs;
@@ -334,21 +353,38 @@ export class CurveFactory {
      * Sweep the initialSection along each segment of the centerLine until it hits the bisector plane at the next vertex.
      * * The caller should place the initialSection on a plane perpendicular to the first edge.
      *   * This plane is commonly (but not necessarily) through the start point itself.
-     *   * If the geometry is not "on a perpendicular plane", the output geometry will still be flattened onto the various planes.
-     * * In the "open path" case (i.e when wrapIfPhysicallyClosed is false or the path does not have matched first and last points)
-     *       the first/last output plane will be at the start/end of the first/last edge and on a perpendicular plane.
-     * * In the "closed path" case, the output plane for the first and last point is the bisector of the start and end planes from the "open path" case,
-     *    and the first/last section geometry may be different from `initialSection`.
-     * * The centerline path does NOT have to be planar, however twisting effects effects will appear in the various bisector planes.
-     * @param centerline sweep path, e.g., as stroked from a smooth centerline curve
-     * @param initialSection profile curve to be swept. As noted above, this should be on a plane perpendicular to the first segment of the centerline.
-     * @param options options for computation and output
+     *   * If the initialSection is not "on a perpendicular plane", the output geometry will still be flattened onto the
+     *     various planes.
+     * * In the "open path" case (i.e when `wrapIfPhysicallyClosed` is false or the path does not have matched first and
+     *   last points), the first/last output plane will be at the start/end of the first/last edge and on a perpendicular
+     *   plane.
+     * * In the "closed path" case, if start/edn tangents are not provided in the `options`, then the output plane for the
+     *   first and last point is the bisector of the start and end planes from the "open path" case, and the first/last
+     *   section geometry may be different from `initialSection`.
+     * * The centerline path does NOT have to be planar, however twisting effects effects will appear in the various bisector
+     *   planes.
+     * @param centerline sweep path, e.g., as stroked from a smooth centerline curve.
+     * @param initialSection profile curve to be swept. As noted above, this should be on a plane perpendicular to the
+     * first segment of the centerline.
+     * @param options options for computation and output.
      * @return array of sections, starting with `initialSection` projected along the first edge to the first plane.
      */
     static createMiteredSweepSections(centerline, initialSection, options) {
         const sectionData = { sections: [], planes: [] };
         const planes = PolylineOps.createBisectorPlanesForDistinctPoints(centerline, options.wrapIfPhysicallyClosed);
+        // apply start/end tangent options
         if (planes !== undefined && planes.length > 1) {
+            const firstPlane = planes[0];
+            const lastPlane = planes[planes.length - 1];
+            const startTang = options.startTangent;
+            const endTang = options.endTangent;
+            if (!firstPlane.getOriginRef().isAlmostEqual(lastPlane.getOriginRef()) ||
+                (startTang && endTang && startTang.isAlmostEqual(endTang, 0.0))) {
+                if (startTang?.tryNormalizeInPlace())
+                    firstPlane.getNormalRef().setFrom(startTang);
+                if (endTang?.tryNormalizeInPlace())
+                    lastPlane.getNormalRef().setFrom(endTang);
+            }
             // Projection to target plane, constructing sweep direction from two given planes.
             // If successful, push the target plane and swept section to the output arrays and return the swept section.
             // If unsuccessful, leave the output arrays alone and return the input section.
@@ -357,12 +393,12 @@ export class CurveFactory {
                 const transform = Transform.createFlattenAlongVectorToPlane(sweepVector, targetPlane.getOriginRef(), targetPlane.getNormalRef());
                 if (transform === undefined)
                     return section;
-                const section1 = section.cloneTransformed(transform);
-                if (section1 === undefined)
+                const transformedSection = section.cloneTransformed(transform);
+                if (transformedSection === undefined)
                     return section;
                 sectionData.planes.push(targetPlane);
-                sectionData.sections.push(section1);
-                return section1;
+                sectionData.sections.push(transformedSection);
+                return transformedSection;
             };
             let currentSection = doSweepToPlane(planes[0], planes[1], planes[0], initialSection);
             for (let i = 1; i < planes.length; i++) {
@@ -398,11 +434,11 @@ export class CurveFactory {
     /**
      * Compute 2 spirals (all in XY) for a symmetric line-to-line transition.
      * * First spiral begins at given start point.
-     * * first tangent aims at shoulder
+     * * first tangent aims at shoulder.
      * * outbound spiral joins line from shoulder to target.
-     * @param spiralType name of spiral type.  THIS MUST BE AN "Integrated" SPIRAL TYPE
+     * @param spiralType name of spiral type. THIS MUST BE AN "Integrated" SPIRAL TYPE.
      * @param startPoint inbound start point.
-     * @param shoulder point target point for (both) spiral-to-line tangencies
+     * @param shoulder point target point for (both) spiral-to-line tangencies.
      * @return array with the computed spirals, or undefined if failure.
      */
     static createLineSpiralSpiralLine(spiralType, startPoint, shoulderPoint, targetPoint) {
@@ -440,9 +476,9 @@ export class CurveFactory {
      * Compute 2 spirals (all in XY) for a symmetric line-to-line transition.
      * * Spiral length is given.
      * * tangency points float on both lines.
-     * @param spiralType name of spiral type.  THIS MUST BE AN "Integrated" SPIRAL TYPE
+     * @param spiralType name of spiral type.  THIS MUST BE AN "Integrated" SPIRAL TYPE.
      * @param pointA inbound start point.
-     * @param shoulder point target point for (both) spiral-to-line tangencies
+     * @param shoulder point target point for (both) spiral-to-line tangencies.
      * @param spiralLength for each part of the spiral pair.
      * @return array with the computed spirals, or undefined if failure.
      */
@@ -480,12 +516,12 @@ export class CurveFactory {
     }
     /**
      * Compute 2 spirals and an arc (all in XY) for a symmetric line-to-line transition.
-     * Spiral lengths and arc radius are given.   (e.g. from design speed standards.)
-     * @param spiralType name of spiral type.  THIS MUST BE AN "Integrated" SPIRAL TYPE
+     * Spiral lengths and arc radius are given (e.g., from design speed standards).
+     * @param spiralType name of spiral type. THIS MUST BE AN "Integrated" SPIRAL TYPE.
      * @param pointA inbound start point.
-     * @param pointB shoulder (target)  point for (both) spiral-to-line tangencies
-     * @param lengthA inbound spiral length
-     * @param lengthB outbound spiral length
+     * @param pointB shoulder (target)  point for (both) spiral-to-line tangencies.
+     * @param lengthA inbound spiral length.
+     * @param lengthB outbound spiral length.
      * @return array with the computed spirals, or undefined if failure.
      */
     static createLineSpiralArcSpiralLine(spiralType, pointA, pointB, pointC, lengthA, lengthB, arcRadius) {
@@ -535,12 +571,7 @@ export class CurveFactory {
         }
         return undefined;
     }
-    /**
-     * Return the intersection point of 3 planes.
-     * @param planeA
-     * @param planeB
-     * @param planeC
-     */
+    /** Return the intersection point of 3 planes. */
     static planePlaneIntersectionRay(planeA, planeB) {
         const altitudeA = planeA.altitudeXYZ(0, 0, 0);
         const altitudeB = planeB.altitudeXYZ(0, 0, 0);
@@ -560,9 +591,7 @@ export class CurveFactory {
         return undefined;
     }
 }
-/**
- * Starting at vectorR, move parallel to vectorV until perpendicular to planeNormal
- */
+/** Starting at vectorR, move parallel to vectorV until perpendicular to planeNormal. */
 function moveVectorToPlane(vectorR, vectorV, planeNormal, result) {
     // find s such that (vectorR + s * vectorV) DOT planeNormal = 0.
     const dotRN = vectorR.dotProduct(planeNormal);