@itwin/core-geometry 5.3.0-dev.8 → 5.4.0-dev.2

package/lib/cjs/geometry3d/PolygonOps.d.ts

@@ -212,18 +212,38 @@ export declare class PolygonOps {
     private static _matrixA;
     private static _matrixB;
     private static _matrixC;
-    /** return a vector which is perpendicular to the polygon and has magnitude equal to the polygon area. */
+    /**
+     * Compute the area and normal of the polygon, packaged as a vector.
+     * * This is just [[areaNormal]] with expanded return type.
+     * @param points polygon vertices, closure point optional. Polygon can be in any plane.
+     * @param result optional pre-allocated vector to populate and return.
+     * @returns polygon normal with magnitude equal to polygon area, or `undefined` if colinear/insufficient points.
+     */
     static areaNormalGo(points: IndexedXYZCollection, result?: Vector3d): Vector3d | undefined;
-    /** return a vector which is perpendicular to the polygon and has magnitude equal to the polygon area. */
+    /**
+     * Compute the area and normal of the polygon, packaged as a vector.
+     * @param points polygon vertices, closure point optional. Polygon can be in any plane.
+     * @param result optional pre-allocated vector to populate and return.
+     * @returns polygon normal with magnitude equal to polygon area, or zero vector if colinear/insufficient points.
+     */
     static areaNormal(points: Point3d[], result?: Vector3d): Vector3d;
-    /** return the area of the polygon.
-     * * This assumes the polygon is planar
-     * * This does NOT assume the polygon is on the xy plane.
+    /**
+     * Compute the area of the polygon.
+     * @param points polygon vertices, closure point optional. Polygon can be in any plane.
+     * @returns polygon area.
      */
     static area(points: Point3d[]): number;
-    /** return the projected XY area of the polygon. */
+    /**
+     * Compute the projected XY area of the polygon.
+     * @param points polygon vertices, closure point optional, z-coordinates ignored.
+     * @returns xy-projected polygon area.
+     */
     static areaXY(points: Point3d[] | IndexedXYZCollection): number;
-    /** Sum the areaXY () values for multiple polygons */
+    /**
+     * Sum the result of [[areaXY]] for multiple polygons.
+     * @param polygons array of polygons, closure point optional for each, z-coordinates ignored.
+     * @returns sum of xy-projected polygon areas.
+     */
     static sumAreaXY(polygons: Point3d[][]): number;
     /**
      * Return a [[Ray3d]] with:

package/lib/cjs/geometry3d/PolygonOps.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PolygonOps.d.ts","sourceRoot":"","sources":["../../../src/geometry3d/PolygonOps.ts"],"names":[],"mappings":"AAUA,OAAO,EAAuB,sBAAsB,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC3F,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAIlD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,6BAA6B,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE7F,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAE,OAAO,EAAY,MAAM,mBAAmB,CAAC;AAEtD,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAEtD,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC,OAAO,EAAE,KAAK,EAAU,MAAM,YAAY,CAAC;AAE3C;;;GAGG;AACH,qBAAa,qBAAqB;IAChC,sCAAsC;IAC/B,KAAK,EAAE,OAAO,CAAC;IACtB,kCAAkC;IAC3B,CAAC,EAAE,MAAM,CAAC;IACjB,kCAAkC;IAC3B,CAAC,EAAE,QAAQ,CAAC;IACnB,iFAAiF;IAC1E,IAAI,EAAE,eAAe,CAAC;IAC7B,wEAAwE;IACjE,gBAAgB,EAAE,MAAM,CAAC;IAChC,mEAAmE;IAC5D,gBAAgB,EAAE,MAAM,CAAC;IAEhC,OAAO;IASP,8BAA8B;IACvB,UAAU;IASjB;;OAEG;WACW,MAAM,CAAC,MAAM,CAAC,EAAE,qBAAqB,GAAG,qBAAqB;IAQ3E;;OAEG;IACI,gBAAgB,CAAC,KAAK,EAAE,qBAAqB;IASpD,oCAAoC;IACpC,IAAW,OAAO,IAAI,OAAO,CAE5B;IAED,2EAA2E;IAC3E,IAAW,YAAY,IAAI,OAAO,CAIjC;IACD;;;OAGG;WACW,oBAAoB,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,GAAE,MAAU,GAAG,qBAAqB;CAS/G;AAED;;;GAGG;AACH,qBAAa,yBAAyB;IACpC,oCAAoC;IAC7B,OAAO,EAAE,qBAAqB,CAAC;IACtC,qCAAqC;IAC9B,OAAO,EAAE,qBAAqB,CAAC;IAEtC,mCAAmC;IACnC,OAAO;IAIP,6CAA6C;WAC/B,MAAM,CAAC,OAAO,EAAE,qBAAqB,EAAE,OAAO,EAAE,qBAAqB,EAAE,MAAM,CAAC,EAAE,yBAAyB,GAAG,yBAAyB;IAOnJ,yDAAyD;IAClD,KAAK,CAAC,MAAM,CAAC,EAAE,yBAAyB,GAAG,yBAAyB;IAM3E,+BAA+B;IACxB,WAAW;CAKnB;AAED;;;GAGG;AACH,qBAAa,OAAO;IAEX,GAAG,EAAE,gBAAgB,CAAC;IAEtB,IAAI,CAAC,EAAE,KAAK,CAAC;IACb,eAAe,EAAE,MAAM,CAAC;IACxB,eAAe,EAAE,MAAM,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,OAAO,CAAC;gBACL,GAAG,EAAE,gBAAgB;IAOxC;;;OAGG;WACW,2BAA2B,CAAC,GAAG,EAAE,gBAAgB,GAAG,OAAO;IAMzE;;;;;OAKG;IACI,kBAAkB,CAAC,GAAG,EAAE,KAAK;IAYpC;;;;OAIG;IACI,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM;IAQjD;;;;OAIG;IACI,MAAM,CAAC,KAAK,EAAE,OAAO;IAI5B,uFAAuF;WACzE,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,GAAG,MAAM;IAKlE;;OAEG;IACI,KAAK,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO;IACvC;;OAEG;IACI,IAAI,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO;CAEvC;AACD;;;;;;;GAOG;AACH,qBAAa,mBAAmB;IAC9B,4GAA4G;IACrG,UAAU,EAAE,OAAO,EAAE,CAAC;IAC7B,gEAAgE;IACzD,WAAW,EAAE,OAAO,EAAE,CAAC;;IAM9B;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAmBxB;;;;OAIG;IACH,OAAO,CAAC,UAAU;IAiBlB;;;OAGG;IACI,iBAAiB;CAoCzB;AACD;;;;GAIG;AACH,MAAM,WAAW,mCAAmC;IAClD,wHAAwH;IACxH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,yGAAyG;IACzG,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,0BAA0B;IAC1B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,mBAAmB;IACnB,UAAU,CAAC,EAAE,QAAQ,CAAC;IACtB,6GAA6G;IAC7G,UAAU,CAAC,EAAE,QAAQ,CAAC;CACvB;AACD;;;GAGG;AACH,MAAM,WAAW,kCAAkC;IACjD,4FAA4F;IAC5F,OAAO,EAAE,MAAM,CAAC;IAChB,4EAA4E;IAC5E,KAAK,EAAE,MAAM,CAAC;IACd,yDAAyD;IACzD,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,8FAA8F;IAC9F,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AACD;;;GAGG;AACH,qBAAa,UAAU;IACrB;;;;OAIG;WACW,gBAAgB,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,gBAAgB,GAAG,MAAM;IAwB5E;;;;;OAKG;WACW,uCAAuC,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,gBAAgB,EAAE,QAAQ,EAAE,QAAQ,GAAG,MAAM;IA+BvH;;;;OAIG;WACW,kBAAkB,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM;IAiB3D;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,sBAAsB,CAA8J;IAC5M;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,yBAAyB,CAIA;IAIjD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAqB;IAC5C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAqB;IAC5C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAqB;IAC5C,OAAO,CAAC,MAAM,CAAC,aAAa,CAAqB;IACjD,OAAO,CAAC,MAAM,CAAC,OAAO,CAAqB;IAC3C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAA6B;IACpD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAA6B;IACpD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAA6B;IACpD,yGAAyG;WAC3F,YAAY,CAAC,MAAM,EAAE,oBAAoB,EAAE,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS;IAkBjG,yGAAyG;WAC3F,UAAU,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ;IAMxE;;;OAGG;WACW,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM;IAG7C,mDAAmD;WACrC,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,oBAAoB,GAAG,MAAM;IAqBtE,qDAAqD;WACvC,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,GAAG,MAAM;IAMtD;;;;;;;OAOG;WACW,kBAAkB,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,EAAE,EAAE,MAAM,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,SAAS;IA0D7G;;;OAGG;WACW,iBAAiB,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS;IAwBzF;;;;;OAKG;WACW,UAAU,CAAC,MAAM,EAAE,oBAAoB,EAAE,MAAM,EAAE,QAAQ,GAAG,OAAO;IAoBjF;;OAEG;IACH;;;;;;;OAOG;WACW,2BAA2B,CAAC,MAAM,EAAE,oBAAoB,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ;IAI1G;;;;;;OAMG;WACW,6BAA6B,CAAC,MAAM,EAAE,oBAAoB,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ;IAG5G;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,kCAAkC;IAsCjD;;;;;;;;;;;;OAYG;WACW,4BAA4B,CAAC,WAAW,EAAE,gBAAgB,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,mCAAmC,GAAG,kCAAkC;IAsB5K;;;;OAIG;WACW,8BAA8B,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,GAAG,MAAM;IA0BnF;;;;OAIG;WACW,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,oBAAoB,GAAG,OAAO;IAyB1E;;;;;;OAMG;WACW,sBAAsB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,GAAG,SAAS;IA2B/F;;;;;;OAMG;WACW,wBAAwB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,oBAAoB,GAAG,MAAM,GAAG,SAAS;IA4B9G;;;;;OAKG;WACW,qCAAqC,CAAC,KAAK,EAAE,6BAA6B,GAAG,6BAA6B,EAAE,EAAE,aAAa,EAAE,QAAQ,GAAG,MAAM;IAiB5J;;;;;;;;OAQG;WACW,uBAAuB,CAAC,KAAK,EAAE,6BAA6B,EAAE,GAAG,6BAA6B,EAAE,EAAE;IAQhH;;;;;OAKG;WACW,qBAAqB,CAAC,KAAK,EAAE,6BAA6B,EAAE,EAAE,aAAa,EAAE,QAAQ,GAAG,SAAS,GAAG,6BAA6B,EAAE,EAAE;IAgCnJ;;;;;;;;;;;;;;;MAeE;WACY,sBAAsB,CAClC,OAAO,EAAE,OAAO,EAAE,GAAG,oBAAoB,EACzC,SAAS,EAAE,OAAO,EAClB,SAAS,GAAE,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,CAAgC,EACnE,MAAM,CAAC,EAAE,qBAAqB,GAC7B,qBAAqB;IAwJxB;;;;;;;;;;;;OAYG;WACW,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,oBAAoB,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,GAAE,MAAqC,EAAE,MAAM,CAAC,EAAE,qBAAqB,GAAG,qBAAqB;IAwBlM,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAU;IAClC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAU;IAClC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAU;IAClC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAU;IAClC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAQ;IAChC,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,CAAW;IACxC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAA+B;IAEzD;;;;;;;;;;;;;OAaG;WACW,cAAc,CAC1B,OAAO,EAAE,OAAO,EAAE,GAAG,oBAAoB,EACzC,GAAG,EAAE,KAAK,EACV,SAAS,GAAE,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,CAAgC,EACnE,MAAM,CAAC,EAAE,qBAAqB,GAC7B,qBAAqB;IAwCxB;;;;;;;;;;;;OAYG;WACW,gBAAgB,CAC5B,OAAO,EAAE,OAAO,EAAE,GAAG,oBAAoB,EACzC,MAAM,EAAE,OAAO,EACf,MAAM,EAAE,OAAO,EACf,SAAS,GAAE,MAAqC,EAChD,MAAM,CAAC,EAAE,qBAAqB,GAC7B,qBAAqB;IAKxB;;;;;;;;OAQG;IACH,OAAO,CAAC,MAAM,CAAC,iBAAiB;IA0BhC;;;;;;;;;;OAUG;IACH,OAAO,CAAC,MAAM,CAAC,kCAAkC;IAyCjD;;;;;;OAMG;WACW,4BAA4B,CACxC,OAAO,EAAE,OAAO,EAAE,GAAG,oBAAoB,EACzC,KAAK,EAAE,OAAO,EACd,SAAS,GAAE,MAAqC,GAC/C,MAAM,EAAE,GAAG,SAAS;IAwDvB;;;;;;OAMG;WACW,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,gBAAgB,EAAE,SAAS,GAAE,MAAqC,GAAG,IAAI;IAWzH;;;;;;OAMG;WACW,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,oBAAoB,EAAE,SAAS,GAAE,MAAqC,GAAG,OAAO,EAAE,GAAG,oBAAoB;IAezJ,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAA0B;IACtD;;;;;;;;;;OAUG;WACW,eAAe,CAC3B,QAAQ,EAAE,OAAO,EAAE,GAAG,oBAAoB,EAC1C,QAAQ,EAAE,OAAO,EAAE,GAAG,oBAAoB,EAC1C,IAAI,GAAE,MAAyB,EAC/B,eAAe,GAAE,OAAe,GAC/B,yBAAyB,GAAG,SAAS;CAezC;AAED;;;GAGG;AACH,qBAAa,8BAA8B;IACzC,OAAO,CAAC,MAAM,CAAC,SAAS,CAA6B;IACrD,OAAO,CAAC,MAAM,CAAC,SAAS,CAA6B;IACrD,OAAO,CAAC,MAAM,CAAC,SAAS,CAA6B;IACrD;;;;;;;;;;;OAWG;WACW,oCAAoC,CAChD,KAAK,EAAE,sBAAsB,EAC7B,GAAG,EAAE,oBAAoB,EACzB,WAAW,EAAE,6BAA6B,EAC1C,WAAW,EAAE,6BAA6B,EAC1C,aAAa,EAAE,OAAO,GACrB,IAAI;IAwDP;;;;;;;;;;;;;;;;;OAiBG;WACW,wBAAwB,CACpC,KAAK,EAAE,sBAAsB,EAC7B,GAAG,EAAE,gBAAgB,EACrB,IAAI,CAAC,EAAE,gBAAgB,EACvB,YAAY,GAAE,OAAc,EAC5B,SAAS,GAAE,MAAqC,GAC/C,MAAM;IAuDT;;;OAGG;WACW,qBAAqB,CAAC,KAAK,EAAE,sBAAsB,EAAE,GAAG,EAAE,oBAAoB,EAAE,SAAS,EAAE,OAAO,EAAE;IAuBlH;;;;;;;OAOG;WACW,2BAA2B,CAAC,KAAK,EAAE,sBAAsB,EAAE,GAAG,EAAE,gBAAgB,EAAE,cAAc,GAAE,MAAU,EAAE,SAAS,GAAE,MAAqC,GAAG,mBAAmB;IAmClM;;;;;OAKG;WACW,eAAe,CAAC,KAAK,EAAE,mBAAmB;IAuBxD;;;;;OAKG;WACW,kCAAkC,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,gBAAgB,GAAG,gBAAgB,GAAG,SAAS;CAqCtH;AACD;;;GAGG;AACH,qBAAa,sBAAsB;IACjC,OAAO,CAAC,MAAM,CAAC,SAAS,CAA6B;IAGrD;;;;;;OAMG;WACW,oCAAoC,CAAC,KAAK,EAAE,sBAAsB,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,OAAO,GAAG,IAAI;IAOpK;;;OAGG;WACW,qBAAqB,CAAC,KAAK,EAAE,sBAAsB,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,IAAI;IAI9G;;;;;OAKG;WACW,wBAAwB,CAAC,KAAK,EAAE,sBAAsB,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,SAAS,EAAE,SAAS,GAAE,MAAqC;CA0CpK"}
+{"version":3,"file":"PolygonOps.d.ts","sourceRoot":"","sources":["../../../src/geometry3d/PolygonOps.ts"],"names":[],"mappings":"AAUA,OAAO,EAAuB,sBAAsB,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC3F,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAIlD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,6BAA6B,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE7F,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAE,OAAO,EAAY,MAAM,mBAAmB,CAAC;AAEtD,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAEtD,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC,OAAO,EAAE,KAAK,EAAU,MAAM,YAAY,CAAC;AAE3C;;;GAGG;AACH,qBAAa,qBAAqB;IAChC,sCAAsC;IAC/B,KAAK,EAAE,OAAO,CAAC;IACtB,kCAAkC;IAC3B,CAAC,EAAE,MAAM,CAAC;IACjB,kCAAkC;IAC3B,CAAC,EAAE,QAAQ,CAAC;IACnB,iFAAiF;IAC1E,IAAI,EAAE,eAAe,CAAC;IAC7B,wEAAwE;IACjE,gBAAgB,EAAE,MAAM,CAAC;IAChC,mEAAmE;IAC5D,gBAAgB,EAAE,MAAM,CAAC;IAEhC,OAAO;IASP,8BAA8B;IACvB,UAAU;IASjB;;OAEG;WACW,MAAM,CAAC,MAAM,CAAC,EAAE,qBAAqB,GAAG,qBAAqB;IAQ3E;;OAEG;IACI,gBAAgB,CAAC,KAAK,EAAE,qBAAqB;IASpD,oCAAoC;IACpC,IAAW,OAAO,IAAI,OAAO,CAE5B;IAED,2EAA2E;IAC3E,IAAW,YAAY,IAAI,OAAO,CAIjC;IACD;;;OAGG;WACW,oBAAoB,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,GAAE,MAAU,GAAG,qBAAqB;CAS/G;AAED;;;GAGG;AACH,qBAAa,yBAAyB;IACpC,oCAAoC;IAC7B,OAAO,EAAE,qBAAqB,CAAC;IACtC,qCAAqC;IAC9B,OAAO,EAAE,qBAAqB,CAAC;IAEtC,mCAAmC;IACnC,OAAO;IAIP,6CAA6C;WAC/B,MAAM,CAAC,OAAO,EAAE,qBAAqB,EAAE,OAAO,EAAE,qBAAqB,EAAE,MAAM,CAAC,EAAE,yBAAyB,GAAG,yBAAyB;IAOnJ,yDAAyD;IAClD,KAAK,CAAC,MAAM,CAAC,EAAE,yBAAyB,GAAG,yBAAyB;IAM3E,+BAA+B;IACxB,WAAW;CAKnB;AAED;;;GAGG;AACH,qBAAa,OAAO;IAEX,GAAG,EAAE,gBAAgB,CAAC;IAEtB,IAAI,CAAC,EAAE,KAAK,CAAC;IACb,eAAe,EAAE,MAAM,CAAC;IACxB,eAAe,EAAE,MAAM,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,OAAO,CAAC;gBACL,GAAG,EAAE,gBAAgB;IAOxC;;;OAGG;WACW,2BAA2B,CAAC,GAAG,EAAE,gBAAgB,GAAG,OAAO;IAMzE;;;;;OAKG;IACI,kBAAkB,CAAC,GAAG,EAAE,KAAK;IAYpC;;;;OAIG;IACI,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM;IAQjD;;;;OAIG;IACI,MAAM,CAAC,KAAK,EAAE,OAAO;IAI5B,uFAAuF;WACzE,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,GAAG,MAAM;IAKlE;;OAEG;IACI,KAAK,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO;IACvC;;OAEG;IACI,IAAI,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO;CAEvC;AACD;;;;;;;GAOG;AACH,qBAAa,mBAAmB;IAC9B,4GAA4G;IACrG,UAAU,EAAE,OAAO,EAAE,CAAC;IAC7B,gEAAgE;IACzD,WAAW,EAAE,OAAO,EAAE,CAAC;;IAM9B;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAmBxB;;;;OAIG;IACH,OAAO,CAAC,UAAU;IAiBlB;;;OAGG;IACI,iBAAiB;CAoCzB;AACD;;;;GAIG;AACH,MAAM,WAAW,mCAAmC;IAClD,wHAAwH;IACxH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,yGAAyG;IACzG,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,0BAA0B;IAC1B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,mBAAmB;IACnB,UAAU,CAAC,EAAE,QAAQ,CAAC;IACtB,6GAA6G;IAC7G,UAAU,CAAC,EAAE,QAAQ,CAAC;CACvB;AACD;;;GAGG;AACH,MAAM,WAAW,kCAAkC;IACjD,4FAA4F;IAC5F,OAAO,EAAE,MAAM,CAAC;IAChB,4EAA4E;IAC5E,KAAK,EAAE,MAAM,CAAC;IACd,yDAAyD;IACzD,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,8FAA8F;IAC9F,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AACD;;;GAGG;AACH,qBAAa,UAAU;IACrB;;;;OAIG;WACW,gBAAgB,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,gBAAgB,GAAG,MAAM;IAwB5E;;;;;OAKG;WACW,uCAAuC,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,gBAAgB,EAAE,QAAQ,EAAE,QAAQ,GAAG,MAAM;IA+BvH;;;;OAIG;WACW,kBAAkB,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM;IAiB3D;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,sBAAsB,CAA8J;IAC5M;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,yBAAyB,CAIA;IAIjD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAqB;IAC5C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAqB;IAC5C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAqB;IAC5C,OAAO,CAAC,MAAM,CAAC,aAAa,CAAqB;IACjD,OAAO,CAAC,MAAM,CAAC,OAAO,CAAqB;IAC3C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAA6B;IACpD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAA6B;IACpD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAA6B;IAEpD;;;;;;OAMG;WACW,YAAY,CAAC,MAAM,EAAE,oBAAoB,EAAE,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS;IAkBjG;;;;;OAKG;WACW,UAAU,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ;IAMxE;;;;OAIG;WACW,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM;IAG7C;;;;OAIG;WACW,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,oBAAoB,GAAG,MAAM;IAsBtE;;;;OAIG;WACW,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,GAAG,MAAM;IAMtD;;;;;;;OAOG;WACW,kBAAkB,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,EAAE,EAAE,MAAM,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,SAAS;IA0D7G;;;OAGG;WACW,iBAAiB,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS;IAwBzF;;;;;OAKG;WACW,UAAU,CAAC,MAAM,EAAE,oBAAoB,EAAE,MAAM,EAAE,QAAQ,GAAG,OAAO;IAoBjF;;OAEG;IACH;;;;;;;OAOG;WACW,2BAA2B,CAAC,MAAM,EAAE,oBAAoB,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ;IAI1G;;;;;;OAMG;WACW,6BAA6B,CAAC,MAAM,EAAE,oBAAoB,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ;IAG5G;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,kCAAkC;IAsCjD;;;;;;;;;;;;OAYG;WACW,4BAA4B,CAAC,WAAW,EAAE,gBAAgB,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,mCAAmC,GAAG,kCAAkC;IAsB5K;;;;OAIG;WACW,8BAA8B,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,GAAG,MAAM;IA0BnF;;;;OAIG;WACW,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,oBAAoB,GAAG,OAAO;IAyB1E;;;;;;OAMG;WACW,sBAAsB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,GAAG,SAAS;IA2B/F;;;;;;OAMG;WACW,wBAAwB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,oBAAoB,GAAG,MAAM,GAAG,SAAS;IA4B9G;;;;;OAKG;WACW,qCAAqC,CAAC,KAAK,EAAE,6BAA6B,GAAG,6BAA6B,EAAE,EAAE,aAAa,EAAE,QAAQ,GAAG,MAAM;IAiB5J;;;;;;;;OAQG;WACW,uBAAuB,CAAC,KAAK,EAAE,6BAA6B,EAAE,GAAG,6BAA6B,EAAE,EAAE;IAQhH;;;;;OAKG;WACW,qBAAqB,CAAC,KAAK,EAAE,6BAA6B,EAAE,EAAE,aAAa,EAAE,QAAQ,GAAG,SAAS,GAAG,6BAA6B,EAAE,EAAE;IAgCnJ;;;;;;;;;;;;;;;MAeE;WACY,sBAAsB,CAClC,OAAO,EAAE,OAAO,EAAE,GAAG,oBAAoB,EACzC,SAAS,EAAE,OAAO,EAClB,SAAS,GAAE,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,CAAgC,EACnE,MAAM,CAAC,EAAE,qBAAqB,GAC7B,qBAAqB;IAwJxB;;;;;;;;;;;;OAYG;WACW,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,oBAAoB,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,GAAE,MAAqC,EAAE,MAAM,CAAC,EAAE,qBAAqB,GAAG,qBAAqB;IAwBlM,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAU;IAClC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAU;IAClC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAU;IAClC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAU;IAClC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAQ;IAChC,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,CAAW;IACxC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAA+B;IAEzD;;;;;;;;;;;;;OAaG;WACW,cAAc,CAC1B,OAAO,EAAE,OAAO,EAAE,GAAG,oBAAoB,EACzC,GAAG,EAAE,KAAK,EACV,SAAS,GAAE,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,CAAgC,EACnE,MAAM,CAAC,EAAE,qBAAqB,GAC7B,qBAAqB;IAwCxB;;;;;;;;;;;;OAYG;WACW,gBAAgB,CAC5B,OAAO,EAAE,OAAO,EAAE,GAAG,oBAAoB,EACzC,MAAM,EAAE,OAAO,EACf,MAAM,EAAE,OAAO,EACf,SAAS,GAAE,MAAqC,EAChD,MAAM,CAAC,EAAE,qBAAqB,GAC7B,qBAAqB;IAKxB;;;;;;;;OAQG;IACH,OAAO,CAAC,MAAM,CAAC,iBAAiB;IA0BhC;;;;;;;;;;OAUG;IACH,OAAO,CAAC,MAAM,CAAC,kCAAkC;IAyCjD;;;;;;OAMG;WACW,4BAA4B,CACxC,OAAO,EAAE,OAAO,EAAE,GAAG,oBAAoB,EACzC,KAAK,EAAE,OAAO,EACd,SAAS,GAAE,MAAqC,GAC/C,MAAM,EAAE,GAAG,SAAS;IAwDvB;;;;;;OAMG;WACW,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,gBAAgB,EAAE,SAAS,GAAE,MAAqC,GAAG,IAAI;IAWzH;;;;;;OAMG;WACW,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,oBAAoB,EAAE,SAAS,GAAE,MAAqC,GAAG,OAAO,EAAE,GAAG,oBAAoB;IAezJ,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAA0B;IACtD;;;;;;;;;;OAUG;WACW,eAAe,CAC3B,QAAQ,EAAE,OAAO,EAAE,GAAG,oBAAoB,EAC1C,QAAQ,EAAE,OAAO,EAAE,GAAG,oBAAoB,EAC1C,IAAI,GAAE,MAAyB,EAC/B,eAAe,GAAE,OAAe,GAC/B,yBAAyB,GAAG,SAAS;CAezC;AAED;;;GAGG;AACH,qBAAa,8BAA8B;IACzC,OAAO,CAAC,MAAM,CAAC,SAAS,CAA6B;IACrD,OAAO,CAAC,MAAM,CAAC,SAAS,CAA6B;IACrD,OAAO,CAAC,MAAM,CAAC,SAAS,CAA6B;IACrD;;;;;;;;;;;OAWG;WACW,oCAAoC,CAChD,KAAK,EAAE,sBAAsB,EAC7B,GAAG,EAAE,oBAAoB,EACzB,WAAW,EAAE,6BAA6B,EAC1C,WAAW,EAAE,6BAA6B,EAC1C,aAAa,EAAE,OAAO,GACrB,IAAI;IAwDP;;;;;;;;;;;;;;;;;OAiBG;WACW,wBAAwB,CACpC,KAAK,EAAE,sBAAsB,EAC7B,GAAG,EAAE,gBAAgB,EACrB,IAAI,CAAC,EAAE,gBAAgB,EACvB,YAAY,GAAE,OAAc,EAC5B,SAAS,GAAE,MAAqC,GAC/C,MAAM;IAuDT;;;OAGG;WACW,qBAAqB,CAAC,KAAK,EAAE,sBAAsB,EAAE,GAAG,EAAE,oBAAoB,EAAE,SAAS,EAAE,OAAO,EAAE;IAuBlH;;;;;;;OAOG;WACW,2BAA2B,CAAC,KAAK,EAAE,sBAAsB,EAAE,GAAG,EAAE,gBAAgB,EAAE,cAAc,GAAE,MAAU,EAAE,SAAS,GAAE,MAAqC,GAAG,mBAAmB;IAmClM;;;;;OAKG;WACW,eAAe,CAAC,KAAK,EAAE,mBAAmB;IAuBxD;;;;;OAKG;WACW,kCAAkC,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,gBAAgB,GAAG,gBAAgB,GAAG,SAAS;CAqCtH;AACD;;;GAGG;AACH,qBAAa,sBAAsB;IACjC,OAAO,CAAC,MAAM,CAAC,SAAS,CAA6B;IAGrD;;;;;;OAMG;WACW,oCAAoC,CAAC,KAAK,EAAE,sBAAsB,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,OAAO,GAAG,IAAI;IAOpK;;;OAGG;WACW,qBAAqB,CAAC,KAAK,EAAE,sBAAsB,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,IAAI;IAI9G;;;;;OAKG;WACW,wBAAwB,CAAC,KAAK,EAAE,sBAAsB,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,SAAS,EAAE,SAAS,GAAE,MAAqC;CA0CpK"}

package/lib/cjs/geometry3d/PolygonOps.js

@@ -441,7 +441,13 @@ class PolygonOps {
     static _matrixA = Matrix4d_1.Matrix4d.createIdentity();
     static _matrixB = Matrix4d_1.Matrix4d.createIdentity();
     static _matrixC = Matrix4d_1.Matrix4d.createIdentity();
-    /** return a vector which is perpendicular to the polygon and has magnitude equal to the polygon area. */
+    /**
+     * Compute the area and normal of the polygon, packaged as a vector.
+     * * This is just [[areaNormal]] with expanded return type.
+     * @param points polygon vertices, closure point optional. Polygon can be in any plane.
+     * @param result optional pre-allocated vector to populate and return.
+     * @returns polygon normal with magnitude equal to polygon area, or `undefined` if colinear/insufficient points.
+     */
     static areaNormalGo(points, result) {
         if (!result)
             result = new Point3dVector3d_1.Vector3d();
@@ -452,7 +458,7 @@ class PolygonOps {
             points.crossProductIndexIndexIndex(0, 1, 2, result);
         }
         else if (n > 3) {
-            // This will work with or without closure edge.  If closure is given, the last vector is 000.
+            // Shoelace. This will work with or without closure point: if present, the last vector is 000.
             for (let i = 2; i < n; i++) {
                 points.accumulateCrossProductIndexIndexIndex(0, i - 1, i, result);
             }
@@ -461,23 +467,34 @@ class PolygonOps {
         result.scaleInPlace(0.5);
         return result.isZero ? undefined : result;
     }
-    /** return a vector which is perpendicular to the polygon and has magnitude equal to the polygon area. */
+    /**
+     * Compute the area and normal of the polygon, packaged as a vector.
+     * @param points polygon vertices, closure point optional. Polygon can be in any plane.
+     * @param result optional pre-allocated vector to populate and return.
+     * @returns polygon normal with magnitude equal to polygon area, or zero vector if colinear/insufficient points.
+     */
     static areaNormal(points, result) {
         if (!result)
             result = Point3dVector3d_1.Vector3d.create();
         PolygonOps.areaNormalGo(new Point3dArrayCarrier_1.Point3dArrayCarrier(points), result);
         return result;
     }
-    /** return the area of the polygon.
-     * * This assumes the polygon is planar
-     * * This does NOT assume the polygon is on the xy plane.
+    /**
+     * Compute the area of the polygon.
+     * @param points polygon vertices, closure point optional. Polygon can be in any plane.
+     * @returns polygon area.
      */
     static area(points) {
         return PolygonOps.areaNormal(points).magnitude();
     }
-    /** return the projected XY area of the polygon. */
+    /**
+     * Compute the projected XY area of the polygon.
+     * @param points polygon vertices, closure point optional, z-coordinates ignored.
+     * @returns xy-projected polygon area.
+     */
     static areaXY(points) {
         let area = 0.0;
+        // Shoelace algorithm
         if (points instanceof IndexedXYZCollection_1.IndexedXYZCollection) {
             if (points.length > 2) {
                 const x0 = points.getXAtUncheckedPointIndex(0);
@@ -485,7 +502,7 @@ class PolygonOps {
                 let u1 = points.getXAtUncheckedPointIndex(1) - x0;
                 let v1 = points.getYAtUncheckedPointIndex(1) - y0;
                 let u2, v2;
-                for (let i = 2; i + 1 < points.length; i++, u1 = u2, v1 = v2) {
+                for (let i = 2; i < points.length; i++, u1 = u2, v1 = v2) {
                     u2 = points.getXAtUncheckedPointIndex(i) - x0;
                     v2 = points.getYAtUncheckedPointIndex(i) - y0;
                     area += Geometry_1.Geometry.crossProductXYXY(u1, v1, u2, v2);
@@ -498,7 +515,11 @@ class PolygonOps {
         }
         return 0.5 * area;
     }
-    /** Sum the areaXY () values for multiple polygons */
+    /**
+     * Sum the result of [[areaXY]] for multiple polygons.
+     * @param polygons array of polygons, closure point optional for each, z-coordinates ignored.
+     * @returns sum of xy-projected polygon areas.
+     */
     static sumAreaXY(polygons) {
         let s = 0.0;
         for (const p of polygons)