@itwin/core-geometry 5.0.0-dev.1 → 5.0.0-dev.100

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

@@ -5,7 +5,7 @@ import { GeometryQuery } from "../curve/GeometryQuery";
 import { GeometryHandler } from "../geometry3d/GeometryHandler";
 import { Point2d } from "../geometry3d/Point2dVector2d";
 import { Point3d, Vector3d } from "../geometry3d/Point3dVector3d";
-import { Range3d } from "../geometry3d/Range";
+import { Range1d, Range3d } from "../geometry3d/Range";
 import { Transform } from "../geometry3d/Transform";
 import { FacetFaceData } from "./FacetFaceData";
 import { IndexedPolyfaceVisitor } from "./IndexedPolyfaceVisitor";
@@ -27,7 +27,9 @@ export declare abstract class Polyface extends GeometryQuery {
      * @param numWrap the number of vertices to replicate in visitor arrays.
      */
     abstract createVisitor(numWrap: number): PolyfaceVisitor;
-    /** Flag indicating if the mesh display must assume both sides are visible. */
+    /**
+     * The [[PolyfaceData.twoSided]] flag.
+     */
     get twoSided(): boolean;
     set twoSided(value: boolean);
     /**
@@ -81,6 +83,15 @@ export declare class IndexedPolyface extends Polyface {
      * @param facetToFacetData optional array of face identifiers (e.g. known during clone)
      */
     protected constructor(data: PolyfaceData, facetStart?: number[], facetToFaceData?: number[]);
+    /** Given an edgeIndex (index into `data.pointIndex`), return the index of the facet containing the edge. */
+    edgeIndexToFacetIndex(k: number | undefined): number | undefined;
+    /**
+     * Given an edgeIndex (index into `data.pointIndex`), return the range of the edgeIndices of the containing facet.
+     * * If an edge with edgeIndex `k` is found in the facet with facetIndex `f`, then the returned range `r` satisfies
+     * `r.low = this.facetIndex0(f) <= k < this.facetIndex1(f) = r.high` and can be used to iterate the facet's face
+     * loop. See [[facetIndex0]].
+     */
+    edgeIndexToFaceLoop(k: number | undefined): Range1d | undefined;
     /** Test if other is an instance of `IndexedPolyface` */
     isSameGeometryClass(other: any): boolean;
     /** Tests for equivalence between two IndexedPolyfaces. */
@@ -89,11 +100,9 @@ export declare class IndexedPolyface extends Polyface {
     get isEmpty(): boolean;
     /**
      * Transform the mesh.
-     * * Apply the transform to points.
-     * * Apply the (inverse transpose of the) matrix part to normals.
-     * * If determinant of the transform matrix is negative, also
-     *   * negate normals
-     *   * reverse index order around each facet.
+     * * If `transform` is a mirror, also reverse the index order around each facet.
+     * * Note that this method always returns true. If transforming the normals fails (due to singular matrix or zero
+     * normal), the original normal(s) are left unchanged.
      */
     tryTransformInPlace(transform: Transform): boolean;
     /** Reverse indices for a single facet. */
@@ -113,7 +122,7 @@ export declare class IndexedPolyface extends Polyface {
      * Return face data using a facet index.
      * * Returns `undefined` if none found.
      * * This is the REFERENCE to the FacetFaceData not a copy.
-     */
+    */
     tryGetFaceData(i: number): FacetFaceData | undefined;
     /**
      * Add facets from `source` to `this` polyface.
@@ -136,7 +145,7 @@ export declare class IndexedPolyface extends Polyface {
      * @param needNormals `true` to allocate empty normal data and index arrays; `false` (default) to leave undefined.
      * @param needParams `true` to allocate empty uv parameter data and index arrays; `false` (default) to leave undefined.
      * @param needColors `true` to allocate empty color data and index arrays; `false` (default) to leave undefined.
-     * @param twoSided `true` if the facets are to be considered viewable from the back; `false` (default) if not.
+     * @param twoSided `true` (default) if the facets are to be considered viewable from the back; `false` if they are amenable to backface culling.
      */
     static create(needNormals?: boolean, needParams?: boolean, needColors?: boolean, twoSided?: boolean): IndexedPolyface;
     /**
@@ -234,14 +243,32 @@ export declare class IndexedPolyface extends Polyface {
     /** Number of normals (read-only property). */
     get normalCount(): number;
     /** Test if `index` is a valid facet index. */
-    isValidFacetIndex(index: number): boolean;
+    isValidFacetIndex(facetIndex: number): boolean;
     /** Return the number of edges in a particular facet. */
     numEdgeInFacet(facetIndex: number): number;
-    /** ASSUME valid facet index. Return start index of facet in pointIndex arrays. */
-    facetIndex0(index: number): number;
-    /** ASSUME valid facet index. Return one past end index of facet in pointIndex arrays. */
-    facetIndex1(index: number): number;
-    /** Create a visitor for this polyface */
+    /**
+     * Given a valid facet index, return the index at which its face loop starts in the index arrays.
+     * * A "face loop" is a contiguous block of indices into the parallel polyface index arrays.
+     * * Each of these indices represents an edge of a facet, thus it is sometimes called an "edgeIndex".
+     * * Together with [[facetIndex1]], this method can be used to iterate the face loop of the facet
+     * with index `iFacet` as follows:
+     * ````
+     * for (let iEdge = this.facetIndex0(iFacet); iEdge < this.facetIndex1(iFacet); iEdge++) {
+     *   const iPoint = this.data.pointIndex[iEdge];
+     *   const p = this.data.point[iPoint];
+     *   // ... process the edge of this facet starting at point p
+     * }
+     * ````
+     */
+    facetIndex0(facetIndex: number): number;
+    /**
+     * Given a valid facet index, return one past the index at which its face loop ends in the index arrays.
+     * * For details, see [[facetIndex0]].
+     */
+    facetIndex1(facetIndex: number): number;
+    /** Return a readonly reference to the facetStart array accessed by [[facetIndex0]] and [[facetIndex1]]. */
+    get facetStart(): ReadonlyArray<number>;
+    /** create a visitor for this polyface */
     createVisitor(numWrap?: number): IndexedPolyfaceVisitor;
     /** Return the range of (optionally transformed) points in this mesh. */
     range(transform?: Transform, result?: Range3d): Range3d;
@@ -265,8 +292,8 @@ export declare class IndexedPolyface extends Polyface {
  * A PolyfaceVisitor manages data while walking through facets.
  * * The polyface visitor holds data for one facet at a time.
  * * The caller can request the position in the addressed polyfaceData as a "readIndex".
- * * The readIndex values (as numbers) are not promised to be sequential (i.e., it might be a simple facet count
- * or might have "gaps" at the whim of the particular PolyfaceVisitor implementation).
+ * * The readIndex values (as numbers) are not assumed to be sequential (i.e., they might be contiguous facet indices
+ * or the indexing scheme might have gaps at the whim of the particular PolyfaceVisitor implementation).
  * @public
  */
 export interface PolyfaceVisitor extends PolyfaceData {
@@ -292,7 +319,7 @@ export interface PolyfaceVisitor extends PolyfaceData {
     clientPolyface(): Polyface | undefined;
     /**
      * Set the number of vertices replicated in visitor arrays (both data and index arrays).
-     * * 0,1,2 are the most common as numWrap.
+     * * 0,1,2 are the most common values.
      * * Example: suppose `[6,7,8]` is the pointIndex array representing a triangle. First edge would be `6,7`. Second
      * edge is `7,8`. Third edge is `8,6`. To access `6` for the third edge, we have to go back to the start of array.
      * Therefore, it is useful to store `6` at the end of pointIndex array, i.e., `[6,7,8,6]` meaning `numWrap = 1`.
@@ -300,7 +327,7 @@ export interface PolyfaceVisitor extends PolyfaceData {
      * the next two points, e.g., to form two adjacent vectors for a cross product.
      */
     setNumWrap(numWrap: number): void;
-    /** Clear the contents of all arrays. Use this along with `pushDataFrom` to build up new facets. */
+    /** Clear the contents of the data arrays. Use this along with `pushDataFrom` to build up new facets. */
     clearArrays(): void;
     /** Transfer data from a specified index of the other visitor as new data in this visitor. */
     pushDataFrom(other: PolyfaceVisitor, index: number): void;

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

@@ -1 +1 @@
-{"version":3,"file":"Polyface.d.ts","sourceRoot":"","sources":["../../../src/polyface/Polyface.ts"],"names":[],"mappings":"AAKA;;GAEG;AAIH,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAEvD,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAGhE,OAAO,EAAE,OAAO,EAAE,MAAM,+BAA+B,CAAC;AACxD,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AAElE,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C;;;;GAIG;AACH,8BAAsB,QAAS,SAAQ,aAAa;IAClD,wCAAwC;IACxC,SAAgB,gBAAgB,cAAc;IAC9C,gCAAgC;IACzB,IAAI,EAAE,YAAY,CAAC;IAC1B,kBAAkB;IAClB,SAAS,aAAa,IAAI,EAAE,YAAY;IAIxC;;;OAGG;aACa,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,eAAe;IAC/D,8EAA8E;IAC9E,IAAW,QAAQ,IAGQ,OAAO,CADjC;IACD,IAAW,QAAQ,CAAC,KAAK,EAAE,OAAO,EAEjC;IACD;;;;OAIG;IACH,IAAW,eAAe,IAAI,MAAM,CAEnC;IACD,IAAW,eAAe,CAAC,KAAK,EAAE,MAAM,EAEvC;IACD;;;;;;;;;;OAUG;WACW,eAAe,CAC3B,OAAO,EAAE,MAAM,EAAE,GAAG,SAAS,EAC7B,cAAc,EAAE,MAAM,EACtB,cAAc,EAAE,MAAM,EACtB,IAAI,EAAE,GAAG,EACT,UAAU,EAAE,MAAM,GACjB,OAAO;IAcV,mDAAmD;IACnD,aAAoB,OAAO,IAAI,OAAO,CAAC;IACvC,iFAAiF;IACjF,IAAW,UAAU,IAAI,MAAM,GAAG,SAAS,CAE1C;CACF;AAED;;;;GAIG;AACH,qBAAa,eAAgB,SAAQ,QAAQ;IAC3C;;;;;;;OAOG;IACH,SAAS,CAAC,WAAW,EAAE,MAAM,EAAE,CAAC;IAChC;;;OAGG;IACH,SAAS,CAAC,gBAAgB,EAAE,MAAM,EAAE,CAAC;IACrC;;;;;OAKG;IACH,SAAS,aAAa,IAAI,EAAE,YAAY,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,EAAE,eAAe,CAAC,EAAE,MAAM,EAAE;IAa3F,wDAAwD;IACjD,mBAAmB,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO;IAG/C,0DAA0D;IAC1C,aAAa,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO;IAQlD,gFAAgF;IAChF,IAAW,OAAO,IAAI,OAAO,CAE5B;IACD;;;;;;;OAOG;IACI,mBAAmB,CAAC,SAAS,EAAE,SAAS;IAU/C,0CAA0C;IACnC,kBAAkB,CAAC,OAAO,EAAE,MAAM;IAGzC,2BAA2B;IACpB,KAAK,IAAI,eAAe;IAI/B;;;OAGG;IACI,gBAAgB,CAAC,SAAS,EAAE,SAAS,GAAG,eAAe;IAK9D,sDAAsD;IAC/C,cAAc;IAGrB,mDAAmD;IAC5C,cAAc;IAGrB;;;;OAIG;IACI,cAAc,CAAC,CAAC,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS;IAQ3D;;;;;;OAMG;IACI,kBAAkB,CAAC,MAAM,EAAE,eAAe,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,GAAG,SAAS;IAsGtG;;;;;;OAMG;IACH,IAAW,wBAAwB,IAAI,MAAM,CAE5C;IACD;;;;;;OAMG;WACW,MAAM,CAClB,WAAW,GAAE,OAAe,EAC5B,UAAU,GAAE,OAAe,EAC3B,UAAU,GAAE,OAAe,EAC3B,QAAQ,GAAE,OAAe,GACxB,eAAe;IAGlB;;;;;OAKG;IACI,QAAQ,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM;IAS5D;;;;;;OAMG;IACI,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM;IAI3D;;;;OAIG;IACI,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM;IAMvC;;;;;;;OAOG;IACI,UAAU,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM;IAU3F;;;;;;OAMG;IACI,SAAS,CAAC,MAAM,EAAE,QAAQ,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM;IAoBtF;;;;;;OAMG;IACI,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM;IAM5D;;;;OAIG;IACI,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAMtC,mDAAmD;IAC5C,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,OAAc,GAAG,IAAI;IAIlE,0BAA0B;IACnB,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAK1C,yBAAyB;IAClB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAKzC,yBAAyB;IAClB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAKzC;;;;OAIG;IACI,gBAAgB,IAAI,IAAI;IAI/B;;;;;OAKG;IACI,kBAAkB,CAAC,MAAM,GAAE,MAAU,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO;IAsBzE;;;;;;;OAOG;IACI,cAAc,CAAC,kBAAkB,GAAE,OAAc,GAAG,MAAM,EAAE,GAAG,SAAS;IAmB/E,6CAA6C;IAC7C,IAAoB,UAAU,IAAI,MAAM,CAEvC;IACD,4CAA4C;IAC5C,IAAW,SAAS,IAAI,MAAM,CAE7B;IACD,6CAA6C;IAC7C,IAAW,UAAU,IAAI,MAAM,CAE9B;IACD,6CAA6C;IAC7C,IAAW,UAAU,IAAI,MAAM,CAE9B;IACD,iDAAiD;IACjD,IAAW,UAAU,IAAI,MAAM,CAE9B;IACD,8CAA8C;IAC9C,IAAW,WAAW,IAAI,MAAM,CAE/B;IACD,8CAA8C;IACvC,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAGhD,wDAAwD;IACjD,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM;IAKjD,kFAAkF;IAC3E,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAGzC,yFAAyF;IAClF,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAGzC,yCAAyC;IAClC,aAAa,CAAC,OAAO,GAAE,MAAU,GAAG,sBAAsB;IAGjE,wEAAwE;IACxD,KAAK,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO;IAGvE,sDAAsD;IAC/C,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,SAAS,CAAC,EAAE,SAAS,GAAG,IAAI;IAG/D;;;OAGG;IACI,uBAAuB,CAAC,UAAU,EAAE,MAAM,GAAG,aAAa;IAGjE;;;;OAIG;IACI,cAAc,CAAC,aAAa,GAAE,MAAU,GAAG,OAAO;IA0BzD,kFAAkF;IAC3E,yBAAyB,CAAC,OAAO,EAAE,eAAe,GAAG,GAAG;CAGhE;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,eAAgB,SAAQ,YAAY;IACnD,gDAAgD;IAChD,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;IACxC,0DAA0D;IAC1D,gBAAgB,IAAI,MAAM,CAAC;IAC3B,oCAAoC;IACpC,eAAe,IAAI,OAAO,CAAC;IAC3B,uFAAuF;IACvF,KAAK,IAAI,IAAI,CAAC;IACd,4EAA4E;IAC5E,gBAAgB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACpC,4EAA4E;IAC5E,gBAAgB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACpC,6EAA6E;IAC7E,iBAAiB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACrC,4EAA4E;IAC5E,gBAAgB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACpC,+EAA+E;IAC/E,cAAc,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAClC,kCAAkC;IAClC,cAAc,IAAI,QAAQ,GAAG,SAAS,CAAC;IACvC;;;;;;;;OAQG;IACH,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,mGAAmG;IACnG,WAAW,IAAI,IAAI,CAAC;IACpB,6FAA6F;IAC7F,YAAY,CAAC,KAAK,EAAE,eAAe,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1D;;;OAGG;IACH,wBAAwB,CAAC,KAAK,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACzG;;;OAGG;IACH,sBAAsB,CAAC,IAAI,MAAM,CAAC;CACnC"}
+{"version":3,"file":"Polyface.d.ts","sourceRoot":"","sources":["../../../src/polyface/Polyface.ts"],"names":[],"mappings":"AAKA;;GAEG;AAIH,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAEvD,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAGhE,OAAO,EAAE,OAAO,EAAE,MAAM,+BAA+B,CAAC;AACxD,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AAElE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C;;;;GAIG;AACH,8BAAsB,QAAS,SAAQ,aAAa;IAClD,wCAAwC;IACxC,SAAgB,gBAAgB,cAAc;IAC9C,gCAAgC;IACzB,IAAI,EAAE,YAAY,CAAC;IAC1B,kBAAkB;IAClB,SAAS,aAAa,IAAI,EAAE,YAAY;IAIxC;;;OAGG;aACa,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,eAAe;IAC/D;;OAEG;IACH,IAAW,QAAQ,IAGQ,OAAO,CADjC;IACD,IAAW,QAAQ,CAAC,KAAK,EAAE,OAAO,EAEjC;IACD;;;;OAIG;IACH,IAAW,eAAe,IAAI,MAAM,CAEnC;IACD,IAAW,eAAe,CAAC,KAAK,EAAE,MAAM,EAEvC;IACD;;;;;;;;;;OAUG;WACW,eAAe,CAC3B,OAAO,EAAE,MAAM,EAAE,GAAG,SAAS,EAC7B,cAAc,EAAE,MAAM,EACtB,cAAc,EAAE,MAAM,EACtB,IAAI,EAAE,GAAG,EACT,UAAU,EAAE,MAAM,GACjB,OAAO;IAcV,mDAAmD;IACnD,aAAoB,OAAO,IAAI,OAAO,CAAC;IACvC,iFAAiF;IACjF,IAAW,UAAU,IAAI,MAAM,GAAG,SAAS,CAE1C;CACF;AAED;;;;GAIG;AACH,qBAAa,eAAgB,SAAQ,QAAQ;IAC3C;;;;;;;OAOG;IACH,SAAS,CAAC,WAAW,EAAE,MAAM,EAAE,CAAC;IAChC;;;OAGG;IACH,SAAS,CAAC,gBAAgB,EAAE,MAAM,EAAE,CAAC;IACrC;;;;;OAKG;IACH,SAAS,aAAa,IAAI,EAAE,YAAY,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,EAAE,eAAe,CAAC,EAAE,MAAM,EAAE;IAc3F,4GAA4G;IACrG,qBAAqB,CAAC,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS;IAKvE;;;;;OAKG;IACI,mBAAmB,CAAC,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS;IAOtE,wDAAwD;IACjD,mBAAmB,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO;IAG/C,0DAA0D;IAC1C,aAAa,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO;IAQlD,gFAAgF;IAChF,IAAW,OAAO,IAAI,OAAO,CAE5B;IACD;;;;;OAKG;IACI,mBAAmB,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO;IAMzD,0CAA0C;IACnC,kBAAkB,CAAC,OAAO,EAAE,MAAM;IAGzC,2BAA2B;IACpB,KAAK,IAAI,eAAe;IAG/B;;;OAGG;IACI,gBAAgB,CAAC,SAAS,EAAE,SAAS,GAAG,eAAe;IAK9D,sDAAsD;IAC/C,cAAc;IAGrB,mDAAmD;IAC5C,cAAc;IAGrB;;;;MAIE;IACK,cAAc,CAAC,CAAC,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS;IAQ3D;;;;;;OAMG;IACI,kBAAkB,CAAC,MAAM,EAAE,eAAe,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,GAAG,SAAS;IAsGtG;;;;;;OAMG;IACH,IAAW,wBAAwB,IAAI,MAAM,CAE5C;IACD;;;;;;OAMG;WACW,MAAM,CAClB,WAAW,GAAE,OAAe,EAC5B,UAAU,GAAE,OAAe,EAC3B,UAAU,GAAE,OAAe,EAC3B,QAAQ,GAAE,OAAc,GACvB,eAAe;IAGlB;;;;;OAKG;IACI,QAAQ,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM;IAS5D;;;;;;OAMG;IACI,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM;IAI3D;;;;OAIG;IACI,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM;IAMvC;;;;;;;OAOG;IACI,UAAU,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM;IAU3F;;;;;;OAMG;IACI,SAAS,CAAC,MAAM,EAAE,QAAQ,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM;IAoBtF;;;;;;OAMG;IACI,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM;IAM5D;;;;OAIG;IACI,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAMtC,mDAAmD;IAC5C,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,OAAc,GAAG,IAAI;IAIlE,0BAA0B;IACnB,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAK1C,yBAAyB;IAClB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAKzC,yBAAyB;IAClB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAKzC;;;;OAIG;IACI,gBAAgB,IAAI,IAAI;IAI/B;;;;;OAKG;IACI,kBAAkB,CAAC,MAAM,GAAE,MAAU,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO;IAoCzE;;;;;;;OAOG;IACI,cAAc,CAAC,kBAAkB,GAAE,OAAc,GAAG,MAAM,EAAE,GAAG,SAAS;IAmB/E,6CAA6C;IAC7C,IAAoB,UAAU,IAAI,MAAM,CAEvC;IACD,4CAA4C;IAC5C,IAAW,SAAS,IAAI,MAAM,CAE7B;IACD,6CAA6C;IAC7C,IAAW,UAAU,IAAI,MAAM,CAE9B;IACD,6CAA6C;IAC7C,IAAW,UAAU,IAAI,MAAM,CAE9B;IACD,iDAAiD;IACjD,IAAW,UAAU,IAAI,MAAM,CAE9B;IACD,8CAA8C;IAC9C,IAAW,WAAW,IAAI,MAAM,CAE/B;IACD,8CAA8C;IACvC,iBAAiB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO;IAGrD,wDAAwD;IACjD,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM;IAKjD;;;;;;;;;;;;;OAaG;IACI,WAAW,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM;IAG9C;;;OAGG;IACI,WAAW,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM;IAG9C,2GAA2G;IAC3G,IAAW,UAAU,IAAI,aAAa,CAAC,MAAM,CAAC,CAE7C;IACD,yCAAyC;IAClC,aAAa,CAAC,OAAO,GAAE,MAAU,GAAG,sBAAsB;IAGjE,wEAAwE;IACxD,KAAK,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO;IAGvE,sDAAsD;IAC/C,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,SAAS,CAAC,EAAE,SAAS,GAAG,IAAI;IAG/D;;;OAGG;IACI,uBAAuB,CAAC,UAAU,EAAE,MAAM,GAAG,aAAa;IAGjE;;;;OAIG;IACI,cAAc,CAAC,aAAa,GAAE,MAAU,GAAG,OAAO;IA0BzD,kFAAkF;IAC3E,yBAAyB,CAAC,OAAO,EAAE,eAAe,GAAG,GAAG;CAGhE;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,eAAgB,SAAQ,YAAY;IACnD,gDAAgD;IAChD,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;IACxC,0DAA0D;IAC1D,gBAAgB,IAAI,MAAM,CAAC;IAC3B,oCAAoC;IACpC,eAAe,IAAI,OAAO,CAAC;IAC3B,uFAAuF;IACvF,KAAK,IAAI,IAAI,CAAC;IACd,4EAA4E;IAC5E,gBAAgB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACpC,4EAA4E;IAC5E,gBAAgB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACpC,6EAA6E;IAC7E,iBAAiB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACrC,4EAA4E;IAC5E,gBAAgB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACpC,+EAA+E;IAC/E,cAAc,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAClC,kCAAkC;IAClC,cAAc,IAAI,QAAQ,GAAG,SAAS,CAAC;IACvC;;;;;;;;OAQG;IACH,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,wGAAwG;IACxG,WAAW,IAAI,IAAI,CAAC;IACpB,6FAA6F;IAC7F,YAAY,CAAC,KAAK,EAAE,eAAe,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1D;;;OAGG;IACH,wBAAwB,CAAC,KAAK,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACzG;;;OAGG;IACH,sBAAsB,CAAC,IAAI,MAAM,CAAC;CACnC"}

package/lib/cjs/polyface/Polyface.js

@@ -15,6 +15,7 @@ const GrowableXYArray_1 = require("../geometry3d/GrowableXYArray");
 const GrowableXYZArray_1 = require("../geometry3d/GrowableXYZArray");
 const Point3dVector3d_1 = require("../geometry3d/Point3dVector3d");
 const PointHelpers_1 = require("../geometry3d/PointHelpers");
+const Range_1 = require("../geometry3d/Range");
 const FacetFaceData_1 = require("./FacetFaceData");
 const IndexedPolyfaceVisitor_1 = require("./IndexedPolyfaceVisitor");
 const PolyfaceData_1 = require("./PolyfaceData");
@@ -24,14 +25,18 @@ const PolyfaceData_1 = require("./PolyfaceData");
  * @public
  */
 class Polyface extends GeometryQuery_1.GeometryQuery {
+    /** String name for schema properties */
+    geometryCategory = "polyface";
+    /** Underlying polyface data. */
+    data;
     /** Constructor */
     constructor(data) {
         super();
-        /** String name for schema properties */
-        this.geometryCategory = "polyface";
         this.data = data;
     }
-    /** Flag indicating if the mesh display must assume both sides are visible. */
+    /**
+     * The [[PolyfaceData.twoSided]] flag.
+     */
     get twoSided() {
         return this.data.twoSided;
     }
@@ -86,6 +91,20 @@ exports.Polyface = Polyface;
  * @public
  */
 class IndexedPolyface extends Polyface {
+    /**
+     * Start indices of all facets of the polyface.
+     * * Each element is an index to the `this.data.pointIndex` array entry for a specific facet.
+     * * The facet count is `_facetStart.length - 1`.
+     * * The face loop for the i_th facet consists of the entries in `this.data.pointIndex` at indices `_facetStart[i]`
+     * up to (but not including) `_facetStart[i + 1]`.
+     * * Note the array is initialized with one entry (value 0).
+     */
+    _facetStart;
+    /**
+     * Index to the `this.data.face` array entry for a specific facet.
+     * * `_facetToFaceData` has one entry per facet.
+     */
+    _facetToFaceData;
     /**
      * Constructor for a new polyface.
      * @param data PolyfaceData arrays to capture.
@@ -105,6 +124,24 @@ class IndexedPolyface extends Polyface {
         else
             this._facetToFaceData = [];
     }
+    /** Given an edgeIndex (index into `data.pointIndex`), return the index of the facet containing the edge. */
+    edgeIndexToFacetIndex(k) {
+        if (k === undefined)
+            return undefined;
+        return PointHelpers_1.NumberArray.searchStrictlyIncreasingNumbers(this._facetStart, k);
+    }
+    /**
+     * Given an edgeIndex (index into `data.pointIndex`), return the range of the edgeIndices of the containing facet.
+     * * If an edge with edgeIndex `k` is found in the facet with facetIndex `f`, then the returned range `r` satisfies
+     * `r.low = this.facetIndex0(f) <= k < this.facetIndex1(f) = r.high` and can be used to iterate the facet's face
+     * loop. See [[facetIndex0]].
+     */
+    edgeIndexToFaceLoop(k) {
+        const q = this.edgeIndexToFacetIndex(k);
+        if (q !== undefined)
+            return Range_1.Range1d.createXX(this.facetIndex0(q), this.facetIndex1(q));
+        return undefined;
+    }
     /** Test if other is an instance of `IndexedPolyface` */
     isSameGeometryClass(other) {
         return other instanceof IndexedPolyface;
@@ -124,20 +161,14 @@ class IndexedPolyface extends Polyface {
     }
     /**
      * Transform the mesh.
-     * * Apply the transform to points.
-     * * Apply the (inverse transpose of the) matrix part to normals.
-     * * If determinant of the transform matrix is negative, also
-     *   * negate normals
-     *   * reverse index order around each facet.
+     * * If `transform` is a mirror, also reverse the index order around each facet.
+     * * Note that this method always returns true. If transforming the normals fails (due to singular matrix or zero
+     * normal), the original normal(s) are left unchanged.
      */
     tryTransformInPlace(transform) {
-        if (!this.data.tryTransformInPlace(transform))
-            return false;
-        const determinant = transform.matrix.determinant();
-        if (determinant < 0) {
+        this.data.tryTransformInPlace(transform);
+        if (transform.matrix.determinant() < 0)
             this.reverseIndices();
-            this.reverseNormals();
-        }
         return true;
     }
     /** Reverse indices for a single facet. */
@@ -146,8 +177,7 @@ class IndexedPolyface extends Polyface {
     }
     /** Return a deep clone. */
     clone() {
-        const result = new IndexedPolyface(this.data.clone(), this._facetStart.slice(), this._facetToFaceData.slice());
-        return result;
+        return new IndexedPolyface(this.data.clone(), this._facetStart.slice(), this._facetToFaceData.slice());
     }
     /**
      * Return a deep clone with transformed points and normals.
@@ -170,7 +200,7 @@ class IndexedPolyface extends Polyface {
      * Return face data using a facet index.
      * * Returns `undefined` if none found.
      * * This is the REFERENCE to the FacetFaceData not a copy.
-     */
+    */
     tryGetFaceData(i) {
         if (i < 0 || i >= this._facetToFaceData.length)
             return undefined;
@@ -302,9 +332,9 @@ class IndexedPolyface extends Polyface {
      * @param needNormals `true` to allocate empty normal data and index arrays; `false` (default) to leave undefined.
      * @param needParams `true` to allocate empty uv parameter data and index arrays; `false` (default) to leave undefined.
      * @param needColors `true` to allocate empty color data and index arrays; `false` (default) to leave undefined.
-     * @param twoSided `true` if the facets are to be considered viewable from the back; `false` (default) if not.
+     * @param twoSided `true` (default) if the facets are to be considered viewable from the back; `false` if they are amenable to backface culling.
      */
-    static create(needNormals = false, needParams = false, needColors = false, twoSided = false) {
+    static create(needNormals = false, needParams = false, needColors = false, twoSided = true) {
         return new IndexedPolyface(new PolyfaceData_1.PolyfaceData(needNormals, needParams, needColors, twoSided));
     }
     /**
@@ -453,6 +483,14 @@ class IndexedPolyface extends Polyface {
     validateAllIndices(index0 = 0, errors) {
         const numPointIndices = this.data.pointIndex.length;
         const messages = errors ?? [];
+        if (0 === numPointIndices) {
+            messages.push("empty pointIndex array");
+            return false;
+        }
+        if (index0 < 0 || index0 >= numPointIndices) {
+            messages.push("invalid input offset");
+            return false;
+        }
         if (this.data.normalIndex && this.data.normalIndex.length !== numPointIndices)
             messages.push("normalIndex count must match pointIndex count");
         if (this.data.paramIndex && this.data.paramIndex.length !== numPointIndices)
@@ -462,13 +500,19 @@ class IndexedPolyface extends Polyface {
         if (this.data.edgeVisible.length !== numPointIndices)
             messages.push("visibleIndex count must equal pointIndex count");
         if (!Polyface.areIndicesValid(this.data.pointIndex, index0, numPointIndices, this.data.point, this.data.point ? this.data.point.length : 0))
-            messages.push("invalid point indices in the last facet");
+            messages.push("invalid point index encountered");
         if (!Polyface.areIndicesValid(this.data.normalIndex, index0, numPointIndices, this.data.normal, this.data.normal ? this.data.normal.length : 0))
-            messages.push("invalid normal indices in the last facet");
+            messages.push("invalid normal index encountered");
         if (!Polyface.areIndicesValid(this.data.paramIndex, index0, numPointIndices, this.data.param, this.data.param ? this.data.param.length : 0))
-            messages.push("invalid param indices in the last facet");
+            messages.push("invalid param index encountered");
         if (!Polyface.areIndicesValid(this.data.colorIndex, index0, numPointIndices, this.data.color, this.data.color ? this.data.color.length : 0))
-            messages.push("invalid color indices in the last facet");
+            messages.push("invalid color index encountered");
+        if (this.data.edgeMateIndex) {
+            if (this.data.edgeMateIndex.length !== numPointIndices)
+                messages.push("edgeMateIndex count must equal pointIndex count");
+            else if (!this.data.edgeMateIndex.every((i) => i === undefined || this.data.isValidEdgeIndex(i)))
+                messages.push("invalid edgeMate encountered");
+        }
         return 0 === messages.length;
     }
     /**
@@ -523,8 +567,8 @@ class IndexedPolyface extends Polyface {
         return this.data.normalCount;
     }
     /** Test if `index` is a valid facet index. */
-    isValidFacetIndex(index) {
-        return index >= 0 && index < this.facetCount;
+    isValidFacetIndex(facetIndex) {
+        return facetIndex >= 0 && facetIndex < this.facetCount;
     }
     /** Return the number of edges in a particular facet. */
     numEdgeInFacet(facetIndex) {
@@ -532,15 +576,35 @@ class IndexedPolyface extends Polyface {
             return this._facetStart[facetIndex + 1] - this._facetStart[facetIndex];
         return 0;
     }
-    /** ASSUME valid facet index. Return start index of facet in pointIndex arrays. */
-    facetIndex0(index) {
-        return this._facetStart[index];
+    /**
+     * Given a valid facet index, return the index at which its face loop starts in the index arrays.
+     * * A "face loop" is a contiguous block of indices into the parallel polyface index arrays.
+     * * Each of these indices represents an edge of a facet, thus it is sometimes called an "edgeIndex".
+     * * Together with [[facetIndex1]], this method can be used to iterate the face loop of the facet
+     * with index `iFacet` as follows:
+     * ````
+     * for (let iEdge = this.facetIndex0(iFacet); iEdge < this.facetIndex1(iFacet); iEdge++) {
+     *   const iPoint = this.data.pointIndex[iEdge];
+     *   const p = this.data.point[iPoint];
+     *   // ... process the edge of this facet starting at point p
+     * }
+     * ````
+     */
+    facetIndex0(facetIndex) {
+        return this._facetStart[facetIndex];
+    }
+    /**
+     * Given a valid facet index, return one past the index at which its face loop ends in the index arrays.
+     * * For details, see [[facetIndex0]].
+     */
+    facetIndex1(facetIndex) {
+        return this._facetStart[facetIndex + 1];
     }
-    /** ASSUME valid facet index. Return one past end index of facet in pointIndex arrays. */
-    facetIndex1(index) {
-        return this._facetStart[index + 1];
+    /** Return a readonly reference to the facetStart array accessed by [[facetIndex0]] and [[facetIndex1]]. */
+    get facetStart() {
+        return this._facetStart;
     }
-    /** Create a visitor for this polyface */
+    /** create a visitor for this polyface */
     createVisitor(numWrap = 0) {
         return IndexedPolyfaceVisitor_1.IndexedPolyfaceVisitor.create(this, numWrap);
     }