@itwin/core-geometry 3.0.0-dev.76 → 3.0.0-dev.80

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

@@ -0,0 +1,204 @@
+import { GeometryHandler } from "../geometry3d/GeometryHandler";
+import { GrowableXYZArray } from "../geometry3d/GrowableXYZArray";
+import { Point3d } from "../geometry3d/Point3dVector3d";
+import { Range3d } from "../geometry3d/Range";
+import { Transform } from "../geometry3d/Transform";
+import { AnyCurve } from "./CurveChain";
+import { CurveLocationDetail } from "./CurveLocationDetail";
+import { CurvePrimitive } from "./CurvePrimitive";
+import { RecursiveCurveProcessor } from "./CurveProcessor";
+import { GeometryQuery } from "./GeometryQuery";
+import { StrokeOptions } from "./StrokeOptions";
+/** Describes the concrete type of a [[CurveCollection]]. Each type name maps to a specific subclass and can be used in conditional statements for type-switching.
+ *    - "loop" => [[Loop]]
+ *    - "path" => [[Path]]
+ *    - "unionRegion" => [[UnionRegion]]
+ *    - "parityRegion" => [[ParityRegion]]
+ *    - "bagOfCurves" => [[BagOfCurves]]
+ * @public
+ */
+export declare type CurveCollectionType = "loop" | "path" | "unionRegion" | "parityRegion" | "bagOfCurves";
+/**
+ * A `CurveCollection` is an abstract (non-instantiable) class for various sets of curves with particular structures:
+ * - `CurveChain` is a (non-instantiable) intermediate class for a sequence of `CurvePrimitive ` joining head-to-tail.  The two instantiable forms of `CurveChain` are
+ *   - `Path` - A chain not required to close, and not enclosing a planar area
+ *   - `Loop` - A chain required to close from last to first so that a planar area is enclosed.
+ * - `ParityRegion` -- a collection of coplanar `Loop`s, with "in/out" classification by parity rules
+ * - `UnionRegion` -- a collection of coplanar `Loop`s, with "in/out" classification by union rules
+ * - `BagOfCurves` -- a collection of `AnyCurve` with no implied structure.
+ *
+ * @see [Curve Collections]($docs/learning/geometry/CurveCollection.md) learning article.
+ * @public
+ */
+export declare abstract class CurveCollection extends GeometryQuery {
+    /** String name for schema properties */
+    readonly geometryCategory = "curveCollection";
+    /** Type discriminator. */
+    abstract readonly curveCollectionType: CurveCollectionType;
+    /**  Flag for inner loop status. Only used by `Loop`. */
+    isInner: boolean;
+    /** Return the sum of the lengths of all contained curves. */
+    sumLengths(): number;
+    /** Return the closest point on the contained curves */
+    closestPoint(spacePoint: Point3d): CurveLocationDetail | undefined;
+    /** return the max gap between adjacent primitives in Path and Loop collections.
+     *
+     * * In a Path, gaps are computed between consecutive primitives.
+     * * In a Loop, gaps are computed between consecutive primitives and between last and first.
+     * * gaps are NOT computed between consecutive CurvePrimitives in "unstructured" collections.  The type is "unstructured" so gaps should not be semantically meaningful.
+     */
+    maxGap(): number;
+    /** return true if the curve collection has any primitives other than LineSegment3d and LineString3d  */
+    checkForNonLinearPrimitives(): boolean;
+    /** Apply transform recursively to children */
+    tryTransformInPlace(transform: Transform): boolean;
+    /** Return a deep copy. */
+    clone(): CurveCollection | undefined;
+    /** Create a deep copy of transformed curves. */
+    cloneTransformed(transform: Transform): CurveCollection | undefined;
+    /** Create a deep copy with all linestrings expanded to multiple LineSegment3d. */
+    cloneWithExpandedLineStrings(): CurveCollection | undefined;
+    /** Recurse through children to collect CurvePrimitive's in flat array. */
+    private collectCurvePrimitivesGo;
+    /**
+     * Return an array containing only the curve primitives.
+     * @param collectorArray optional array to receive primitives.   If present, new primitives are ADDED (without clearing the array.)
+     * @param smallestPossiblePrimitives if false, CurvePrimitiveWithDistanceIndex returns only itself.  If true, it recurses to its (otherwise hidden) children.
+     */
+    collectCurvePrimitives(collectorArray?: CurvePrimitive[], smallestPossiblePrimitives?: boolean, explodeLineStrings?: boolean): CurvePrimitive[];
+    /** Return true for planar region types:
+     * * `Loop`
+     * * `ParityRegion`
+     * * `UnionRegion`
+     */
+    get isAnyRegionType(): boolean;
+    /** Return true for a `Path`, i.e. a chain of curves joined head-to-tail
+     */
+    get isOpenPath(): boolean;
+    /** Return true for a single-loop planar region type, i.e. `Loop`.
+     * * This is _not- a test for physical closure of a `Path`
+     */
+    get isClosedPath(): boolean;
+    /** Return a CurveCollection with the same structure but all curves replaced by strokes. */
+    abstract cloneStroked(options?: StrokeOptions): AnyCurve;
+    /** Support method for ICurvePrimitive ... one line call to specific announce method . . */
+    abstract announceToCurveProcessor(processor: RecursiveCurveProcessor): void;
+    /** clone an empty collection. */
+    abstract cloneEmptyPeer(): CurveCollection;
+    /** Return the boundary type of a corresponding  MicroStation CurveVector.
+     * * Derived class must implement.
+     */
+    abstract dgnBoundaryType(): number;
+    /**
+     * Try to add a child.
+     * @param child child to add.
+     * @return true if child is an acceptable type for this collection.
+     */
+    abstract tryAddChild(child: AnyCurve | undefined): boolean;
+    /** Return a child identified by by index */
+    abstract getChild(i: number): AnyCurve | undefined;
+    /** Extend (increase) `rangeToExtend` as needed to include these curves (optionally transformed) */
+    extendRange(rangeToExtend: Range3d, transform?: Transform): void;
+    /**
+     * * Find any curve primitive in the source.
+     * * Evaluate it at a fraction (which by default is an interior fraction)
+     * @param source containing `CurvePrimitive` or `CurveCollection`
+     * @param fraction fraction to use in `curve.fractionToPoint(fraction)`
+     */
+    static createCurveLocationDetailOnAnyCurvePrimitive(source: GeometryQuery | undefined, fraction?: number): CurveLocationDetail | undefined;
+}
+/** Shared base class for use by both open and closed paths.
+ * - A `CurveChain` contains only curvePrimitives.  No other paths, loops, or regions allowed.
+ * - A single entry in the chain can in fact contain multiple curve primitives if the entry itself is (for instance) `CurveChainWithDistanceIndex`
+ *   which presents itself (through method interface) as a CurvePrimitive with well defined mappings from fraction to xyz, but in fact does all the
+ *   calculations over multiple primitives.
+ * - The specific derived classes are `Path` and `Loop`
+ * - `CurveChain` is an intermediate class.   It is not instantiable on its own.
+ * @see [Curve Collections]($docs/learning/geometry/CurveCollection.md) learning article.
+ * @public
+ */
+export declare abstract class CurveChain extends CurveCollection {
+    /** The curve primitives in the chain. */
+    protected _curves: CurvePrimitive[];
+    protected constructor();
+    /** Return the array of `CurvePrimitive` */
+    get children(): CurvePrimitive[];
+    /**
+     * Return the `[index]` curve primitive, optionally using `modulo` to map`index` to the cyclic indexing.
+     * * In particular, `-1` is the final curve.
+     * @param index cyclic index
+     */
+    cyclicCurvePrimitive(index: number, cyclic?: boolean): CurvePrimitive | undefined;
+    /** Stroke the chain into a simple xyz array.
+     * @param options tolerance parameters controlling the stroking.
+     */
+    getPackedStrokes(options?: StrokeOptions): GrowableXYZArray | undefined;
+    /** Return a structural clone, with CurvePrimitive objects stroked. */
+    abstract cloneStroked(options?: StrokeOptions): AnyCurve;
+    /** add a child curve.
+     * * Returns false if the given child is not a CurvePrimitive.
+     */
+    tryAddChild(child: AnyCurve | undefined): boolean;
+    /** Return a child by index */
+    getChild(i: number): CurvePrimitive | undefined;
+    /** invoke `curve.extendRange(range, transform)` for each child  */
+    extendRange(range: Range3d, transform?: Transform): void;
+    /**
+     * Reverse each child curve (in place)
+     * Reverse the order of the children in the CurveChain array.
+     */
+    reverseChildrenInPlace(): void;
+    /** Evaluate an indexed curve at a fraction.  Return as a CurveLocationDetail that indicates the primitive.
+     */
+    primitiveIndexAndFractionToCurveLocationDetailPointAndDerivative(index: number, fraction: number, cyclic?: boolean, result?: CurveLocationDetail): CurveLocationDetail | undefined;
+}
+/**
+ * * A `BagOfCurves` object is a collection of `AnyCurve` objects.
+ * * A `BagOfCurves` has no implied properties such as being planar.
+ * @public
+ */
+export declare class BagOfCurves extends CurveCollection {
+    /** String name for schema properties */
+    readonly curveCollectionType = "bagOfCurves";
+    /** test if `other` is an instance of `BagOfCurves` */
+    isSameGeometryClass(other: GeometryQuery): boolean;
+    /** Array of children.
+     * * No restrictions on type.
+     */
+    protected _children: AnyCurve[];
+    /** Construct an empty `BagOfCurves` */
+    constructor();
+    /** Return the (reference to) array of children */
+    get children(): AnyCurve[];
+    /** create with given curves. */
+    static create(...data: AnyCurve[]): BagOfCurves;
+    /** Return the boundary type (0) of a corresponding  MicroStation CurveVector */
+    dgnBoundaryType(): number;
+    /** invoke `processor.announceBagOfCurves(this, indexInParent);` */
+    announceToCurveProcessor(processor: RecursiveCurveProcessor, indexInParent?: number): void;
+    /** Clone all children in stroked form. */
+    cloneStroked(options?: StrokeOptions): BagOfCurves;
+    /** Return an empty `BagOfCurves` */
+    cloneEmptyPeer(): BagOfCurves;
+    /** Add a child  */
+    tryAddChild(child: AnyCurve | undefined): boolean;
+    /** Get a child by index */
+    getChild(i: number): AnyCurve | undefined;
+    /** Second step of double dispatch:  call `handler.handleBagOfCurves(this)` */
+    dispatchToGeometryHandler(handler: GeometryHandler): any;
+}
+/**
+ * * Options to control method `RegionOps.consolidateAdjacentPrimitives`
+ * @public
+ */
+export declare class ConsolidateAdjacentCurvePrimitivesOptions {
+    /** True to consolidated linear geometry   (e.g. separate LineSegment3d and LineString3d) into LineString3d */
+    consolidateLinearGeometry: boolean;
+    /** True to consolidate contiguous arcs */
+    consolidateCompatibleArcs: boolean;
+    /** Tolerance for collapsing identical points */
+    duplicatePointTolerance: number;
+    /** Tolerance for removing interior colinear points. */
+    colinearPointTolerance: number;
+}
+//# sourceMappingURL=CurveCollection.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CurveCollection.d.ts","sourceRoot":"","sources":["../../../src/curve/CurveCollection.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAClE,OAAO,EAAE,OAAO,EAAE,MAAM,+BAA+B,CAAC;AACxD,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACxC,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAQhD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD;;;;;;;GAOG;AACH,oBAAY,mBAAmB,GAAG,MAAM,GAAG,MAAM,GAAG,aAAa,GAAG,cAAc,GAAG,aAAa,CAAC;AAEnG;;;;;;;;;;;GAWG;AACH,8BAAsB,eAAgB,SAAQ,aAAa;IACzD,wCAAwC;IACxC,SAAgB,gBAAgB,qBAAqB;IACrD,0BAA0B;IAC1B,kBAAyB,mBAAmB,EAAE,mBAAmB,CAAC;IAGlE,wDAAwD;IACjD,OAAO,EAAE,OAAO,CAAS;IAChC,6DAA6D;IACtD,UAAU,IAAI,MAAM;IAC3B,uDAAuD;IAChD,YAAY,CAAC,UAAU,EAAE,OAAO,GAAG,mBAAmB,GAAG,SAAS;IAgBzE;;;;;OAKG;IACI,MAAM,IAAI,MAAM;IACvB,wGAAwG;IACjG,2BAA2B,IAAI,OAAO;IAC7C,8CAA8C;IACvC,mBAAmB,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO;IACzD,0BAA0B;IACnB,KAAK,IAAI,eAAe,GAAG,SAAS;IAG3C,gDAAgD;IACzC,gBAAgB,CAAC,SAAS,EAAE,SAAS,GAAG,eAAe,GAAG,SAAS;IAG1E,kFAAkF;IAC3E,4BAA4B,IAAI,eAAe,GAAG,SAAS;IAGlE,0EAA0E;IAC1E,OAAO,CAAC,wBAAwB;IAWhC;;;;OAIG;IACI,sBAAsB,CAAC,cAAc,CAAC,EAAE,cAAc,EAAE,EAAE,0BAA0B,GAAE,OAAe,EAAE,kBAAkB,GAAE,OAAe,GAAG,cAAc,EAAE;IAMpK;;;;OAIG;IACH,IAAW,eAAe,IAAI,OAAO,CAEpC;IACD;OACG;IACH,IAAW,UAAU,IAAI,OAAO,CAE/B;IACD;;OAEG;IACH,IAAW,YAAY,IAAI,OAAO,CAEjC;IACD,2FAA2F;aAC3E,YAAY,CAAC,OAAO,CAAC,EAAE,aAAa,GAAG,QAAQ;IAE/D,2FAA2F;aAC3E,wBAAwB,CAAC,SAAS,EAAE,uBAAuB,GAAG,IAAI;IAClF,iCAAiC;aACjB,cAAc,IAAI,eAAe;IACjD;;OAEG;aACa,eAAe,IAAI,MAAM;IACzC;;;;OAIG;aACa,WAAW,CAAC,KAAK,EAAE,QAAQ,GAAG,SAAS,GAAG,OAAO;IACjE,4CAA4C;aAC5B,QAAQ,CAAC,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS;IACzD,mGAAmG;IAC5F,WAAW,CAAC,aAAa,EAAE,OAAO,EAAE,SAAS,CAAC,EAAE,SAAS,GAAG,IAAI;IAQvE;;;;;OAKG;WACW,4CAA4C,CAAC,MAAM,EAAE,aAAa,GAAG,SAAS,EAAE,QAAQ,GAAE,MAAY,GAAG,mBAAmB,GAAG,SAAS;CAavJ;AACD;;;;;;;;;GASG;AACH,8BAAsB,UAAW,SAAQ,eAAe;IACtD,yCAAyC;IACzC,SAAS,CAAC,OAAO,EAAE,cAAc,EAAE,CAAC;IACpC,SAAS;IACT,2CAA2C;IAC3C,IAAoB,QAAQ,IAAI,cAAc,EAAE,CAI/C;IACD;;;;OAIG;IACI,oBAAoB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,GAAE,OAAc,GAAG,cAAc,GAAG,SAAS;IAa9F;;OAEG;IACI,gBAAgB,CAAC,OAAO,CAAC,EAAE,aAAa,GAAG,gBAAgB,GAAG,SAAS;IAY9E,sEAAsE;aAC7C,YAAY,CAAC,OAAO,CAAC,EAAE,aAAa,GAAG,QAAQ;IAWxE;;OAEG;IACI,WAAW,CAAC,KAAK,EAAE,QAAQ,GAAG,SAAS,GAAG,OAAO;IAOxD,8BAA8B;IACvB,QAAQ,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS;IAItD,mEAAmE;IACnD,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,SAAS,CAAC,EAAE,SAAS,GAAG,IAAI;IAIxE;;;OAGG;IACI,sBAAsB;IAK7B;OACG;IACI,gEAAgE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,GAAE,OAAe,EAAE,MAAM,CAAC,EAAE,mBAAmB,GAAG,mBAAmB,GAAG,SAAS;CAOjM;AAED;;;;GAIG;AACH,qBAAa,WAAY,SAAQ,eAAe;IAC9C,wCAAwC;IACxC,SAAgB,mBAAmB,iBAAiB;IAEpD,sDAAsD;IAC/C,mBAAmB,CAAC,KAAK,EAAE,aAAa,GAAG,OAAO;IACzD;;OAEG;IACH,SAAS,CAAC,SAAS,EAAE,QAAQ,EAAE,CAAC;IAChC,uCAAuC;;IAEvC,kDAAkD;IAClD,IAAoB,QAAQ,IAAI,QAAQ,EAAE,CAA2B;IACrE,gCAAgC;WAClB,MAAM,CAAC,GAAG,IAAI,EAAE,QAAQ,EAAE,GAAG,WAAW;IAOtD,gFAAgF;IACzE,eAAe,IAAI,MAAM;IAChC,mEAAmE;IAC5D,wBAAwB,CAAC,SAAS,EAAE,uBAAuB,EAAE,aAAa,GAAE,MAAW,GAAG,IAAI;IAGrG,0CAA0C;IACnC,YAAY,CAAC,OAAO,CAAC,EAAE,aAAa,GAAG,WAAW;IAiBzD,oCAAoC;IAC7B,cAAc,IAAI,WAAW;IACpC,mBAAmB;IACZ,WAAW,CAAC,KAAK,EAAE,QAAQ,GAAG,SAAS,GAAG,OAAO;IAKxD,2BAA2B;IACpB,QAAQ,CAAC,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS;IAKhD,8EAA8E;IACvE,yBAAyB,CAAC,OAAO,EAAE,eAAe,GAAG,GAAG;CAGhE;AACD;;;GAGG;AACH,qBAAa,yCAAyC;IACpD,8GAA8G;IACvG,yBAAyB,EAAE,OAAO,CAAQ;IACjD,0CAA0C;IACnC,yBAAyB,EAAE,OAAO,CAAQ;IACjD,gDAAgD;IACzC,uBAAuB,SAAgC;IAC9D,uDAAuD;IAChD,sBAAsB,SAAgC;CAC9D"}

