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

package/lib/esm/clipping/BooleanClipFactory.d.ts

@@ -0,0 +1,80 @@
+import { Clipper } from "./ClipUtils";
+/** A BooleanClipFactory is a factory to create objects that implement interior nodes of a tree of boolean clip operations.
+ * * These methods create specific clip tree types:
+ *   * Union
+ *   * Intersection
+ *   * Parity
+ *   * Difference
+ * * Each construction has a `keepInside` flag that optionally negates the initial result of the parity, intersection, parity, or difference:
+ *   * if `keepInside === true`, accept the "inside" of the initial result
+ *   * if `keepInside === false`, accept the "outside"  of the initial result
+ * * These methods create various other specialized clippers
+ *   *
+ * @public
+ */
+export declare class BooleanClipFactory {
+    /**
+     * Create a boolean clipper which performs a union over its children
+     * * if `keepInside === true`, accept the "inside" of the union result
+     * * if `keepInside === false`, accept the "outside" of the union result
+     * @param clippers clip objects to capture
+     * @param keepInside flag to select results inside or outside the clippers.
+     */
+    static createCaptureUnion(clippers: Clipper | Clipper[], keepInside: boolean): Clipper;
+    /**
+     * Create a boolean clipper which performs an intersection over its children
+     * * if `keepInside === true`, accept the "inside" of the intersection result
+     * * if `keepInside === false`, accept the "outside" of the intersection result
+     * @param clippers clip objects to capture
+     * @param keepInside flag to select results inside or outside the clippers.
+     */
+    static createCaptureIntersection(clippers: Clipper | Clipper[], keepInside: boolean): Clipper;
+    /**
+     * Create a boolean clipper which performs a parity over its children
+     * * if `keepInside === true`, accept the "inside" of the parity result
+     * * if `keepInside === false`, accept the "outside" of the parity result
+     * @param clippers clip objects to capture
+     * @param keepInside flag to select results inside or outside the clippers.
+     */
+    static createCaptureParity(clippers: Clipper | Clipper[], keepInside: boolean): Clipper;
+    /**
+     * Create a boolean clipper which performs a difference operation for points "inside `primaryClipper`" and "outside `excludedClipper`"
+     * * if `keepInside === true`, accept the "inside" of the difference
+     * * if `keepInside === false`, accept the "outside" of the difference
+     * @param primaryClipper any clip object whose output is treated as positive
+     * @param excludeClip any clipper whose output is treated as negative.
+     * @param keepInside flag to select results inside or outside the initial `primary minus excludeClipper` clippers.
+     */
+    static createCaptureDifference(primaryClipper: Clipper, excludedClipper: Clipper, keepInside: boolean): Clipper;
+    /**
+     * Create a boolean clipper which performs the reverse of that of `primaryClipper`
+     * @param primaryClipper clip objects to capture
+     * @param keepInside flag to select results inside or outside the clippers.
+     */
+    static createCaptureClipOutside(primaryClipper: Clipper): Clipper;
+    /**
+     * convert `source` to an array of clipper objects.
+     * * ANY TYPE OF Clipper is accepted.
+     * * REMARK: This is normally called only from the primary public method `parseToClipper`.
+     * @param source
+     * @param internal
+     */
+    static parseToClipperArray(source: any): Clipper[] | undefined;
+    /**
+     * look for content that represents a clipper.
+     * * Possible outputs are
+     *   * `ClipPlane`
+     *   * `ConvexClipPlaneSet`
+     *   * `UnionOfConvexClipPlaneSets`
+     *   * One of the `ClipBoolean` derived classes
+     *     * `ClipBooleanXOR`
+     *     * `ClipBooleanOR`
+     *     * `ClipBooleanAND`
+     * @param source json object
+     * @public
+     */
+    static parseToClipper(source?: object): Clipper | undefined;
+    /** Choose a `toJSON` method appropriate to the clipper */
+    static anyClipperToJSON(clipper: any): any | undefined;
+}
+//# sourceMappingURL=BooleanClipFactory.d.ts.map

package/lib/esm/clipping/BooleanClipFactory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BooleanClipFactory.d.ts","sourceRoot":"","sources":["../../../src/clipping/BooleanClipFactory.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,OAAO,EAAiB,MAAM,aAAa,CAAC;AAIrD;;;;;;;;;;;;GAYG;AACH,qBAAa,kBAAkB;IAC7B;;;;;;OAMG;WACW,kBAAkB,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,EAAE,EAAE,UAAU,EAAE,OAAO,GAAG,OAAO;IAK7F;;;;;;OAMG;WACW,yBAAyB,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,EAAE,EAAE,UAAU,EAAE,OAAO,GAAG,OAAO;IAKpG;;;;;;OAMG;WACW,mBAAmB,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,EAAE,EAAE,UAAU,EAAE,OAAO,GAAG,OAAO;IAK9F;;;;;;;OAOG;WACW,uBAAuB,CAAC,cAAc,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,GAAG,OAAO;IAItH;;;;OAIG;WACW,wBAAwB,CAAC,cAAc,EAAE,OAAO,GAAG,OAAO;IAIxE;;;;;;OAMG;WACW,mBAAmB,CAAC,MAAM,EAAE,GAAG,GAAG,OAAO,EAAE,GAAG,SAAS;IAoBrE;;;;;;;;;;;;OAYG;WACW,cAAc,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;IA0DlE,0DAA0D;WAC5C,gBAAgB,CAAC,OAAO,EAAE,GAAG,GAAG,GAAG,GAAG,SAAS;CAQ9D"}

