@itwin/core-geometry 5.1.0-dev.9 → 5.2.0-dev.1

package/lib/cjs/polyface/IndexedEdgeMatcher.d.ts

@@ -2,60 +2,76 @@
  * @module Polyface
  */
 /**
- * * For boundary sorting, an edge is a (packed!) Float64Array.
- * * Fixed entry positions are:
- *   * [0] is start vertex index (in CCW order around its facet)
- *   * [1] is end vertex index (in CCW order around its facet)
- *   * [2] is facet index (or another number to associate with this edge).
+ * Represent an [[IndexedPolyface]] edge as:
+ * * vertex start index and vertex end index (CCW order around its facet)
+ * * an additional number to associate with the edge (e.g., facet index)
+ * @public
  */
-export declare class SortableEdge extends Float64Array {
+export declare class SortableEdge {
+    private _v;
+    private _a;
+    /** Constructor. */
+    constructor(startVertex: number, endVertex: number, facetIndex: number);
+    /** Clone the edge. */
+    clone(): SortableEdge;
     /** Return the vertex index that appears first in the order stored.  */
-    get vertexIndexA(): number;
+    get startVertex(): number;
     /** Return the vertex index that appears second in the order stored.  */
-    get vertexIndexB(): number;
+    get endVertex(): number;
     /**
      * Return the facet index.
      * * This value is carried along during matching. Typically it is a facet index, but it does not have to be.
      */
     get facetIndex(): number;
-    /** return true if vertexIndexA is less than vertexIndexB. */
+    /** return true if `startVertex` is less than `endVertex`. */
     get isLowHigh(): boolean;
     /** Return the vertex index with lower numeric value. */
-    get lowVertexIndex(): number;
+    get lowVertex(): number;
     /** Return the vertex index with higher numeric value. */
-    get highVertexIndex(): number;
-    /** Return true if the vertices edgeA and edgeB are the same vertex indices in opposite order. */
+    get highVertex(): number;
+    /** Return true if edgeA and edgeB traverse the same edge in the same direction. */
+    private static areSameEdge;
+    /** Return true if edgeA and edgeB traverse the same edge in opposite directions. */
     static areDirectedPartners(edgeA: SortableEdge, edgeB: SortableEdge): boolean;
-    /** Return true if the vertices edgeA and edgeB are the same vertex indices with no consideration of order. */
+    /** Return true if edgeA and edgeB traverse the same edge in the same or opposite directions. */
     static areUndirectedPartners(edgeA: SortableEdge, edgeB: SortableEdge): boolean;
     /**
-     * Return numeric relationship of edgeA and edgeB:
-     * * 1 if they share start and end in the same order.
-     * * -1 if they share start and end in reversed order.
+     * Return numeric identifier for the relationship between edgeA and edgeB:
+     * * 1 if they share start and end vertex indices in the same order.
+     * * -1 if they share start and end vertex indices in reversed order.
      * * 0 otherwise.
      */
     static relativeOrientation(edgeA: SortableEdge, edgeB: SortableEdge): number;
+    /** Whether the start and end vertex indices are equal. */
     get isNullEdge(): boolean;
     /**
      * Lexical comparison of two edges.
-     * * If the edges have the same vertex pair (in same or opposite order) they will end up adjacent in a sort.
-     * * If the edges have 0 or 1 shared vertex indices, the one with lowest low comes first.
+     * * If the edges have the same vertex index pair (in same or opposite order) they will end up adjacent in a sort.
      * @param edgeA first edge
      * @param edgeB second edge
      */
     static lessThan(edgeA: SortableEdge, edgeB: SortableEdge): number;
-    constructor(vertexA: number, vertexB: number, facetIndex: number);
+    /** Return the edge data as a JSON array. */
     toJSON(): any;
+    /** Return the edge cluster in JSON format.  */
     static clusterToJSON(data: SortableEdgeCluster): any;
+    /** Return the edge cluster array in JSON format. */
     static clusterArrayToJSON(data: SortableEdgeCluster[]): any[];
 }
+/**
+ * Union type for a single [[SortableEdge]] or a (matched) array of them.
+ * @public
+ */
 export type SortableEdgeCluster = SortableEdge | SortableEdge[];
 /**
- * An IndexedEdgeMatcher carries an array of edge start & end indices for sorting and subsequent analyses
- * (such as testing for closed mesh).
+ * An IndexedEdgeMatcher carries an array of edge start and end indices for sorting and subsequent analyses,
+ * such as testing for closed mesh.
+ * @public
  */
 export declare class IndexedEdgeMatcher {
+    /** The array of edges to be sorted. */
     edges: SortableEdge[];
+    /** Constructor. Call [[addEdge]] or [[addPath]] to populate `edges`. */
     constructor();
     /**
      * Push a new edge.
@@ -66,32 +82,31 @@ export declare class IndexedEdgeMatcher {
      */
     addEdge(vertexA: number, vertexB: number, facetIndex: number): SortableEdge;
     /**
-     * Push edges all around a facet, returning to vertexArray[0].
-     * @param vertexArray array of vertex indices around facet
-     * @param facetIndex value to carry along during matching
+     * Push edges along a path.
+     * * Typically used to add edges around a facet.
+     * @param vertexIndices array of vertex indices along an open or closed path.
+     * @param facetIndex value to set on each edge pushed.
      * @param closeLoop true to add an edge from last to first vertex.
      */
-    addPath(vertexArray: number[], facetIndex: number, closeLoop?: boolean): void;
-    /** Sort the edge index array. */
+    addPath(vertexIndices: number[], facetIndex: number, closeLoop: boolean): void;
+    /** Sort the edges. */
     sort(): void;
     /** Create a single or compound SortableEdgeCluster in dest. */
     private collectSortableEdgeCluster;
     /**
-     * Sort the edges, and look for three categories of paired edges:
-     * * caller must allocate all result arrays of interest.
-     * * Any combination of the result arrays may be `undefined`, indicating that category is to be ignored.
-     * * Any combination of the result arrays may be aliased as the same target, in which case those to categories are
+     * Sort the edges, and collect up to four categories of edges: manifold pairs, singletons, null edges,
+     * and everything else.
+     * * Caller should allocate arrays of interest.
+     * * Any combination of the arrays may be `undefined`, indicating that category is to be ignored.
+     * * Any combination of the arrays may be aliased as the same target, in which case the aliased categories are
      * merged into the target.
-     * * For instance, to ignore manifold pairs and collect all others (singleton, null, and other) as a single array
-     * `allOther`, create `const allOther = []` as an empty array and call
-     * `sortAndCollectClusters (undefined, allOther, allOther, allOther);`
-     * @param manifoldPairs optional array to receive pairs of properly mated SortableEdgePairs, i.e. simple interior
-     * edges adjacent to two facets in opposing directions.
-     * @param singletons optional array to receive edges that are simple boundary edges.
-     * @param nullEdges optional array to receive arrays of null edges (same start and end vertex)
-     * @param allOtherClusters optional array to receive arrays in which all the edges are partners in an undirected sense
-     * but not a simple directed pair.
+     * * For instance, to ignore manifold pairs and collect all other edges in a single array:
+     * `const foo = []; matcher.sortAndCollectClusters(undefined, foo, foo, foo);`
+     * @param manifoldPairs array to receive pairs of properly mated edges, i.e. mesh interior edges.
+     * @param singletons array to receive edges that have no partner, i.e., mesh boundary edges.
+     * @param nullEdges array to receive arrays of matched null edges, for which start === end vertex index.
+     * @param allOtherClusters array to receive arrays of edges that are partners in an undirected, non-manifold sense.
      */
-    sortAndCollectClusters(manifoldPairs: SortableEdgeCluster[] | undefined, singletons?: SortableEdgeCluster[], nullEdges?: SortableEdgeCluster[], allOtherClusters?: SortableEdgeCluster[]): void;
+    sortAndCollectClusters(manifoldPairs?: SortableEdgeCluster[], singletons?: SortableEdgeCluster[], nullEdges?: SortableEdgeCluster[], allOtherClusters?: SortableEdgeCluster[]): void;
 }
 //# sourceMappingURL=IndexedEdgeMatcher.d.ts.map

package/lib/cjs/polyface/IndexedEdgeMatcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"IndexedEdgeMatcher.d.ts","sourceRoot":"","sources":["../../../src/polyface/IndexedEdgeMatcher.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH;;;;;;GAMG;AACH,qBAAa,YAAa,SAAQ,YAAY;IAC5C,uEAAuE;IACvE,IAAW,YAAY,IAAI,MAAM,CAEhC;IACD,wEAAwE;IACxE,IAAW,YAAY,IAAI,MAAM,CAEhC;IACD;;;OAGG;IACH,IAAW,UAAU,IAAI,MAAM,CAE9B;IACD,6DAA6D;IAC7D,IAAW,SAAS,IAAI,OAAO,CAE9B;IACD,wDAAwD;IACxD,IAAW,cAAc,IAAI,MAAM,CAElC;IACD,yDAAyD;IACzD,IAAW,eAAe,IAAI,MAAM,CAEnC;IACD,iGAAiG;WACnF,mBAAmB,CAAC,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,GAAG,OAAO;IAGpF,8GAA8G;WAChG,qBAAqB,CAAC,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,GAAG,OAAO;IAGtF;;;;;OAKG;WACW,mBAAmB,CAAC,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,GAAG,MAAM;IAMnF,IAAW,UAAU,IAAI,OAAO,CAE/B;IACD;;;;;;OAMG;WACW,QAAQ,CAAC,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,GAAG,MAAM;gBAiBrD,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;IAMhE,MAAM,IAAI,GAAG;WAGN,aAAa,CAAC,IAAI,EAAE,mBAAmB,GAAG,GAAG;WAM7C,kBAAkB,CAAC,IAAI,EAAE,mBAAmB,EAAE;CAM7D;AACD,MAAM,MAAM,mBAAmB,GAAG,YAAY,GAAG,YAAY,EAAE,CAAC;AAChE;;;GAGG;AACH,qBAAa,kBAAkB;IACtB,KAAK,EAAE,YAAY,EAAE,CAAC;;IAK7B;;;;;;OAMG;IACI,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,YAAY;IAKlF;;;;;OAKG;IACI,OAAO,CAAC,WAAW,EAAE,MAAM,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,GAAE,OAAc;IASnF,iCAAiC;IAC1B,IAAI;IAGX,+DAA+D;IAC/D,OAAO,CAAC,0BAA0B;IAYlC;;;;;;;;;;;;;;;OAeG;IACI,sBAAsB,CAC3B,aAAa,EAAE,mBAAmB,EAAE,GAAG,SAAS,EAChD,UAAU,CAAC,EAAE,mBAAmB,EAAE,EAClC,SAAS,CAAC,EAAE,mBAAmB,EAAE,EACjC,gBAAgB,CAAC,EAAE,mBAAmB,EAAE,GACvC,IAAI;CA0BR"}
+{"version":3,"file":"IndexedEdgeMatcher.d.ts","sourceRoot":"","sources":["../../../src/polyface/IndexedEdgeMatcher.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH;;;;;GAKG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,EAAE,CAAW;IACrB,OAAO,CAAC,EAAE,CAAS;IAEnB,mBAAmB;gBACA,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;IAI7E,sBAAsB;IACf,KAAK,IAAI,YAAY;IAG5B,uEAAuE;IACvE,IAAW,WAAW,IAAI,MAAM,CAE/B;IACD,wEAAwE;IACxE,IAAW,SAAS,IAAI,MAAM,CAE7B;IACD;;;OAGG;IACH,IAAW,UAAU,IAAI,MAAM,CAE9B;IACD,6DAA6D;IAC7D,IAAW,SAAS,IAAI,OAAO,CAE9B;IACD,wDAAwD;IACxD,IAAW,SAAS,IAAI,MAAM,CAE7B;IACD,yDAAyD;IACzD,IAAW,UAAU,IAAI,MAAM,CAE9B;IACD,mFAAmF;IACnF,OAAO,CAAC,MAAM,CAAC,WAAW;IAG1B,oFAAoF;WACtE,mBAAmB,CAAC,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,GAAG,OAAO;IAGpF,gGAAgG;WAClF,qBAAqB,CAAC,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,GAAG,OAAO;IAGtF;;;;;OAKG;WACW,mBAAmB,CAAC,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,GAAG,MAAM;IAOnF,0DAA0D;IAC1D,IAAW,UAAU,IAAI,OAAO,CAE/B;IACD;;;;;OAKG;WACW,QAAQ,CAAC,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,GAAG,MAAM;IAiBxE,4CAA4C;IACrC,MAAM,IAAI,GAAG;IAGpB,+CAA+C;WACjC,aAAa,CAAC,IAAI,EAAE,mBAAmB,GAAG,GAAG;IAO3D,oDAAoD;WACtC,kBAAkB,CAAC,IAAI,EAAE,mBAAmB,EAAE;CAM7D;AAED;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,YAAY,GAAG,YAAY,EAAE,CAAC;AAEhE;;;;GAIG;AACH,qBAAa,kBAAkB;IAC7B,uCAAuC;IAChC,KAAK,EAAE,YAAY,EAAE,CAAC;IAC7B,wEAAwE;;IAIxE;;;;;;OAMG;IACI,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,YAAY;IAKlF;;;;;;OAMG;IACI,OAAO,CAAC,aAAa,EAAE,MAAM,EAAE,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO;IAS9E,sBAAsB;IACf,IAAI;IAGX,+DAA+D;IAC/D,OAAO,CAAC,0BAA0B;IAYlC;;;;;;;;;;;;;OAaG;IACI,sBAAsB,CAC3B,aAAa,CAAC,EAAE,mBAAmB,EAAE,EACrC,UAAU,CAAC,EAAE,mBAAmB,EAAE,EAClC,SAAS,CAAC,EAAE,mBAAmB,EAAE,EACjC,gBAAgB,CAAC,EAAE,mBAAmB,EAAE,GACvC,IAAI;CA6BR"}

package/lib/cjs/polyface/IndexedEdgeMatcher.js

@@ -9,97 +9,107 @@ exports.IndexedEdgeMatcher = exports.SortableEdge = void 0;
  * @module Polyface
  */
 /**
- * * For boundary sorting, an edge is a (packed!) Float64Array.
- * * Fixed entry positions are:
- *   * [0] is start vertex index (in CCW order around its facet)
- *   * [1] is end vertex index (in CCW order around its facet)
- *   * [2] is facet index (or another number to associate with this edge).
+ * Represent an [[IndexedPolyface]] edge as:
+ * * vertex start index and vertex end index (CCW order around its facet)
+ * * an additional number to associate with the edge (e.g., facet index)
+ * @public
  */
-class SortableEdge extends Float64Array {
+class SortableEdge {
+    _v;
+    _a;
+    /** Constructor. */
+    constructor(startVertex, endVertex, facetIndex) {
+        this._v = [startVertex, endVertex];
+        this._a = facetIndex;
+    }
+    /** Clone the edge. */
+    clone() {
+        return new SortableEdge(this._v[0], this._v[1], this._a);
+    }
     /** Return the vertex index that appears first in the order stored.  */
-    get vertexIndexA() {
-        return this[0];
+    get startVertex() {
+        return this._v[0];
     }
     /** Return the vertex index that appears second in the order stored.  */
-    get vertexIndexB() {
-        return this[1];
+    get endVertex() {
+        return this._v[1];
     }
     /**
      * Return the facet index.
      * * This value is carried along during matching. Typically it is a facet index, but it does not have to be.
      */
     get facetIndex() {
-        return this[2];
+        return this._a;
     }
-    /** return true if vertexIndexA is less than vertexIndexB. */
+    /** return true if `startVertex` is less than `endVertex`. */
     get isLowHigh() {
-        return this[0] < this[1];
+        return this._v[0] < this._v[1];
     }
     /** Return the vertex index with lower numeric value. */
-    get lowVertexIndex() {
-        return this[0] < this[1] ? this[0] : this[1];
+    get lowVertex() {
+        return this.isLowHigh ? this._v[0] : this._v[1];
     }
     /** Return the vertex index with higher numeric value. */
-    get highVertexIndex() {
-        return this[0] > this[1] ? this[0] : this[1];
+    get highVertex() {
+        return this.isLowHigh ? this._v[1] : this._v[0];
+    }
+    /** Return true if edgeA and edgeB traverse the same edge in the same direction. */
+    static areSameEdge(edgeA, edgeB) {
+        return edgeA._v[0] === edgeB._v[0] && edgeA._v[1] === edgeB._v[1];
     }
-    /** Return true if the vertices edgeA and edgeB are the same vertex indices in opposite order. */
+    /** Return true if edgeA and edgeB traverse the same edge in opposite directions. */
     static areDirectedPartners(edgeA, edgeB) {
-        return edgeA[0] === edgeB[1] && edgeA[1] === edgeB[0];
+        return edgeA._v[0] === edgeB._v[1] && edgeA._v[1] === edgeB._v[0];
     }
-    /** Return true if the vertices edgeA and edgeB are the same vertex indices with no consideration of order. */
+    /** Return true if edgeA and edgeB traverse the same edge in the same or opposite directions. */
     static areUndirectedPartners(edgeA, edgeB) {
-        return (edgeA[0] === edgeB[0] && edgeA[1] === edgeB[1]) || ((edgeA[0] === edgeB[1] && edgeA[1] === edgeB[0]));
+        return this.areSameEdge(edgeA, edgeB) || this.areDirectedPartners(edgeA, edgeB);
     }
     /**
-     * Return numeric relationship of edgeA and edgeB:
-     * * 1 if they share start and end in the same order.
-     * * -1 if they share start and end in reversed order.
+     * Return numeric identifier for the relationship between edgeA and edgeB:
+     * * 1 if they share start and end vertex indices in the same order.
+     * * -1 if they share start and end vertex indices in reversed order.
      * * 0 otherwise.
      */
     static relativeOrientation(edgeA, edgeB) {
-        if (edgeA[0] === edgeB[0] && edgeA[1] === edgeB[1])
+        if (this.areSameEdge(edgeA, edgeB))
             return 1;
-        if (edgeA[0] === edgeB[1] && edgeA[1] === edgeB[0])
+        if (this.areDirectedPartners(edgeA, edgeB))
             return -1;
         return 0;
     }
+    /** Whether the start and end vertex indices are equal. */
     get isNullEdge() {
-        return this[0] === this[1];
+        return this._v[0] === this._v[1];
     }
     /**
      * Lexical comparison of two edges.
-     * * If the edges have the same vertex pair (in same or opposite order) they will end up adjacent in a sort.
-     * * If the edges have 0 or 1 shared vertex indices, the one with lowest low comes first.
+     * * If the edges have the same vertex index pair (in same or opposite order) they will end up adjacent in a sort.
      * @param edgeA first edge
      * @param edgeB second edge
      */
     static lessThan(edgeA, edgeB) {
         // primary compare is based on indirect indices
-        const lowA = edgeA.lowVertexIndex;
-        const lowB = edgeB.lowVertexIndex;
+        const lowA = edgeA.lowVertex;
+        const lowB = edgeB.lowVertex;
         if (lowA < lowB)
             return -1;
         if (lowB < lowA)
             return 1;
-        const highA = edgeA.highVertexIndex;
-        const highB = edgeB.highVertexIndex;
+        const highA = edgeA.highVertex;
+        const highB = edgeB.highVertex;
         if (highA < highB)
             return -1;
         if (highB < highA)
             return 1;
         // undirected indices match ... use directed vertexIndexA
-        return edgeA.vertexIndexA - edgeB.vertexIndexA;
-    }
-    constructor(vertexA, vertexB, facetIndex) {
-        super(3);
-        this[0] = vertexA;
-        this[1] = vertexB;
-        this[2] = facetIndex;
+        return edgeA.startVertex - edgeB.startVertex;
     }
+    /** Return the edge data as a JSON array. */
     toJSON() {
-        return [this[0], this[1], this[2]];
+        return [this._v[0], this._v[1], this._a];
     }
+    /** Return the edge cluster in JSON format.  */
     static clusterToJSON(data) {
         if (data instanceof SortableEdge)
             return data.toJSON();
@@ -107,6 +117,7 @@ class SortableEdge extends Float64Array {
         for (const edge of data)
             result.push(edge.toJSON());
     }
+    /** Return the edge cluster array in JSON format. */
     static clusterArrayToJSON(data) {
         const result = [];
         for (const cluster of data)
@@ -116,11 +127,14 @@ class SortableEdge extends Float64Array {
 }
 exports.SortableEdge = SortableEdge;
 /**
- * An IndexedEdgeMatcher carries an array of edge start & end indices for sorting and subsequent analyses
- * (such as testing for closed mesh).
+ * An IndexedEdgeMatcher carries an array of edge start and end indices for sorting and subsequent analyses,
+ * such as testing for closed mesh.
+ * @public
  */
 class IndexedEdgeMatcher {
+    /** The array of edges to be sorted. */
     edges;
+    /** Constructor. Call [[addEdge]] or [[addPath]] to populate `edges`. */
     constructor() {
         this.edges = [];
     }
@@ -137,22 +151,22 @@ class IndexedEdgeMatcher {
         return edge;
     }
     /**
-     * Push edges all around a facet, returning to vertexArray[0].
-     * @param vertexArray array of vertex indices around facet
-     * @param facetIndex value to carry along during matching
+     * Push edges along a path.
+     * * Typically used to add edges around a facet.
+     * @param vertexIndices array of vertex indices along an open or closed path.
+     * @param facetIndex value to set on each edge pushed.
      * @param closeLoop true to add an edge from last to first vertex.
      */
-    addPath(vertexArray, facetIndex, closeLoop = true) {
-        if (vertexArray.length === 0)
+    addPath(vertexIndices, facetIndex, closeLoop) {
+        if (vertexIndices.length === 0)
             return;
-        const m = vertexArray.length - 1;
-        for (let i = 0; i < m; i++) {
-            this.addEdge(vertexArray[i], vertexArray[i + 1], facetIndex);
-        }
+        const m = vertexIndices.length - 1;
+        for (let i = 0; i < m; i++)
+            this.addEdge(vertexIndices[i], vertexIndices[i + 1], facetIndex);
         if (closeLoop)
-            this.addEdge(vertexArray[m], vertexArray[0], facetIndex);
+            this.addEdge(vertexIndices[m], vertexIndices[0], facetIndex);
     }
-    /** Sort the edge index array. */
+    /** Sort the edges. */
     sort() {
         this.edges.sort((edgeA, edgeB) => SortableEdge.lessThan(edgeA, edgeB));
     }
@@ -171,20 +185,18 @@ class IndexedEdgeMatcher {
         }
     }
     /**
-     * Sort the edges, and look for three categories of paired edges:
-     * * caller must allocate all result arrays of interest.
-     * * Any combination of the result arrays may be `undefined`, indicating that category is to be ignored.
-     * * Any combination of the result arrays may be aliased as the same target, in which case those to categories are
+     * Sort the edges, and collect up to four categories of edges: manifold pairs, singletons, null edges,
+     * and everything else.
+     * * Caller should allocate arrays of interest.
+     * * Any combination of the arrays may be `undefined`, indicating that category is to be ignored.
+     * * Any combination of the arrays may be aliased as the same target, in which case the aliased categories are
      * merged into the target.
-     * * For instance, to ignore manifold pairs and collect all others (singleton, null, and other) as a single array
-     * `allOther`, create `const allOther = []` as an empty array and call
-     * `sortAndCollectClusters (undefined, allOther, allOther, allOther);`
-     * @param manifoldPairs optional array to receive pairs of properly mated SortableEdgePairs, i.e. simple interior
-     * edges adjacent to two facets in opposing directions.
-     * @param singletons optional array to receive edges that are simple boundary edges.
-     * @param nullEdges optional array to receive arrays of null edges (same start and end vertex)
-     * @param allOtherClusters optional array to receive arrays in which all the edges are partners in an undirected sense
-     * but not a simple directed pair.
+     * * For instance, to ignore manifold pairs and collect all other edges in a single array:
+     * `const foo = []; matcher.sortAndCollectClusters(undefined, foo, foo, foo);`
+     * @param manifoldPairs array to receive pairs of properly mated edges, i.e. mesh interior edges.
+     * @param singletons array to receive edges that have no partner, i.e., mesh boundary edges.
+     * @param nullEdges array to receive arrays of matched null edges, for which start === end vertex index.
+     * @param allOtherClusters array to receive arrays of edges that are partners in an undirected, non-manifold sense.
      */
     sortAndCollectClusters(manifoldPairs, singletons, nullEdges, allOtherClusters) {
         this.sort();
@@ -205,18 +217,14 @@ class IndexedEdgeMatcher {
                 SortableEdge.areUndirectedPartners(baseEdge, this.edges[index1]); index1++) {
                 clusterLength++;
             }
-            if (this.edges[index0].isNullEdge) {
+            if (this.edges[index0].isNullEdge)
                 this.collectSortableEdgeCluster(index0, index0 + clusterLength, nullEdges);
-            }
-            else if (clusterLength === 2 && SortableEdge.areDirectedPartners(baseEdge, this.edges[index0 + 1])) {
+            else if (clusterLength === 2 && SortableEdge.areDirectedPartners(baseEdge, this.edges[index0 + 1]))
                 this.collectSortableEdgeCluster(index0, index0 + clusterLength, manifoldPairs);
-            }
-            else if (clusterLength === 1) {
+            else if (clusterLength === 1)
                 this.collectSortableEdgeCluster(index0, index0 + 1, singletons);
-            }
-            else {
+            else
                 this.collectSortableEdgeCluster(index0, index0 + clusterLength, allOtherClusters);
-            }
         }
     }
 }

package/lib/cjs/polyface/IndexedEdgeMatcher.js.map

@@ -1 +1 @@
-{"version":3,"file":"IndexedEdgeMatcher.js","sourceRoot":"","sources":["../../../src/polyface/IndexedEdgeMatcher.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F;;GAEG;AAEH;;;;;;GAMG;AACH,MAAa,YAAa,SAAQ,YAAY;IAC5C,uEAAuE;IACvE,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC;IACjB,CAAC;IACD,wEAAwE;IACxE,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC;IACjB,CAAC;IACD;;;OAGG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC;IACjB,CAAC;IACD,6DAA6D;IAC7D,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IAC3B,CAAC;IACD,wDAAwD;IACxD,IAAW,cAAc;QACvB,OAAO,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC/C,CAAC;IACD,yDAAyD;IACzD,IAAW,eAAe;QACxB,OAAO,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC/C,CAAC;IACD,iGAAiG;IAC1F,MAAM,CAAC,mBAAmB,CAAC,KAAmB,EAAE,KAAmB;QACxE,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC;IACxD,CAAC;IACD,8GAA8G;IACvG,MAAM,CAAC,qBAAqB,CAAC,KAAmB,EAAE,KAAmB;QAC1E,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAChH,CAAC;IACD;;;;;OAKG;IACI,MAAM,CAAC,mBAAmB,CAAC,KAAmB,EAAE,KAAmB;QACxE,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC;YAAE,OAAO,CAAC,CAAC;QAC7D,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC;YAAE,OAAO,CAAC,CAAC,CAAC;QAC9D,OAAO,CAAC,CAAC;IACX,CAAC;IAED,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC;IAC7B,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,QAAQ,CAAC,KAAmB,EAAE,KAAmB;QAC7D,+CAA+C;QAC/C,MAAM,IAAI,GAAG,KAAK,CAAC,cAAc,CAAC;QAClC,MAAM,IAAI,GAAG,KAAK,CAAC,cAAc,CAAC;QAClC,IAAI,IAAI,GAAG,IAAI;YACb,OAAO,CAAC,CAAC,CAAC;QACZ,IAAI,IAAI,GAAG,IAAI;YACb,OAAO,CAAC,CAAC;QACX,MAAM,KAAK,GAAG,KAAK,CAAC,eAAe,CAAC;QACpC,MAAM,KAAK,GAAG,KAAK,CAAC,eAAe,CAAC;QACpC,IAAI,KAAK,GAAG,KAAK;YACf,OAAO,CAAC,CAAC,CAAC;QACZ,IAAI,KAAK,GAAG,KAAK;YACf,OAAO,CAAC,CAAC;QACX,yDAAyD;QACzD,OAAO,KAAK,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC;IACjD,CAAC;IACD,YAAmB,OAAe,EAAE,OAAe,EAAE,UAAkB;QACrE,KAAK,CAAC,CAAC,CAAC,CAAC;QACT,IAAI,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC;QAClB,IAAI,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC;QAClB,IAAI,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC;IACvB,CAAC;IACM,MAAM;QACX,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IACrC,CAAC;IACM,MAAM,CAAC,aAAa,CAAC,IAAyB;QACnD,IAAI,IAAI,YAAY,YAAY;YAC9B,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;QACvB,MAAM,MAAM,GAAG,EAAE,CAAC;QAClB,KAAK,MAAM,IAAI,IAAI,IAAI;YAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACtD,CAAC;IACM,MAAM,CAAC,kBAAkB,CAAC,IAA2B;QAC1D,MAAM,MAAM,GAAG,EAAE,CAAC;QAClB,KAAK,MAAM,OAAO,IAAI,IAAI;YACxB,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;QACnD,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAhGD,oCAgGC;AAED;;;GAGG;AACH,MAAa,kBAAkB;IACtB,KAAK,CAAiB;IAE7B;QACE,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;IAClB,CAAC;IACD;;;;;;OAMG;IACI,OAAO,CAAC,OAAe,EAAE,OAAe,EAAE,UAAkB;QACjE,MAAM,IAAI,GAAG,IAAI,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAC5D,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;;OAKG;IACI,OAAO,CAAC,WAAqB,EAAE,UAAkB,EAAE,YAAqB,IAAI;QACjF,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO;QACrC,MAAM,CAAC,GAAG,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC;QACjC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YAC3B,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC;QAC/D,CAAC;QACD,IAAI,SAAS;YACX,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC;IAC7D,CAAC;IACD,iCAAiC;IAC1B,IAAI;QACT,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;IACzE,CAAC;IACD,+DAA+D;IACvD,0BAA0B,CAAC,MAAc,EAAE,MAAc,EAAE,IAAuC;QACxG,IAAI,IAAI,KAAK,SAAS,IAAI,MAAM,GAAG,MAAM,EAAE,CAAC;YAC1C,IAAI,MAAM,KAAK,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC1B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;YAChC,CAAC;iBAAM,CAAC;gBACN,MAAM,OAAO,GAAG,EAAE,CAAC;gBACnB,KAAK,IAAI,CAAC,GAAG,MAAM,EAAE,CAAC,GAAG,MAAM,EAAE,CAAC,EAAE;oBAClC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC9B,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACrB,CAAC;QACH,CAAC;IACH,CAAC;IACD;;;;;;;;;;;;;;;OAeG;IACI,sBAAsB,CAC3B,aAAgD,EAChD,UAAkC,EAClC,SAAiC,EACjC,gBAAwC;QAExC,IAAI,CAAC,IAAI,EAAE,CAAC;QACZ,IAAI,aAAa;YAAE,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC;QAC5C,IAAI,UAAU;YAAE,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC;QACtC,IAAI,SAAS;YAAE,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;QACpC,IAAI,gBAAgB;YAAE,gBAAgB,CAAC,MAAM,GAAG,CAAC,CAAC;QAClD,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;QAC5B,IAAI,aAAa,CAAC;QAClB,KAAK,IAAI,MAAM,GAAG,CAAC,EAAE,MAAM,GAAG,CAAC,EAAE,MAAM,IAAI,aAAa,EAAE,CAAC;YACzD,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YACpC,aAAa,GAAG,CAAC,CAAC;YAClB,KAAK,IAAI,MAAM,GAAG,MAAM,GAAG,CAAC,EAAE,MAAM,GAAG,CAAC;gBACtC,YAAY,CAAC,qBAAqB,CAAC,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC;gBAC7E,aAAa,EAAE,CAAC;YAClB,CAAC;YACD,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,CAAC;gBAClC,IAAI,CAAC,0BAA0B,CAAC,MAAM,EAAE,MAAM,GAAG,aAAa,EAAE,SAAS,CAAC,CAAC;YAC7E,CAAC;iBAAM,IAAI,aAAa,KAAK,CAAC,IAAI,YAAY,CAAC,mBAAmB,CAAC,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;gBACrG,IAAI,CAAC,0BAA0B,CAAC,MAAM,EAAE,MAAM,GAAG,aAAa,EAAE,aAAa,CAAC,CAAC;YACjF,CAAC;iBAAM,IAAI,aAAa,KAAK,CAAC,EAAE,CAAC;gBAC/B,IAAI,CAAC,0BAA0B,CAAC,MAAM,EAAE,MAAM,GAAG,CAAC,EAAE,UAAU,CAAC,CAAC;YAClE,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,0BAA0B,CAAC,MAAM,EAAE,MAAM,GAAG,aAAa,EAAE,gBAAgB,CAAC,CAAC;YACpF,CAAC;QACH,CAAC;IACH,CAAC;CACF;AAjGD,gDAiGC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n\n/** @packageDocumentation\n * @module Polyface\n */\n\n/**\n * * For boundary sorting, an edge is a (packed!) Float64Array.\n * * Fixed entry positions are:\n *   * [0] is start vertex index (in CCW order around its facet)\n *   * [1] is end vertex index (in CCW order around its facet)\n *   * [2] is facet index (or another number to associate with this edge).\n */\nexport class SortableEdge extends Float64Array {\n  /** Return the vertex index that appears first in the order stored.  */\n  public get vertexIndexA(): number {\n    return this[0];\n  }\n  /** Return the vertex index that appears second in the order stored.  */\n  public get vertexIndexB(): number {\n    return this[1];\n  }\n  /**\n   * Return the facet index.\n   * * This value is carried along during matching. Typically it is a facet index, but it does not have to be.\n   */\n  public get facetIndex(): number {\n    return this[2];\n  }\n  /** return true if vertexIndexA is less than vertexIndexB. */\n  public get isLowHigh(): boolean {\n    return this[0] < this[1];\n  }\n  /** Return the vertex index with lower numeric value. */\n  public get lowVertexIndex(): number {\n    return this[0] < this[1] ? this[0] : this[1];\n  }\n  /** Return the vertex index with higher numeric value. */\n  public get highVertexIndex(): number {\n    return this[0] > this[1] ? this[0] : this[1];\n  }\n  /** Return true if the vertices edgeA and edgeB are the same vertex indices in opposite order. */\n  public static areDirectedPartners(edgeA: SortableEdge, edgeB: SortableEdge): boolean {\n    return edgeA[0] === edgeB[1] && edgeA[1] === edgeB[0];\n  }\n  /** Return true if the vertices edgeA and edgeB are the same vertex indices with no consideration of order. */\n  public static areUndirectedPartners(edgeA: SortableEdge, edgeB: SortableEdge): boolean {\n    return (edgeA[0] === edgeB[0] && edgeA[1] === edgeB[1]) || ((edgeA[0] === edgeB[1] && edgeA[1] === edgeB[0]));\n  }\n  /**\n   * Return numeric relationship of edgeA and edgeB:\n   * * 1 if they share start and end in the same order.\n   * * -1 if they share start and end in reversed order.\n   * * 0 otherwise.\n   */\n  public static relativeOrientation(edgeA: SortableEdge, edgeB: SortableEdge): number {\n    if (edgeA[0] === edgeB[0] && edgeA[1] === edgeB[1]) return 1;\n    if (edgeA[0] === edgeB[1] && edgeA[1] === edgeB[0]) return -1;\n    return 0;\n  }\n\n  public get isNullEdge(): boolean {\n    return this[0] === this[1];\n  }\n  /**\n   * Lexical comparison of two edges.\n   * * If the edges have the same vertex pair (in same or opposite order) they will end up adjacent in a sort.\n   * * If the edges have 0 or 1 shared vertex indices, the one with lowest low comes first.\n   * @param edgeA first edge\n   * @param edgeB second edge\n   */\n  public static lessThan(edgeA: SortableEdge, edgeB: SortableEdge): number {\n    // primary compare is based on indirect indices\n    const lowA = edgeA.lowVertexIndex;\n    const lowB = edgeB.lowVertexIndex;\n    if (lowA < lowB)\n      return -1;\n    if (lowB < lowA)\n      return 1;\n    const highA = edgeA.highVertexIndex;\n    const highB = edgeB.highVertexIndex;\n    if (highA < highB)\n      return -1;\n    if (highB < highA)\n      return 1;\n    // undirected indices match ... use directed vertexIndexA\n    return edgeA.vertexIndexA - edgeB.vertexIndexA;\n  }\n  public constructor(vertexA: number, vertexB: number, facetIndex: number) {\n    super(3);\n    this[0] = vertexA;\n    this[1] = vertexB;\n    this[2] = facetIndex;\n  }\n  public toJSON(): any {\n    return [this[0], this[1], this[2]];\n  }\n  public static clusterToJSON(data: SortableEdgeCluster): any {\n    if (data instanceof SortableEdge)\n      return data.toJSON();\n    const result = [];\n    for (const edge of data) result.push(edge.toJSON());\n  }\n  public static clusterArrayToJSON(data: SortableEdgeCluster[]) {\n    const result = [];\n    for (const cluster of data)\n      result.push(SortableEdge.clusterToJSON(cluster));\n    return result;\n  }\n}\nexport type SortableEdgeCluster = SortableEdge | SortableEdge[];\n/**\n * An IndexedEdgeMatcher carries an array of edge start & end indices for sorting and subsequent analyses\n * (such as testing for closed mesh).\n */\nexport class IndexedEdgeMatcher {\n  public edges: SortableEdge[];\n\n  constructor() {\n    this.edges = [];\n  }\n  /**\n   * Push a new edge.\n   * @param vertexA start vertex\n   * @param vertexB end vertex\n   * @param facetIndex value to carry along during matching\n   * @returns the edge pushed onto the `edges` array\n   */\n  public addEdge(vertexA: number, vertexB: number, facetIndex: number): SortableEdge {\n    const edge = new SortableEdge(vertexA, vertexB, facetIndex);\n    this.edges.push(edge);\n    return edge;\n  }\n  /**\n   * Push edges all around a facet, returning to vertexArray[0].\n   * @param vertexArray array of vertex indices around facet\n   * @param facetIndex value to carry along during matching\n   * @param closeLoop true to add an edge from last to first vertex.\n   */\n  public addPath(vertexArray: number[], facetIndex: number, closeLoop: boolean = true) {\n    if (vertexArray.length === 0) return;\n    const m = vertexArray.length - 1;\n    for (let i = 0; i < m; i++) {\n      this.addEdge(vertexArray[i], vertexArray[i + 1], facetIndex);\n    }\n    if (closeLoop)\n      this.addEdge(vertexArray[m], vertexArray[0], facetIndex);\n  }\n  /** Sort the edge index array. */\n  public sort() {\n    this.edges.sort((edgeA, edgeB) => SortableEdge.lessThan(edgeA, edgeB));\n  }\n  /** Create a single or compound SortableEdgeCluster in dest. */\n  private collectSortableEdgeCluster(index0: number, index1: number, dest: SortableEdgeCluster[] | undefined) {\n    if (dest !== undefined && index1 > index0) {\n      if (index1 === index0 + 1) {\n        dest.push(this.edges[index0]);\n      } else {\n        const cluster = [];\n        for (let i = index0; i < index1; i++)\n          cluster.push(this.edges[i]);\n        dest.push(cluster);\n      }\n    }\n  }\n  /**\n   * Sort the edges, and look for three categories of paired edges:\n   * * caller must allocate all result arrays of interest.\n   * * Any combination of the result arrays may be `undefined`, indicating that category is to be ignored.\n   * * Any combination of the result arrays may be aliased as the same target, in which case those to categories are\n   * merged into the target.\n   * * For instance, to ignore manifold pairs and collect all others (singleton, null, and other) as a single array\n   * `allOther`, create `const allOther = []` as an empty array and call\n   * `sortAndCollectClusters (undefined, allOther, allOther, allOther);`\n   * @param manifoldPairs optional array to receive pairs of properly mated SortableEdgePairs, i.e. simple interior\n   * edges adjacent to two facets in opposing directions.\n   * @param singletons optional array to receive edges that are simple boundary edges.\n   * @param nullEdges optional array to receive arrays of null edges (same start and end vertex)\n   * @param allOtherClusters optional array to receive arrays in which all the edges are partners in an undirected sense\n   * but not a simple directed pair.\n   */\n  public sortAndCollectClusters(\n    manifoldPairs: SortableEdgeCluster[] | undefined,\n    singletons?: SortableEdgeCluster[],\n    nullEdges?: SortableEdgeCluster[],\n    allOtherClusters?: SortableEdgeCluster[],\n  ): void {\n    this.sort();\n    if (manifoldPairs) manifoldPairs.length = 0;\n    if (singletons) singletons.length = 0;\n    if (nullEdges) nullEdges.length = 0;\n    if (allOtherClusters) allOtherClusters.length = 0;\n    const n = this.edges.length;\n    let clusterLength;\n    for (let index0 = 0; index0 < n; index0 += clusterLength) {\n      const baseEdge = this.edges[index0];\n      clusterLength = 1;\n      for (let index1 = index0 + 1; index1 < n &&\n        SortableEdge.areUndirectedPartners(baseEdge, this.edges[index1]); index1++) {\n        clusterLength++;\n      }\n      if (this.edges[index0].isNullEdge) {\n        this.collectSortableEdgeCluster(index0, index0 + clusterLength, nullEdges);\n      } else if (clusterLength === 2 && SortableEdge.areDirectedPartners(baseEdge, this.edges[index0 + 1])) {\n        this.collectSortableEdgeCluster(index0, index0 + clusterLength, manifoldPairs);\n      } else if (clusterLength === 1) {\n        this.collectSortableEdgeCluster(index0, index0 + 1, singletons);\n      } else {\n        this.collectSortableEdgeCluster(index0, index0 + clusterLength, allOtherClusters);\n      }\n    }\n  }\n}\n"]}
+{"version":3,"file":"IndexedEdgeMatcher.js","sourceRoot":"","sources":["../../../src/polyface/IndexedEdgeMatcher.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F;;GAEG;AAEH;;;;;GAKG;AACH,MAAa,YAAY;IACf,EAAE,CAAW;IACb,EAAE,CAAS;IAEnB,mBAAmB;IACnB,YAAmB,WAAmB,EAAE,SAAiB,EAAE,UAAkB;QAC3E,IAAI,CAAC,EAAE,GAAG,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;QACnC,IAAI,CAAC,EAAE,GAAG,UAAU,CAAC;IACvB,CAAC;IACD,sBAAsB;IACf,KAAK;QACV,OAAO,IAAI,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;IAC3D,CAAC;IACD,uEAAuE;IACvE,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC;IACD,wEAAwE;IACxE,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC;IACD;;;OAGG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,EAAE,CAAC;IACjB,CAAC;IACD,6DAA6D;IAC7D,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACjC,CAAC;IACD,wDAAwD;IACxD,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAClD,CAAC;IACD,yDAAyD;IACzD,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAClD,CAAC;IACD,mFAAmF;IAC3E,MAAM,CAAC,WAAW,CAAC,KAAmB,EAAE,KAAmB;QACjE,OAAO,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACpE,CAAC;IACD,oFAAoF;IAC7E,MAAM,CAAC,mBAAmB,CAAC,KAAmB,EAAE,KAAmB;QACxE,OAAO,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACpE,CAAC;IACD,gGAAgG;IACzF,MAAM,CAAC,qBAAqB,CAAC,KAAmB,EAAE,KAAmB;QAC1E,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,mBAAmB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAClF,CAAC;IACD;;;;;OAKG;IACI,MAAM,CAAC,mBAAmB,CAAC,KAAmB,EAAE,KAAmB;QACxE,IAAI,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,KAAK,CAAC;YAChC,OAAO,CAAC,CAAC;QACX,IAAI,IAAI,CAAC,mBAAmB,CAAC,KAAK,EAAE,KAAK,CAAC;YACxC,OAAO,CAAC,CAAC,CAAC;QACZ,OAAO,CAAC,CAAC;IACX,CAAC;IACD,0DAA0D;IAC1D,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACnC,CAAC;IACD;;;;;OAKG;IACI,MAAM,CAAC,QAAQ,CAAC,KAAmB,EAAE,KAAmB;QAC7D,+CAA+C;QAC/C,MAAM,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC;QAC7B,MAAM,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC;QAC7B,IAAI,IAAI,GAAG,IAAI;YACb,OAAO,CAAC,CAAC,CAAC;QACZ,IAAI,IAAI,GAAG,IAAI;YACb,OAAO,CAAC,CAAC;QACX,MAAM,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC;QAC/B,MAAM,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC;QAC/B,IAAI,KAAK,GAAG,KAAK;YACf,OAAO,CAAC,CAAC,CAAC;QACZ,IAAI,KAAK,GAAG,KAAK;YACf,OAAO,CAAC,CAAC;QACX,yDAAyD;QACzD,OAAO,KAAK,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;IAC/C,CAAC;IACD,4CAA4C;IACrC,MAAM;QACX,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;IAC3C,CAAC;IACD,+CAA+C;IACxC,MAAM,CAAC,aAAa,CAAC,IAAyB;QACnD,IAAI,IAAI,YAAY,YAAY;YAC9B,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;QACvB,MAAM,MAAM,GAAG,EAAE,CAAC;QAClB,KAAK,MAAM,IAAI,IAAI,IAAI;YACrB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IAC/B,CAAC;IACD,oDAAoD;IAC7C,MAAM,CAAC,kBAAkB,CAAC,IAA2B;QAC1D,MAAM,MAAM,GAAG,EAAE,CAAC;QAClB,KAAK,MAAM,OAAO,IAAI,IAAI;YACxB,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;QACnD,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AA/GD,oCA+GC;AAQD;;;;GAIG;AACH,MAAa,kBAAkB;IAC7B,uCAAuC;IAChC,KAAK,CAAiB;IAC7B,wEAAwE;IACxE;QACE,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;IAClB,CAAC;IACD;;;;;;OAMG;IACI,OAAO,CAAC,OAAe,EAAE,OAAe,EAAE,UAAkB;QACjE,MAAM,IAAI,GAAG,IAAI,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAC5D,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;;;OAMG;IACI,OAAO,CAAC,aAAuB,EAAE,UAAkB,EAAE,SAAkB;QAC5E,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC;YAC5B,OAAO;QACT,MAAM,CAAC,GAAG,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC;QACnC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE;YACxB,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC;QACnE,IAAI,SAAS;YACX,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC;IACjE,CAAC;IACD,sBAAsB;IACf,IAAI;QACT,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;IACzE,CAAC;IACD,+DAA+D;IACvD,0BAA0B,CAAC,MAAc,EAAE,MAAc,EAAE,IAAuC;QACxG,IAAI,IAAI,KAAK,SAAS,IAAI,MAAM,GAAG,MAAM,EAAE,CAAC;YAC1C,IAAI,MAAM,KAAK,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC1B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;YAChC,CAAC;iBAAM,CAAC;gBACN,MAAM,OAAO,GAAG,EAAE,CAAC;gBACnB,KAAK,IAAI,CAAC,GAAG,MAAM,EAAE,CAAC,GAAG,MAAM,EAAE,CAAC,EAAE;oBAClC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC9B,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACrB,CAAC;QACH,CAAC;IACH,CAAC;IACD;;;;;;;;;;;;;OAaG;IACI,sBAAsB,CAC3B,aAAqC,EACrC,UAAkC,EAClC,SAAiC,EACjC,gBAAwC;QAExC,IAAI,CAAC,IAAI,EAAE,CAAC;QACZ,IAAI,aAAa;YACf,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC;QAC3B,IAAI,UAAU;YACZ,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC;QACxB,IAAI,SAAS;YACX,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;QACvB,IAAI,gBAAgB;YAClB,gBAAgB,CAAC,MAAM,GAAG,CAAC,CAAC;QAC9B,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;QAC5B,IAAI,aAAa,CAAC;QAClB,KAAK,IAAI,MAAM,GAAG,CAAC,EAAE,MAAM,GAAG,CAAC,EAAE,MAAM,IAAI,aAAa,EAAE,CAAC;YACzD,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YACpC,aAAa,GAAG,CAAC,CAAC;YAClB,KAAK,IAAI,MAAM,GAAG,MAAM,GAAG,CAAC,EAAE,MAAM,GAAG,CAAC;gBACtC,YAAY,CAAC,qBAAqB,CAAC,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC;gBAC7E,aAAa,EAAE,CAAC;YAClB,CAAC;YACD,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,UAAU;gBAC/B,IAAI,CAAC,0BAA0B,CAAC,MAAM,EAAE,MAAM,GAAG,aAAa,EAAE,SAAS,CAAC,CAAC;iBACxE,IAAI,aAAa,KAAK,CAAC,IAAI,YAAY,CAAC,mBAAmB,CAAC,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;gBAChG,IAAI,CAAC,0BAA0B,CAAC,MAAM,EAAE,MAAM,GAAG,aAAa,EAAE,aAAa,CAAC,CAAC;iBAC5E,IAAI,aAAa,KAAK,CAAC;gBAC1B,IAAI,CAAC,0BAA0B,CAAC,MAAM,EAAE,MAAM,GAAG,CAAC,EAAE,UAAU,CAAC,CAAC;;gBAEhE,IAAI,CAAC,0BAA0B,CAAC,MAAM,EAAE,MAAM,GAAG,aAAa,EAAE,gBAAgB,CAAC,CAAC;QACtF,CAAC;IACH,CAAC;CACF;AApGD,gDAoGC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n\n/** @packageDocumentation\n * @module Polyface\n */\n\n/**\n * Represent an [[IndexedPolyface]] edge as:\n * * vertex start index and vertex end index (CCW order around its facet)\n * * an additional number to associate with the edge (e.g., facet index)\n * @public\n */\nexport class SortableEdge {\n  private _v: number[];\n  private _a: number;\n\n  /** Constructor. */\n  public constructor(startVertex: number, endVertex: number, facetIndex: number) {\n    this._v = [startVertex, endVertex];\n    this._a = facetIndex;\n  }\n  /** Clone the edge. */\n  public clone(): SortableEdge {\n    return new SortableEdge(this._v[0], this._v[1], this._a);\n  }\n  /** Return the vertex index that appears first in the order stored.  */\n  public get startVertex(): number {\n    return this._v[0];\n  }\n  /** Return the vertex index that appears second in the order stored.  */\n  public get endVertex(): number {\n    return this._v[1];\n  }\n  /**\n   * Return the facet index.\n   * * This value is carried along during matching. Typically it is a facet index, but it does not have to be.\n   */\n  public get facetIndex(): number {\n    return this._a;\n  }\n  /** return true if `startVertex` is less than `endVertex`. */\n  public get isLowHigh(): boolean {\n    return this._v[0] < this._v[1];\n  }\n  /** Return the vertex index with lower numeric value. */\n  public get lowVertex(): number {\n    return this.isLowHigh ? this._v[0] : this._v[1];\n  }\n  /** Return the vertex index with higher numeric value. */\n  public get highVertex(): number {\n    return this.isLowHigh ? this._v[1] : this._v[0];\n  }\n  /** Return true if edgeA and edgeB traverse the same edge in the same direction. */\n  private static areSameEdge(edgeA: SortableEdge, edgeB: SortableEdge): boolean {\n    return edgeA._v[0] === edgeB._v[0] && edgeA._v[1] === edgeB._v[1];\n  }\n  /** Return true if edgeA and edgeB traverse the same edge in opposite directions. */\n  public static areDirectedPartners(edgeA: SortableEdge, edgeB: SortableEdge): boolean {\n    return edgeA._v[0] === edgeB._v[1] && edgeA._v[1] === edgeB._v[0];\n  }\n  /** Return true if edgeA and edgeB traverse the same edge in the same or opposite directions. */\n  public static areUndirectedPartners(edgeA: SortableEdge, edgeB: SortableEdge): boolean {\n    return this.areSameEdge(edgeA, edgeB) || this.areDirectedPartners(edgeA, edgeB);\n  }\n  /**\n   * Return numeric identifier for the relationship between edgeA and edgeB:\n   * * 1 if they share start and end vertex indices in the same order.\n   * * -1 if they share start and end vertex indices in reversed order.\n   * * 0 otherwise.\n   */\n  public static relativeOrientation(edgeA: SortableEdge, edgeB: SortableEdge): number {\n    if (this.areSameEdge(edgeA, edgeB))\n      return 1;\n    if (this.areDirectedPartners(edgeA, edgeB))\n      return -1;\n    return 0;\n  }\n  /** Whether the start and end vertex indices are equal. */\n  public get isNullEdge(): boolean {\n    return this._v[0] === this._v[1];\n  }\n  /**\n   * Lexical comparison of two edges.\n   * * If the edges have the same vertex index pair (in same or opposite order) they will end up adjacent in a sort.\n   * @param edgeA first edge\n   * @param edgeB second edge\n   */\n  public static lessThan(edgeA: SortableEdge, edgeB: SortableEdge): number {\n    // primary compare is based on indirect indices\n    const lowA = edgeA.lowVertex;\n    const lowB = edgeB.lowVertex;\n    if (lowA < lowB)\n      return -1;\n    if (lowB < lowA)\n      return 1;\n    const highA = edgeA.highVertex;\n    const highB = edgeB.highVertex;\n    if (highA < highB)\n      return -1;\n    if (highB < highA)\n      return 1;\n    // undirected indices match ... use directed vertexIndexA\n    return edgeA.startVertex - edgeB.startVertex;\n  }\n  /** Return the edge data as a JSON array. */\n  public toJSON(): any {\n    return [this._v[0], this._v[1], this._a];\n  }\n  /** Return the edge cluster in JSON format.  */\n  public static clusterToJSON(data: SortableEdgeCluster): any {\n    if (data instanceof SortableEdge)\n      return data.toJSON();\n    const result = [];\n    for (const edge of data)\n      result.push(edge.toJSON());\n  }\n  /** Return the edge cluster array in JSON format. */\n  public static clusterArrayToJSON(data: SortableEdgeCluster[]) {\n    const result = [];\n    for (const cluster of data)\n      result.push(SortableEdge.clusterToJSON(cluster));\n    return result;\n  }\n}\n\n/**\n * Union type for a single [[SortableEdge]] or a (matched) array of them.\n * @public\n */\nexport type SortableEdgeCluster = SortableEdge | SortableEdge[];\n\n/**\n * An IndexedEdgeMatcher carries an array of edge start and end indices for sorting and subsequent analyses,\n * such as testing for closed mesh.\n * @public\n */\nexport class IndexedEdgeMatcher {\n  /** The array of edges to be sorted. */\n  public edges: SortableEdge[];\n  /** Constructor. Call [[addEdge]] or [[addPath]] to populate `edges`. */\n  public constructor() {\n    this.edges = [];\n  }\n  /**\n   * Push a new edge.\n   * @param vertexA start vertex\n   * @param vertexB end vertex\n   * @param facetIndex value to carry along during matching\n   * @returns the edge pushed onto the `edges` array\n   */\n  public addEdge(vertexA: number, vertexB: number, facetIndex: number): SortableEdge {\n    const edge = new SortableEdge(vertexA, vertexB, facetIndex);\n    this.edges.push(edge);\n    return edge;\n  }\n  /**\n   * Push edges along a path.\n   * * Typically used to add edges around a facet.\n   * @param vertexIndices array of vertex indices along an open or closed path.\n   * @param facetIndex value to set on each edge pushed.\n   * @param closeLoop true to add an edge from last to first vertex.\n   */\n  public addPath(vertexIndices: number[], facetIndex: number, closeLoop: boolean) {\n    if (vertexIndices.length === 0)\n      return;\n    const m = vertexIndices.length - 1;\n    for (let i = 0; i < m; i++)\n      this.addEdge(vertexIndices[i], vertexIndices[i + 1], facetIndex);\n    if (closeLoop)\n      this.addEdge(vertexIndices[m], vertexIndices[0], facetIndex);\n  }\n  /** Sort the edges. */\n  public sort() {\n    this.edges.sort((edgeA, edgeB) => SortableEdge.lessThan(edgeA, edgeB));\n  }\n  /** Create a single or compound SortableEdgeCluster in dest. */\n  private collectSortableEdgeCluster(index0: number, index1: number, dest: SortableEdgeCluster[] | undefined) {\n    if (dest !== undefined && index1 > index0) {\n      if (index1 === index0 + 1) {\n        dest.push(this.edges[index0]);\n      } else {\n        const cluster = [];\n        for (let i = index0; i < index1; i++)\n          cluster.push(this.edges[i]);\n        dest.push(cluster);\n      }\n    }\n  }\n  /**\n   * Sort the edges, and collect up to four categories of edges: manifold pairs, singletons, null edges,\n   * and everything else.\n   * * Caller should allocate arrays of interest.\n   * * Any combination of the arrays may be `undefined`, indicating that category is to be ignored.\n   * * Any combination of the arrays may be aliased as the same target, in which case the aliased categories are\n   * merged into the target.\n   * * For instance, to ignore manifold pairs and collect all other edges in a single array:\n   * `const foo = []; matcher.sortAndCollectClusters(undefined, foo, foo, foo);`\n   * @param manifoldPairs array to receive pairs of properly mated edges, i.e. mesh interior edges.\n   * @param singletons array to receive edges that have no partner, i.e., mesh boundary edges.\n   * @param nullEdges array to receive arrays of matched null edges, for which start === end vertex index.\n   * @param allOtherClusters array to receive arrays of edges that are partners in an undirected, non-manifold sense.\n   */\n  public sortAndCollectClusters(\n    manifoldPairs?: SortableEdgeCluster[],\n    singletons?: SortableEdgeCluster[],\n    nullEdges?: SortableEdgeCluster[],\n    allOtherClusters?: SortableEdgeCluster[],\n  ): void {\n    this.sort();\n    if (manifoldPairs)\n      manifoldPairs.length = 0;\n    if (singletons)\n      singletons.length = 0;\n    if (nullEdges)\n      nullEdges.length = 0;\n    if (allOtherClusters)\n      allOtherClusters.length = 0;\n    const n = this.edges.length;\n    let clusterLength;\n    for (let index0 = 0; index0 < n; index0 += clusterLength) {\n      const baseEdge = this.edges[index0];\n      clusterLength = 1;\n      for (let index1 = index0 + 1; index1 < n &&\n        SortableEdge.areUndirectedPartners(baseEdge, this.edges[index1]); index1++) {\n        clusterLength++;\n      }\n      if (this.edges[index0].isNullEdge)\n        this.collectSortableEdgeCluster(index0, index0 + clusterLength, nullEdges);\n      else if (clusterLength === 2 && SortableEdge.areDirectedPartners(baseEdge, this.edges[index0 + 1]))\n        this.collectSortableEdgeCluster(index0, index0 + clusterLength, manifoldPairs);\n      else if (clusterLength === 1)\n        this.collectSortableEdgeCluster(index0, index0 + 1, singletons);\n      else\n        this.collectSortableEdgeCluster(index0, index0 + clusterLength, allOtherClusters);\n    }\n  }\n}\n"]}

package/lib/cjs/polyface/IndexedPolyfaceVisitor.d.ts

@@ -40,7 +40,7 @@ export declare class IndexedPolyfaceVisitor extends PolyfaceData implements Poly
     moveToReadIndex(facetIndex: number): boolean;
     /** Advance the iterator to a the 'next' facet in the client polyface. */
     moveToNextFacet(): boolean;
-    /** Reset the iterator to start at the first facet of the polyface. */
+    /** Restart the visitor at the first facet. */
     reset(): void;
     /**
      * Attempts to extract the distance parameter for the given vertex `index` on the current facet.
@@ -73,6 +73,8 @@ export declare class IndexedPolyfaceVisitor extends PolyfaceData implements Poly
      * * All data values are interpolated at `fraction` between `other` values at `index0` and `index1`.
      */
     pushInterpolatedDataFrom(other: PolyfaceVisitor, index0: number, fraction: number, index1: number): void;
+    /** Create a visitor for a subset of the facets visitable by the instance. */
+    createSubsetVisitor(facetIndices: number[], numWrap?: number): IndexedPolyfaceSubsetVisitor;
 }
 /**
  * An `IndexedPolyfaceSubsetVisitor` is an `IndexedPolyfaceVisitor` which only visits a subset of facets in the polyface.
@@ -81,38 +83,37 @@ export declare class IndexedPolyfaceVisitor extends PolyfaceData implements Poly
  * @public
  */
 export declare class IndexedPolyfaceSubsetVisitor extends IndexedPolyfaceVisitor {
-    private _parentFacetIndices?;
-    private _currentActiveIndex;
-    private _nextActiveIndex;
+    private _facetIndices;
+    private _currentSubsetIndex;
+    private _nextSubsetIndex;
     private constructor();
     private isValidSubsetIndex;
     /**
      * Create a visitor for iterating a subset of the facets of `polyface`.
      * @param polyface reference to the client polyface, supplying facets
-     * @param activeFacetIndices array of indices of facets in the client polyface to visit. This array is cloned.
+     * @param facetIndices array of indices of facets in the client polyface to visit. This array is cloned.
      * @param numWrap number of vertices replicated in the visitor arrays to facilitate simpler caller code. Default is zero.
      */
-    static createSubsetVisitor(polyface: IndexedPolyface, activeFacetIndices: number[], numWrap?: number): IndexedPolyfaceSubsetVisitor;
+    static createSubsetVisitor(polyface: IndexedPolyface, facetIndices: number[], numWrap?: number): IndexedPolyfaceSubsetVisitor;
     /**
      * Advance the iterator to a particular facet in the subset of client polyface facets.
-     * @param activeIndex the index of the facet within the subset, not to be confused with the index of the facet within
-     * the client polyface.
+     * @param subsetIndex index into the subset array, not to be confused with the client facet index.
      * @return whether the iterator was successfully moved.
      */
-    moveToReadIndex(activeIndex: number): boolean;
+    moveToReadIndex(subsetIndex: number): boolean;
     /**
      * Advance the iterator to the next facet in the subset of client polyface facets.
      * @return whether the iterator was successfully moved.
      */
     moveToNextFacet(): boolean;
-    /** Reset the iterator to start at the first active facet in the subset of client polyface facets. */
+    /** Restart the visitor at the first facet. */
     reset(): void;
     /**
-     * Return the parent facet index of the indicated index within the subset of client polyface facets.
-     * @param activeIndex index of the facet within the subset. Default is the active facet.
-     * @return valid client polyface facet index, or `undefined` if invalid input index.
+     * Return the client polyface facet index (aka "readIndex") for the given subset index.
+     * @param subsetIndex index into the subset array. Default is the subset index of the currently visited facet.
+     * @return valid client polyface facet index, or `undefined` if invalid subset index.
      */
-    parentFacetIndex(activeIndex?: number): number | undefined;
+    parentFacetIndex(subsetIndex?: number): number | undefined;
     /** Return the number of facets this visitor is able to visit. */
     getVisitableFacetCount(): number;
     /**

package/lib/cjs/polyface/IndexedPolyfaceVisitor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"IndexedPolyfaceVisitor.d.ts","sourceRoot":"","sources":["../../../src/polyface/IndexedPolyfaceVisitor.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,+BAA+B,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AAEzD,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C;;;;GAIG;AACH,qBAAa,sBAAuB,SAAQ,YAAa,YAAW,eAAe;IACjF,OAAO,CAAC,kBAAkB,CAAS;IACnC,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,SAAS,CAAkB;IAEnC,SAAS,aAAa,QAAQ,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM;IAchE,yCAAyC;IAClC,cAAc,IAAI,eAAe;IAGxC,iEAAiE;IAC1D,sBAAsB,IAAI,MAAM;IAGvC;;;;;;;;OAQG;IACI,UAAU,CAAC,OAAO,EAAE,MAAM;IAGjC;;;OAGG;IACH,IAAW,iBAAiB,IAAI,MAAM,CAErC;IACD,+DAA+D;WACjD,MAAM,CAAC,QAAQ,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,GAAG,sBAAsB;IAGxF,yEAAyE;IAClE,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO;IAenD,yEAAyE;IAClE,eAAe,IAAI,OAAO;IAMjC,sEAAsE;IAC/D,KAAK,IAAI,IAAI;IAIpB;;;OAGG;IACI,uBAAuB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,SAAS;IAcpF;;;OAGG;IACI,yBAAyB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,SAAS;IActF,sFAAsF;IAC/E,gBAAgB,IAAI,MAAM;IAGjC,8EAA8E;IACvE,gBAAgB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM;IAG1C,8EAA8E;IACvE,gBAAgB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM;IAG1C,+EAA+E;IACxE,iBAAiB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM;IAG3C,8EAA8E;IACvE,gBAAgB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM;IAG1C,iFAAiF;IAC1E,cAAc,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM;IAGxC,6CAA6C;IACtC,WAAW,IAAI,IAAI;IAW1B,iGAAiG;IAC1F,YAAY,CAAC,KAAK,EAAE,eAAe,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAWhE;;;OAGG;IACI,wBAAwB,CAAC,KAAK,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;CAchH;AACD;;;;;GAKG;AACH,qBAAa,4BAA6B,SAAQ,sBAAsB;IACtE,OAAO,CAAC,mBAAmB,CAAC,CAAW;IACvC,OAAO,CAAC,mBAAmB,CAAS;IACpC,OAAO,CAAC,gBAAgB,CAAS;IAEjC,OAAO;IAMP,OAAO,CAAC,kBAAkB;IAG1B;;;;;OAKG;WACW,mBAAmB,CAC/B,QAAQ,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,EAAE,EAAE,OAAO,GAAE,MAAU,GAC3E,4BAA4B;IAG/B;;;;;OAKG;IACa,eAAe,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO;IAQ7D;;;OAGG;IACa,eAAe,IAAI,OAAO;IAM1C,qGAAqG;IACrF,KAAK,IAAI,IAAI;IAI7B;;;;OAIG;IACI,gBAAgB,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAKjE,iEAAiE;IACjD,sBAAsB,IAAI,MAAM;IAGhD;;;;;;;;;;;;MAYE;WACY,sBAAsB,CAClC,IAAI,EAAE,eAAe,GAAG,sBAAsB,EAC9C,aAAa,GAAE,QAA2B,EAC1C,SAAS,GAAE,KAAgC,EAC3C,OAAO,GAAE,MAAU,GAClB,4BAA4B;CAiBhC"}
+{"version":3,"file":"IndexedPolyfaceVisitor.d.ts","sourceRoot":"","sources":["../../../src/polyface/IndexedPolyfaceVisitor.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,+BAA+B,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AAEzD,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C;;;;GAIG;AACH,qBAAa,sBAAuB,SAAQ,YAAa,YAAW,eAAe;IACjF,OAAO,CAAC,kBAAkB,CAAS;IACnC,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,SAAS,CAAkB;IAEnC,SAAS,aAAa,QAAQ,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM;IAahE,yCAAyC;IAClC,cAAc,IAAI,eAAe;IAGxC,iEAAiE;IAC1D,sBAAsB,IAAI,MAAM;IAGvC;;;;;;;;OAQG;IACI,UAAU,CAAC,OAAO,EAAE,MAAM;IAGjC;;;OAGG;IACH,IAAW,iBAAiB,IAAI,MAAM,CAErC;IACD,+DAA+D;WACjD,MAAM,CAAC,QAAQ,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,GAAG,sBAAsB;IAGxF,yEAAyE;IAClE,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO;IAkBnD,yEAAyE;IAClE,eAAe,IAAI,OAAO;IAMjC,8CAA8C;IACvC,KAAK,IAAI,IAAI;IAIpB;;;OAGG;IACI,uBAAuB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,SAAS;IAcpF;;;OAGG;IACI,yBAAyB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,SAAS;IActF,sFAAsF;IAC/E,gBAAgB,IAAI,MAAM;IAGjC,8EAA8E;IACvE,gBAAgB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM;IAG1C,8EAA8E;IACvE,gBAAgB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM;IAG1C,+EAA+E;IACxE,iBAAiB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM;IAG3C,8EAA8E;IACvE,gBAAgB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM;IAG1C,iFAAiF;IAC1E,cAAc,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM;IAGxC,6CAA6C;IACtC,WAAW,IAAI,IAAI;IAW1B,iGAAiG;IAC1F,YAAY,CAAC,KAAK,EAAE,eAAe,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAWhE;;;OAGG;IACI,wBAAwB,CAAC,KAAK,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;IAc/G,6EAA6E;IACtE,mBAAmB,CAAC,YAAY,EAAE,MAAM,EAAE,EAAE,OAAO,GAAE,MAAU,GAAG,4BAA4B;CAGtG;AAED;;;;;GAKG;AACH,qBAAa,4BAA6B,SAAQ,sBAAsB;IACtE,OAAO,CAAC,aAAa,CAAW;IAChC,OAAO,CAAC,mBAAmB,CAAS;IACpC,OAAO,CAAC,gBAAgB,CAAS;IAEjC,OAAO;IAOP,OAAO,CAAC,kBAAkB;IAG1B;;;;;OAKG;WACW,mBAAmB,CAC/B,QAAQ,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,OAAO,GAAE,MAAU,GACrE,4BAA4B;IAG/B;;;;OAIG;IACa,eAAe,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO;IAQ7D;;;OAGG;IACa,eAAe,IAAI,OAAO;IAM1C,8CAA8C;IAC9B,KAAK,IAAI,IAAI;IAM7B;;;;OAIG;IACI,gBAAgB,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAKjE,iEAAiE;IACjD,sBAAsB,IAAI,MAAM;IAGhD;;;;;;;;;;;;MAYE;WACY,sBAAsB,CAClC,IAAI,EAAE,eAAe,GAAG,sBAAsB,EAC9C,aAAa,GAAE,QAA2B,EAC1C,SAAS,GAAE,KAAgC,EAC3C,OAAO,GAAE,MAAU,GAClB,4BAA4B;CAiBhC"}