package/lib/esm/curve/CurveCollection.js

@@ -0,0 +1,338 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Curve
+ */
+import { Geometry } from "../Geometry";
+import { CurveLocationDetail } from "./CurveLocationDetail";
+import { CurvePrimitive } from "./CurvePrimitive";
+import { GeometryQuery } from "./GeometryQuery";
+import { CloneCurvesContext } from "./internalContexts/CloneCurvesContext";
+import { CloneWithExpandedLineStrings } from "./internalContexts/CloneWithExpandedLineStrings";
+import { CountLinearPartsSearchContext } from "./internalContexts/CountLinearPartsSearchContext";
+import { GapSearchContext } from "./internalContexts/GapSearchContext";
+import { SumLengthsContext } from "./internalContexts/SumLengthsContext";
+import { TransformInPlaceContext } from "./internalContexts/TransformInPlaceContext";
+import { LineString3d } from "./LineString3d";
+/**
+ * A `CurveCollection` is an abstract (non-instantiable) class for various sets of curves with particular structures:
+ * - `CurveChain` is a (non-instantiable) intermediate class for a sequence of `CurvePrimitive ` joining head-to-tail.  The two instantiable forms of `CurveChain` are
+ *   - `Path` - A chain not required to close, and not enclosing a planar area
+ *   - `Loop` - A chain required to close from last to first so that a planar area is enclosed.
+ * - `ParityRegion` -- a collection of coplanar `Loop`s, with "in/out" classification by parity rules
+ * - `UnionRegion` -- a collection of coplanar `Loop`s, with "in/out" classification by union rules
+ * - `BagOfCurves` -- a collection of `AnyCurve` with no implied structure.
+ *
+ * @see [Curve Collections]($docs/learning/geometry/CurveCollection.md) learning article.
+ * @public
+ */
+export class CurveCollection extends GeometryQuery {
+    constructor() {
+        super(...arguments);
+        /** String name for schema properties */
+        this.geometryCategory = "curveCollection";
+        /* eslint-disable @typescript-eslint/naming-convention, no-empty */
+        /**  Flag for inner loop status. Only used by `Loop`. */
+        this.isInner = false;
+    }
+    /** Return the sum of the lengths of all contained curves. */
+    sumLengths() { return SumLengthsContext.sumLengths(this); }
+    /** Return the closest point on the contained curves */
+    closestPoint(spacePoint) {
+        let detailA;
+        if (this.children !== undefined) {
+            for (const child of this.children) {
+                if (child instanceof CurvePrimitive) {
+                    const detailB = child.closestPoint(spacePoint, false);
+                    detailA = CurveLocationDetail.chooseSmallerA(detailA, detailB);
+                }
+                else if (child instanceof CurveCollection) {
+                    const detailB = child.closestPoint(spacePoint);
+                    detailA = CurveLocationDetail.chooseSmallerA(detailA, detailB);
+                }
+            }
+        }
+        return detailA;
+    }
+    /** return the max gap between adjacent primitives in Path and Loop collections.
+     *
+     * * In a Path, gaps are computed between consecutive primitives.
+     * * In a Loop, gaps are computed between consecutive primitives and between last and first.
+     * * gaps are NOT computed between consecutive CurvePrimitives in "unstructured" collections.  The type is "unstructured" so gaps should not be semantically meaningful.
+     */
+    maxGap() { return GapSearchContext.maxGap(this); }
+    /** return true if the curve collection has any primitives other than LineSegment3d and LineString3d  */
+    checkForNonLinearPrimitives() { return CountLinearPartsSearchContext.hasNonLinearPrimitives(this); }
+    /** Apply transform recursively to children */
+    tryTransformInPlace(transform) { return TransformInPlaceContext.tryTransformInPlace(this, transform); }
+    /** Return a deep copy. */
+    clone() {
+        return CloneCurvesContext.clone(this);
+    }
+    /** Create a deep copy of transformed curves. */
+    cloneTransformed(transform) {
+        return CloneCurvesContext.clone(this, transform);
+    }
+    /** Create a deep copy with all linestrings expanded to multiple LineSegment3d. */
+    cloneWithExpandedLineStrings() {
+        return CloneWithExpandedLineStrings.clone(this);
+    }
+    /** Recurse through children to collect CurvePrimitive's in flat array. */
+    collectCurvePrimitivesGo(results, smallestPossiblePrimitives, explodeLinestrings = false) {
+        if (this.children) {
+            for (const child of this.children) {
+                if (child instanceof CurvePrimitive)
+                    child.collectCurvePrimitivesGo(results, smallestPossiblePrimitives, explodeLinestrings);
+                else if (child instanceof CurveCollection)
+                    child.collectCurvePrimitivesGo(results, smallestPossiblePrimitives, explodeLinestrings);
+            }
+        }
+    }
+    /**
+     * Return an array containing only the curve primitives.
+     * @param collectorArray optional array to receive primitives.   If present, new primitives are ADDED (without clearing the array.)
+     * @param smallestPossiblePrimitives if false, CurvePrimitiveWithDistanceIndex returns only itself.  If true, it recurses to its (otherwise hidden) children.
+     */
+    collectCurvePrimitives(collectorArray, smallestPossiblePrimitives = false, explodeLineStrings = false) {
+        const results = collectorArray === undefined ? [] : collectorArray;
+        this.collectCurvePrimitivesGo(results, smallestPossiblePrimitives, explodeLineStrings);
+        return results;
+    }
+    /** Return true for planar region types:
+     * * `Loop`
+     * * `ParityRegion`
+     * * `UnionRegion`
+     */
+    get isAnyRegionType() {
+        return this.dgnBoundaryType() === 2 || this.dgnBoundaryType() === 5 || this.dgnBoundaryType() === 4;
+    }
+    /** Return true for a `Path`, i.e. a chain of curves joined head-to-tail
+     */
+    get isOpenPath() {
+        return this.dgnBoundaryType() === 1;
+    }
+    /** Return true for a single-loop planar region type, i.e. `Loop`.
+     * * This is _not- a test for physical closure of a `Path`
+     */
+    get isClosedPath() {
+        return this.dgnBoundaryType() === 2;
+    }
+    /** Extend (increase) `rangeToExtend` as needed to include these curves (optionally transformed) */
+    extendRange(rangeToExtend, transform) {
+        const children = this.children;
+        if (children) {
+            for (const c of children) {
+                c.extendRange(rangeToExtend, transform);
+            }
+        }
+    }
+    /**
+     * * Find any curve primitive in the source.
+     * * Evaluate it at a fraction (which by default is an interior fraction)
+     * @param source containing `CurvePrimitive` or `CurveCollection`
+     * @param fraction fraction to use in `curve.fractionToPoint(fraction)`
+     */
+    static createCurveLocationDetailOnAnyCurvePrimitive(source, fraction = 0.5) {
+        if (!source)
+            return undefined;
+        if (source instanceof CurvePrimitive) {
+            return CurveLocationDetail.createCurveEvaluatedFraction(source, fraction);
+        }
+        else if (source instanceof CurveCollection && source.children !== undefined)
+            for (const child of source.children) {
+                const detail = this.createCurveLocationDetailOnAnyCurvePrimitive(child, fraction);
+                if (detail)
+                    return detail;
+            }
+        return undefined;
+    }
+}
+/** Shared base class for use by both open and closed paths.
+ * - A `CurveChain` contains only curvePrimitives.  No other paths, loops, or regions allowed.
+ * - A single entry in the chain can in fact contain multiple curve primitives if the entry itself is (for instance) `CurveChainWithDistanceIndex`
+ *   which presents itself (through method interface) as a CurvePrimitive with well defined mappings from fraction to xyz, but in fact does all the
+ *   calculations over multiple primitives.
+ * - The specific derived classes are `Path` and `Loop`
+ * - `CurveChain` is an intermediate class.   It is not instantiable on its own.
+ * @see [Curve Collections]($docs/learning/geometry/CurveCollection.md) learning article.
+ * @public
+ */
+export class CurveChain extends CurveCollection {
+    constructor() { super(); this._curves = []; }
+    /** Return the array of `CurvePrimitive` */
+    get children() {
+        if (this._curves === undefined)
+            this._curves = [];
+        return this._curves;
+    }
+    /**
+     * Return the `[index]` curve primitive, optionally using `modulo` to map`index` to the cyclic indexing.
+     * * In particular, `-1` is the final curve.
+     * @param index cyclic index
+     */
+    cyclicCurvePrimitive(index, cyclic = true) {
+        const n = this.children.length;
+        if (n === 0)
+            return undefined;
+        /** Try simplest non-cyclic access first . . */
+        if (index >= 0 && index < n)
+            return this.children[index];
+        if (cyclic) {
+            const index2 = Geometry.modulo(index, n);
+            return this.children[index2];
+        }
+        return undefined;
+    }
+    /** Stroke the chain into a simple xyz array.
+     * @param options tolerance parameters controlling the stroking.
+     */
+    getPackedStrokes(options) {
+        const tree = this.cloneStroked(options);
+        if (tree instanceof CurveChain) {
+            const children = tree.children;
+            if (children.length === 1) {
+                const ls = children[0];
+                if (ls instanceof LineString3d)
+                    return ls.packedPoints;
+            }
+        }
+        return undefined;
+    }
+    /*  EDL 01/20 Path, Loop, CurveChainWithDistanceIndex all implement this.
+        Reducing it to abstract.
+        Hypothetically, a derived class in the wild might be depending on this.
+     {
+      const strokes = LineString3d.create();
+      for (const curve of this.children)
+        curve.emitStrokes(strokes, options);
+      return strokes;
+    }
+    */
+    /** add a child curve.
+     * * Returns false if the given child is not a CurvePrimitive.
+     */
+    tryAddChild(child) {
+        if (child && child instanceof CurvePrimitive) {
+            this._curves.push(child);
+            return true;
+        }
+        return false;
+    }
+    /** Return a child by index */
+    getChild(i) {
+        if (i < this._curves.length)
+            return this._curves[i];
+        return undefined;
+    }
+    /** invoke `curve.extendRange(range, transform)` for each child  */
+    extendRange(range, transform) {
+        for (const curve of this._curves)
+            curve.extendRange(range, transform);
+    }
+    /**
+     * Reverse each child curve (in place)
+     * Reverse the order of the children in the CurveChain array.
+     */
+    reverseChildrenInPlace() {
+        for (const curve of this._curves)
+            curve.reverseInPlace();
+        this._curves.reverse();
+    }
+    /** Evaluate an indexed curve at a fraction.  Return as a CurveLocationDetail that indicates the primitive.
+     */
+    primitiveIndexAndFractionToCurveLocationDetailPointAndDerivative(index, fraction, cyclic = false, result) {
+        const primitive = this.cyclicCurvePrimitive(index, cyclic);
+        if (primitive) {
+            return CurveLocationDetail.createCurveEvaluatedFractionPointAndDerivative(primitive, fraction, result);
+        }
+        return undefined;
+    }
+}
+/**
+ * * A `BagOfCurves` object is a collection of `AnyCurve` objects.
+ * * A `BagOfCurves` has no implied properties such as being planar.
+ * @public
+ */
+export class BagOfCurves extends CurveCollection {
+    /** Construct an empty `BagOfCurves` */
+    constructor() {
+        super();
+        /** String name for schema properties */
+        this.curveCollectionType = "bagOfCurves";
+        this._children = [];
+    }
+    /** test if `other` is an instance of `BagOfCurves` */
+    isSameGeometryClass(other) { return other instanceof BagOfCurves; }
+    /** Return the (reference to) array of children */
+    get children() { return this._children; }
+    /** create with given curves. */
+    static create(...data) {
+        const result = new BagOfCurves();
+        for (const child of data) {
+            result.tryAddChild(child);
+        }
+        return result;
+    }
+    /** Return the boundary type (0) of a corresponding  MicroStation CurveVector */
+    dgnBoundaryType() { return 0; }
+    /** invoke `processor.announceBagOfCurves(this, indexInParent);` */
+    announceToCurveProcessor(processor, indexInParent = -1) {
+        return processor.announceBagOfCurves(this, indexInParent);
+    }
+    /** Clone all children in stroked form. */
+    cloneStroked(options) {
+        const clone = new BagOfCurves();
+        let child;
+        for (child of this.children) {
+            if (child instanceof CurvePrimitive) {
+                const ls = LineString3d.create();
+                child.emitStrokes(ls, options);
+                if (ls)
+                    clone.children.push(ls);
+            }
+            else if (child instanceof CurveCollection) {
+                const childStrokes = child.cloneStroked(options);
+                if (childStrokes)
+                    clone.children.push(childStrokes);
+            }
+        }
+        return clone;
+    }
+    /** Return an empty `BagOfCurves` */
+    cloneEmptyPeer() { return new BagOfCurves(); }
+    /** Add a child  */
+    tryAddChild(child) {
+        if (child)
+            this._children.push(child);
+        return true;
+    }
+    /** Get a child by index */
+    getChild(i) {
+        if (i < this._children.length)
+            return this._children[i];
+        return undefined;
+    }
+    /** Second step of double dispatch:  call `handler.handleBagOfCurves(this)` */
+    dispatchToGeometryHandler(handler) {
+        return handler.handleBagOfCurves(this);
+    }
+}
+/**
+ * * Options to control method `RegionOps.consolidateAdjacentPrimitives`
+ * @public
+ */
+export class ConsolidateAdjacentCurvePrimitivesOptions {
+    constructor() {
+        /** True to consolidated linear geometry   (e.g. separate LineSegment3d and LineString3d) into LineString3d */
+        this.consolidateLinearGeometry = true;
+        /** True to consolidate contiguous arcs */
+        this.consolidateCompatibleArcs = true;
+        /** Tolerance for collapsing identical points */
+        this.duplicatePointTolerance = Geometry.smallMetricDistance;
+        /** Tolerance for removing interior colinear points. */
+        this.colinearPointTolerance = Geometry.smallMetricDistance;
+    }
+}
+//# sourceMappingURL=CurveCollection.js.map

