@itwin/core-geometry 4.1.0-dev.70 → 4.1.0-dev.72

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

@@ -32,7 +32,8 @@ export declare enum ClipMaskXYZRangePlanes {
     /** all 6 planes */
     All = 63
 }
-/** Wire format describing a [[ClipPrimitive]] defined by a set of clip planes.
+/**
+ * Wire format describing a [[ClipPrimitive]] defined by a set of clip planes.
  * @public
  */
 export interface ClipPrimitivePlanesProps {
@@ -43,7 +44,8 @@ export interface ClipPrimitivePlanesProps {
         invisible?: boolean;
     };
 }
-/** Wire format describing a [[ClipShape]].
+/**
+ * Wire format describing a [[ClipShape]].
  * @public
  */
 export interface ClipPrimitiveShapeProps {
@@ -69,17 +71,18 @@ export interface ClipPrimitiveShapeProps {
 export type ClipPrimitiveProps = ClipPrimitivePlanesProps | ClipPrimitiveShapeProps;
 /**
  * * ClipPrimitive is a base class for clipping implementations that use
- *   * A UnionOfConvexClipPlaneSets designated "clipPlanes"
- *   * an "invisible" flag
- * * When constructed directly, objects of type ClipPrimitive (directly, not through a derived class) will have just planes
+ *   * A UnionOfConvexClipPlaneSets designated "clipPlanes".
+ *   * An "invisible" flag.
+ * * When constructed directly, objects of type ClipPrimitive (directly, not through a derived class) will have just planes.
  * * Derived classes (e.g. ClipShape) carry additional data such as a swept shape.
  * * ClipPrimitive can be constructed with no planes.
  *     * Derived class is responsible for filling the plane sets.
- *     * At discretion of derived classes, plane construction can be done at construction time or "on demand when" queries call `ensurePlaneSets ()`
+ *     * At discretion of derived classes, plane construction can be done at construction time or "on demand when" queries
+ * call `ensurePlaneSets ()`
  * * ClipPrimitive can be constructed directly with planes (and no derived class).
  * * That the prevailing use is via a ClipShape derived class.
  *    * The ClipShape has an "isMask" property
- *       * isMask === false means the plane sets should cover the inside of its polygon
+ *       * isMask === false means the plane sets should cover the inside of its polygon.
  *       * isMask === true means the plane sets should cover the outside of its polygon.
  *  * Note that the ClipShape's `isMask` property and the ClipPrimitive's `isInvisible` property are distinct controls.
  *     * In normal usage, callers get "outside" clip behavior using ONLY the ClipShape isMask property.
@@ -92,9 +95,10 @@ export declare class ClipPrimitive implements Clipper {
     protected _clipPlanes?: UnionOfConvexClipPlaneSets;
     /** If true, pointInside inverts the sense of the pointInside for the _clipPlanes */
     protected _invisible: boolean;
-    /** Get a reference to the `UnionOfConvexClipPlaneSets`.
-     *  * It triggers construction of the sets by `this.ensurePlaneSets()`.
-     *  * Derived class typically caches the set on the first such call.
+    /**
+     * Get a reference to the `UnionOfConvexClipPlaneSets`.
+     * * It triggers construction of the sets by `this.ensurePlaneSets()`.
+     * * Derived class typically caches the set on the first such call.
      */
     fetchClipPlanesRef(): UnionOfConvexClipPlaneSets | undefined;
     /** Ask if this primitive is a hole. */
@@ -110,31 +114,38 @@ export declare class ClipPrimitive implements Clipper {
     toJSON(): ClipPrimitiveProps;
     /**
      * Returns true if the planes are present.
-     * * This can be false (for instance) if a ClipShape is holding a polygon but has not yet been asked to construct the planes.
+     * * This can be false (for instance) if a ClipShape is holding a polygon but has not yet been asked to construct
+     * the planes.
      */
     arePlanesDefined(): boolean;
-    /** Return a deep clone  */
+    /** Return a deep clone. */
     clone(): ClipPrimitive;
     /**
-     * * trigger (if needed)  computation of plane sets (if applicable) in the derived class.
+     * Trigger (if needed) computation of plane sets (if applicable) in the derived class.
      * * Base class is no op.
      * * In derived class, on first call create planes sets from defining data (e.g. swept shape).
      * * In derived class, if planes are present leave them alone.
      */
     ensurePlaneSets(): void;
-    /** Return true if the point lies inside/on this polygon (or not inside/on if this polygon is a mask). Otherwise, return false.
-     * * Note that a derived class may choose to (a) implement its own test using its defining data, or (b) accept this implementation using planes that it inserted in the base class.
+    /**
+     * Return true if the point lies inside/on this polygon (or not inside/on if this polygon is a mask). Otherwise,
+     * return false.
+     * * Note that a derived class may choose to (a) implement its own test using its defining data, or (b) accept
+     * this implementation using planes that it inserted in the base class.
      */
     pointInside(point: Point3d, onTolerance?: number): boolean;
-    /** Method from [[Clipper]] interface.
+    /**
+     * Method from [[Clipper]] interface.
      * * Implement as dispatch to clipPlaneSets as supplied by derived class.
      */
     isPointOnOrInside(point: Point3d, onTolerance?: number): boolean;
-    /** Method from [[Clipper]] interface.
+    /**
+     * Method from [[Clipper]] interface.
      * * Implement as dispatch to clipPlaneSets as supplied by derived class.
      */
     announceClippedSegmentIntervals(f0: number, f1: number, pointA: Point3d, pointB: Point3d, announce?: AnnounceNumberNumber): boolean;
-    /** Method from [[Clipper]] interface.
+    /**
+     * Method from [[Clipper]] interface.
      * * Implement as dispatch to clipPlaneSets as supplied by derived class.
      */
     announceClippedArcIntervals(arc: Arc3d, announce?: AnnounceNumberNumberCurvePrimitive): boolean;
@@ -142,29 +153,33 @@ export declare class ClipPrimitive implements Clipper {
      * Multiply all ClipPlanes DPoint4d by matrix.
      * @param matrix matrix to apply.
      * @param invert if true, use in verse of the matrix.
-     * @param transpose if true, use the transpose of the matrix (or inverse, per invert parameter)
-     * * Note that if matrixA is applied to all of space, the matrix to send to this method to get a corresponding effect on the plane is the inverse transpose of matrixA
+     * @param transpose if true, use the transpose of the matrix (or inverse, per invert parameter).
+     * @param matrix matrix to apply.
+     * * Note that if matrixA is applied to all of space, the matrix to send to this method to get a corresponding
+     * effect on the plane is the inverse transpose of matrixA.
      * * Callers that will apply the same matrix to many planes should pre-invert the matrix for efficiency.
      * * Both params default to true to get the full effect of transforming space.
-     * @param matrix matrix to apply
      */
     multiplyPlanesByMatrix4d(matrix: Matrix4d, invert?: boolean, transpose?: boolean): boolean;
-    /** Apply a transform to the clipper (e.g. transform all planes) */
+    /** Apply a transform to the clipper (e.g. transform all planes). */
     transformInPlace(transform: Transform): boolean;
     /** Sets both the clip plane set and the mask set visibility */
     setInvisible(invisible: boolean): void;
     /**
-     * Return true if any plane of the primary clipPlanes has (a) non-zero z component in its normal vector and (b) finite distance from origin.
+     * Return true if any plane of the primary clipPlanes has (a) non-zero z component in its normal vector and
+     * (b) finite distance from origin.
      */
     containsZClip(): boolean;
     /**
      * Quick test of whether the given points fall completely inside or outside.
-     * @param points points to test
-     * @param ignoreInvisibleSetting if true, do the test with the clip planes and return that, ignoring the invisible setting.
+     * @param points points to test.
+     * @param ignoreInvisibleSetting if true, do the test with the clip planes and return that, ignoring the
+     * invisible setting.
      */
     classifyPointContainment(points: Point3d[], ignoreInvisibleSetting: boolean): ClipPlaneContainment;
-    /** Promote json object form to class instance
-     * * First try to convert to a ClipShape
+    /**
+     * Promote json object form to class instance.
+     * * First try to convert to a ClipShape.
      * * then try as a standalone instance of the base class ClipPrimitive.
      */
     static fromJSON(json: ClipPrimitiveProps | undefined): ClipPrimitive | undefined;
@@ -180,15 +195,15 @@ export declare class ClipPrimitive implements Clipper {
 export declare class ClipShape extends ClipPrimitive {
     /** Points of the polygon, in the xy plane of the local coordinate system.  */
     protected _polygon: Point3d[];
-    /** optional low z (in local coordinates) */
+    /** optional low z (in local coordinates). */
     protected _zLow?: number;
-    /** optional high z (in local coordinates) */
+    /** optional high z (in local coordinates). */
     protected _zHigh?: number;
-    /** true if this is considered a hole (keep geometry outside of the polygon.) */
+    /** true if this is considered a hole (keep geometry outside of the polygon). */
     protected _isMask: boolean;
-    /** transform from local to world */
+    /** transform from local to world. */
     protected _transformFromClip?: Transform;
-    /** Transform from world to local */
+    /** Transform from world to local. */
     protected _transformToClip?: Transform;
     protected constructor(polygon?: Point3d[], zLow?: number, zHigh?: number, transform?: Transform, isMask?: boolean, invisible?: boolean);
     /** Returns true if this ClipShape is marked as invisible. */
@@ -216,18 +231,19 @@ export declare class ClipShape extends ClipPrimitive {
     /** Sets the polygon points array of this ClipShape to the array given (by reference). */
     setPolygon(polygon: Point3d[]): void;
     /**
-     * * If the ClipShape's associated `UnionOfConvexClipPlaneSets` is defined, do nothing.
-     * * If the ClipShape's associated `UnionOfConvexClipPlaneSets` is undefined, generate it from the `ClipShape` and transform.
+     * If the ClipShape's associated `UnionOfConvexClipPlaneSets` is defined, do nothing.
+     * If the ClipShape's associated `UnionOfConvexClipPlaneSets` is undefined, generate it from the `ClipShape`
+     * and transform.
      */
     ensurePlaneSets(): void;
     /**
      * Initialize the members of the ClipShape class that may at times be undefined.
-     * zLow and zHigh default to Number.MAX_VALUE, and the transform defaults to an identity transform
+     * zLow and zHigh default to Number.MAX_VALUE, and the transform defaults to an identity transform.
      */
     initSecondaryProps(isMask: boolean, zLow?: number, zHigh?: number, transform?: Transform): void;
-    /** emit json object form */
+    /** Emit json object form */
     toJSON(): ClipPrimitiveShapeProps;
-    /** parse `json` to a clip shape. */
+    /** Parse `json` to a clip shape. */
     static fromClipShapeJSON(json: ClipPrimitiveShapeProps | undefined, result?: ClipShape): ClipShape | undefined;
     /** Returns a new ClipShape that is a deep copy of the ClipShape given */
     static createFrom(other: ClipShape, result?: ClipShape): ClipShape;
@@ -242,33 +258,48 @@ export declare class ClipShape extends ClipPrimitive {
     static createEmpty(isMask?: boolean, invisible?: boolean, transform?: Transform, result?: ClipShape): ClipShape;
     /** Checks to ensure that the member polygon has an area, and that the polygon is closed. */
     get isValidPolygon(): boolean;
-    /** Returns a deep copy of this instance of ClipShape, storing in an optional result */
+    /** Returns a deep copy of this instance of ClipShape, storing in an optional result. */
     clone(result?: ClipShape): ClipShape;
-    /** Given the current polygon data, parses clip planes that together form an object, storing the result in the set given, either clipplanes or maskplanes. */
+    /**
+     * Given the current polygon data, parses clip planes that together form an object, storing the result in
+     * the set given, either clip planes or mask planes.
+     */
     private parseClipPlanes;
-    /** Given a start and end point, populate the given UnionOfConvexClipPlaneSets with ConvexClipPlaneSets defining the bounded region of linear planes. Returns true if successful. */
+    /**
+     * Given a start and end point, populate the given UnionOfConvexClipPlaneSets with ConvexClipPlaneSets
+     * defining the bounded region of linear planes. Returns true if successful.
+     */
     private parseLinearPlanes;
-    /** Given a convex polygon defined as an array of points, populate the given UnionOfConvexClipPlaneSets with ConvexClipPlaneSets defining the bounded region. Returns true if successful. */
+    /**
+     * Given a convex polygon defined as an array of points, populate the given UnionOfConvexClipPlaneSets with
+     * ConvexClipPlaneSets defining the bounded region. Returns true if successful.
+     */
     private parseConvexPolygonPlanes;
-    /** Given a (possibly non-convex) polygon defined as an array of points, populate the given UnionOfConvexClipPlaneSets with multiple ConvexClipPlaneSets defining the bounded region. Returns true if successful. */
+    /**
+     * Given a (possibly non-convex) polygon defined as an array of points, populate the given UnionOfConvexClipPlaneSets
+     * with multiple ConvexClipPlaneSets defining the bounded region. Returns true if successful.
+     */
     private parsePolygonPlanes;
     /**
      * Multiply all ClipPlanes DPoint4d by matrix.
      * @param matrix matrix to apply.
      * @param invert if true, use in verse of the matrix.
-     * @param transpose if true, use the transpose of the matrix (or inverse, per invert parameter)
-     * * Note that if matrixA is applied to all of space, the matrix to send to this method to get a corresponding effect on the plane is the inverse transpose of matrixA
+     * @param transpose if true, use the transpose of the matrix (or inverse, per invert parameter).
+     * @param matrix matrix to apply.
+     * * Note that if matrixA is applied to all of space, the matrix to send to this method to get a corresponding effect
+     * on the plane is the inverse transpose of matrixA.
      * * Callers that will apply the same matrix to many planes should pre-invert the matrix for efficiency.
      * * Both params default to true to get the full effect of transforming space.
-     * @param matrix matrix to apply
      */
     multiplyPlanesByMatrix4d(matrix: Matrix4d, invert?: boolean, transpose?: boolean): boolean;
-    /** Apply `transform` to the local to world (`transformFromClip`) transform.
+    /**
+     * Apply `transform` to the local to world (`transformFromClip`) transform.
      * * The world to local transform (`transformToClip` is recomputed from the (changed) `transformToClip`
      * * the transform is passed to the base class to be applied to clip plane form of the clipper.
      */
     transformInPlace(transform: Transform): boolean;
-    /** Return true if
+    /**
+     * Return true if
      * * at least one point is defined
      * * The local to world transform (transformFromClip) either
      *   * is undefined

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

@@ -1 +1 @@
-{"version":3,"file":"ClipPrimitive.d.ts","sourceRoot":"","sources":["../../../src/clipping/ClipPrimitive.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,OAAO,EAAY,MAAM,+BAA+B,CAAC;AAElE,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAClE,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAIlD,OAAO,EAAE,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,0BAA0B,EAAE,+BAA+B,EAAE,MAAM,8BAA8B,CAAC;AAI3G,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACvC,OAAO,EAAE,oBAAoB,EAAE,kCAAkC,EAAE,MAAM,yBAAyB,CAAC;AAGnG;;;GAGG;AACH,oBAAY,sBAAsB;IAChC,gBAAgB;IAChB,IAAI,IAAO;IACX,kBAAkB;IAClB,IAAI,IAAO;IACX,mBAAmB;IACnB,KAAK,IAAO;IACZ,kBAAkB;IAClB,IAAI,IAAO;IACX,mBAAmB;IACnB,KAAK,IAAO;IACZ,kBAAkB;IAClB,IAAI,KAAO;IACX,mBAAmB;IACnB,KAAK,KAAO;IACZ,0CAA0C;IAC1C,KAAK,KAAO;IACZ,mBAAmB;IACnB,GAAG,KAAO;CACX;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,MAAM,CAAC,EAAE;QACP,8BAA8B;QAC9B,KAAK,CAAC,EAAE,+BAA+B,CAAC;QACxC,yCAAyC;QACzC,SAAS,CAAC,EAAE,OAAO,CAAC;KACrB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,wBAAwB;IACxB,KAAK,CAAC,EAAE;QACN,yCAAyC;QACzC,MAAM,CAAC,EAAE,QAAQ,EAAE,CAAC;QACpB,wCAAwC;QACxC,KAAK,CAAC,EAAE,cAAc,CAAC;QACvB,wBAAwB;QACxB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,wBAAwB;QACxB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,sCAAsC;QACtC,IAAI,CAAC,EAAE,OAAO,CAAC;QACf,yCAAyC;QACzC,SAAS,CAAC,EAAE,OAAO,CAAC;KACrB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,wBAAwB,GAAG,uBAAuB,CAAC;AAEpF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,aAAc,YAAW,OAAO;IAC3C,qCAAqC;IACrC,SAAS,CAAC,WAAW,CAAC,EAAE,0BAA0B,CAAC;IACnD,oFAAoF;IACpF,SAAS,CAAC,UAAU,EAAE,OAAO,CAAC;IAC9B;;;OAGG;IACI,kBAAkB,IAAI,0BAA0B,GAAG,SAAS;IACnE,uCAAuC;IACvC,IAAW,SAAS,IAAI,OAAO,CAA4B;IAE3D,SAAS,aAAa,QAAQ,CAAC,EAAE,0BAA0B,GAAG,SAAS,EAAE,WAAW,GAAE,OAAe;IAIrG;;;;OAIG;WACW,aAAa,CAAC,MAAM,EAAE,0BAA0B,GAAG,kBAAkB,GAAG,SAAS,EAAE,WAAW,GAAE,OAAe,GAAG,aAAa;IAS7I,wCAAwC;IACjC,MAAM,IAAI,kBAAkB;IAWnC;;;OAGG;IACI,gBAAgB,IAAI,OAAO;IAGlC,2BAA2B;IACpB,KAAK,IAAI,aAAa;IAM7B;;;;;OAKG;IACI,eAAe;IACtB;;OAEG;IACI,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,WAAW,GAAE,MAA4C,GAAG,OAAO;IAQtG;;OAEG;IACK,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,WAAW,GAAE,MAA4C,GAAG,OAAO;IAO7G;;OAEG;IACK,+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;IAO3I;;OAEG;IACI,2BAA2B,CAAC,GAAG,EAAE,KAAK,EAAE,QAAQ,CAAC,EAAE,kCAAkC,GAAG,OAAO;IAQtG;;;;;;;;;OASG;IACI,wBAAwB,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAE,OAAc,EAAE,SAAS,GAAE,OAAc,GAAG,OAAO;IAa7G,mEAAmE;IAC5D,gBAAgB,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO;IAOtD,+DAA+D;IACxD,YAAY,CAAC,SAAS,EAAE,OAAO;IAItC;;OAEG;IACI,aAAa,IAAI,OAAO;IAS/B;;;;OAIG;IACI,wBAAwB,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,sBAAsB,EAAE,OAAO,GAAG,oBAAoB;IAiBzG;;;OAGG;WACW,QAAQ,CAAC,IAAI,EAAE,kBAAkB,GAAG,SAAS,GAAG,aAAa,GAAG,SAAS;IAUvF,iEAAiE;WACnD,qBAAqB,CAAC,IAAI,EAAE,wBAAwB,GAAG,SAAS,GAAG,aAAa,GAAG,SAAS;CAS3G;AA2BD;;;;;GAKG;AACH,qBAAa,SAAU,SAAQ,aAAa;IAC1C,8EAA8E;IAC9E,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE,CAAC;IAC9B,4CAA4C;IAC5C,SAAS,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACzB,6CAA6C;IAC7C,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAC1B,gFAAgF;IAChF,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC;IAC3B,oCAAoC;IACpC,SAAS,CAAC,kBAAkB,CAAC,EAAE,SAAS,CAAC;IACzC,oCAAoC;IACpC,SAAS,CAAC,gBAAgB,CAAC,EAAE,SAAS,CAAC;IACvC,SAAS,aAAa,OAAO,GAAE,OAAO,EAAO,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,SAAS,EAAE,MAAM,GAAE,OAAe,EAAE,SAAS,GAAE,OAAe;IAMxJ,6DAA6D;IAC7D,IAAoB,SAAS,IAAI,OAAO,CAA4B;IACpE,6DAA6D;IAC7D,IAAW,iBAAiB,IAAI,SAAS,GAAG,SAAS,CAAoC;IACzF,2DAA2D;IAC3D,IAAW,eAAe,IAAI,SAAS,GAAG,SAAS,CAAkC;IACrF,qEAAqE;IACrE,IAAW,cAAc,IAAI,OAAO,CAAiD;IACrF,gEAAgE;IAChE,IAAW,SAAS,IAAI,OAAO,CAAqC;IACpE,gEAAgE;IAChE,IAAW,UAAU,IAAI,OAAO,CAAsC;IACtE,mEAAmE;IACnE,IAAW,gBAAgB,IAAI,OAAO,CAAkD;IACxF,gDAAgD;IAChD,IAAW,IAAI,IAAI,MAAM,GAAG,SAAS,CAAuB;IAC5D,iDAAiD;IACjD,IAAW,KAAK,IAAI,MAAM,GAAG,SAAS,CAAwB;IAC9D,6DAA6D;IAC7D,IAAW,OAAO,IAAI,OAAO,EAAE,CAA0B;IACzD,uDAAuD;IACvD,IAAW,MAAM,IAAI,OAAO,CAAyB;IACrD,yFAAyF;IAClF,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE;IAMpC;;;OAGG;IACa,eAAe;IAQ/B;;;OAGG;IACI,kBAAkB,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,SAAS;IAc/F,4BAA4B;IACZ,MAAM,IAAI,uBAAuB;IAuBjD,oCAAoC;WACtB,iBAAiB,CAAC,IAAI,EAAE,uBAAuB,GAAG,SAAS,EAAE,MAAM,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS;IAerH,yEAAyE;WAC3D,UAAU,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE,SAAS,GAAG,SAAS;IAazE,mHAAmH;WACrG,WAAW,CAAC,OAAO,GAAE,OAAO,EAAO,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,SAAS,EAAE,MAAM,GAAE,OAAe,EAAE,SAAS,GAAE,OAAe,EAAE,MAAM,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS;IAmBxM;;;OAGG;WACW,WAAW,CAAC,WAAW,EAAE,OAAO,EAAE,QAAQ,EAAE,sBAAsB,EAAE,MAAM,GAAE,OAAe,EAAE,SAAS,GAAE,OAAe,EAAE,SAAS,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE,SAAS,GAAG,SAAS;IAY5L,gGAAgG;WAClF,WAAW,CAAC,MAAM,UAAQ,EAAE,SAAS,GAAE,OAAe,EAAE,SAAS,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE,SAAS,GAAG,SAAS;IAU3H,4FAA4F;IAC5F,IAAW,cAAc,IAAI,OAAO,CAMnC;IACD,uFAAuF;IACvE,KAAK,CAAC,MAAM,CAAC,EAAE,SAAS,GAAG,SAAS;IAGpD,6JAA6J;IAC7J,OAAO,CAAC,eAAe;IAoBvB,oLAAoL;IACpL,OAAO,CAAC,iBAAiB;IA+BzB,4LAA4L;IAC5L,OAAO,CAAC,wBAAwB;IAwDhC,oNAAoN;IACpN,OAAO,CAAC,kBAAkB;IAyC1B;;;;;;;;;OASG;IACa,wBAAwB,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAE,OAAc,EAAE,SAAS,GAAE,OAAc,GAAG,OAAO;IAItH;;;OAGG;IACa,gBAAgB,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO;IAW/D;;;;;OAKG;IACH,IAAW,WAAW,IAAI,OAAO,CAOhC;IACD,wFAAwF;IACjF,sBAAsB,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;IAInD,0FAA0F;IACnF,wBAAwB,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;CAItD"}
+{"version":3,"file":"ClipPrimitive.d.ts","sourceRoot":"","sources":["../../../src/clipping/ClipPrimitive.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,OAAO,EAAY,MAAM,+BAA+B,CAAC;AAElE,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAClE,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAIlD,OAAO,EAAE,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,0BAA0B,EAAE,+BAA+B,EAAE,MAAM,8BAA8B,CAAC;AAI3G,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACvC,OAAO,EAAE,oBAAoB,EAAE,kCAAkC,EAAE,MAAM,yBAAyB,CAAC;AAGnG;;;GAGG;AACH,oBAAY,sBAAsB;IAChC,gBAAgB;IAChB,IAAI,IAAO;IACX,kBAAkB;IAClB,IAAI,IAAO;IACX,mBAAmB;IACnB,KAAK,IAAO;IACZ,kBAAkB;IAClB,IAAI,IAAO;IACX,mBAAmB;IACnB,KAAK,IAAO;IACZ,kBAAkB;IAClB,IAAI,KAAO;IACX,mBAAmB;IACnB,KAAK,KAAO;IACZ,0CAA0C;IAC1C,KAAK,KAAO;IACZ,mBAAmB;IACnB,GAAG,KAAO;CACX;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC,MAAM,CAAC,EAAE;QACP,8BAA8B;QAC9B,KAAK,CAAC,EAAE,+BAA+B,CAAC;QACxC,yCAAyC;QACzC,SAAS,CAAC,EAAE,OAAO,CAAC;KACrB,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,wBAAwB;IACxB,KAAK,CAAC,EAAE;QACN,yCAAyC;QACzC,MAAM,CAAC,EAAE,QAAQ,EAAE,CAAC;QACpB,wCAAwC;QACxC,KAAK,CAAC,EAAE,cAAc,CAAC;QACvB,wBAAwB;QACxB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,wBAAwB;QACxB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,sCAAsC;QACtC,IAAI,CAAC,EAAE,OAAO,CAAC;QACf,yCAAyC;QACzC,SAAS,CAAC,EAAE,OAAO,CAAC;KACrB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,wBAAwB,GAAG,uBAAuB,CAAC;AAEpF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,aAAc,YAAW,OAAO;IAC3C,qCAAqC;IACrC,SAAS,CAAC,WAAW,CAAC,EAAE,0BAA0B,CAAC;IACnD,oFAAoF;IACpF,SAAS,CAAC,UAAU,EAAE,OAAO,CAAC;IAC9B;;;;OAIG;IACI,kBAAkB,IAAI,0BAA0B,GAAG,SAAS;IAInE,uCAAuC;IACvC,IAAW,SAAS,IAAI,OAAO,CAE9B;IACD,SAAS,aAAa,QAAQ,CAAC,EAAE,0BAA0B,GAAG,SAAS,EAAE,WAAW,GAAE,OAAe;IAIrG;;;;OAIG;WACW,aAAa,CACzB,MAAM,EAAE,0BAA0B,GAAG,kBAAkB,GAAG,SAAS,EAAE,WAAW,GAAE,OAAe,GAChG,aAAa;IAShB,wCAAwC;IACjC,MAAM,IAAI,kBAAkB;IAUnC;;;;OAIG;IACI,gBAAgB,IAAI,OAAO;IAGlC,2BAA2B;IACpB,KAAK,IAAI,aAAa;IAK7B;;;;;OAKG;IACI,eAAe;IACtB;;;;;OAKG;IACI,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,WAAW,GAAE,MAA4C,GAAG,OAAO;IAOtG;;;OAGG;IACI,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,WAAW,GAAE,MAA4C,GAAG,OAAO;IAO5G;;;OAGG;IACI,+BAA+B,CACpC,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,oBAAoB,GACxF,OAAO;IAOV;;;OAGG;IACI,2BAA2B,CAAC,GAAG,EAAE,KAAK,EAAE,QAAQ,CAAC,EAAE,kCAAkC,GAAG,OAAO;IAOtG;;;;;;;;;;OAUG;IACI,wBAAwB,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAE,OAAc,EAAE,SAAS,GAAE,OAAc,GAAG,OAAO;IAW7G,oEAAoE;IAC7D,gBAAgB,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO;IAKtD,+DAA+D;IACxD,YAAY,CAAC,SAAS,EAAE,OAAO;IAGtC;;;OAGG;IACI,aAAa,IAAI,OAAO;IAQ/B;;;;;OAKG;IACI,wBAAwB,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,sBAAsB,EAAE,OAAO,GAAG,oBAAoB;IAiBzG;;;;OAIG;WACW,QAAQ,CAAC,IAAI,EAAE,kBAAkB,GAAG,SAAS,GAAG,aAAa,GAAG,SAAS;IAQvF,iEAAiE;WACnD,qBAAqB,CAAC,IAAI,EAAE,wBAAwB,GAAG,SAAS,GAAG,aAAa,GAAG,SAAS;CAS3G;AA4BD;;;;;GAKG;AACH,qBAAa,SAAU,SAAQ,aAAa;IAC1C,8EAA8E;IAC9E,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE,CAAC;IAC9B,6CAA6C;IAC7C,SAAS,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACzB,8CAA8C;IAC9C,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAC1B,gFAAgF;IAChF,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC;IAC3B,qCAAqC;IACrC,SAAS,CAAC,kBAAkB,CAAC,EAAE,SAAS,CAAC;IACzC,qCAAqC;IACrC,SAAS,CAAC,gBAAgB,CAAC,EAAE,SAAS,CAAC;IAEvC,SAAS,aACP,OAAO,GAAE,OAAO,EAAO,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,SAAS,EAAE,MAAM,GAAE,OAAe,EAAE,SAAS,GAAE,OAAe;IAOpI,6DAA6D;IAC7D,IAAoB,SAAS,IAAI,OAAO,CAEvC;IACD,6DAA6D;IAC7D,IAAW,iBAAiB,IAAI,SAAS,GAAG,SAAS,CAEpD;IACD,2DAA2D;IAC3D,IAAW,eAAe,IAAI,SAAS,GAAG,SAAS,CAElD;IACD,qEAAqE;IACrE,IAAW,cAAc,IAAI,OAAO,CAEnC;IACD,gEAAgE;IAChE,IAAW,SAAS,IAAI,OAAO,CAE9B;IACD,gEAAgE;IAChE,IAAW,UAAU,IAAI,OAAO,CAE/B;IACD,mEAAmE;IACnE,IAAW,gBAAgB,IAAI,OAAO,CAErC;IACD,gDAAgD;IAChD,IAAW,IAAI,IAAI,MAAM,GAAG,SAAS,CAEpC;IACD,iDAAiD;IACjD,IAAW,KAAK,IAAI,MAAM,GAAG,SAAS,CAErC;IACD,6DAA6D;IAC7D,IAAW,OAAO,IAAI,OAAO,EAAE,CAE9B;IACD,uDAAuD;IACvD,IAAW,MAAM,IAAI,OAAO,CAE3B;IACD,yFAAyF;IAClF,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE;IAMpC;;;;OAIG;IACa,eAAe;IAQ/B;;;OAGG;IACI,kBAAkB,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,SAAS;IAa/F,4BAA4B;IACZ,MAAM,IAAI,uBAAuB;IAgBjD,oCAAoC;WACtB,iBAAiB,CAAC,IAAI,EAAE,uBAAuB,GAAG,SAAS,EAAE,MAAM,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS;IAarH,yEAAyE;WAC3D,UAAU,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE,SAAS,GAAG,SAAS;IAazE,mHAAmH;WACrG,WAAW,CACvB,OAAO,GAAE,OAAO,EAAO,EACvB,IAAI,CAAC,EAAE,MAAM,EACb,KAAK,CAAC,EAAE,MAAM,EACd,SAAS,CAAC,EAAE,SAAS,EACrB,MAAM,GAAE,OAAe,EACvB,SAAS,GAAE,OAAe,EAC1B,MAAM,CAAC,EAAE,SAAS,GACjB,SAAS,GAAG,SAAS;IAmBxB;;;OAGG;WACW,WAAW,CACvB,WAAW,EAAE,OAAO,EACpB,QAAQ,EAAE,sBAAsB,EAChC,MAAM,GAAE,OAAe,EACvB,SAAS,GAAE,OAAe,EAC1B,SAAS,CAAC,EAAE,SAAS,EACrB,MAAM,CAAC,EAAE,SAAS,GACjB,SAAS;IAoBZ,gGAAgG;WAClF,WAAW,CACvB,MAAM,UAAQ,EAAE,SAAS,GAAE,OAAe,EAAE,SAAS,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE,SAAS,GACpF,SAAS;IAUZ,4FAA4F;IAC5F,IAAW,cAAc,IAAI,OAAO,CAMnC;IACD,wFAAwF;IACxE,KAAK,CAAC,MAAM,CAAC,EAAE,SAAS,GAAG,SAAS;IAGpD;;;OAGG;IACH,OAAO,CAAC,eAAe;IAkBvB;;;OAGG;IACH,OAAO,CAAC,iBAAiB;IAwCzB;;;OAGG;IACH,OAAO,CAAC,wBAAwB;IAsEhC;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IA0C1B;;;;;;;;;;OAUG;IACa,wBAAwB,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAE,OAAc,EAAE,SAAS,GAAE,OAAc,GAAG,OAAO;IAItH;;;;OAIG;IACa,gBAAgB,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO;IAW/D;;;;;;OAMG;IACH,IAAW,WAAW,IAAI,OAAO,CAOhC;IACD,wFAAwF;IACjF,sBAAsB,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;IAInD,0FAA0F;IACnF,wBAAwB,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;CAItD"}

package/lib/esm/clipping/ClipPrimitive.js

@@ -48,17 +48,18 @@ export var ClipMaskXYZRangePlanes;
 })(ClipMaskXYZRangePlanes || (ClipMaskXYZRangePlanes = {}));
 /**
  * * ClipPrimitive is a base class for clipping implementations that use
- *   * A UnionOfConvexClipPlaneSets designated "clipPlanes"
- *   * an "invisible" flag
- * * When constructed directly, objects of type ClipPrimitive (directly, not through a derived class) will have just planes
+ *   * A UnionOfConvexClipPlaneSets designated "clipPlanes".
+ *   * An "invisible" flag.
+ * * When constructed directly, objects of type ClipPrimitive (directly, not through a derived class) will have just planes.
  * * Derived classes (e.g. ClipShape) carry additional data such as a swept shape.
  * * ClipPrimitive can be constructed with no planes.
  *     * Derived class is responsible for filling the plane sets.
- *     * At discretion of derived classes, plane construction can be done at construction time or "on demand when" queries call `ensurePlaneSets ()`
+ *     * At discretion of derived classes, plane construction can be done at construction time or "on demand when" queries
+ * call `ensurePlaneSets ()`
  * * ClipPrimitive can be constructed directly with planes (and no derived class).
  * * That the prevailing use is via a ClipShape derived class.
  *    * The ClipShape has an "isMask" property
- *       * isMask === false means the plane sets should cover the inside of its polygon
+ *       * isMask === false means the plane sets should cover the inside of its polygon.
  *       * isMask === true means the plane sets should cover the outside of its polygon.
  *  * Note that the ClipShape's `isMask` property and the ClipPrimitive's `isInvisible` property are distinct controls.
  *     * In normal usage, callers get "outside" clip behavior using ONLY the ClipShape isMask property.
@@ -67,13 +68,19 @@ export var ClipMaskXYZRangePlanes;
  * @public
  */
 export class ClipPrimitive {
-    /** Get a reference to the `UnionOfConvexClipPlaneSets`.
-     *  * It triggers construction of the sets by `this.ensurePlaneSets()`.
-     *  * Derived class typically caches the set on the first such call.
+    /**
+     * Get a reference to the `UnionOfConvexClipPlaneSets`.
+     * * It triggers construction of the sets by `this.ensurePlaneSets()`.
+     * * Derived class typically caches the set on the first such call.
      */
-    fetchClipPlanesRef() { this.ensurePlaneSets(); return this._clipPlanes; }
+    fetchClipPlanesRef() {
+        this.ensurePlaneSets();
+        return this._clipPlanes;
+    }
     /** Ask if this primitive is a hole. */
-    get invisible() { return this._invisible; }
+    get invisible() {
+        return this._invisible;
+    }
     constructor(planeSet, isInvisible = false) {
         this._clipPlanes = planeSet;
         this._invisible = isInvisible;
@@ -102,26 +109,30 @@ export class ClipPrimitive {
     }
     /**
      * Returns true if the planes are present.
-     * * This can be false (for instance) if a ClipShape is holding a polygon but has not yet been asked to construct the planes.
+     * * This can be false (for instance) if a ClipShape is holding a polygon but has not yet been asked to construct
+     * the planes.
      */
     arePlanesDefined() {
         return this._clipPlanes !== undefined;
     }
-    /** Return a deep clone  */
+    /** Return a deep clone. */
     clone() {
         const newPlanes = this._clipPlanes ? this._clipPlanes.clone() : undefined;
         const result = new ClipPrimitive(newPlanes, this._invisible);
         return result;
     }
     /**
-     * * trigger (if needed)  computation of plane sets (if applicable) in the derived class.
+     * Trigger (if needed) computation of plane sets (if applicable) in the derived class.
      * * Base class is no op.
      * * In derived class, on first call create planes sets from defining data (e.g. swept shape).
      * * In derived class, if planes are present leave them alone.
      */
     ensurePlaneSets() { }
-    /** Return true if the point lies inside/on this polygon (or not inside/on if this polygon is a mask). Otherwise, return false.
-     * * Note that a derived class may choose to (a) implement its own test using its defining data, or (b) accept this implementation using planes that it inserted in the base class.
+    /**
+     * Return true if the point lies inside/on this polygon (or not inside/on if this polygon is a mask). Otherwise,
+     * return false.
+     * * Note that a derived class may choose to (a) implement its own test using its defining data, or (b) accept
+     * this implementation using planes that it inserted in the base class.
      */
     pointInside(point, onTolerance = Geometry.smallMetricDistanceSquared) {
         this.ensurePlaneSets();
@@ -130,7 +141,8 @@ export class ClipPrimitive {
             inside = this._clipPlanes.isPointOnOrInside(point, onTolerance);
         return inside;
     }
-    /** Method from [[Clipper]] interface.
+    /**
+     * Method from [[Clipper]] interface.
      * * Implement as dispatch to clipPlaneSets as supplied by derived class.
      */
     isPointOnOrInside(point, onTolerance = Geometry.smallMetricDistanceSquared) {
@@ -140,7 +152,8 @@ export class ClipPrimitive {
             inside = this._clipPlanes.isPointOnOrInside(point, onTolerance);
         return inside;
     }
-    /** Method from [[Clipper]] interface.
+    /**
+     * Method from [[Clipper]] interface.
      * * Implement as dispatch to clipPlaneSets as supplied by derived class.
      */
     announceClippedSegmentIntervals(f0, f1, pointA, pointB, announce) {
@@ -150,7 +163,8 @@ export class ClipPrimitive {
             hasInsideParts = this._clipPlanes.announceClippedSegmentIntervals(f0, f1, pointA, pointB, announce);
         return hasInsideParts;
     }
-    /** Method from [[Clipper]] interface.
+    /**
+     * Method from [[Clipper]] interface.
      * * Implement as dispatch to clipPlaneSets as supplied by derived class.
      */
     announceClippedArcIntervals(arc, announce) {
@@ -164,11 +178,12 @@ export class ClipPrimitive {
      * Multiply all ClipPlanes DPoint4d by matrix.
      * @param matrix matrix to apply.
      * @param invert if true, use in verse of the matrix.
-     * @param transpose if true, use the transpose of the matrix (or inverse, per invert parameter)
-     * * Note that if matrixA is applied to all of space, the matrix to send to this method to get a corresponding effect on the plane is the inverse transpose of matrixA
+     * @param transpose if true, use the transpose of the matrix (or inverse, per invert parameter).
+     * @param matrix matrix to apply.
+     * * Note that if matrixA is applied to all of space, the matrix to send to this method to get a corresponding
+     * effect on the plane is the inverse transpose of matrixA.
      * * Callers that will apply the same matrix to many planes should pre-invert the matrix for efficiency.
      * * Both params default to true to get the full effect of transforming space.
-     * @param matrix matrix to apply
      */
     multiplyPlanesByMatrix4d(matrix, invert = true, transpose = true) {
         if (invert) { // form inverse once here, reuse for all planes
@@ -181,7 +196,7 @@ export class ClipPrimitive {
             this._clipPlanes.multiplyPlanesByMatrix4d(matrix);
         return true;
     }
-    /** Apply a transform to the clipper (e.g. transform all planes) */
+    /** Apply a transform to the clipper (e.g. transform all planes). */
     transformInPlace(transform) {
         if (this._clipPlanes)
             this._clipPlanes.transformInPlace(transform);
@@ -192,7 +207,8 @@ export class ClipPrimitive {
         this._invisible = invisible;
     }
     /**
-     * Return true if any plane of the primary clipPlanes has (a) non-zero z component in its normal vector and (b) finite distance from origin.
+     * Return true if any plane of the primary clipPlanes has (a) non-zero z component in its normal vector and
+     * (b) finite distance from origin.
      */
     containsZClip() {
         if (this.fetchClipPlanesRef() !== undefined)
@@ -204,8 +220,9 @@ export class ClipPrimitive {
     }
     /**
      * Quick test of whether the given points fall completely inside or outside.
-     * @param points points to test
-     * @param ignoreInvisibleSetting if true, do the test with the clip planes and return that, ignoring the invisible setting.
+     * @param points points to test.
+     * @param ignoreInvisibleSetting if true, do the test with the clip planes and return that, ignoring the
+     * invisible setting.
      */
     classifyPointContainment(points, ignoreInvisibleSetting) {
         this.ensurePlaneSets();
@@ -224,8 +241,9 @@ export class ClipPrimitive {
             }
         return inside;
     }
-    /** Promote json object form to class instance
-     * * First try to convert to a ClipShape
+    /**
+     * Promote json object form to class instance.
+     * * First try to convert to a ClipShape.
      * * then try as a standalone instance of the base class ClipPrimitive.
      */
     static fromJSON(json) {
@@ -281,27 +299,49 @@ export class ClipShape extends ClipPrimitive {
         this.initSecondaryProps(isMask, zLow, zHigh, transform);
     }
     /** Returns true if this ClipShape is marked as invisible. */
-    get invisible() { return this._invisible; }
+    get invisible() {
+        return this._invisible;
+    }
     /** Return this transformFromClip, which may be undefined. */
-    get transformFromClip() { return this._transformFromClip; }
+    get transformFromClip() {
+        return this._transformFromClip;
+    }
     /** Return this transformToClip, which may be undefined. */
-    get transformToClip() { return this._transformToClip; }
+    get transformToClip() {
+        return this._transformToClip;
+    }
     /** Returns true if this ClipShape's transforms are currently set. */
-    get transformValid() { return this.transformFromClip !== undefined; }
+    get transformValid() {
+        return this.transformFromClip !== undefined;
+    }
     /** Returns true if this ClipShape's lower z boundary is set. */
-    get zLowValid() { return this._zLow !== undefined; }
+    get zLowValid() {
+        return this._zLow !== undefined;
+    }
     /** Returns true if this ClipShape's upper z boundary is set. */
-    get zHighValid() { return this._zHigh !== undefined; }
+    get zHighValid() {
+        return this._zHigh !== undefined;
+    }
     /** Return true if this ClipShape has a local to world transform */
-    get transformIsValid() { return this._transformFromClip !== undefined; }
+    get transformIsValid() {
+        return this._transformFromClip !== undefined;
+    }
     /** Return this zLow, which may be undefined. */
-    get zLow() { return this._zLow; }
+    get zLow() {
+        return this._zLow;
+    }
     /** Return this zHigh, which may be undefined. */
-    get zHigh() { return this._zHigh; }
+    get zHigh() {
+        return this._zHigh;
+    }
     /** Returns a reference to this ClipShape's polygon array. */
-    get polygon() { return this._polygon; }
+    get polygon() {
+        return this._polygon;
+    }
     /** Returns true if this ClipShape is a masking set. */
-    get isMask() { return this._isMask; }
+    get isMask() {
+        return this._isMask;
+    }
     /** Sets the polygon points array of this ClipShape to the array given (by reference). */
     setPolygon(polygon) {
         // Add closure point
@@ -310,8 +350,9 @@ export class ClipShape extends ClipPrimitive {
         this._polygon = polygon;
     }
     /**
-     * * If the ClipShape's associated `UnionOfConvexClipPlaneSets` is defined, do nothing.
-     * * If the ClipShape's associated `UnionOfConvexClipPlaneSets` is undefined, generate it from the `ClipShape` and transform.
+     * If the ClipShape's associated `UnionOfConvexClipPlaneSets` is defined, do nothing.
+     * If the ClipShape's associated `UnionOfConvexClipPlaneSets` is undefined, generate it from the `ClipShape`
+     * and transform.
      */
     ensurePlaneSets() {
         if (this._clipPlanes !== undefined)
@@ -323,7 +364,7 @@ export class ClipShape extends ClipPrimitive {
     }
     /**
      * Initialize the members of the ClipShape class that may at times be undefined.
-     * zLow and zHigh default to Number.MAX_VALUE, and the transform defaults to an identity transform
+     * zLow and zHigh default to Number.MAX_VALUE, and the transform defaults to an identity transform.
      */
     initSecondaryProps(isMask, zLow, zHigh, transform) {
         this._isMask = isMask;
@@ -338,7 +379,7 @@ export class ClipShape extends ClipPrimitive {
             this._transformToClip = Transform.createIdentity();
         }
     }
-    /** emit json object form */
+    /** Emit json object form */
     toJSON() {
         const shape = {
             points: this._polygon.map((pt) => pt.toJSON()),
@@ -355,7 +396,7 @@ export class ClipShape extends ClipPrimitive {
             shape.zhigh = this.zHigh;
         return { shape };
     }
-    /** parse `json` to a clip shape. */
+    /** Parse `json` to a clip shape. */
     static fromClipShapeJSON(json, result) {
         const shape = json?.shape;
         if (!shape)
@@ -417,7 +458,7 @@ export class ClipShape extends ClipPrimitive {
         blockPoints[1].x = blockPoints[2].x = high.x;
         blockPoints[0].y = blockPoints[1].y = blockPoints[4].y = low.y;
         blockPoints[2].y = blockPoints[3].y = high.y;
-        return ClipShape.createShape(blockPoints, (ClipMaskXYZRangePlanes.None !== (clipMask & ClipMaskXYZRangePlanes.ZLow)) ? low.z : undefined, ClipMaskXYZRangePlanes.None !== (clipMask & ClipMaskXYZRangePlanes.ZHigh) ? high.z : undefined, transform, isMask, invisible, result);
+        return ClipShape.createShape(blockPoints, (ClipMaskXYZRangePlanes.None !== (clipMask & ClipMaskXYZRangePlanes.ZLow)) ? low.z : undefined, (ClipMaskXYZRangePlanes.None !== (clipMask & ClipMaskXYZRangePlanes.ZHigh)) ? high.z : undefined, transform, isMask, invisible, result);
     }
     /** Creates a new ClipShape with undefined members and a polygon points array of zero length. */
     static createEmpty(isMask = false, invisible = false, transform, result) {
@@ -438,11 +479,14 @@ export class ClipShape extends ClipPrimitive {
             return false;
         return true;
     }
-    /** Returns a deep copy of this instance of ClipShape, storing in an optional result */
+    /** Returns a deep copy of this instance of ClipShape, storing in an optional result. */
     clone(result) {
         return ClipShape.createFrom(this, result);
     }
-    /** Given the current polygon data, parses clip planes that together form an object, storing the result in the set given, either clipplanes or maskplanes. */
+    /**
+     * Given the current polygon data, parses clip planes that together form an object, storing the result in
+     * the set given, either clip planes or mask planes.
+     */
     parseClipPlanes(set) {
         const points = this._polygon;
         if (points.length === 3 && !this._isMask && points[0].isExactEqual(points[points.length - 1])) {
@@ -461,7 +505,10 @@ export class ClipShape extends ClipPrimitive {
         this.parsePolygonPlanes(set, this._polygon, this.isMask);
         return true;
     }
-    /** Given a start and end point, populate the given UnionOfConvexClipPlaneSets with ConvexClipPlaneSets defining the bounded region of linear planes. Returns true if successful. */
+    /**
+     * Given a start and end point, populate the given UnionOfConvexClipPlaneSets with ConvexClipPlaneSets
+     * defining the bounded region of linear planes. Returns true if successful.
+     */
     parseLinearPlanes(set, start, end, cameraFocalLength) {
         // Handles the degenerate case of 2 distinct points (used by select by line).
         const normal = start.vectorTo(end);
@@ -493,7 +540,10 @@ export class ClipShape extends ClipPrimitive {
         set.addConvexSet(convexSet);
         return true;
     }
-    /** Given a convex polygon defined as an array of points, populate the given UnionOfConvexClipPlaneSets with ConvexClipPlaneSets defining the bounded region. Returns true if successful. */
+    /**
+     * Given a convex polygon defined as an array of points, populate the given UnionOfConvexClipPlaneSets with
+     * ConvexClipPlaneSets defining the bounded region. Returns true if successful.
+     */
     parseConvexPolygonPlanes(set, polygon, direction, buildExteriorClipper, cameraFocalLength) {
         const samePointTolerance = 1.0e-8; // This could possibly be replaced with more widely used constants
         const edges = [];
@@ -551,7 +601,10 @@ export class ClipShape extends ClipPrimitive {
         }
         return true;
     }
-    /** Given a (possibly non-convex) polygon defined as an array of points, populate the given UnionOfConvexClipPlaneSets with multiple ConvexClipPlaneSets defining the bounded region. Returns true if successful. */
+    /**
+     * Given a (possibly non-convex) polygon defined as an array of points, populate the given UnionOfConvexClipPlaneSets
+     * with multiple ConvexClipPlaneSets defining the bounded region. Returns true if successful.
+     */
     parsePolygonPlanes(set, polygon, isMask, cameraFocalLength) {
         const cleanPolygon = PolylineOps.compressDanglers(polygon, true);
         const announceFace = (_graph, edge) => {
@@ -598,17 +651,19 @@ export class ClipShape extends ClipPrimitive {
      * Multiply all ClipPlanes DPoint4d by matrix.
      * @param matrix matrix to apply.
      * @param invert if true, use in verse of the matrix.
-     * @param transpose if true, use the transpose of the matrix (or inverse, per invert parameter)
-     * * Note that if matrixA is applied to all of space, the matrix to send to this method to get a corresponding effect on the plane is the inverse transpose of matrixA
+     * @param transpose if true, use the transpose of the matrix (or inverse, per invert parameter).
+     * @param matrix matrix to apply.
+     * * Note that if matrixA is applied to all of space, the matrix to send to this method to get a corresponding effect
+     * on the plane is the inverse transpose of matrixA.
      * * Callers that will apply the same matrix to many planes should pre-invert the matrix for efficiency.
      * * Both params default to true to get the full effect of transforming space.
-     * @param matrix matrix to apply
      */
     multiplyPlanesByMatrix4d(matrix, invert = true, transpose = true) {
         this.ensurePlaneSets();
         return super.multiplyPlanesByMatrix4d(matrix, invert, transpose);
     }
-    /** Apply `transform` to the local to world (`transformFromClip`) transform.
+    /**
+     * Apply `transform` to the local to world (`transformFromClip`) transform.
      * * The world to local transform (`transformToClip` is recomputed from the (changed) `transformToClip`
      * * the transform is passed to the base class to be applied to clip plane form of the clipper.
      */
@@ -623,7 +678,8 @@ export class ClipShape extends ClipPrimitive {
         this._transformToClip = this._transformFromClip.inverse(); // could be undefined
         return true;
     }
-    /** Return true if
+    /**
+     * Return true if
      * * at least one point is defined
      * * The local to world transform (transformFromClip) either
      *   * is undefined