@itwin/core-geometry 5.1.0-dev.5 → 5.1.0-dev.51

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

@@ -36,13 +36,14 @@ export declare enum RegionBinaryOpType {
 }
 /**
  * Class `RegionOps` has static members for calculations on regions (areas).
- * * Regions are represented by these `CurveCollection` subclasses:
- *   * `Loop` -- a single loop
- *   * `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.
- * * **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.
+ * * Regions are represented by these [[CurveCollection]] subclasses:
+ *   * [[Loop]] -- a single loop
+ *   * [[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.
+ *   * Assume consistent Loop orientation: "solid" Loops are counterclockwise; "hole" Loops are clockwise.
  * @public
  */
 export declare class RegionOps {
@@ -65,7 +66,8 @@ export declare class RegionOps {
     /**
      * Return a (signed) xy area for a region.
      * * The input region should lie in a plane parallel to the xy-plane, as z-coords will be ignored.
-     * * The area is negative if and only if the region is oriented clockwise with respect to the positive z-axis.
+     * * For a non-self-intersecting Loop, the returned area is negative if and only if the Loop is oriented clockwise
+     * with respect to the positive z-axis.
      * @param region any [[Loop]], [[ParityRegion]], or [[UnionRegion]].
      */
     static computeXYArea(region: AnyRegion): number | undefined;
@@ -136,12 +138,35 @@ export declare class RegionOps {
      * @param triangulate whether to triangulate the result
      */
     static polygonXYAreaDifferenceLoopsToPolyface(loopsA: MultiLineStringDataVariant, loopsB: MultiLineStringDataVariant, triangulate?: boolean): Polyface | undefined;
+    /**
+     * Return the region's simplest representation by stripping redundant parent(s).
+     * * No Boolean operations are performed.
+     * @param region input region (unchanged). Assumed to have at least one child.
+     * @returns
+     * * For a [[UnionRegion]] with exactly one child, return the child if it is a [[Loop]],
+     * or if it is a [[ParityRegion]] with multiple children; otherwise return the `ParityRegion`'s `Loop`.
+     * * For a `ParityRegion` with exactly one child, return the `Loop`.
+     * * All other inputs returned unchanged.
+     * @see [[simplifyRegion]]
+     */
+    static simplifyRegionType(region: AnyRegion): AnyRegion;
+    /**
+     * Simplify the region's parent/child hierarchy in place:
+     * * Regions with exactly one child are simplified as per [[simplifyRegionType]].
+     * * Regions without children are removed.
+     * * No Boolean operations are performed.
+     * @param region region to simplify in place
+     * @returns reference to the updated input region
+     * @see [[simplifyRegionType]]
+     */
+    static simplifyRegion(region: AnyRegion): AnyRegion | undefined;
     /**
      * Return areas defined by a boolean operation.
-     * * If there are multiple regions in loopsA, they are treated as a union.
-     * * If there are multiple regions in loopsB, they are treated as a union.
-     * @param loopsA first set of loops
-     * @param loopsB second set of loops
+     * @note For best results, input regions should have correctly oriented loops. See [[sortOuterAndHoleLoopsXY]].
+     * @note A common use case of this method is to convert a region with overlapping children into one with
+     * non-overlapping children: `regionOut = RegionOps.regionBooleanXY(regionIn, undefined, RegionBinaryOpType.Union)`.
+     * @param loopsA first set of loops (treated as a union)
+     * @param loopsB second set of loops (treated as a union)
      * @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
@@ -299,14 +324,15 @@ export declare class RegionOps {
      */
     static consolidateAdjacentPrimitives(curves: CurveCollection, options?: ConsolidateAdjacentCurvePrimitivesOptions): void;
     /**
-     * Reverse and reorder loops in the xy-plane for consistency and containment.
-     * @param loops multiple loops in any order and orientation, z-coordinates ignored
+     * Reverse and reorder loops in the xy-plane for consistent orientation and containment.
+     * @param loops multiple loops in any order and orientation, z-coordinates ignored.
+     * * For best results, all overlaps should be containments, i.e., loop boundaries can touch, but should not cross.
      * @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.
+     * * [[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
+     * * [[UnionRegion]] if any other input configuration. Its children are individually ordered/oriented as in
      * the above cases.
      * @see [[PolygonOps.sortOuterAndHoleLoopsXY]]
      */
@@ -315,14 +341,14 @@ export declare class RegionOps {
      * Find all xy-areas bounded by the unstructured, possibly intersecting curves.
      * * For best results, input curves should be parallel to the xy-plane, as z-coordinates are ignored.
      * * A common use case of this method is to assemble the bounding "exterior" loop (or loops) containing the
-     * input curves.
+     * input curves. Note that "holes" implied by inputs are _not_ preserved in output.
      * * 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
+     * primitives, stripped of parity context. This means holes are _not_ preserved in output.
+     * @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.
@@ -374,12 +400,10 @@ export declare class RegionOps {
     private static triangulateRegionComponent;
     /**
      * Facet the region according to stroke options.
+     * @note For best results, [[UnionRegion]] input should consist of non-overlapping children. See [[regionBooleanXY]].
+     * @note For best results, [[ParityRegion]] input should be correctly oriented. See [[sortOuterAndHoleLoopsXY]].
      * @param region a closed xy-planar region, possibly with holes.
      * * The z-coordinates of the region are ignored. Caller is responsible for rotating the region into plane local coordinates beforehand, and reversing the rotation afterwards.
-     * * For best results, `UnionRegion` input should consist of non-overlapping children.
-     * Caller can ensure this by passing in `region = RegionOps.regionBooleanXY(unionRegion, undefined, RegionBinaryOpType.Union)`.
-     * * For best results, `ParityRegion` input should be correctly oriented (holes have opposite orientation to their containing loop).
-     * Caller can ensure this for non-intersecting loops by passing in `region = RegionOps.sortOuterAndHoleLoopsXY(loops)`.
      * @param options primarily how to stroke the region boundary, but also how to facet the region interior.
      * * By default, a triangulation is returned, but if `options.maximizeConvexFacets === true`, edges between coplanar triangles are removed to return maximally convex facets.
      * @returns facets for the region, or undefined if facetting failed
@@ -394,17 +418,19 @@ export declare class RegionOps {
     static convexDecomposePolygonXY(polygon: MultiLineStringDataVariant, maximize?: boolean): GrowableXYZArray[] | undefined;
 }
 /**
- * * Options to control method `RegionOps.consolidateAdjacentPrimitives`
+ * * Options to control method `RegionOps.consolidateAdjacentPrimitives`.
  * @public
  */
 export declare class ConsolidateAdjacentCurvePrimitivesOptions {
-    /** True to consolidate adjacent linear geometry into a single LineString3d */
+    /** True to consolidate adjacent linear geometry into a single LineString3d. */
     consolidateLinearGeometry: boolean;
-    /** True to consolidate contiguous compatible arcs into a single Arc3d */
+    /** True to consolidate contiguous compatible arcs into a single Arc3d. */
     consolidateCompatibleArcs: boolean;
-    /** Tolerance for collapsing identical points */
+    /** Disable LineSegment3d and LineString3d point compression. */
+    disableLinearCompression?: boolean;
+    /** Tolerance for collapsing identical points (if `!disableLinearCompression`). */
     duplicatePointTolerance: number;
-    /** Tolerance for removing interior colinear points. */
+    /** Tolerance for removing interior colinear points (if `!disableLinearCompression`). */
     colinearPointTolerance: number;
 }
 //# sourceMappingURL=RegionOps.d.ts.map

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,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAClE,OAAO,EAC0B,oBAAoB,EAAyB,0BAA0B,EACvG,MAAM,oCAAoC,CAAC;AAE5C,OAAO,EAAE,OAAO,EAAY,MAAM,+BAA+B,CAAC;AAGlE,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAE5C,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAEpD,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAEjE,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAI1E,OAAO,EAAe,UAAU,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAG7E,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAM7D,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAE9D,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAO9B,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAGhD;;;;;;;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;;;;;;;;OAQG;WACW,oBAAoB,CAAC,MAAM,EAAE,SAAS,GAAG,UAAU,GAAG,SAAS;IAS7E;;;;MAIE;WACY,sBAAsB,CAAC,KAAK,EAAE,OAAO,EAAE,iBAAiB,GAAE,MAAqC,GAAG,MAAM;IAKtH;;;;;OAKG;WACW,aAAa,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS;IAQlE;;;;;;;;OAQG;WACW,wBAAwB,CAAC,KAAK,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS;IAO/E;;;;;;;OAOG;WACW,kBAAkB,CAAC,MAAM,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,SAAS;IA6BtF;;;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;IA0BxB;;;;;;;;;;;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;;;;;;;;;;;OAWG;WACW,4BAA4B,CACxC,MAAM,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,uBAAuB,EAAE,MAAM,GAAG,YAAY,GAC/E,UAAU,GAAG,SAAS;IAIzB;;;;;;;OAOG;WACW,sBAAsB,CAClC,MAAM,EAAE,IAAI,GAAG,IAAI,EAAE,uBAAuB,EAAE,MAAM,GAAG,YAAY,GAAG,aAAa,GAClF,eAAe,GAAG,SAAS;IAI9B;;;;;;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,QAAQ,GAAG,SAAS;IAahH;;;;;;;;OAQG;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,CAAC,EAAE,QAAQ,CAAA;KAAE;IAG/E;;;;;OAKG;WACW,aAAa,CAAC,SAAS,EAAE,QAAQ,EAAE,EAAE,YAAY,GAAE,MAAqC,GAAG,QAAQ,GAAG,SAAS;IAG7H;;;;;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;;;;;;;;;;;;;;;;;;;OAmBG;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;IAkB3E;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,iCAAiC;IAqChD,oCAAoC;IACpC,OAAO,CAAC,MAAM,CAAC,qBAAqB;IAepC;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,0BAA0B;IAIzC;;;;;;;;;;;OAWG;WACW,aAAa,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,eAAe,GAAG,SAAS;IAyBpG;;;;;MAKE;WACY,wBAAwB,CAAC,OAAO,EAAE,0BAA0B,EAAE,QAAQ,GAAE,OAAc,GAAG,gBAAgB,EAAE,GAAG,SAAS;CActI;AAaD;;;GAGG;AACH,qBAAa,yCAAyC;IACpD,8EAA8E;IACvE,yBAAyB,EAAE,OAAO,CAAQ;IACjD,yEAAyE;IAClE,yBAAyB,EAAE,OAAO,CAAQ;IACjD,gDAAgD;IACzC,uBAAuB,SAAgC;IAC9D,uDAAuD;IAChD,sBAAsB,SAAgC;CAC9D"}
+{"version":3,"file":"RegionOps.d.ts","sourceRoot":"","sources":["../../../src/curve/RegionOps.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAClE,OAAO,EAC0B,oBAAoB,EAAyB,0BAA0B,EACvG,MAAM,oCAAoC,CAAC;AAE5C,OAAO,EAAE,OAAO,EAAY,MAAM,+BAA+B,CAAC;AAGlE,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAE5C,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAEpD,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAEjE,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAI1E,OAAO,EAAe,UAAU,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAG7E,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAO7D,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAE9D,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAO9B,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAGhD;;;;;;;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;;;;;;;;;;;GAWG;AACH,qBAAa,SAAS;IACpB;;;;;;;;OAQG;WACW,oBAAoB,CAAC,MAAM,EAAE,SAAS,GAAG,UAAU,GAAG,SAAS;IAS7E;;;;MAIE;WACY,sBAAsB,CAAC,KAAK,EAAE,OAAO,EAAE,iBAAiB,GAAE,MAAqC,GAAG,MAAM;IAKtH;;;;;;OAMG;WACW,aAAa,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS;IAQlE;;;;;;;;OAQG;WACW,wBAAwB,CAAC,KAAK,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS;IAO/E;;;;;;;OAOG;WACW,kBAAkB,CAAC,MAAM,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,SAAS;IA6BtF;;;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,kBAAkB,CAAC,MAAM,EAAE,SAAS,GAAG,SAAS;IAU9D;;;;;;;;OAQG;WACW,cAAc,CAAC,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS;IAqBtE;;;;;;;;;;;OAWG;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;IA2BxB;;;;;;;;;;;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;;;;;;;;;;;OAWG;WACW,4BAA4B,CACxC,MAAM,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,uBAAuB,EAAE,MAAM,GAAG,YAAY,GAC/E,UAAU,GAAG,SAAS;IAIzB;;;;;;;OAOG;WACW,sBAAsB,CAClC,MAAM,EAAE,IAAI,GAAG,IAAI,EAAE,uBAAuB,EAAE,MAAM,GAAG,YAAY,GAAG,aAAa,GAClF,eAAe,GAAG,SAAS;IAI9B;;;;;;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,QAAQ,GAAG,SAAS;IAahH;;;;;;;;OAQG;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,CAAC,EAAE,QAAQ,CAAA;KAAE;IAG/E;;;;;OAKG;WACW,aAAa,CAAC,SAAS,EAAE,QAAQ,EAAE,EAAE,YAAY,GAAE,MAAqC,GAAG,QAAQ,GAAG,SAAS;IAG7H;;;;;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,CAAC,MAAM,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,yCAAyC,GAAG,IAAI;IAI/H;;;;;;;;;;;;OAYG;WACW,uBAAuB,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,GAAG,oBAAoB,CAAC,GAAG,SAAS;IAY3F;;;;;;;;;;;;;;;;;;;OAmBG;WACW,yBAAyB,CACrC,gBAAgB,EAAE,QAAQ,GAAG,QAAQ,EAAE,EAAE,SAAS,GAAE,MAAqC,GACxF,WAAW,EAAE;IAShB;;;;;;;;;;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;IAkB3E;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,iCAAiC;IAqChD,oCAAoC;IACpC,OAAO,CAAC,MAAM,CAAC,qBAAqB;IAepC;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,0BAA0B;IAIzC;;;;;;;;;OASG;WACW,aAAa,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,eAAe,GAAG,SAAS;IAyBpG;;;;;MAKE;WACY,wBAAwB,CAAC,OAAO,EAAE,0BAA0B,EAAE,QAAQ,GAAE,OAAc,GAAG,gBAAgB,EAAE,GAAG,SAAS;CActI;AAaD;;;GAGG;AACH,qBAAa,yCAAyC;IACpD,+EAA+E;IACxE,yBAAyB,EAAE,OAAO,CAAQ;IACjD,0EAA0E;IACnE,yBAAyB,EAAE,OAAO,CAAQ;IACjD,gEAAgE;IACzD,wBAAwB,CAAC,EAAE,OAAO,CAAS;IAClD,kFAAkF;IAC3E,uBAAuB,EAAE,MAAM,CAAgC;IACtE,wFAAwF;IACjF,sBAAsB,EAAE,MAAM,CAAgC;CACtE"}

package/lib/cjs/curve/RegionOps.js

@@ -8,6 +8,7 @@ exports.ConsolidateAdjacentCurvePrimitivesOptions = exports.RegionOps = exports.
 /** @packageDocumentation
  * @module Curve
  */
+const core_bentley_1 = require("@itwin/core-bentley");
 const Geometry_1 = require("../Geometry");
 const FrameBuilder_1 = require("../geometry3d/FrameBuilder");
 const GrowableXYZArray_1 = require("../geometry3d/GrowableXYZArray");
@@ -34,6 +35,7 @@ const CurveWireMomentsXYZ_1 = require("./CurveWireMomentsXYZ");
 const GeometryQuery_1 = require("./GeometryQuery");
 const ChainCollectorContext_1 = require("./internalContexts/ChainCollectorContext");
 const PolygonOffsetContext_1 = require("./internalContexts/PolygonOffsetContext");
+const TransferWithSplitArcs_1 = require("./internalContexts/TransferWithSplitArcs");
 const LineString3d_1 = require("./LineString3d");
 const Loop_1 = require("./Loop");
 const OffsetOptions_1 = require("./OffsetOptions");
@@ -60,13 +62,14 @@ var RegionBinaryOpType;
 })(RegionBinaryOpType || (exports.RegionBinaryOpType = RegionBinaryOpType = {}));
 /**
  * Class `RegionOps` has static members for calculations on regions (areas).
- * * Regions are represented by these `CurveCollection` subclasses:
- *   * `Loop` -- a single loop
- *   * `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.
- * * **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.
+ * * Regions are represented by these [[CurveCollection]] subclasses:
+ *   * [[Loop]] -- a single loop
+ *   * [[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.
+ *   * Assume consistent Loop orientation: "solid" Loops are counterclockwise; "hole" Loops are clockwise.
  * @public
  */
 class RegionOps {
@@ -101,7 +104,8 @@ class RegionOps {
     /**
      * Return a (signed) xy area for a region.
      * * The input region should lie in a plane parallel to the xy-plane, as z-coords will be ignored.
-     * * The area is negative if and only if the region is oriented clockwise with respect to the positive z-axis.
+     * * For a non-self-intersecting Loop, the returned area is negative if and only if the Loop is oriented clockwise
+     * with respect to the positive z-axis.
      * @param region any [[Loop]], [[ParityRegion]], or [[UnionRegion]].
      */
     static computeXYArea(region) {
@@ -281,21 +285,73 @@ class RegionOps {
         const graph = RegionOpsClassificationSweeps_1.RegionOpsFaceToFaceSearch.doPolygonBoolean(loopsA, loopsB, (inA, inB) => (inA && !inB), this._graphCheckPointFunction);
         return this.finishGraphToPolyface(graph, triangulate);
     }
+    /**
+     * Return the region's simplest representation by stripping redundant parent(s).
+     * * No Boolean operations are performed.
+     * @param region input region (unchanged). Assumed to have at least one child.
+     * @returns
+     * * For a [[UnionRegion]] with exactly one child, return the child if it is a [[Loop]],
+     * or if it is a [[ParityRegion]] with multiple children; otherwise return the `ParityRegion`'s `Loop`.
+     * * For a `ParityRegion` with exactly one child, return the `Loop`.
+     * * All other inputs returned unchanged.
+     * @see [[simplifyRegion]]
+     */
+    static simplifyRegionType(region) {
+        if (region instanceof UnionRegion_1.UnionRegion) {
+            if (region.children.length === 1)
+                return this.simplifyRegionType(region.children[0]);
+        }
+        else if (region instanceof ParityRegion_1.ParityRegion) {
+            if (region.children.length === 1)
+                return region.children[0];
+        }
+        return region;
+    }
+    /**
+     * Simplify the region's parent/child hierarchy in place:
+     * * Regions with exactly one child are simplified as per [[simplifyRegionType]].
+     * * Regions without children are removed.
+     * * No Boolean operations are performed.
+     * @param region region to simplify in place
+     * @returns reference to the updated input region
+     * @see [[simplifyRegionType]]
+     */
+    static simplifyRegion(region) {
+        if (region instanceof Loop_1.Loop)
+            return region.children.length > 0 ? region : undefined;
+        // remove childless Parity/UnionRegion
+        for (let i = 0; i < region.children.length; ++i) {
+            const child = region.children[i];
+            const newChild = this.simplifyRegion(child);
+            if (!newChild) {
+                region.children.splice(i--, 1);
+            }
+            else if (newChild !== child) {
+                (0, core_bentley_1.assert)(!(newChild instanceof UnionRegion_1.UnionRegion));
+                region.children.splice(i--, 1, newChild);
+            }
+        }
+        if (region.children.length === 0)
+            return undefined;
+        // remove redundant Parity/UnionRegion parent
+        if (region.children.length === 1)
+            return region.children.splice(0, 1)[0];
+        return region;
+    }
     /**
      * Return areas defined by a boolean operation.
-     * * If there are multiple regions in loopsA, they are treated as a union.
-     * * If there are multiple regions in loopsB, they are treated as a union.
-     * @param loopsA first set of loops
-     * @param loopsB second set of loops
+     * @note For best results, input regions should have correctly oriented loops. See [[sortOuterAndHoleLoopsXY]].
+     * @note A common use case of this method is to convert a region with overlapping children into one with
+     * non-overlapping children: `regionOut = RegionOps.regionBooleanXY(regionIn, undefined, RegionBinaryOpType.Union)`.
+     * @param loopsA first set of loops (treated as a union)
+     * @param loopsB second set of loops (treated as a union)
      * @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.
      */
     static regionBooleanXY(loopsA, loopsB, operation, mergeTolerance = Geometry_1.Geometry.smallMetricDistance) {
-        // Always return UnionRegion for now. But keep return type as AnyRegion:
-        // in the future, we might return the *simplest* region type.
-        const result = UnionRegion_1.UnionRegion.create();
+        let result;
         const context = RegionOpsClassificationSweeps_1.RegionBooleanContext.create(RegionOpsClassificationSweeps_1.RegionGroupOpType.Union, RegionOpsClassificationSweeps_1.RegionGroupOpType.Union);
         context.addMembers(loopsA, loopsB);
         context.annotateAndMergeCurvesInGraph(mergeTolerance);
@@ -309,11 +365,14 @@ class RegionOps {
                 return;
             if (faceType === 1) {
                 const loop = PlanarSubdivision_1.PlanarSubdivision.createLoopInFace(face);
-                if (loop)
+                if (loop) {
+                    if (!result)
+                        result = UnionRegion_1.UnionRegion.create();
                     result.tryAddChild(loop);
+                }
             }
         });
-        return result;
+        return result ? this.simplifyRegion(result) : undefined;
     }
     /**
      * Return a polyface whose facets are a boolean operation between the input regions.
@@ -604,14 +663,15 @@ class RegionOps {
         curves.dispatchToGeometryHandler(context);
     }
     /**
-     * Reverse and reorder loops in the xy-plane for consistency and containment.
-     * @param loops multiple loops in any order and orientation, z-coordinates ignored
+     * Reverse and reorder loops in the xy-plane for consistent orientation and containment.
+     * @param loops multiple loops in any order and orientation, z-coordinates ignored.
+     * * For best results, all overlaps should be containments, i.e., loop boundaries can touch, but should not cross.
      * @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.
+     * * [[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
+     * * [[UnionRegion]] if any other input configuration. Its children are individually ordered/oriented as in
      * the above cases.
      * @see [[PolygonOps.sortOuterAndHoleLoopsXY]]
      */
@@ -631,14 +691,14 @@ class RegionOps {
      * Find all xy-areas bounded by the unstructured, possibly intersecting curves.
      * * For best results, input curves should be parallel to the xy-plane, as z-coordinates are ignored.
      * * A common use case of this method is to assemble the bounding "exterior" loop (or loops) containing the
-     * input curves.
+     * input curves. Note that "holes" implied by inputs are _not_ preserved in output.
      * * 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
+     * primitives, stripped of parity context. This means holes are _not_ preserved in output.
+     * @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.
@@ -648,7 +708,8 @@ class RegionOps {
      * 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);
+        let primitives = RegionOps.collectCurvePrimitives(curvesAndRegions, undefined, true, true);
+        primitives = TransferWithSplitArcs_1.TransferWithSplitArcs.clone(CurveCollection_1.BagOfCurves.create(...primitives)).children;
         const range = this.curveArrayRange(primitives);
         const areaTol = this.computeXYAreaTolerance(range, tolerance);
         const intersections = CurveCurve_1.CurveCurve.allIntersectionsAmongPrimitivesXY(primitives, tolerance);
@@ -801,12 +862,10 @@ class RegionOps {
     }
     /**
      * Facet the region according to stroke options.
+     * @note For best results, [[UnionRegion]] input should consist of non-overlapping children. See [[regionBooleanXY]].
+     * @note For best results, [[ParityRegion]] input should be correctly oriented. See [[sortOuterAndHoleLoopsXY]].
      * @param region a closed xy-planar region, possibly with holes.
      * * The z-coordinates of the region are ignored. Caller is responsible for rotating the region into plane local coordinates beforehand, and reversing the rotation afterwards.
-     * * For best results, `UnionRegion` input should consist of non-overlapping children.
-     * Caller can ensure this by passing in `region = RegionOps.regionBooleanXY(unionRegion, undefined, RegionBinaryOpType.Union)`.
-     * * For best results, `ParityRegion` input should be correctly oriented (holes have opposite orientation to their containing loop).
-     * Caller can ensure this for non-intersecting loops by passing in `region = RegionOps.sortOuterAndHoleLoopsXY(loops)`.
      * @param options primarily how to stroke the region boundary, but also how to facet the region interior.
      * * By default, a triangulation is returned, but if `options.maximizeConvexFacets === true`, edges between coplanar triangles are removed to return maximally convex facets.
      * @returns facets for the region, or undefined if facetting failed
@@ -870,17 +929,19 @@ function pushToInOnOutArrays(curve, select, arrayNegative, array0, arrayPositive
         array0.push(curve);
 }
 /**
- * * Options to control method `RegionOps.consolidateAdjacentPrimitives`
+ * * Options to control method `RegionOps.consolidateAdjacentPrimitives`.
  * @public
  */
 class ConsolidateAdjacentCurvePrimitivesOptions {
-    /** True to consolidate adjacent linear geometry into a single LineString3d */
+    /** True to consolidate adjacent linear geometry into a single LineString3d. */
     consolidateLinearGeometry = true;
-    /** True to consolidate contiguous compatible arcs into a single Arc3d */
+    /** True to consolidate contiguous compatible arcs into a single Arc3d. */
     consolidateCompatibleArcs = true;
-    /** Tolerance for collapsing identical points */
+    /** Disable LineSegment3d and LineString3d point compression. */
+    disableLinearCompression = false;
+    /** Tolerance for collapsing identical points (if `!disableLinearCompression`). */
     duplicatePointTolerance = Geometry_1.Geometry.smallMetricDistance;
-    /** Tolerance for removing interior colinear points. */
+    /** Tolerance for removing interior colinear points (if `!disableLinearCompression`). */
     colinearPointTolerance = Geometry_1.Geometry.smallMetricDistance;
 }
 exports.ConsolidateAdjacentCurvePrimitivesOptions = ConsolidateAdjacentCurvePrimitivesOptions;