@itwin/core-geometry 4.1.0-dev.6 → 4.1.0-dev.63

package/lib/cjs/curve/RegionOps.d.ts

@@ -7,13 +7,14 @@ import { Polyface } from "../polyface/Polyface";
 import { HalfEdge, HalfEdgeGraph, HalfEdgeMask } from "../topology/Graph";
 import { MultiLineStringDataVariant } from "../topology/Triangulation";
 import { AnyCurve, AnyRegion } from "./CurveChain";
-import { BagOfCurves, ConsolidateAdjacentCurvePrimitivesOptions, CurveCollection } from "./CurveCollection";
+import { BagOfCurves, ConsolidateAdjacentCurvePrimitivesOptions, CurveChain, CurveCollection } from "./CurveCollection";
 import { CurvePrimitive } from "./CurvePrimitive";
 import { JointOptions, OffsetOptions } from "./internalContexts/PolygonOffsetContext";
 import { Loop, SignedLoops } from "./Loop";
 import { Path } from "./Path";
 /**
- * Possible return types from [[splitToPathsBetweenBreaks]], [[collectInsideAndOutsideOffsets]] and [[collectChains]].
+ * Possible return types from [[splitToPathsBetweenBreaks]], [[collectInsideAndOutsideOffsets]] and
+ * [[collectChains]].
  * @public
  */
 export type ChainTypes = CurvePrimitive | Path | BagOfCurves | Loop | undefined;