package/lib/esm/clipping/BooleanClipFactory.js

@@ -0,0 +1,198 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module CartesianGeometry
+ */
+import { BooleanClipNodeIntersection, BooleanClipNodeParity, BooleanClipNodeUnion } from "./BooleanClipNode";
+import { ClipPlane } from "./ClipPlane";
+import { ClipUtilities } from "./ClipUtils";
+import { ConvexClipPlaneSet } from "./ConvexClipPlaneSet";
+import { UnionOfConvexClipPlaneSets } from "./UnionOfConvexClipPlaneSets";
+/** A BooleanClipFactory is a factory to create objects that implement interior nodes of a tree of boolean clip operations.
+ * * These methods create specific clip tree types:
+ *   * Union
+ *   * Intersection
+ *   * Parity
+ *   * Difference
+ * * Each construction has a `keepInside` flag that optionally negates the initial result of the parity, intersection, parity, or difference:
+ *   * if `keepInside === true`, accept the "inside" of the initial result
+ *   * if `keepInside === false`, accept the "outside"  of the initial result
+ * * These methods create various other specialized clippers
+ *   *
+ * @public
+ */
+export class BooleanClipFactory {
+    /**
+     * Create a boolean clipper which performs a union over its children
+     * * if `keepInside === true`, accept the "inside" of the union result
+     * * if `keepInside === false`, accept the "outside" of the union result
+     * @param clippers clip objects to capture
+     * @param keepInside flag to select results inside or outside the clippers.
+     */
+    static createCaptureUnion(clippers, keepInside) {
+        const result = new BooleanClipNodeUnion(keepInside);
+        result.captureChild(clippers);
+        return result;
+    }
+    /**
+     * Create a boolean clipper which performs an intersection over its children
+     * * if `keepInside === true`, accept the "inside" of the intersection result
+     * * if `keepInside === false`, accept the "outside" of the intersection result
+     * @param clippers clip objects to capture
+     * @param keepInside flag to select results inside or outside the clippers.
+     */
+    static createCaptureIntersection(clippers, keepInside) {
+        const result = new BooleanClipNodeIntersection(keepInside);
+        result.captureChild(clippers);
+        return result;
+    }
+    /**
+     * Create a boolean clipper which performs a parity over its children
+     * * if `keepInside === true`, accept the "inside" of the parity result
+     * * if `keepInside === false`, accept the "outside" of the parity result
+     * @param clippers clip objects to capture
+     * @param keepInside flag to select results inside or outside the clippers.
+     */
+    static createCaptureParity(clippers, keepInside) {
+        const result = new BooleanClipNodeParity(keepInside);
+        result.captureChild(clippers);
+        return result;
+    }
+    /**
+     * Create a boolean clipper which performs a difference operation for points "inside `primaryClipper`" and "outside `excludedClipper`"
+     * * if `keepInside === true`, accept the "inside" of the difference
+     * * if `keepInside === false`, accept the "outside" of the difference
+     * @param primaryClipper any clip object whose output is treated as positive
+     * @param excludeClip any clipper whose output is treated as negative.
+     * @param keepInside flag to select results inside or outside the initial `primary minus excludeClipper` clippers.
+     */
+    static createCaptureDifference(primaryClipper, excludedClipper, keepInside) {
+        const mask = this.createCaptureUnion(excludedClipper, false);
+        return this.createCaptureIntersection([primaryClipper, mask], keepInside);
+    }
+    /**
+     * Create a boolean clipper which performs the reverse of that of `primaryClipper`
+     * @param primaryClipper clip objects to capture
+     * @param keepInside flag to select results inside or outside the clippers.
+     */
+    static createCaptureClipOutside(primaryClipper) {
+        return this.createCaptureUnion([primaryClipper], false);
+    }
+    /**
+     * convert `source` to an array of clipper objects.
+     * * ANY TYPE OF Clipper is accepted.
+     * * REMARK: This is normally called only from the primary public method `parseToClipper`.
+     * @param source
+     * @param internal
+     */
+    static parseToClipperArray(source) {
+        if (Array.isArray(source)) {
+            const clippers = [];
+            for (const c of source) {
+                const c1 = this.parseToClipper(c);
+                if (!c1)
+                    return undefined;
+                clippers.push(c1);
+            }
+            if (clippers.length === 0)
+                return undefined;
+            return clippers;
+        }
+        else {
+            // accept singleton to singleton array
+            const c = this.parseToClipper(source);
+            if (c)
+                return [c];
+        }
+        return undefined;
+    }
+    /**
+     * look for content that represents a clipper.
+     * * Possible outputs are
+     *   * `ClipPlane`
+     *   * `ConvexClipPlaneSet`
+     *   * `UnionOfConvexClipPlaneSets`
+     *   * One of the `ClipBoolean` derived classes
+     *     * `ClipBooleanXOR`
+     *     * `ClipBooleanOR`
+     *     * `ClipBooleanAND`
+     * @param source json object
+     * @public
+     */
+    static parseToClipper(source) {
+        if (!source)
+            return undefined;
+        if (source.hasOwnProperty("normal") && source.hasOwnProperty("dist")) {
+            return ClipPlane.fromJSON(source);
+        }
+        else if (Array.isArray(source)) {
+            const clippers = [];
+            let numPlanes = 0;
+            let numConvexSets = 0;
+            for (const c of source) {
+                const c1 = this.parseToClipper(c);
+                if (!c1)
+                    return undefined;
+                clippers.push(c1);
+                if (c1 instanceof ClipPlane)
+                    numPlanes++;
+                else if (c1 instanceof ConvexClipPlaneSet)
+                    numConvexSets++;
+                else
+                    return undefined;
+            }
+            if (clippers.length === 0)
+                return undefined;
+            if (numPlanes === source.length) {
+                // array of planes is a convex clip plane set.
+                return ConvexClipPlaneSet.createPlanes(clippers);
+            }
+            else if (numConvexSets === source.length) {
+                return UnionOfConvexClipPlaneSets.createConvexSets(clippers);
+            }
+            // array of mixed types should not occur.  fall out to undefined.
+        }
+        else if (source.hasOwnProperty("OR")) {
+            const clippers = this.parseToClipperArray(source.OR);
+            if (clippers)
+                return this.createCaptureUnion(clippers, true);
+        }
+        else if (source.hasOwnProperty("NOR")) {
+            const clippers = this.parseToClipperArray(source.NOR);
+            if (clippers)
+                return this.createCaptureUnion(clippers, false);
+        }
+        else if (source.hasOwnProperty("AND")) {
+            const clippers = this.parseToClipperArray(source.AND);
+            if (clippers)
+                return this.createCaptureIntersection(clippers, true);
+        }
+        else if (source.hasOwnProperty("NAND")) {
+            const clippers = this.parseToClipperArray(source.NAND);
+            if (clippers)
+                return this.createCaptureIntersection(clippers, true);
+        }
+        else if (source.hasOwnProperty("XOR")) {
+            const clippers = this.parseToClipperArray(source.XOR);
+            if (clippers)
+                return this.createCaptureParity(clippers, true);
+        }
+        else if (source.hasOwnProperty("NXOR")) {
+            const clippers = this.parseToClipperArray(source.NXOR);
+            if (clippers)
+                return this.createCaptureParity(clippers, true);
+        }
+        return undefined;
+    }
+    /** Choose a `toJSON` method appropriate to the clipper */
+    static anyClipperToJSON(clipper) {
+        if (ClipUtilities.isClipper(clipper)) {
+            if (clipper.toJSON)
+                return clipper.toJSON();
+        }
+        return undefined;
+    }
+}
+//# sourceMappingURL=BooleanClipFactory.js.map