package/lib/esm/curve/CurveCollection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CurveCollection.js","sourceRoot":"","sources":["../../../src/curve/CurveCollection.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F;;GAEG;AACH,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAOvC,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAC;AAC3E,OAAO,EAAE,4BAA4B,EAAE,MAAM,iDAAiD,CAAC;AAC/F,OAAO,EAAE,6BAA6B,EAAE,MAAM,kDAAkD,CAAC;AACjG,OAAO,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AACvE,OAAO,EAAE,iBAAiB,EAAE,MAAM,sCAAsC,CAAC;AACzE,OAAO,EAAE,uBAAuB,EAAE,MAAM,4CAA4C,CAAC;AACrF,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAa9C;;;;;;;;;;;GAWG;AACH,MAAM,OAAgB,eAAgB,SAAQ,aAAa;IAA3D;;QACE,wCAAwC;QACxB,qBAAgB,GAAG,iBAAiB,CAAC;QAIrD,mEAAmE;QACnE,wDAAwD;QACjD,YAAO,GAAY,KAAK,CAAC;IAoIlC,CAAC;IAnIC,6DAA6D;IACtD,UAAU,KAAa,OAAO,iBAAiB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC1E,uDAAuD;IAChD,YAAY,CAAC,UAAmB;QACrC,IAAI,OAAwC,CAAC;QAC7C,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE;YAC/B,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,EAAE;gBACjC,IAAI,KAAK,YAAY,cAAc,EAAE;oBACnC,MAAM,OAAO,GAAG,KAAK,CAAC,YAAY,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;oBACtD,OAAO,GAAG,mBAAmB,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;iBAChE;qBAAM,IAAI,KAAK,YAAY,eAAe,EAAE;oBAC3C,MAAM,OAAO,GAAG,KAAK,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;oBAC/C,OAAO,GAAG,mBAAmB,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;iBAChE;aACF;SACF;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;OAKG;IACI,MAAM,KAAa,OAAO,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACjE,wGAAwG;IACjG,2BAA2B,KAAc,OAAO,6BAA6B,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpH,8CAA8C;IACvC,mBAAmB,CAAC,SAAoB,IAAa,OAAO,uBAAuB,CAAC,mBAAmB,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;IAClI,0BAA0B;IACnB,KAAK;QACV,OAAO,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC;IACD,gDAAgD;IACzC,gBAAgB,CAAC,SAAoB;QAC1C,OAAO,kBAAkB,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IACnD,CAAC;IACD,kFAAkF;IAC3E,4BAA4B;QACjC,OAAO,4BAA4B,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAClD,CAAC;IACD,0EAA0E;IAClE,wBAAwB,CAAC,OAAyB,EAAE,0BAAmC,EAAE,qBAA8B,KAAK;QAClI,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,EAAE;gBACjC,IAAI,KAAK,YAAY,cAAc;oBACjC,KAAK,CAAC,wBAAwB,CAAC,OAAO,EAAE,0BAA0B,EAAE,kBAAkB,CAAC,CAAC;qBACrF,IAAI,KAAK,YAAY,eAAe;oBACvC,KAAK,CAAC,wBAAwB,CAAC,OAAO,EAAE,0BAA0B,EAAE,kBAAkB,CAAC,CAAC;aAC3F;SACF;IACH,CAAC;IAED;;;;OAIG;IACI,sBAAsB,CAAC,cAAiC,EAAE,6BAAsC,KAAK,EAAE,qBAA8B,KAAK;QAC/I,MAAM,OAAO,GAAqB,cAAc,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC;QACrF,IAAI,CAAC,wBAAwB,CAAC,OAAO,EAAE,0BAA0B,EAAE,kBAAkB,CAAC,CAAC;QACvF,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACH,IAAW,eAAe;QACxB,OAAO,IAAI,CAAC,eAAe,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,eAAe,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;IACtG,CAAC;IACD;OACG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;IACtC,CAAC;IACD;;OAEG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;IACtC,CAAC;IAoBD,mGAAmG;IAC5F,WAAW,CAAC,aAAsB,EAAE,SAAqB;QAC9D,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC/B,IAAI,QAAQ,EAAE;YACZ,KAAK,MAAM,CAAC,IAAI,QAAQ,EAAE;gBACxB,CAAC,CAAC,WAAW,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;aACzC;SACF;IACH,CAAC;IACD;;;;;OAKG;IACI,MAAM,CAAC,4CAA4C,CAAC,MAAiC,EAAE,WAAmB,GAAG;QAClH,IAAI,CAAC,MAAM;YACT,OAAO,SAAS,CAAC;QACnB,IAAI,MAAM,YAAY,cAAc,EAAE;YACpC,OAAO,mBAAmB,CAAC,4BAA4B,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;SAC3E;aAAM,IAAI,MAAM,YAAY,eAAe,IAAI,MAAM,CAAC,QAAQ,KAAK,SAAS;YAC3E,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,QAAQ,EAAE;gBACnC,MAAM,MAAM,GAAG,IAAI,CAAC,4CAA4C,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;gBAClF,IAAI,MAAM;oBACR,OAAO,MAAM,CAAC;aACjB;QACH,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AACD;;;;;;;;;GASG;AACH,MAAM,OAAgB,UAAW,SAAQ,eAAe;IAGtD,gBAA0B,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC,CAAC,CAAC;IACvD,2CAA2C;IAC3C,IAAoB,QAAQ;QAC1B,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS;YAC5B,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QACpB,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IACD;;;;OAIG;IACI,oBAAoB,CAAC,KAAa,EAAE,SAAkB,IAAI;QAC/D,MAAM,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;QAC/B,IAAI,CAAC,KAAK,CAAC;YACT,OAAO,SAAS,CAAC;QACnB,+CAA+C;QAC/C,IAAI,KAAK,IAAI,CAAC,IAAI,KAAK,GAAG,CAAC;YACzB,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC9B,IAAI,MAAM,EAAE;YACV,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YACzC,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;SAC9B;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD;;OAEG;IACI,gBAAgB,CAAC,OAAuB;QAC7C,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QACxC,IAAI,IAAI,YAAY,UAAU,EAAE;YAC9B,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;YAC/B,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;gBACzB,MAAM,EAAE,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;gBACvB,IAAI,EAAE,YAAY,YAAY;oBAC5B,OAAO,EAAE,CAAC,YAAY,CAAC;aAC1B;SACF;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAGD;;;;;;;;;MASE;IACF;;OAEG;IACI,WAAW,CAAC,KAA2B;QAC5C,IAAI,KAAK,IAAI,KAAK,YAAY,cAAc,EAAE;YAC5C,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACzB,OAAO,IAAI,CAAC;SACb;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IACD,8BAA8B;IACvB,QAAQ,CAAC,CAAS;QACvB,IAAI,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM;YAAE,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QACpD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,mEAAmE;IACnD,WAAW,CAAC,KAAc,EAAE,SAAqB;QAC/D,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO;YAC9B,KAAK,CAAC,WAAW,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;IACxC,CAAC;IACD;;;OAGG;IACI,sBAAsB;QAC3B,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO;YAC9B,KAAK,CAAC,cAAc,EAAE,CAAC;QACzB,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;IACzB,CAAC;IACD;OACG;IACI,gEAAgE,CAAC,KAAa,EAAE,QAAgB,EAAE,SAAkB,KAAK,EAAE,MAA4B;QAC5J,MAAM,SAAS,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC3D,IAAI,SAAS,EAAE;YACb,OAAO,mBAAmB,CAAC,8CAA8C,CAAC,SAAS,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;SACxG;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,WAAY,SAAQ,eAAe;IAU9C,uCAAuC;IACvC;QAAuB,KAAK,EAAE,CAAC;QAV/B,wCAAwC;QACxB,wBAAmB,GAAG,aAAa,CAAC;QASpB,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;IAAC,CAAC;IAPtD,sDAAsD;IAC/C,mBAAmB,CAAC,KAAoB,IAAa,OAAO,KAAK,YAAY,WAAW,CAAC,CAAC,CAAC;IAOlG,kDAAkD;IAClD,IAAoB,QAAQ,KAAiB,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IACrE,gCAAgC;IACzB,MAAM,CAAC,MAAM,CAAC,GAAG,IAAgB;QACtC,MAAM,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC;QACjC,KAAK,MAAM,KAAK,IAAI,IAAI,EAAE;YACxB,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;SAC3B;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,gFAAgF;IACzE,eAAe,KAAa,OAAO,CAAC,CAAC,CAAC,CAAC;IAC9C,mEAAmE;IAC5D,wBAAwB,CAAC,SAAkC,EAAE,gBAAwB,CAAC,CAAC;QAC5F,OAAO,SAAS,CAAC,mBAAmB,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;IAC5D,CAAC;IACD,0CAA0C;IACnC,YAAY,CAAC,OAAuB;QACzC,MAAM,KAAK,GAAG,IAAI,WAAW,EAAE,CAAC;QAChC,IAAI,KAAK,CAAC;QACV,KAAK,KAAK,IAAI,IAAI,CAAC,QAAQ,EAAE;YAC3B,IAAI,KAAK,YAAY,cAAc,EAAE;gBACnC,MAAM,EAAE,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC;gBACjC,KAAK,CAAC,WAAW,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;gBAC/B,IAAI,EAAE;oBACJ,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;aAC3B;iBAAM,IAAI,KAAK,YAAY,eAAe,EAAE;gBAC3C,MAAM,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;gBACjD,IAAI,YAAY;oBACd,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;aACrC;SACF;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IACD,oCAAoC;IAC7B,cAAc,KAAkB,OAAO,IAAI,WAAW,EAAE,CAAC,CAAC,CAAC;IAClE,mBAAmB;IACZ,WAAW,CAAC,KAA2B;QAC5C,IAAI,KAAK;YACP,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IACD,2BAA2B;IACpB,QAAQ,CAAC,CAAS;QACvB,IAAI,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM;YAC3B,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAC3B,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,8EAA8E;IACvE,yBAAyB,CAAC,OAAwB;QACvD,OAAO,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC;CACF;AACD;;;GAGG;AACH,MAAM,OAAO,yCAAyC;IAAtD;QACE,8GAA8G;QACvG,8BAAyB,GAAY,IAAI,CAAC;QACjD,0CAA0C;QACnC,8BAAyB,GAAY,IAAI,CAAC;QACjD,gDAAgD;QACzC,4BAAuB,GAAG,QAAQ,CAAC,mBAAmB,CAAC;QAC9D,uDAAuD;QAChD,2BAAsB,GAAG,QAAQ,CAAC,mBAAmB,CAAC;IAC/D,CAAC;CAAA","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\n/** @packageDocumentation\r\n * @module Curve\r\n */\r\nimport { Geometry } from \"../Geometry\";\r\nimport { GeometryHandler } from \"../geometry3d/GeometryHandler\";\r\nimport { GrowableXYZArray } from \"../geometry3d/GrowableXYZArray\";\r\nimport { Point3d } from \"../geometry3d/Point3dVector3d\";\r\nimport { Range3d } from \"../geometry3d/Range\";\r\nimport { Transform } from \"../geometry3d/Transform\";\r\nimport { AnyCurve } from \"./CurveChain\";\r\nimport { CurveLocationDetail } from \"./CurveLocationDetail\";\r\nimport { CurvePrimitive } from \"./CurvePrimitive\";\r\nimport { RecursiveCurveProcessor } from \"./CurveProcessor\";\r\nimport { GeometryQuery } from \"./GeometryQuery\";\r\nimport { CloneCurvesContext } from \"./internalContexts/CloneCurvesContext\";\r\nimport { CloneWithExpandedLineStrings } from \"./internalContexts/CloneWithExpandedLineStrings\";\r\nimport { CountLinearPartsSearchContext } from \"./internalContexts/CountLinearPartsSearchContext\";\r\nimport { GapSearchContext } from \"./internalContexts/GapSearchContext\";\r\nimport { SumLengthsContext } from \"./internalContexts/SumLengthsContext\";\r\nimport { TransformInPlaceContext } from \"./internalContexts/TransformInPlaceContext\";\r\nimport { LineString3d } from \"./LineString3d\";\r\nimport { StrokeOptions } from \"./StrokeOptions\";\r\n\r\n/** Describes the concrete type of a [[CurveCollection]]. Each type name maps to a specific subclass and can be used in conditional statements for type-switching.\r\n *    - \"loop\" => [[Loop]]\r\n *    - \"path\" => [[Path]]\r\n *    - \"unionRegion\" => [[UnionRegion]]\r\n *    - \"parityRegion\" => [[ParityRegion]]\r\n *    - \"bagOfCurves\" => [[BagOfCurves]]\r\n * @public\r\n */\r\nexport type CurveCollectionType = \"loop\" | \"path\" | \"unionRegion\" | \"parityRegion\" | \"bagOfCurves\";\r\n\r\n/**\r\n * A `CurveCollection` is an abstract (non-instantiable) class for various sets of curves with particular structures:\r\n * - `CurveChain` is a (non-instantiable) intermediate class for a sequence of `CurvePrimitive ` joining head-to-tail.  The two instantiable forms of `CurveChain` are\r\n *   - `Path` - A chain not required to close, and not enclosing a planar area\r\n *   - `Loop` - A chain required to close from last to first so that a planar area is enclosed.\r\n * - `ParityRegion` -- a collection of coplanar `Loop`s, with \"in/out\" classification by parity rules\r\n * - `UnionRegion` -- a collection of coplanar `Loop`s, with \"in/out\" classification by union rules\r\n * - `BagOfCurves` -- a collection of `AnyCurve` with no implied structure.\r\n *\r\n * @see [Curve Collections]($docs/learning/geometry/CurveCollection.md) learning article.\r\n * @public\r\n */\r\nexport abstract class CurveCollection extends GeometryQuery {\r\n  /** String name for schema properties */\r\n  public readonly geometryCategory = \"curveCollection\";\r\n  /** Type discriminator. */\r\n  public abstract readonly curveCollectionType: CurveCollectionType;\r\n\r\n  /* eslint-disable @typescript-eslint/naming-convention, no-empty */\r\n  /**  Flag for inner loop status. Only used by `Loop`. */\r\n  public isInner: boolean = false;\r\n  /** Return the sum of the lengths of all contained curves. */\r\n  public sumLengths(): number { return SumLengthsContext.sumLengths(this); }\r\n  /** Return the closest point on the contained curves */\r\n  public closestPoint(spacePoint: Point3d): CurveLocationDetail | undefined {\r\n    let detailA: CurveLocationDetail | undefined;\r\n    if (this.children !== undefined) {\r\n      for (const child of this.children) {\r\n        if (child instanceof CurvePrimitive) {\r\n          const detailB = child.closestPoint(spacePoint, false);\r\n          detailA = CurveLocationDetail.chooseSmallerA(detailA, detailB);\r\n        } else if (child instanceof CurveCollection) {\r\n          const detailB = child.closestPoint(spacePoint);\r\n          detailA = CurveLocationDetail.chooseSmallerA(detailA, detailB);\r\n        }\r\n      }\r\n    }\r\n    return detailA;\r\n  }\r\n\r\n  /** return the max gap between adjacent primitives in Path and Loop collections.\r\n   *\r\n   * * In a Path, gaps are computed between consecutive primitives.\r\n   * * In a Loop, gaps are computed between consecutive primitives and between last and first.\r\n   * * gaps are NOT computed between consecutive CurvePrimitives in \"unstructured\" collections.  The type is \"unstructured\" so gaps should not be semantically meaningful.\r\n   */\r\n  public maxGap(): number { return GapSearchContext.maxGap(this); }\r\n  /** return true if the curve collection has any primitives other than LineSegment3d and LineString3d  */\r\n  public checkForNonLinearPrimitives(): boolean { return CountLinearPartsSearchContext.hasNonLinearPrimitives(this); }\r\n  /** Apply transform recursively to children */\r\n  public tryTransformInPlace(transform: Transform): boolean { return TransformInPlaceContext.tryTransformInPlace(this, transform); }\r\n  /** Return a deep copy. */\r\n  public clone(): CurveCollection | undefined {\r\n    return CloneCurvesContext.clone(this);\r\n  }\r\n  /** Create a deep copy of transformed curves. */\r\n  public cloneTransformed(transform: Transform): CurveCollection | undefined {\r\n    return CloneCurvesContext.clone(this, transform);\r\n  }\r\n  /** Create a deep copy with all linestrings expanded to multiple LineSegment3d. */\r\n  public cloneWithExpandedLineStrings(): CurveCollection | undefined {\r\n    return CloneWithExpandedLineStrings.clone(this);\r\n  }\r\n  /** Recurse through children to collect CurvePrimitive's in flat array. */\r\n  private collectCurvePrimitivesGo(results: CurvePrimitive[], smallestPossiblePrimitives: boolean, explodeLinestrings: boolean = false) {\r\n    if (this.children) {\r\n      for (const child of this.children) {\r\n        if (child instanceof CurvePrimitive)\r\n          child.collectCurvePrimitivesGo(results, smallestPossiblePrimitives, explodeLinestrings);\r\n        else if (child instanceof CurveCollection)\r\n          child.collectCurvePrimitivesGo(results, smallestPossiblePrimitives, explodeLinestrings);\r\n      }\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Return an array containing only the curve primitives.\r\n   * @param collectorArray optional array to receive primitives.   If present, new primitives are ADDED (without clearing the array.)\r\n   * @param smallestPossiblePrimitives if false, CurvePrimitiveWithDistanceIndex returns only itself.  If true, it recurses to its (otherwise hidden) children.\r\n   */\r\n  public collectCurvePrimitives(collectorArray?: CurvePrimitive[], smallestPossiblePrimitives: boolean = false, explodeLineStrings: boolean = false): CurvePrimitive[] {\r\n    const results: CurvePrimitive[] = collectorArray === undefined ? [] : collectorArray;\r\n    this.collectCurvePrimitivesGo(results, smallestPossiblePrimitives, explodeLineStrings);\r\n    return results;\r\n  }\r\n\r\n  /** Return true for planar region types:\r\n   * * `Loop`\r\n   * * `ParityRegion`\r\n   * * `UnionRegion`\r\n   */\r\n  public get isAnyRegionType(): boolean {\r\n    return this.dgnBoundaryType() === 2 || this.dgnBoundaryType() === 5 || this.dgnBoundaryType() === 4;\r\n  }\r\n  /** Return true for a `Path`, i.e. a chain of curves joined head-to-tail\r\n   */\r\n  public get isOpenPath(): boolean {\r\n    return this.dgnBoundaryType() === 1;\r\n  }\r\n  /** Return true for a single-loop planar region type, i.e. `Loop`.\r\n   * * This is _not- a test for physical closure of a `Path`\r\n   */\r\n  public get isClosedPath(): boolean {\r\n    return this.dgnBoundaryType() === 2;\r\n  }\r\n  /** Return a CurveCollection with the same structure but all curves replaced by strokes. */\r\n  public abstract cloneStroked(options?: StrokeOptions): AnyCurve;\r\n\r\n  /** Support method for ICurvePrimitive ... one line call to specific announce method . . */\r\n  public abstract announceToCurveProcessor(processor: RecursiveCurveProcessor): void;\r\n  /** clone an empty collection. */\r\n  public abstract cloneEmptyPeer(): CurveCollection;\r\n  /** Return the boundary type of a corresponding  MicroStation CurveVector.\r\n   * * Derived class must implement.\r\n   */\r\n  public abstract dgnBoundaryType(): number;\r\n  /**\r\n   * Try to add a child.\r\n   * @param child child to add.\r\n   * @return true if child is an acceptable type for this collection.\r\n   */\r\n  public abstract tryAddChild(child: AnyCurve | undefined): boolean;\r\n  /** Return a child identified by by index */\r\n  public abstract getChild(i: number): AnyCurve | undefined;\r\n  /** Extend (increase) `rangeToExtend` as needed to include these curves (optionally transformed) */\r\n  public extendRange(rangeToExtend: Range3d, transform?: Transform): void {\r\n    const children = this.children;\r\n    if (children) {\r\n      for (const c of children) {\r\n        c.extendRange(rangeToExtend, transform);\r\n      }\r\n    }\r\n  }\r\n  /**\r\n   * * Find any curve primitive in the source.\r\n   * * Evaluate it at a fraction (which by default is an interior fraction)\r\n   * @param source containing `CurvePrimitive` or `CurveCollection`\r\n   * @param fraction fraction to use in `curve.fractionToPoint(fraction)`\r\n   */\r\n  public static createCurveLocationDetailOnAnyCurvePrimitive(source: GeometryQuery | undefined, fraction: number = 0.5): CurveLocationDetail | undefined {\r\n    if (!source)\r\n      return undefined;\r\n    if (source instanceof CurvePrimitive) {\r\n      return CurveLocationDetail.createCurveEvaluatedFraction(source, fraction);\r\n    } else if (source instanceof CurveCollection && source.children !== undefined)\r\n      for (const child of source.children) {\r\n        const detail = this.createCurveLocationDetailOnAnyCurvePrimitive(child, fraction);\r\n        if (detail)\r\n          return detail;\r\n      }\r\n    return undefined;\r\n  }\r\n}\r\n/** Shared base class for use by both open and closed paths.\r\n * - A `CurveChain` contains only curvePrimitives.  No other paths, loops, or regions allowed.\r\n * - A single entry in the chain can in fact contain multiple curve primitives if the entry itself is (for instance) `CurveChainWithDistanceIndex`\r\n *   which presents itself (through method interface) as a CurvePrimitive with well defined mappings from fraction to xyz, but in fact does all the\r\n *   calculations over multiple primitives.\r\n * - The specific derived classes are `Path` and `Loop`\r\n * - `CurveChain` is an intermediate class.   It is not instantiable on its own.\r\n * @see [Curve Collections]($docs/learning/geometry/CurveCollection.md) learning article.\r\n * @public\r\n */\r\nexport abstract class CurveChain extends CurveCollection {\r\n  /** The curve primitives in the chain. */\r\n  protected _curves: CurvePrimitive[];\r\n  protected constructor() { super(); this._curves = []; }\r\n  /** Return the array of `CurvePrimitive` */\r\n  public override get children(): CurvePrimitive[] {\r\n    if (this._curves === undefined)\r\n      this._curves = [];\r\n    return this._curves;\r\n  }\r\n  /**\r\n   * Return the `[index]` curve primitive, optionally using `modulo` to map`index` to the cyclic indexing.\r\n   * * In particular, `-1` is the final curve.\r\n   * @param index cyclic index\r\n   */\r\n  public cyclicCurvePrimitive(index: number, cyclic: boolean = true): CurvePrimitive | undefined {\r\n    const n = this.children.length;\r\n    if (n === 0)\r\n      return undefined;\r\n    /** Try simplest non-cyclic access first . . */\r\n    if (index >= 0 && index < n)\r\n      return this.children[index];\r\n    if (cyclic) {\r\n      const index2 = Geometry.modulo(index, n);\r\n      return this.children[index2];\r\n    }\r\n    return undefined;\r\n  }\r\n  /** Stroke the chain into a simple xyz array.\r\n   * @param options tolerance parameters controlling the stroking.\r\n   */\r\n  public getPackedStrokes(options?: StrokeOptions): GrowableXYZArray | undefined {\r\n    const tree = this.cloneStroked(options);\r\n    if (tree instanceof CurveChain) {\r\n      const children = tree.children;\r\n      if (children.length === 1) {\r\n        const ls = children[0];\r\n        if (ls instanceof LineString3d)\r\n          return ls.packedPoints;\r\n      }\r\n    }\r\n    return undefined;\r\n  }\r\n  /** Return a structural clone, with CurvePrimitive objects stroked. */\r\n  public abstract override cloneStroked(options?: StrokeOptions): AnyCurve;\r\n  /*  EDL 01/20 Path, Loop, CurveChainWithDistanceIndex all implement this.\r\n      Reducing it to abstract.\r\n      Hypothetically, a derived class in the wild might be depending on this.\r\n   {\r\n    const strokes = LineString3d.create();\r\n    for (const curve of this.children)\r\n      curve.emitStrokes(strokes, options);\r\n    return strokes;\r\n  }\r\n  */\r\n  /** add a child curve.\r\n   * * Returns false if the given child is not a CurvePrimitive.\r\n   */\r\n  public tryAddChild(child: AnyCurve | undefined): boolean {\r\n    if (child && child instanceof CurvePrimitive) {\r\n      this._curves.push(child);\r\n      return true;\r\n    }\r\n    return false;\r\n  }\r\n  /** Return a child by index */\r\n  public getChild(i: number): CurvePrimitive | undefined {\r\n    if (i < this._curves.length) return this._curves[i];\r\n    return undefined;\r\n  }\r\n  /** invoke `curve.extendRange(range, transform)` for each child  */\r\n  public override extendRange(range: Range3d, transform?: Transform): void {\r\n    for (const curve of this._curves)\r\n      curve.extendRange(range, transform);\r\n  }\r\n  /**\r\n   * Reverse each child curve (in place)\r\n   * Reverse the order of the children in the CurveChain array.\r\n   */\r\n  public reverseChildrenInPlace() {\r\n    for (const curve of this._curves)\r\n      curve.reverseInPlace();\r\n    this._curves.reverse();\r\n  }\r\n  /** Evaluate an indexed curve at a fraction.  Return as a CurveLocationDetail that indicates the primitive.\r\n   */\r\n  public primitiveIndexAndFractionToCurveLocationDetailPointAndDerivative(index: number, fraction: number, cyclic: boolean = false, result?: CurveLocationDetail): CurveLocationDetail | undefined {\r\n    const primitive = this.cyclicCurvePrimitive(index, cyclic);\r\n    if (primitive) {\r\n      return CurveLocationDetail.createCurveEvaluatedFractionPointAndDerivative(primitive, fraction, result);\r\n    }\r\n    return undefined;\r\n  }\r\n}\r\n\r\n/**\r\n * * A `BagOfCurves` object is a collection of `AnyCurve` objects.\r\n * * A `BagOfCurves` has no implied properties such as being planar.\r\n * @public\r\n */\r\nexport class BagOfCurves extends CurveCollection {\r\n  /** String name for schema properties */\r\n  public readonly curveCollectionType = \"bagOfCurves\";\r\n\r\n  /** test if `other` is an instance of `BagOfCurves` */\r\n  public isSameGeometryClass(other: GeometryQuery): boolean { return other instanceof BagOfCurves; }\r\n  /** Array of children.\r\n   * * No restrictions on type.\r\n   */\r\n  protected _children: AnyCurve[];\r\n  /** Construct an empty `BagOfCurves` */\r\n  public constructor() { super(); this._children = []; }\r\n  /** Return the (reference to) array of children */\r\n  public override get children(): AnyCurve[] { return this._children; }\r\n  /** create with given curves. */\r\n  public static create(...data: AnyCurve[]): BagOfCurves {\r\n    const result = new BagOfCurves();\r\n    for (const child of data) {\r\n      result.tryAddChild(child);\r\n    }\r\n    return result;\r\n  }\r\n  /** Return the boundary type (0) of a corresponding  MicroStation CurveVector */\r\n  public dgnBoundaryType(): number { return 0; }\r\n  /** invoke `processor.announceBagOfCurves(this, indexInParent);` */\r\n  public announceToCurveProcessor(processor: RecursiveCurveProcessor, indexInParent: number = -1): void {\r\n    return processor.announceBagOfCurves(this, indexInParent);\r\n  }\r\n  /** Clone all children in stroked form. */\r\n  public cloneStroked(options?: StrokeOptions): BagOfCurves {\r\n    const clone = new BagOfCurves();\r\n    let child;\r\n    for (child of this.children) {\r\n      if (child instanceof CurvePrimitive) {\r\n        const ls = LineString3d.create();\r\n        child.emitStrokes(ls, options);\r\n        if (ls)\r\n          clone.children.push(ls);\r\n      } else if (child instanceof CurveCollection) {\r\n        const childStrokes = child.cloneStroked(options);\r\n        if (childStrokes)\r\n          clone.children.push(childStrokes);\r\n      }\r\n    }\r\n    return clone;\r\n  }\r\n  /** Return an empty `BagOfCurves` */\r\n  public cloneEmptyPeer(): BagOfCurves { return new BagOfCurves(); }\r\n  /** Add a child  */\r\n  public tryAddChild(child: AnyCurve | undefined): boolean {\r\n    if (child)\r\n      this._children.push(child);\r\n    return true;\r\n  }\r\n  /** Get a child by index */\r\n  public getChild(i: number): AnyCurve | undefined {\r\n    if (i < this._children.length)\r\n      return this._children[i];\r\n    return undefined;\r\n  }\r\n  /** Second step of double dispatch:  call `handler.handleBagOfCurves(this)` */\r\n  public dispatchToGeometryHandler(handler: GeometryHandler): any {\r\n    return handler.handleBagOfCurves(this);\r\n  }\r\n}\r\n/**\r\n * * Options to control method `RegionOps.consolidateAdjacentPrimitives`\r\n * @public\r\n */\r\nexport class ConsolidateAdjacentCurvePrimitivesOptions {\r\n  /** True to consolidated linear geometry   (e.g. separate LineSegment3d and LineString3d) into LineString3d */\r\n  public consolidateLinearGeometry: boolean = true;\r\n  /** True to consolidate contiguous arcs */\r\n  public consolidateCompatibleArcs: boolean = true;\r\n  /** Tolerance for collapsing identical points */\r\n  public duplicatePointTolerance = Geometry.smallMetricDistance;\r\n  /** Tolerance for removing interior colinear points. */\r\n  public colinearPointTolerance = Geometry.smallMetricDistance;\r\n}\r\n"]}