@@ -44,7 +45,8 @@ export declare enum RegionBinaryOpType {
  *   * `ParityRegion` -- a collection of loops, interpreted by parity rules.
  * The common "One outer loop and many Inner loops" is a parity region.
  *   * `UnionRegion` -- a collection of `Loop` and `ParityRegion` objects understood as a (probably disjoint) union.
- * * Most of the methods in this class ignore z-coordinates, so callers should ensure that input geometry has been rotated parallel to the xy-plane.
+ * * **NOTE:** Most of the methods in this class ignore z-coordinates, so callers should ensure that input geometry has
+ * been rotated parallel to the xy-plane.
  * @public
  */
 export declare class RegionOps {
@@ -55,7 +57,8 @@ export declare class RegionOps {
      * @param root any Loop, ParityRegion, or UnionRegion.
      */
     static computeXYAreaMoments(root: AnyRegion): MomentData | undefined;
-    /** Return an area tolerance for a given xy-range and optional distance tolerance.
+    /**
+     * Return an area tolerance for a given xy-range and optional distance tolerance.
      * @param range range of planar region to tolerance
      * @param distanceTolerance optional absolute distance tolerance
     */
@@ -67,18 +70,20 @@ export declare class RegionOps {
      * @param root any Loop, ParityRegion, or UnionRegion.
      */
     static computeXYArea(root: AnyRegion): number | undefined;
-    /** Return MomentData with the sums of wire moments.
+    /**
+     * Return MomentData with the sums of wire moments.
      * * If `rawMomentData` is the MomentData returned by computeXYAreaMoments, convert to principal axes and moments with
      *    call `principalMomentData = MomentData.inertiaProductsToPrincipalAxes (rawMomentData.origin, rawMomentData.sums);`
      * @param root any CurveCollection or CurvePrimitive.
      */
     static computeXYZWireMomentSums(root: AnyCurve): MomentData | undefined;
     /**
-     * * create loops in the graph.
+     * Create loops in the graph.
      * @internal
      */
     static addLoopsToGraph(graph: HalfEdgeGraph, data: MultiLineStringDataVariant, announceIsolatedLoop: (graph: HalfEdgeGraph, seed: HalfEdge) => void): void;
-    /** Add multiple loops to a graph.
+    /**
+     * Add multiple loops to a graph.
      * * Apply edgeTag and mask to each edge.
      * @internal
      */
@@ -86,7 +91,6 @@ export declare class RegionOps {
     /**
      * Given a graph just produced by booleans, convert to a polyface
      * * "just produced" implies exterior face markup.
-     *
      * @param graph
      * @param triangulate
      */
@@ -129,7 +133,8 @@ export declare class RegionOps {
      * @param loopsB second set of loops
      * @param operation indicates Union, Intersection, Parity, AMinusB, or BMinusA
      * @param mergeTolerance absolute distance tolerance for merging loops
-     * @returns a region resulting from merging input loops and the boolean operation. May contain bridge edges added to connect interior loops to exterior loops.
+     * @returns a region resulting from merging input loops and the boolean operation. May contain bridge edges added
+     * to connect interior loops to exterior loops.
      */
     static regionBooleanXY(loopsA: AnyRegion | AnyRegion[] | undefined, loopsB: AnyRegion | AnyRegion[] | undefined, operation: RegionBinaryOpType, mergeTolerance?: number): AnyRegion | undefined;
     /**
@@ -157,29 +162,30 @@ export declare class RegionOps {
      * @param inputB second set of loops
      */
     static polygonBooleanXYToLoops(inputA: MultiLineStringDataVariant[], operation: RegionBinaryOpType, inputB: MultiLineStringDataVariant[]): AnyRegion | undefined;
-    /** Construct a wire (not area!!) that is offset from given polyline or polygon.
-     * * This is a simple wire offset, not an area.
-     * * The construction algorithm attempts to eliminate some self-intersections within the offsets, but does not guarantee a simple area offset.
-     * * The construction algorithm is subject to being changed, resulting in different (hopefully better) self-intersection behavior on the future.
+    /**
+     * Construct a wire that is offset from the given polyline or polygon.
+     * * This is a simple wire offset, not an area offset.
+     * * Since z-coordinates are ignored, for best results the input points should lie in (a plane parallel to)
+     * the xy-plane.
+     * * The construction algorithm attempts to eliminate some self-intersections within the offsets, but does not
+     * guarantee a simple area offset.
+     * * If offsetDistance is given as a number, default OffsetOptions are applied.
+     * * See [[JointOptions]] class doc for offset construction rules.
      * @param points a single loop or path
      * @param wrap true to include wraparound
-     * @param offsetDistance distance of offset from wire.  Positive is left.
+     * @param offsetDistanceOrOptions offset distance (positive to left of curve, negative to right) or JointOptions
+     * object.
      */
-    static constructPolygonWireXYOffset(points: Point3d[], wrap: boolean, offsetDistance: number): CurveCollection | undefined;
+    static constructPolygonWireXYOffset(points: Point3d[], wrap: boolean, offsetDistanceOrOptions: number | JointOptions): CurveChain | undefined;
     /**
-   * Construct curves that are offset from a Path or Loop as viewed in xy-plane (ignoring z).
-   * * The construction will remove "some" local effects of features smaller than the offset distance, but will not detect self intersection among widely separated edges.
-   * * If offsetDistance is given as a number, default OffsetOptions are applied.
-   * * When the offset needs to do an "outside" turn, the first applicable construction is applied:
-   *   * If the turn is larger than `options.minArcDegrees`, a circular arc is constructed.
-   *   * If the turn is less than or equal to `options.maxChamferTurnDegrees`, extend curves along tangent to single intersection point.
-   *   * If the turn is larger than `options.maxChamferDegrees`, the turn is constructed as a sequence of straight lines that are:
-   *      * outside the arc
-   *      * have uniform turn angle less than `options.maxChamferDegrees`
-   *      * each line segment (except first and last) touches the arc at its midpoint.
-   * @param curves base curves.
-   * @param offsetDistanceOrOptions offset distance (positive to left of curve, negative to right) or options object.
-   */
+     * Construct curves that are offset from a Path or Loop as viewed in xy-plane (ignoring z).
+     * * The construction will remove "some" local effects of features smaller than the offset distance, but will
+     * not detect self intersection among widely separated edges.
+     * * If offsetDistance is given as a number, default OffsetOptions are applied.
+     * * See [[JointOptions]] class doc for offset construction rules.
+     * @param curves base curves.
+     * @param offsetDistanceOrOptions offset distance (positive to left of curve, negative to right) or options object.
+     */
     static constructCurveXYOffset(curves: Path | Loop, offsetDistanceOrOptions: number | JointOptions | OffsetOptions): CurveCollection | undefined;
     /**
      * Test if point (x,y) is IN, OUT or ON a region.
@@ -189,7 +195,8 @@ export declare class RegionOps {
      * @param y y coordinate of point to test
      */
     static testPointInOnOutRegionXY(curves: AnyRegion, x: number, y: number): number;
-    /** Create curve collection of subtype determined by gaps between the input curves.
+    /**
+     * Create curve collection of subtype determined by gaps between the input curves.
      * * If (a) wrap is requested and (b) all curves connect head-to-tail (including wraparound), assemble as a `loop`.
      * * If all curves connect head-to-tail except for closure, return a `Path`.
      * * If there are internal gaps, return a `BagOfCurves`
@@ -217,7 +224,8 @@ export declare class RegionOps {
     static cloneCurvesWithXYSplits(curvesToCut: AnyCurve | undefined, cutterCurves: CurveCollection): AnyCurve | undefined;
     /**
      * Create paths assembled from many curves.
-     * * Assemble paths from consecutive curves NOT separated by either gaps or the split markup set by [[cloneCurvesWithXYSplits]].
+     * * Assemble paths from consecutive curves NOT separated by either gaps or the split markup set by
+     * [[cloneCurvesWithXYSplits]].
      * * Return simplest form -- single primitive, single path, or bag of curves.
      */
     static splitToPathsBetweenBreaks(source: AnyCurve | undefined, makeClones: boolean): ChainTypes;
@@ -242,7 +250,8 @@ export declare class RegionOps {
      */
     static collectChains(fragments: AnyCurve[], gapTolerance?: number): ChainTypes;
     /**
-     * Find all intersections among curves in `curvesToCut` against the boundaries of `region` and return fragments of `curvesToCut`.
+     * Find all intersections among curves in `curvesToCut` against the boundaries of `region` and return fragments
+     * of `curvesToCut`.
      * * Break `curvesToCut` into parts inside, outside, and coincident.
      * @returns output object with all fragments split among `insideParts`, `outsideParts`, and `coincidentParts`
      */
@@ -251,7 +260,8 @@ export declare class RegionOps {
         outsideParts: AnyCurve[];
         coincidentParts: AnyCurve[];
     };
-    /** If `data` is one of several forms of a rectangle, return its edge Transform.
+    /**
+     * If `data` is one of several forms of a rectangle, return its edge Transform.
      * * Points are considered a rectangle if, within the first 4 points:
      *     * vectors from 0 to 1 and 0 to 3 are perpendicular and have a non-zero cross product
      *     * vectors from 0 to 3 and 1 to 2 are the same
@@ -262,7 +272,8 @@ export declare class RegionOps {
      *   * Array of Point3d[]
      *   * IndexedXYZCollection
      * @param requireClosurePoint whether to require a 5th point equal to the 1st point.
-     * @returns Transform with origin at one corner, x and y columns extending along two adjacent sides, and unit normal in z column. If not a rectangle, return undefined.
+     * @returns Transform with origin at one corner, x and y columns extending along two adjacent sides, and unit
+     * normal in z column. If not a rectangle, return undefined.
      */
     static rectangleEdgeTransform(data: AnyCurve | Point3d[] | IndexedXYZCollection, requireClosurePoint?: boolean): Transform | undefined;
     /**
@@ -270,9 +281,10 @@ export declare class RegionOps {
      * * Contiguous `LineSegment3d` and `LineString3d` objects.
      *   * collect all points
      *   * eliminate duplicated points
-     *   * eliminate points colinear with surrounding points.
-     *   * Contiguous concentric circular or elliptic arcs
+     *   * eliminate points colinear with surrounding points
+     *   * contiguous concentric circular or elliptic arcs
      *   * combine angular ranges
+     * * This function can be used to compress adjacent LineSegment3ds into a LineString3d
      * @param curves Path or loop (or larger collection containing paths and loops) to be simplified
      * @param options options for tolerance and selective simplification.
      */
@@ -283,24 +295,31 @@ export declare class RegionOps {
      * @returns a region that captures the input pointers. This region is a:
      * * `Loop` if there is exactly one input loop. It is oriented counterclockwise.
      * * `ParityRegion` if input consists of exactly one outer loop with at least one hole loop.
-     * Its first child is an outer loop oriented counterclockwise; all subsequent children are holes oriented clockwise.
-     * * `UnionRegion` if any other input configuration. Its children are individually ordered/oriented as in the above cases.
+     * Its first child is an outer loop oriented counterclockwise; all subsequent children are holes oriented
+     * clockwise.
+     * * `UnionRegion` if any other input configuration. Its children are individually ordered/oriented as in
+     * the above cases.
      * @see [[PolygonOps.sortOuterAndHoleLoopsXY]]
      */
     static sortOuterAndHoleLoopsXY(loops: Array<Loop | IndexedXYZCollection>): AnyRegion;
     /**
      * Find all areas bounded by the unstructured, possibly intersecting curves.
-     * * A common use case of this method is to assemble the bounding "exterior" loop (or loops) containing the input curves.
-     * * This method does not add bridge edges to connect outer loops to inner loops. Each disconnected loop, regardless
-     * of its containment, is returned as its own SignedLoops object. Pre-process with [[regionBooleanXY]] to add bridge edges so that
-     * [[constructAllXYRegionLoops]] will return outer and inner loops in the same SignedLoops object.
-     * @param curvesAndRegions Any collection of curves. Each Loop/ParityRegion/UnionRegion contributes its curve primitives.
+     * * A common use case of this method is to assemble the bounding "exterior" loop (or loops) containing the
+     * input curves.
+     * * This method does not add bridge edges to connect outer loops to inner loops. Each disconnected loop,
+     * regardless of its containment, is returned as its own SignedLoops object. Pre-process with [[regionBooleanXY]]
+     * to add bridge edges so that [[constructAllXYRegionLoops]] will return outer and inner loops in the same
+     * SignedLoops object.
+     * @param curvesAndRegions Any collection of curves. Each Loop/ParityRegion/UnionRegion contributes its curve
+     * primitives.
      * @param tolerance optional distance tolerance for coincidence
      * @returns array of [[SignedLoops]], each entry of which describes the faces in a single connected component:
-     *    * `positiveAreaLoops` contains "interior" loops, _including holes in ParityRegion input_. These loops have positive area and counterclockwise orientation.
+     *    * `positiveAreaLoops` contains "interior" loops, _including holes in ParityRegion input_. These loops have
+     * positive area and counterclockwise orientation.
      *    * `negativeAreaLoops` contains (probably just one) "exterior" loop which is ordered clockwise.
      *    * `slivers` contains sliver loops that have zero area, such as appear between coincident curves.
-     *    * `edges` contains a [[LoopCurveLoopCurve]] object for each component edge, collecting both loops adjacent to the edge and a constituent curve in each.
+     *    * `edges` contains a [[LoopCurveLoopCurve]] object for each component edge, collecting both loops adjacent
+     * to the edge and a constituent curve in each.
      */
     static constructAllXYRegionLoops(curvesAndRegions: AnyCurve | AnyCurve[], tolerance?: number): SignedLoops[];
     /**
@@ -309,12 +328,15 @@ export declare class RegionOps {
      * * Optionally recurses into hidden primitives if `smallestPossiblePrimitives` is true.
      * @param candidates input curves
      * @param collectorArray optional pre-defined output array. If defined, it is NOT cleared: primitives are appended.
-     * @param smallestPossiblePrimitives if true, recurse into the children of a [[CurveChainWithDistanceIndex]]. If false, push the [[CurveChainWithDistanceIndex]] instead.
-     * @param explodeLinestrings if true, push a [[LineSegment3d]] for each segment of a [[LineString3d]]. If false, push the [[LineString3d]] instead.
+     * @param smallestPossiblePrimitives if true, recurse into the children of a [[CurveChainWithDistanceIndex]]. If
+     * false, push the [[CurveChainWithDistanceIndex]] instead.
+     * @param explodeLinestrings if true, push a [[LineSegment3d]] for each segment of a [[LineString3d]]. If false,
+     * push the [[LineString3d]] instead.
      */
     static collectCurvePrimitives(candidates: AnyCurve | AnyCurve[], collectorArray?: CurvePrimitive[], smallestPossiblePrimitives?: boolean, explodeLinestrings?: boolean): CurvePrimitive[];
     /**
-     * Copy primitive pointers from candidates to result array, replacing each [[LineString3d]] by newly constructed instances of [[LineSegment3d]].
+     * Copy primitive pointers from candidates to result array, replacing each [[LineString3d]] by newly constructed
+     * instances of [[LineSegment3d]].
      * @param candidates input curves
      * @return copied (captured) inputs except for the linestrings, which are exploded
      */

package/lib/cjs/curve/RegionOps.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RegionOps.d.ts","sourceRoot":"","sources":["../../../src/curve/RegionOps.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAE1E,OAAO,EAAE,OAAO,EAAE,MAAM,+BAA+B,CAAC;AAExD,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAE9C,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAEhD,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAE1E,OAAO,EAAyB,0BAA0B,EAAgB,MAAM,2BAA2B,CAAC;AAE5G,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,yCAAyC,EAAc,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAExH,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAIlD,OAAO,EAA+B,YAAY,EAAE,aAAa,EAA4B,MAAM,yCAAyC,CAAC;AAE7I,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAE3C,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAS9B;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,cAAc,GAAG,IAAI,GAAG,WAAW,GAAG,IAAI,GAAG,SAAS,CAAC;AAEhF;;;;;;;GAOG;AACH,MAAM,MAAM,uBAAuB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,GAAG,KAAK,GAAG,CAAC;AACvH;;;GAGG;AACH,oBAAY,kBAAkB;IAC5B,KAAK,IAAI;IACT,MAAM,IAAI;IACV,YAAY,IAAI;IAChB,OAAO,IAAI;IACX,OAAO,IAAI;CACZ;AAED;;;;;;;;;GASG;AACH,qBAAa,SAAS;IACpB;;;;;OAKG;WACW,oBAAoB,CAAC,IAAI,EAAE,SAAS,GAAG,UAAU,GAAG,SAAS;IAS3E;;;MAGE;WACY,sBAAsB,CAAC,KAAK,EAAE,OAAO,EAAE,iBAAiB,GAAE,MAAqC,GAAG,MAAM;IAKtH;;;;;OAKG;WACW,aAAa,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS;IAQhE;;;;OAIG;WACW,wBAAwB,CAAC,IAAI,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS;IAQ9E;;;OAGG;WACW,eAAe,CAAC,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,0BAA0B,EAAE,oBAAoB,EAAE,CAAC,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,QAAQ,KAAK,IAAI;IAqC1J;;;OAGG;WACW,0BAA0B,CAAC,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,0BAA0B,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,GAAG,GAAG,QAAQ,EAAE,GAAG,SAAS;IAY1J;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,CAAC,qBAAqB;IAUpC;;;;;;;;OAQG;WACW,qCAAqC,CAAC,MAAM,EAAE,0BAA0B,EAAE,MAAM,EAAE,0BAA0B,EAAE,WAAW,GAAE,OAAe,GAAG,QAAQ,GAAG,SAAS;IAO/K;;;;;;;;OAQG;WACW,iCAAiC,CAAC,MAAM,EAAE,0BAA0B,EAAE,MAAM,EAAE,0BAA0B,EAAE,WAAW,GAAE,OAAe,GAAG,QAAQ,GAAG,SAAS;IAM3K;;;;;;;;OAQG;WACW,sCAAsC,CAAC,MAAM,EAAE,0BAA0B,EAAE,MAAM,EAAE,0BAA0B,EAAE,WAAW,GAAE,OAAe,GAAG,QAAQ,GAAG,SAAS;IAOhL;;;;;;;;;OASG;WACW,eAAe,CAAC,MAAM,EAAE,SAAS,GAAG,SAAS,EAAE,GAAG,SAAS,EAAE,MAAM,EAAE,SAAS,GAAG,SAAS,EAAE,GAAG,SAAS,EAAE,SAAS,EAAE,kBAAkB,EAAE,cAAc,GAAE,MAAqC,GAAG,SAAS,GAAG,SAAS;IAsBpO;;;;;;;;;;;OAWG;WACW,0BAA0B,CAAC,MAAM,EAAE,0BAA0B,EAAE,EAAE,SAAS,EAAE,kBAAkB,EAC1G,MAAM,EAAE,0BAA0B,EAAE,EAAE,WAAW,GAAE,OAAe,GAAG,QAAQ,GAAG,SAAS;IAO3F;;;;;;;;;;OAUG;WACW,uBAAuB,CACnC,MAAM,EAAE,0BAA0B,EAAE,EACpC,SAAS,EAAE,kBAAkB,EAC7B,MAAM,EAAE,0BAA0B,EAAE,GAAG,SAAS,GAAG,SAAS;IAqB9D;;;;;;;OAOG;WACW,4BAA4B,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS;IAIjI;;;;;;;;;;;;;KAaC;WACa,sBAAsB,CAAC,MAAM,EAAE,IAAI,GAAG,IAAI,EAAE,uBAAuB,EAAE,MAAM,GAAG,YAAY,GAAG,aAAa,GAAG,eAAe,GAAG,SAAS;IAGtJ;;;;;;OAMG;WACW,wBAAwB,CAAC,MAAM,EAAE,SAAS,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM;IAGvF;;;;;;;;OAQG;WACW,2BAA2B,CAAC,MAAM,EAAE,cAAc,EAAE,EAAE,IAAI,GAAE,OAAc,EAAE,6BAA6B,GAAE,OAAe,GAAG,eAAe,GAAG,SAAS;IAwBtK,OAAO,CAAC,MAAM,CAAC,wBAAwB,CAAC,CAA0B;IAClE;;;OAGG;WACW,qBAAqB,CAAC,CAAC,CAAC,EAAE,uBAAuB;IAC/D;;;;;;;;OAQG;WACW,uBAAuB,CAAC,WAAW,EAAE,QAAQ,GAAG,SAAS,EAAE,YAAY,EAAE,eAAe,GAAG,QAAQ,GAAG,SAAS;IAG7H;;;;OAIG;WACW,yBAAyB,CAAC,MAAM,EAAE,QAAQ,GAAG,SAAS,EAAE,UAAU,EAAE,OAAO,GAAG,UAAU;IAatG;;;;;;;OAOG;WACW,8BAA8B,CAAC,SAAS,EAAE,QAAQ,EAAE,EAAE,cAAc,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG;QAAE,aAAa,EAAE,QAAQ,EAAE,CAAC;QAAC,cAAc,EAAE,QAAQ,EAAE,CAAC;QAAC,MAAM,EAAE,UAAU,CAAA;KAAE;IAGhM;;;;;OAKG;WACW,aAAa,CAAC,SAAS,EAAE,QAAQ,EAAE,EAAE,YAAY,GAAE,MAAqC,GAAG,UAAU;IAInH;;;;OAIG;WACW,2BAA2B,CAAC,WAAW,EAAE,QAAQ,GAAG,SAAS,EAAE,MAAM,EAAE,SAAS,GAAG;QAAE,WAAW,EAAE,QAAQ,EAAE,CAAC;QAAC,YAAY,EAAE,QAAQ,EAAE,CAAC;QAAC,eAAe,EAAE,QAAQ,EAAE,CAAA;KAAE;IAqBnL;;;;;;;;;;;;OAYG;WACW,sBAAsB,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO,EAAE,GAAG,oBAAoB,EAAE,mBAAmB,GAAE,OAAc,GAAG,SAAS,GAAG,SAAS;IA6CnJ;;;;;;;;;;OAUG;WACW,6BAA6B,CAAC,MAAM,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,yCAAyC;IAIxH;;;;;;;;;OASG;WACW,uBAAuB,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,GAAG,oBAAoB,CAAC,GAAG,SAAS;IAY3F;;;;;;;;;;;;;OAaG;WACW,yBAAyB,CAAC,gBAAgB,EAAE,QAAQ,GAAG,QAAQ,EAAE,EAAE,SAAS,GAAE,MAAqC,GAAG,WAAW,EAAE;IASjJ;;;;;;;;OAQG;WACW,sBAAsB,CAAC,UAAU,EAAE,QAAQ,GAAG,QAAQ,EAAE,EAAE,cAAc,CAAC,EAAE,cAAc,EAAE,EACvG,0BAA0B,GAAE,OAAe,EAC3C,kBAAkB,GAAE,OAAe,GAAG,cAAc,EAAE;IAaxD;;;;OAIG;WACW,iBAAiB,CAAC,UAAU,EAAE,cAAc,EAAE,GAAG,cAAc,EAAE;IAe/E;;;;OAIG;WACW,eAAe,CAAC,IAAI,EAAE,GAAG,EAAE,YAAY,CAAC,EAAE,SAAS,GAAG,OAAO;CAkB5E"}
+{"version":3,"file":"RegionOps.d.ts","sourceRoot":"","sources":["../../../src/curve/RegionOps.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAE1E,OAAO,EAAE,OAAO,EAAE,MAAM,+BAA+B,CAAC;AAExD,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAE9C,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAEhD,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAE1E,OAAO,EAAyB,0BAA0B,EAAgB,MAAM,2BAA2B,CAAC;AAE5G,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,yCAAyC,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAExH,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAIlD,OAAO,EAA+B,YAAY,EAAE,aAAa,EAA4B,MAAM,yCAAyC,CAAC;AAE7I,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAE3C,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAS9B;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG,cAAc,GAAG,IAAI,GAAG,WAAW,GAAG,IAAI,GAAG,SAAS,CAAC;AAEhF;;;;;;;GAOG;AACH,MAAM,MAAM,uBAAuB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,GAAG,KAAK,GAAG,CAAC;AAEvH;;;GAGG;AACH,oBAAY,kBAAkB;IAC5B,KAAK,IAAI;IACT,MAAM,IAAI;IACV,YAAY,IAAI;IAChB,OAAO,IAAI;IACX,OAAO,IAAI;CACZ;AAED;;;;;;;;;;GAUG;AACH,qBAAa,SAAS;IACpB;;;;;OAKG;WACW,oBAAoB,CAAC,IAAI,EAAE,SAAS,GAAG,UAAU,GAAG,SAAS;IAS3E;;;;MAIE;WACY,sBAAsB,CAAC,KAAK,EAAE,OAAO,EAAE,iBAAiB,GAAE,MAAqC,GAAG,MAAM;IAKtH;;;;;OAKG;WACW,aAAa,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS;IAQhE;;;;;OAKG;WACW,wBAAwB,CAAC,IAAI,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS;IAO9E;;;OAGG;WACW,eAAe,CAC3B,KAAK,EAAE,aAAa,EACpB,IAAI,EAAE,0BAA0B,EAChC,oBAAoB,EAAE,CAAC,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,QAAQ,KAAK,IAAI,GACnE,IAAI;IAqCP;;;;OAIG;WACW,0BAA0B,CACtC,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,0BAA0B,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,GAAG,GACvF,QAAQ,EAAE,GAAG,SAAS;IAYzB;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,qBAAqB;IAUpC;;;;;;;;OAQG;WACW,qCAAqC,CACjD,MAAM,EAAE,0BAA0B,EAAE,MAAM,EAAE,0BAA0B,EAAE,WAAW,GAAE,OAAe,GACnG,QAAQ,GAAG,SAAS;IASvB;;;;;;;;OAQG;WACW,iCAAiC,CAC7C,MAAM,EAAE,0BAA0B,EAAE,MAAM,EAAE,0BAA0B,EAAE,WAAW,GAAE,OAAe,GACnG,QAAQ,GAAG,SAAS;IASvB;;;;;;;;OAQG;WACW,sCAAsC,CAClD,MAAM,EAAE,0BAA0B,EAAE,MAAM,EAAE,0BAA0B,EAAE,WAAW,GAAE,OAAe,GACnG,QAAQ,GAAG,SAAS;IASvB;;;;;;;;;;OAUG;WACW,eAAe,CAC3B,MAAM,EAAE,SAAS,GAAG,SAAS,EAAE,GAAG,SAAS,EAC3C,MAAM,EAAE,SAAS,GAAG,SAAS,EAAE,GAAG,SAAS,EAC3C,SAAS,EAAE,kBAAkB,EAC7B,cAAc,GAAE,MAAqC,GACpD,SAAS,GAAG,SAAS;IAwBxB;;;;;;;;;;;OAWG;WACW,0BAA0B,CACtC,MAAM,EAAE,0BAA0B,EAAE,EACpC,SAAS,EAAE,kBAAkB,EAC7B,MAAM,EAAE,0BAA0B,EAAE,EACpC,WAAW,GAAE,OAAe,GAC3B,QAAQ,GAAG,SAAS;IASvB;;;;;;;;;;OAUG;WACW,uBAAuB,CACnC,MAAM,EAAE,0BAA0B,EAAE,EACpC,SAAS,EAAE,kBAAkB,EAC7B,MAAM,EAAE,0BAA0B,EAAE,GACnC,SAAS,GAAG,SAAS;IAwBxB;;;;;;;;;;;;;OAaG;WACW,4BAA4B,CACxC,MAAM,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,uBAAuB,EAAE,MAAM,GAAG,YAAY,GAC/E,UAAU,GAAG,SAAS;IAIzB;;;;;;;;OAQG;WACW,sBAAsB,CAClC,MAAM,EAAE,IAAI,GAAG,IAAI,EAAE,uBAAuB,EAAE,MAAM,GAAG,YAAY,GAAG,aAAa,GAClF,eAAe,GAAG,SAAS;IAG9B;;;;;;OAMG;WACW,wBAAwB,CAAC,MAAM,EAAE,SAAS,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM;IAGvF;;;;;;;;;OASG;WACW,2BAA2B,CACvC,MAAM,EAAE,cAAc,EAAE,EAAE,IAAI,GAAE,OAAc,EAAE,6BAA6B,GAAE,OAAe,GAC7F,eAAe,GAAG,SAAS;IAuB9B,OAAO,CAAC,MAAM,CAAC,wBAAwB,CAAC,CAA0B;IAClE;;;OAGG;WACW,qBAAqB,CAAC,CAAC,CAAC,EAAE,uBAAuB;IAG/D;;;;;;;;OAQG;WACW,uBAAuB,CACnC,WAAW,EAAE,QAAQ,GAAG,SAAS,EAAE,YAAY,EAAE,eAAe,GAC/D,QAAQ,GAAG,SAAS;IAGvB;;;;;OAKG;WACW,yBAAyB,CAAC,MAAM,EAAE,QAAQ,GAAG,SAAS,EAAE,UAAU,EAAE,OAAO,GAAG,UAAU;IAatG;;;;;;;OAOG;WACW,8BAA8B,CAC1C,SAAS,EAAE,QAAQ,EAAE,EAAE,cAAc,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAClE;QAAE,aAAa,EAAE,QAAQ,EAAE,CAAC;QAAC,cAAc,EAAE,QAAQ,EAAE,CAAC;QAAC,MAAM,EAAE,UAAU,CAAA;KAAE;IAGhF;;;;;OAKG;WACW,aAAa,CAAC,SAAS,EAAE,QAAQ,EAAE,EAAE,YAAY,GAAE,MAAqC,GAAG,UAAU;IAGnH;;;;;OAKG;WACW,2BAA2B,CACvC,WAAW,EAAE,QAAQ,GAAG,SAAS,EAAE,MAAM,EAAE,SAAS,GACnD;QAAE,WAAW,EAAE,QAAQ,EAAE,CAAC;QAAC,YAAY,EAAE,QAAQ,EAAE,CAAC;QAAC,eAAe,EAAE,QAAQ,EAAE,CAAA;KAAE;IAqBrF;;;;;;;;;;;;;;OAcG;WACW,sBAAsB,CAClC,IAAI,EAAE,QAAQ,GAAG,OAAO,EAAE,GAAG,oBAAoB,EAAE,mBAAmB,GAAE,OAAc,GACrF,SAAS,GAAG,SAAS;IA+CxB;;;;;;;;;;;OAWG;WACW,6BAA6B,CACzC,MAAM,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,yCAAyC,GAC3E,IAAI;IAIP;;;;;;;;;;;OAWG;WACW,uBAAuB,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,GAAG,oBAAoB,CAAC,GAAG,SAAS;IAY3F;;;;;;;;;;;;;;;;;;OAkBG;WACW,yBAAyB,CACrC,gBAAgB,EAAE,QAAQ,GAAG,QAAQ,EAAE,EAAE,SAAS,GAAE,MAAqC,GACxF,WAAW,EAAE;IAQhB;;;;;;;;;;OAUG;WACW,sBAAsB,CAClC,UAAU,EAAE,QAAQ,GAAG,QAAQ,EAAE,EACjC,cAAc,CAAC,EAAE,cAAc,EAAE,EACjC,0BAA0B,GAAE,OAAe,EAC3C,kBAAkB,GAAE,OAAe,GAClC,cAAc,EAAE;IAanB;;;;;OAKG;WACW,iBAAiB,CAAC,UAAU,EAAE,cAAc,EAAE,GAAG,cAAc,EAAE;IAe/E;;;;OAIG;WACW,eAAe,CAAC,IAAI,EAAE,GAAG,EAAE,YAAY,CAAC,EAAE,SAAS,GAAG,OAAO;CAkB5E"}

package/lib/cjs/curve/RegionOps.js

@@ -60,7 +60,8 @@ var RegionBinaryOpType;
  *   * `ParityRegion` -- a collection of loops, interpreted by parity rules.
  * The common "One outer loop and many Inner loops" is a parity region.
  *   * `UnionRegion` -- a collection of `Loop` and `ParityRegion` objects understood as a (probably disjoint) union.
- * * Most of the methods in this class ignore z-coordinates, so callers should ensure that input geometry has been rotated parallel to the xy-plane.
+ * * **NOTE:** Most of the methods in this class ignore z-coordinates, so callers should ensure that input geometry has
+ * been rotated parallel to the xy-plane.
  * @public
  */
 class RegionOps {
@@ -79,7 +80,8 @@ class RegionOps {
         }
         return undefined;
     }
-    /** Return an area tolerance for a given xy-range and optional distance tolerance.
+    /**
+     * Return an area tolerance for a given xy-range and optional distance tolerance.
      * @param range range of planar region to tolerance
      * @param distanceTolerance optional absolute distance tolerance
     */
@@ -102,7 +104,8 @@ class RegionOps {
         }
         return undefined;
     }
-    /** Return MomentData with the sums of wire moments.
+    /**
+     * Return MomentData with the sums of wire moments.
      * * If `rawMomentData` is the MomentData returned by computeXYAreaMoments, convert to principal axes and moments with
      *    call `principalMomentData = MomentData.inertiaProductsToPrincipalAxes (rawMomentData.origin, rawMomentData.sums);`
      * @param root any CurveCollection or CurvePrimitive.
@@ -115,7 +118,7 @@ class RegionOps {
         return result;
     }
     /**
-     * * create loops in the graph.
+     * Create loops in the graph.
      * @internal
      */
     static addLoopsToGraph(graph, data, announceIsolatedLoop) {
@@ -159,7 +162,8 @@ class RegionOps {
             }
         }
     }
-    /** Add multiple loops to a graph.
+    /**
+     * Add multiple loops to a graph.
      * * Apply edgeTag and mask to each edge.
      * @internal
      */
@@ -178,7 +182,6 @@ class RegionOps {
     /**
      * Given a graph just produced by booleans, convert to a polyface
      * * "just produced" implies exterior face markup.
-     *
      * @param graph
      * @param triangulate
      */
@@ -239,7 +242,8 @@ class RegionOps {
      * @param loopsB second set of loops
      * @param operation indicates Union, Intersection, Parity, AMinusB, or BMinusA
      * @param mergeTolerance absolute distance tolerance for merging loops
-     * @returns a region resulting from merging input loops and the boolean operation. May contain bridge edges added to connect interior loops to exterior loops.
+     * @returns a region resulting from merging input loops and the boolean operation. May contain bridge edges added
+     * to connect interior loops to exterior loops.
      */
     static regionBooleanXY(loopsA, loopsB, operation, mergeTolerance = Geometry_1.Geometry.smallMetricDistance) {
         const result = UnionRegion_1.UnionRegion.create();
@@ -306,32 +310,33 @@ class RegionOps {
         }
         return RegionOps.sortOuterAndHoleLoopsXY(allLoops);
     }
-    /** Construct a wire (not area!!) that is offset from given polyline or polygon.
-     * * This is a simple wire offset, not an area.
-     * * The construction algorithm attempts to eliminate some self-intersections within the offsets, but does not guarantee a simple area offset.
-     * * The construction algorithm is subject to being changed, resulting in different (hopefully better) self-intersection behavior on the future.
+    /**
+     * Construct a wire that is offset from the given polyline or polygon.
+     * * This is a simple wire offset, not an area offset.
+     * * Since z-coordinates are ignored, for best results the input points should lie in (a plane parallel to)
+     * the xy-plane.
+     * * The construction algorithm attempts to eliminate some self-intersections within the offsets, but does not
+     * guarantee a simple area offset.
+     * * If offsetDistance is given as a number, default OffsetOptions are applied.
+     * * See [[JointOptions]] class doc for offset construction rules.
      * @param points a single loop or path
      * @param wrap true to include wraparound
-     * @param offsetDistance distance of offset from wire.  Positive is left.
+     * @param offsetDistanceOrOptions offset distance (positive to left of curve, negative to right) or JointOptions
+     * object.
      */
-    static constructPolygonWireXYOffset(points, wrap, offsetDistance) {
+    static constructPolygonWireXYOffset(points, wrap, offsetDistanceOrOptions) {
         const context = new PolygonOffsetContext_1.PolygonWireOffsetContext();
-        return context.constructPolygonWireXYOffset(points, wrap, offsetDistance);
+        return context.constructPolygonWireXYOffset(points, wrap, offsetDistanceOrOptions);
     }
     /**
-   * Construct curves that are offset from a Path or Loop as viewed in xy-plane (ignoring z).
-   * * The construction will remove "some" local effects of features smaller than the offset distance, but will not detect self intersection among widely separated edges.
-   * * If offsetDistance is given as a number, default OffsetOptions are applied.
-   * * When the offset needs to do an "outside" turn, the first applicable construction is applied:
-   *   * If the turn is larger than `options.minArcDegrees`, a circular arc is constructed.
-   *   * If the turn is less than or equal to `options.maxChamferTurnDegrees`, extend curves along tangent to single intersection point.
-   *   * If the turn is larger than `options.maxChamferDegrees`, the turn is constructed as a sequence of straight lines that are:
-   *      * outside the arc
-   *      * have uniform turn angle less than `options.maxChamferDegrees`
-   *      * each line segment (except first and last) touches the arc at its midpoint.
-   * @param curves base curves.
-   * @param offsetDistanceOrOptions offset distance (positive to left of curve, negative to right) or options object.
-   */
+     * Construct curves that are offset from a Path or Loop as viewed in xy-plane (ignoring z).
+     * * The construction will remove "some" local effects of features smaller than the offset distance, but will
+     * not detect self intersection among widely separated edges.
+     * * If offsetDistance is given as a number, default OffsetOptions are applied.
+     * * See [[JointOptions]] class doc for offset construction rules.
+     * @param curves base curves.
+     * @param offsetDistanceOrOptions offset distance (positive to left of curve, negative to right) or options object.
+     */
     static constructCurveXYOffset(curves, offsetDistanceOrOptions) {
         return PolygonOffsetContext_1.CurveChainWireOffsetContext.constructCurveXYOffset(curves, offsetDistanceOrOptions);
     }
@@ -345,7 +350,8 @@ class RegionOps {
     static testPointInOnOutRegionXY(curves, x, y) {
         return InOutTests_1.PointInOnOutContext.testPointInOnOutRegionXY(curves, x, y);
     }
-    /** Create curve collection of subtype determined by gaps between the input curves.
+    /**
+     * Create curve collection of subtype determined by gaps between the input curves.
      * * If (a) wrap is requested and (b) all curves connect head-to-tail (including wraparound), assemble as a `loop`.
      * * If all curves connect head-to-tail except for closure, return a `Path`.
      * * If there are internal gaps, return a `BagOfCurves`
@@ -382,7 +388,9 @@ class RegionOps {
      * Announce Checkpoint function for use during booleans
      * @internal
      */
-    static setCheckPointFunction(f) { this._graphCheckPointFunction = f; }
+    static setCheckPointFunction(f) {
+        this._graphCheckPointFunction = f;
+    }
     /**
      * Find all intersections among curves in `curvesToCut` and `cutterCurves` and return fragments of `curvesToCut`.
      * * For a `Loop`, `ParityRegion`, or `UnionRegion` in `curvesToCut`:
@@ -397,7 +405,8 @@ class RegionOps {
     }
     /**
      * Create paths assembled from many curves.
-     * * Assemble paths from consecutive curves NOT separated by either gaps or the split markup set by [[cloneCurvesWithXYSplits]].
+     * * Assemble paths from consecutive curves NOT separated by either gaps or the split markup set by
+     * [[cloneCurvesWithXYSplits]].
      * * Return simplest form -- single primitive, single path, or bag of curves.
      */
     static splitToPathsBetweenBreaks(source, makeClones) {
@@ -434,7 +443,8 @@ class RegionOps {
         return MultiChainCollector_1.OffsetHelpers.collectChains(fragments, gapTolerance);
     }
     /**
-     * Find all intersections among curves in `curvesToCut` against the boundaries of `region` and return fragments of `curvesToCut`.
+     * Find all intersections among curves in `curvesToCut` against the boundaries of `region` and return fragments
+     * of `curvesToCut`.
      * * Break `curvesToCut` into parts inside, outside, and coincident.
      * @returns output object with all fragments split among `insideParts`, `outsideParts`, and `coincidentParts`
      */
@@ -460,7 +470,8 @@ class RegionOps {
         }
         return result;
     }
-    /** If `data` is one of several forms of a rectangle, return its edge Transform.
+    /**
+     * If `data` is one of several forms of a rectangle, return its edge Transform.
      * * Points are considered a rectangle if, within the first 4 points:
      *     * vectors from 0 to 1 and 0 to 3 are perpendicular and have a non-zero cross product
      *     * vectors from 0 to 3 and 1 to 2 are the same
@@ -471,7 +482,8 @@ class RegionOps {
      *   * Array of Point3d[]
      *   * IndexedXYZCollection
      * @param requireClosurePoint whether to require a 5th point equal to the 1st point.
-     * @returns Transform with origin at one corner, x and y columns extending along two adjacent sides, and unit normal in z column. If not a rectangle, return undefined.
+     * @returns Transform with origin at one corner, x and y columns extending along two adjacent sides, and unit
+     * normal in z column. If not a rectangle, return undefined.
      */
     static rectangleEdgeTransform(data, requireClosurePoint = true) {
         if (data instanceof LineString3d_1.LineString3d) {
@@ -531,9 +543,10 @@ class RegionOps {
      * * Contiguous `LineSegment3d` and `LineString3d` objects.
      *   * collect all points
      *   * eliminate duplicated points
-     *   * eliminate points colinear with surrounding points.
-     *   * Contiguous concentric circular or elliptic arcs
+     *   * eliminate points colinear with surrounding points
+     *   * contiguous concentric circular or elliptic arcs
      *   * combine angular ranges
+     * * This function can be used to compress adjacent LineSegment3ds into a LineString3d
      * @param curves Path or loop (or larger collection containing paths and loops) to be simplified
      * @param options options for tolerance and selective simplification.
      */
@@ -547,8 +560,10 @@ class RegionOps {
      * @returns a region that captures the input pointers. This region is a:
      * * `Loop` if there is exactly one input loop. It is oriented counterclockwise.
      * * `ParityRegion` if input consists of exactly one outer loop with at least one hole loop.
-     * Its first child is an outer loop oriented counterclockwise; all subsequent children are holes oriented clockwise.
-     * * `UnionRegion` if any other input configuration. Its children are individually ordered/oriented as in the above cases.
+     * Its first child is an outer loop oriented counterclockwise; all subsequent children are holes oriented
+     * clockwise.
+     * * `UnionRegion` if any other input configuration. Its children are individually ordered/oriented as in
+     * the above cases.
      * @see [[PolygonOps.sortOuterAndHoleLoopsXY]]
      */
     static sortOuterAndHoleLoopsXY(loops) {
@@ -565,17 +580,22 @@ class RegionOps {
     }
     /**
      * Find all areas bounded by the unstructured, possibly intersecting curves.
-     * * A common use case of this method is to assemble the bounding "exterior" loop (or loops) containing the input curves.
-     * * This method does not add bridge edges to connect outer loops to inner loops. Each disconnected loop, regardless
-     * of its containment, is returned as its own SignedLoops object. Pre-process with [[regionBooleanXY]] to add bridge edges so that
-     * [[constructAllXYRegionLoops]] will return outer and inner loops in the same SignedLoops object.
-     * @param curvesAndRegions Any collection of curves. Each Loop/ParityRegion/UnionRegion contributes its curve primitives.
+     * * A common use case of this method is to assemble the bounding "exterior" loop (or loops) containing the
+     * input curves.
+     * * This method does not add bridge edges to connect outer loops to inner loops. Each disconnected loop,
+     * regardless of its containment, is returned as its own SignedLoops object. Pre-process with [[regionBooleanXY]]
+     * to add bridge edges so that [[constructAllXYRegionLoops]] will return outer and inner loops in the same
+     * SignedLoops object.
+     * @param curvesAndRegions Any collection of curves. Each Loop/ParityRegion/UnionRegion contributes its curve
+     * primitives.
      * @param tolerance optional distance tolerance for coincidence
      * @returns array of [[SignedLoops]], each entry of which describes the faces in a single connected component:
-     *    * `positiveAreaLoops` contains "interior" loops, _including holes in ParityRegion input_. These loops have positive area and counterclockwise orientation.
+     *    * `positiveAreaLoops` contains "interior" loops, _including holes in ParityRegion input_. These loops have
+     * positive area and counterclockwise orientation.
      *    * `negativeAreaLoops` contains (probably just one) "exterior" loop which is ordered clockwise.
      *    * `slivers` contains sliver loops that have zero area, such as appear between coincident curves.
-     *    * `edges` contains a [[LoopCurveLoopCurve]] object for each component edge, collecting both loops adjacent to the edge and a constituent curve in each.
+     *    * `edges` contains a [[LoopCurveLoopCurve]] object for each component edge, collecting both loops adjacent
+     * to the edge and a constituent curve in each.
      */
     static constructAllXYRegionLoops(curvesAndRegions, tolerance = Geometry_1.Geometry.smallMetricDistance) {
         const primitives = RegionOps.collectCurvePrimitives(curvesAndRegions, undefined, true, true);
@@ -591,8 +611,10 @@ class RegionOps {
      * * Optionally recurses into hidden primitives if `smallestPossiblePrimitives` is true.
      * @param candidates input curves
      * @param collectorArray optional pre-defined output array. If defined, it is NOT cleared: primitives are appended.
-     * @param smallestPossiblePrimitives if true, recurse into the children of a [[CurveChainWithDistanceIndex]]. If false, push the [[CurveChainWithDistanceIndex]] instead.
-     * @param explodeLinestrings if true, push a [[LineSegment3d]] for each segment of a [[LineString3d]]. If false, push the [[LineString3d]] instead.
+     * @param smallestPossiblePrimitives if true, recurse into the children of a [[CurveChainWithDistanceIndex]]. If
+     * false, push the [[CurveChainWithDistanceIndex]] instead.
+     * @param explodeLinestrings if true, push a [[LineSegment3d]] for each segment of a [[LineString3d]]. If false,
+     * push the [[LineString3d]] instead.
      */
     static collectCurvePrimitives(candidates, collectorArray, smallestPossiblePrimitives = false, explodeLinestrings = false) {
         const results = collectorArray === undefined ? [] : collectorArray;
@@ -610,7 +632,8 @@ class RegionOps {
         return results;
     }
     /**
-     * Copy primitive pointers from candidates to result array, replacing each [[LineString3d]] by newly constructed instances of [[LineSegment3d]].
+     * Copy primitive pointers from candidates to result array, replacing each [[LineString3d]] by newly constructed
+     * instances of [[LineSegment3d]].
      * @param candidates input curves
      * @return copied (captured) inputs except for the linestrings, which are exploded
      */