package/lib/esm/clipping/BooleanClipFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BooleanClipFactory.js","sourceRoot":"","sources":["../../../src/clipping/BooleanClipFactory.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F;;GAEG;AACH,OAAO,EAAE,2BAA2B,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAC7G,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAW,aAAa,EAAE,MAAM,aAAa,CAAC;AACrD,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAE1E;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,kBAAkB;IAC7B;;;;;;OAMG;IACI,MAAM,CAAC,kBAAkB,CAAC,QAA6B,EAAE,UAAmB;QACjF,MAAM,MAAM,GAAG,IAAI,oBAAoB,CAAC,UAAU,CAAC,CAAC;QACpD,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAC9B,OAAO,MAAM,CAAC;IAChB,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,yBAAyB,CAAC,QAA6B,EAAE,UAAmB;QACxF,MAAM,MAAM,GAAG,IAAI,2BAA2B,CAAC,UAAU,CAAC,CAAC;QAC3D,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAC9B,OAAO,MAAM,CAAC;IAChB,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,mBAAmB,CAAC,QAA6B,EAAE,UAAmB;QAClF,MAAM,MAAM,GAAG,IAAI,qBAAqB,CAAC,UAAU,CAAC,CAAC;QACrD,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAC9B,OAAO,MAAM,CAAC;IAChB,CAAC;IACD;;;;;;;OAOG;IACI,MAAM,CAAC,uBAAuB,CAAC,cAAuB,EAAE,eAAwB,EAAE,UAAmB;QAC1G,MAAM,IAAI,GAAG,IAAI,CAAC,kBAAkB,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;QAC7D,OAAO,IAAI,CAAC,yBAAyB,CAAC,CAAC,cAAc,EAAE,IAAI,CAAC,EAAE,UAAU,CAAC,CAAC;IAC5E,CAAC;IACD;;;;OAIG;IACI,MAAM,CAAC,wBAAwB,CAAC,cAAuB;QAC5D,OAAO,IAAI,CAAC,kBAAkB,CAAC,CAAC,cAAc,CAAC,EAAE,KAAK,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,mBAAmB,CAAC,MAAW;QAC3C,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;YACzB,MAAM,QAAQ,GAAG,EAAE,CAAC;YACpB,KAAK,MAAM,CAAC,IAAI,MAAM,EAAE;gBACtB,MAAM,EAAE,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;gBAClC,IAAI,CAAC,EAAE;oBACL,OAAO,SAAS,CAAC;gBACnB,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;aACnB;YACD,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;gBACvB,OAAO,SAAS,CAAC;YACnB,OAAO,QAAQ,CAAC;SACjB;aAAM;YACL,sCAAsC;YACtC,MAAM,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;YACtC,IAAI,CAAC;gBACH,OAAO,CAAC,CAAC,CAAC,CAAC;SACd;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD;;;;;;;;;;;;OAYG;IACI,MAAM,CAAC,cAAc,CAAC,MAAe;QAC1C,IAAI,CAAC,MAAM;YACT,OAAO,SAAS,CAAC;QAEnB,IAAI,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE;YACpE,OAAO,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;SACnC;aAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;YAChC,MAAM,QAAQ,GAAc,EAAE,CAAC;YAC/B,IAAI,SAAS,GAAG,CAAC,CAAC;YAClB,IAAI,aAAa,GAAG,CAAC,CAAC;YACtB,KAAK,MAAM,CAAC,IAAI,MAAM,EAAE;gBACtB,MAAM,EAAE,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;gBAClC,IAAI,CAAC,EAAE;oBACL,OAAO,SAAS,CAAC;gBACnB,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBAClB,IAAI,EAAE,YAAY,SAAS;oBACzB,SAAS,EAAE,CAAC;qBACT,IAAI,EAAE,YAAY,kBAAkB;oBACvC,aAAa,EAAE,CAAC;;oBAEhB,OAAO,SAAS,CAAC;aACpB;YACD,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;gBACvB,OAAO,SAAS,CAAC;YACnB,IAAI,SAAS,KAAK,MAAM,CAAC,MAAM,EAAE;gBAC/B,8CAA8C;gBAC9C,OAAO,kBAAkB,CAAC,YAAY,CAAC,QAAuB,CAAC,CAAC;aACjE;iBAAM,IAAI,aAAa,KAAK,MAAM,CAAC,MAAM,EAAE;gBAC1C,OAAO,0BAA0B,CAAC,gBAAgB,CAAC,QAAgC,CAAC,CAAC;aACtF;YACD,iEAAiE;SAClE;aAAM,IAAI,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE;YACtC,MAAM,QAAQ,GAAG,IAAI,CAAC,mBAAmB,CAAE,MAAc,CAAC,EAAE,CAAC,CAAC;YAC9D,IAAI,QAAQ;gBACV,OAAO,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;SAClD;aAAM,IAAI,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE;YACvC,MAAM,QAAQ,GAAG,IAAI,CAAC,mBAAmB,CAAE,MAAc,CAAC,GAAG,CAAC,CAAC;YAC/D,IAAI,QAAQ;gBACV,OAAO,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;SACnD;aAAM,IAAI,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE;YACvC,MAAM,QAAQ,GAAG,IAAI,CAAC,mBAAmB,CAAE,MAAc,CAAC,GAAG,CAAC,CAAC;YAC/D,IAAI,QAAQ;gBACV,OAAO,IAAI,CAAC,yBAAyB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;SACzD;aAAM,IAAI,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE;YACxC,MAAM,QAAQ,GAAG,IAAI,CAAC,mBAAmB,CAAE,MAAc,CAAC,IAAI,CAAC,CAAC;YAChE,IAAI,QAAQ;gBACV,OAAO,IAAI,CAAC,yBAAyB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;SACzD;aAAM,IAAI,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE;YACvC,MAAM,QAAQ,GAAG,IAAI,CAAC,mBAAmB,CAAE,MAAc,CAAC,GAAG,CAAC,CAAC;YAC/D,IAAI,QAAQ;gBACV,OAAO,IAAI,CAAC,mBAAmB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;SACnD;aAAM,IAAI,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE;YACxC,MAAM,QAAQ,GAAG,IAAI,CAAC,mBAAmB,CAAE,MAAc,CAAC,IAAI,CAAC,CAAC;YAChE,IAAI,QAAQ;gBACV,OAAO,IAAI,CAAC,mBAAmB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;SACnD;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,0DAA0D;IACnD,MAAM,CAAC,gBAAgB,CAAC,OAAY;QACzC,IAAI,aAAa,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE;YACpC,IAAI,OAAO,CAAC,MAAM;gBAChB,OAAO,OAAO,CAAC,MAAM,EAAE,CAAC;SAC3B;QACD,OAAO,SAAS,CAAC;IAEnB,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\n/** @packageDocumentation\r\n * @module CartesianGeometry\r\n */\r\nimport { BooleanClipNodeIntersection, BooleanClipNodeParity, BooleanClipNodeUnion } from \"./BooleanClipNode\";\r\nimport { ClipPlane } from \"./ClipPlane\";\r\nimport { Clipper, ClipUtilities } from \"./ClipUtils\";\r\nimport { ConvexClipPlaneSet } from \"./ConvexClipPlaneSet\";\r\nimport { UnionOfConvexClipPlaneSets } from \"./UnionOfConvexClipPlaneSets\";\r\n\r\n/** A BooleanClipFactory is a factory to create objects that implement interior nodes of a tree of boolean clip operations.\r\n * * These methods create specific clip tree types:\r\n *   * Union\r\n *   * Intersection\r\n *   * Parity\r\n *   * Difference\r\n * * Each construction has a `keepInside` flag that optionally negates the initial result of the parity, intersection, parity, or difference:\r\n *   * if `keepInside === true`, accept the \"inside\" of the initial result\r\n *   * if `keepInside === false`, accept the \"outside\"  of the initial result\r\n * * These methods create various other specialized clippers\r\n *   *\r\n * @public\r\n */\r\nexport class BooleanClipFactory {\r\n  /**\r\n   * Create a boolean clipper which performs a union over its children\r\n   * * if `keepInside === true`, accept the \"inside\" of the union result\r\n   * * if `keepInside === false`, accept the \"outside\" of the union result\r\n   * @param clippers clip objects to capture\r\n   * @param keepInside flag to select results inside or outside the clippers.\r\n   */\r\n  public static createCaptureUnion(clippers: Clipper | Clipper[], keepInside: boolean): Clipper {\r\n    const result = new BooleanClipNodeUnion(keepInside);\r\n    result.captureChild(clippers);\r\n    return result;\r\n  }\r\n  /**\r\n   * Create a boolean clipper which performs an intersection over its children\r\n   * * if `keepInside === true`, accept the \"inside\" of the intersection result\r\n   * * if `keepInside === false`, accept the \"outside\" of the intersection result\r\n   * @param clippers clip objects to capture\r\n   * @param keepInside flag to select results inside or outside the clippers.\r\n   */\r\n  public static createCaptureIntersection(clippers: Clipper | Clipper[], keepInside: boolean): Clipper {\r\n    const result = new BooleanClipNodeIntersection(keepInside);\r\n    result.captureChild(clippers);\r\n    return result;\r\n  }\r\n  /**\r\n   * Create a boolean clipper which performs a parity over its children\r\n   * * if `keepInside === true`, accept the \"inside\" of the parity result\r\n   * * if `keepInside === false`, accept the \"outside\" of the parity result\r\n   * @param clippers clip objects to capture\r\n   * @param keepInside flag to select results inside or outside the clippers.\r\n   */\r\n  public static createCaptureParity(clippers: Clipper | Clipper[], keepInside: boolean): Clipper {\r\n    const result = new BooleanClipNodeParity(keepInside);\r\n    result.captureChild(clippers);\r\n    return result;\r\n  }\r\n  /**\r\n   * Create a boolean clipper which performs a difference operation for points \"inside `primaryClipper`\" and \"outside `excludedClipper`\"\r\n   * * if `keepInside === true`, accept the \"inside\" of the difference\r\n   * * if `keepInside === false`, accept the \"outside\" of the difference\r\n   * @param primaryClipper any clip object whose output is treated as positive\r\n   * @param excludeClip any clipper whose output is treated as negative.\r\n   * @param keepInside flag to select results inside or outside the initial `primary minus excludeClipper` clippers.\r\n   */\r\n  public static createCaptureDifference(primaryClipper: Clipper, excludedClipper: Clipper, keepInside: boolean): Clipper {\r\n    const mask = this.createCaptureUnion(excludedClipper, false);\r\n    return this.createCaptureIntersection([primaryClipper, mask], keepInside);\r\n  }\r\n  /**\r\n   * Create a boolean clipper which performs the reverse of that of `primaryClipper`\r\n   * @param primaryClipper clip objects to capture\r\n   * @param keepInside flag to select results inside or outside the clippers.\r\n   */\r\n  public static createCaptureClipOutside(primaryClipper: Clipper): Clipper {\r\n    return this.createCaptureUnion([primaryClipper], false);\r\n  }\r\n\r\n  /**\r\n   * convert `source` to an array of clipper objects.\r\n   * * ANY TYPE OF Clipper is accepted.\r\n   * * REMARK: This is normally called only from the primary public method `parseToClipper`.\r\n   * @param source\r\n   * @param internal\r\n   */\r\n  public static parseToClipperArray(source: any): Clipper[] | undefined {\r\n    if (Array.isArray(source)) {\r\n      const clippers = [];\r\n      for (const c of source) {\r\n        const c1 = this.parseToClipper(c);\r\n        if (!c1)\r\n          return undefined;\r\n        clippers.push(c1);\r\n      }\r\n      if (clippers.length === 0)\r\n        return undefined;\r\n      return clippers;\r\n    } else {\r\n      // accept singleton to singleton array\r\n      const c = this.parseToClipper(source);\r\n      if (c)\r\n        return [c];\r\n    }\r\n    return undefined;\r\n  }\r\n  /**\r\n   * look for content that represents a clipper.\r\n   * * Possible outputs are\r\n   *   * `ClipPlane`\r\n   *   * `ConvexClipPlaneSet`\r\n   *   * `UnionOfConvexClipPlaneSets`\r\n   *   * One of the `ClipBoolean` derived classes\r\n   *     * `ClipBooleanXOR`\r\n   *     * `ClipBooleanOR`\r\n   *     * `ClipBooleanAND`\r\n   * @param source json object\r\n   * @public\r\n   */\r\n  public static parseToClipper(source?: object): Clipper | undefined {\r\n    if (!source)\r\n      return undefined;\r\n\r\n    if (source.hasOwnProperty(\"normal\") && source.hasOwnProperty(\"dist\")) {\r\n      return ClipPlane.fromJSON(source);\r\n    } else if (Array.isArray(source)) {\r\n      const clippers: Clipper[] = [];\r\n      let numPlanes = 0;\r\n      let numConvexSets = 0;\r\n      for (const c of source) {\r\n        const c1 = this.parseToClipper(c);\r\n        if (!c1)\r\n          return undefined;\r\n        clippers.push(c1);\r\n        if (c1 instanceof ClipPlane)\r\n          numPlanes++;\r\n        else if (c1 instanceof ConvexClipPlaneSet)\r\n          numConvexSets++;\r\n        else\r\n          return undefined;\r\n      }\r\n      if (clippers.length === 0)\r\n        return undefined;\r\n      if (numPlanes === source.length) {\r\n        // array of planes is a convex clip plane set.\r\n        return ConvexClipPlaneSet.createPlanes(clippers as ClipPlane[]);\r\n      } else if (numConvexSets === source.length) {\r\n        return UnionOfConvexClipPlaneSets.createConvexSets(clippers as ConvexClipPlaneSet[]);\r\n      }\r\n      // array of mixed types should not occur.  fall out to undefined.\r\n    } else if (source.hasOwnProperty(\"OR\")) {\r\n      const clippers = this.parseToClipperArray((source as any).OR);\r\n      if (clippers)\r\n        return this.createCaptureUnion(clippers, true);\r\n    } else if (source.hasOwnProperty(\"NOR\")) {\r\n      const clippers = this.parseToClipperArray((source as any).NOR);\r\n      if (clippers)\r\n        return this.createCaptureUnion(clippers, false);\r\n    } else if (source.hasOwnProperty(\"AND\")) {\r\n      const clippers = this.parseToClipperArray((source as any).AND);\r\n      if (clippers)\r\n        return this.createCaptureIntersection(clippers, true);\r\n    } else if (source.hasOwnProperty(\"NAND\")) {\r\n      const clippers = this.parseToClipperArray((source as any).NAND);\r\n      if (clippers)\r\n        return this.createCaptureIntersection(clippers, true);\r\n    } else if (source.hasOwnProperty(\"XOR\")) {\r\n      const clippers = this.parseToClipperArray((source as any).XOR);\r\n      if (clippers)\r\n        return this.createCaptureParity(clippers, true);\r\n    } else if (source.hasOwnProperty(\"NXOR\")) {\r\n      const clippers = this.parseToClipperArray((source as any).NXOR);\r\n      if (clippers)\r\n        return this.createCaptureParity(clippers, true);\r\n    }\r\n    return undefined;\r\n  }\r\n  /** Choose a `toJSON` method appropriate to the clipper */\r\n  public static anyClipperToJSON(clipper: any): any | undefined {\r\n    if (ClipUtilities.isClipper(clipper)) {\r\n      if (clipper.toJSON)\r\n        return clipper.toJSON();\r\n    }\r\n    return undefined;\r\n\r\n  }\r\n}\r\n"]}

package/lib/esm/clipping/BooleanClipNode.d.ts

@@ -0,0 +1,103 @@
+/** @packageDocumentation
+ * @module CartesianGeometry
+ */
+import { Arc3d } from "../curve/Arc3d";
+import { AnnounceNumberNumber, AnnounceNumberNumberCurvePrimitive, CurvePrimitive } from "../curve/CurvePrimitive";
+import { Point3d } from "../geometry3d/Point3dVector3d";
+import { Range1d } from "../geometry3d/Range";
+import { Clipper } from "./ClipUtils";
+/** BooleanClipNode is an abstract base class for boolean actions by an array of clippers.
+ * * Derived class must implement
+ *   * The single point test `isPointOnOrInsideChildren`
+ *   * Boolean operation on 1d intervals `combineIntervals`
+ * * The `keepInside` flag controls an additional optional flip of the boolean result.
+ *   * if `keepInside === true`, accept the "inside" of the clip clippers
+ *   * if `keepInside === false`, accept the "outside" of the child clippers.
+ * * Hence the combinations of derived classes for (OR, AND, XOR) and keepInside are
+ *   * (OR, true) = simple union (OR), i.e. "in" one or more clips
+ *   * (OR, false) = complement of union (NOR), i.e. "outside" all clips
+ *   * (AND, true) = simple intersection (AND), i.e. "in" all clips
+ *   * (AND, false) = complement of intersection (NAND), i.e. "outside" one or more clips
+ *   * (XOR,true) = simple parity, i.e. "in" an odd number of clips
+ *   * (XOR,false) = complement of parity ), i.e. "in" an even number of clips
+ * @internal
+ */
+export declare abstract class BooleanClipNode implements Clipper {
+    protected _clippers: Clipper[];
+    protected _intervalsA: Range1d[];
+    protected _intervalsB: Range1d[];
+    protected _keepInside: boolean;
+    constructor(keepInside: boolean);
+    protected abstract isPointOnOrInsideChildren(point: Point3d): boolean;
+    protected abstract combineIntervals(operandA: Range1d[], operandB: Range1d[]): Range1d[];
+    abstract get operationName(): string;
+    toJSON(): any;
+    /** Capture a (reference to a) child node or nodes */
+    captureChild(child: Clipper | Clipper[]): void;
+    /** toggle the "keepInside" behavior.  Return the prior value.  */
+    toggleResult(): boolean;
+    /** Set the "keepInside" behavior  */
+    selectResult(keepInside: boolean): boolean;
+    /**
+     * * Conditionally (if a1 > a0 strictly) call announce (a0, a1).
+     * * Return 0 if not called, 1 if called.
+     */
+    protected testedAnnounceNN(a0: number, a1: number, announce?: AnnounceNumberNumber): number;
+    /**
+     * * Conditionally (if a1 > a0 strictly) call announce (a0, a1, cp).
+     * * Return 0 if not called, 1 if called.
+     */
+    protected testedAnnounceNNC(a0: number, a1: number, cp: CurvePrimitive, announce?: AnnounceNumberNumberCurvePrimitive): number;
+    /** Swap the _intervalsA and _intervalsB */
+    protected swapAB(): void;
+    /**
+     * * announce all "outside intervals" --not masked by intervals
+     * * return true if any intervals announced.
+     */
+    protected announcePartsNN(keepInside: boolean, intervals: Range1d[], f0: number, f1: number, announce?: AnnounceNumberNumber): boolean;
+    /**
+     * * announce all "outside intervals" --not masked by intervals
+     * * return true if any intervals announced.
+     */
+    protected announcePartsNNC(keepInside: boolean, intervals: Range1d[], f0: number, f1: number, cp: CurvePrimitive, announce?: AnnounceNumberNumberCurvePrimitive): boolean;
+    /** Invoke callback to test if a point is "in" this clipper */
+    isPointOnOrInside(point: Point3d): boolean;
+    /** Announce "in" portions of a line segment.  See `Clipper.announceClippedSegmentIntervals` */
+    announceClippedSegmentIntervals(f0: number, f1: number, pointA: Point3d, pointB: Point3d, announce?: AnnounceNumberNumber): boolean;
+    /** Announce "in" portions of a line segment.  See `Clipper.announceClippedSegmentIntervals` */
+    announceClippedArcIntervals(arc: Arc3d, announce?: AnnounceNumberNumberCurvePrimitive): boolean;
+}
+/**
+ * Implement BooleanClipNode virtual methods for intersection (boolean OR) among children
+ * @internal
+ */
+export declare class BooleanClipNodeUnion extends BooleanClipNode {
+    get operationName(): string;
+    constructor(keepInside: boolean);
+    /** return true if inside any child clipper */
+    isPointOnOrInsideChildren(point: Point3d): boolean;
+    combineIntervals(operandA: Range1d[], operandB: Range1d[]): Range1d[];
+}
+/**
+ * Implement BooleanClipNode virtual methods for intersection (boolean OR) among children
+ * @internal
+ */
+export declare class BooleanClipNodeParity extends BooleanClipNode {
+    get operationName(): string;
+    constructor(keepInside: boolean);
+    /** return true if inside an odd number of clippers child clipper */
+    isPointOnOrInsideChildren(point: Point3d): boolean;
+    combineIntervals(operandA: Range1d[], operandB: Range1d[]): Range1d[];
+}
+/**
+ * Implement BooleanClipNode virtual methods for intersection (boolean OR) among children
+ * @internal
+ */
+export declare class BooleanClipNodeIntersection extends BooleanClipNode {
+    get operationName(): string;
+    constructor(keepInside: boolean);
+    /** return false if outside of any child clipper */
+    isPointOnOrInsideChildren(point: Point3d): boolean;
+    combineIntervals(operandA: Range1d[], operandB: Range1d[]): Range1d[];
+}
+//# sourceMappingURL=BooleanClipNode.d.ts.map

package/lib/esm/clipping/BooleanClipNode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BooleanClipNode.d.ts","sourceRoot":"","sources":["../../../src/clipping/BooleanClipNode.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACvC,OAAO,EAAE,oBAAoB,EAAE,kCAAkC,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACnH,OAAO,EAAE,OAAO,EAAE,MAAM,+BAA+B,CAAC;AACxD,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAE9C,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAEtC;;;;;;;;;;;;;;;GAeG;AACH,8BAAsB,eAAgB,YAAW,OAAO;IACtD,SAAS,CAAC,SAAS,EAAE,OAAO,EAAE,CAAC;IAC/B,SAAS,CAAC,WAAW,EAAE,OAAO,EAAE,CAAC;IACjC,SAAS,CAAC,WAAW,EAAE,OAAO,EAAE,CAAC;IACjC,SAAS,CAAC,WAAW,EAAE,OAAO,CAAC;gBAEZ,UAAU,EAAE,OAAO;IAMtC,SAAS,CAAC,QAAQ,CAAC,yBAAyB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;IACrE,SAAS,CAAC,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE;IACxF,aAAoB,aAAa,IAAI,MAAM,CAAC;IACrC,MAAM,IAAI,GAAG;IAcpB,qDAAqD;IAC9C,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,EAAE;IAO9C,kEAAkE;IAC3D,YAAY,IAAI,OAAO;IAG9B,qCAAqC;IAC9B,YAAY,CAAC,UAAU,EAAE,OAAO,GAAG,OAAO;IAMjD;;;OAGG;IACH,SAAS,CAAC,gBAAgB,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,oBAAoB,GAAG,MAAM;IAQ3F;;;OAGG;IACH,SAAS,CAAC,iBAAiB,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,cAAc,EAAE,QAAQ,CAAC,EAAE,kCAAkC,GAAG,MAAM;IAQ9H,2CAA2C;IAC3C,SAAS,CAAC,MAAM,IAAI,IAAI;IAKxB;;;OAGG;IACH,SAAS,CAAC,eAAe,CAAC,UAAU,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,oBAAoB,GAAG,OAAO;IAiBtI;;;OAGG;IACH,SAAS,CAAC,gBAAgB,CAAC,UAAU,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,cAAc,EAAE,QAAQ,CAAC,EAAE,kCAAkC,GAAG,OAAO;IAkBzK,8DAA8D;IACvD,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;IAMjD,+FAA+F;IACxF,+BAA+B,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,oBAAoB,GAAG,OAAO;IAyB1I,+FAA+F;IACxF,2BAA2B,CAAC,GAAG,EAAE,KAAK,EAAE,QAAQ,CAAC,EAAE,kCAAkC,GAAG,OAAO;CAoBvG;AACD;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,eAAe;IACvD,IAAW,aAAa,IAAI,MAAM,CAA4C;gBAC3D,UAAU,EAAE,OAAO;IAGtC,8CAA8C;IACvC,yBAAyB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;IAOlD,gBAAgB,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE;CAG7E;AAED;;;GAGG;AACH,qBAAa,qBAAsB,SAAQ,eAAe;IACxD,IAAW,aAAa,IAAI,MAAM,CAA8C;gBAC7D,UAAU,EAAE,OAAO;IAGtC,oEAAoE;IAC7D,yBAAyB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;IAQlD,gBAAgB,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE;CAG7E;AACD;;;GAGG;AACH,qBAAa,2BAA4B,SAAQ,eAAe;IAC9D,IAAW,aAAa,IAAI,MAAM,CAA8C;gBAC7D,UAAU,EAAE,OAAO;IAGtC,mDAAmD;IAC5C,yBAAyB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;IAOlD,gBAAgB,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE;CAG7E"}