@itwin/core-geometry 4.1.0-dev.8 → 4.1.0-dev.81

package/lib/esm/curve/CurveCurveCloseApproachXY.d.ts

@@ -5,17 +5,22 @@ import { BSplineCurve3d } from "../bspline/BSplineCurve";
 import { BSplineCurve3dH } from "../bspline/BSplineCurve3dH";
 import { NullGeometryHandler } from "../geometry3d/GeometryHandler";
 import { Arc3d } from "./Arc3d";
-import { CurveLocationDetail, CurveLocationDetailPair } from "./CurveLocationDetail";
+import { CurveLocationDetailPair } from "./CurveLocationDetail";
 import { CurvePrimitive } from "./CurvePrimitive";
 import { GeometryQuery } from "./GeometryQuery";
 import { LineSegment3d } from "./LineSegment3d";
 import { LineString3d } from "./LineString3d";
 /**
+ * Handler class for XY close approach between _geometryB and another geometry.
+ * * Approach means the distance between _geometryB and another geometry.
+ * * **NOTE:** GeometryQuery input (_geometryB) should really be AnyCurve.
+ * * Closest approach is a measure of the proximity of one curve to another. It's the length of the shortest line
+ * segment perpendicular to both curves; if the curves intersect, the closest approach is zero. In the context of
+ * this class, z-coordinates are ignored, so the closest approach is as seen in the top view. If you have coplanar
+ * input curves, rotate them first into a plane parallel to the xy-plane, then afterward, you should rotate the
+ * results back as required.
  * * Instances are initialized and called from CurveCurve.
- * * Constructor is told two geometry items A and B
- *   * geometryB is saved for later reference
- *   * type-specific handler methods will "see" geometry A repeatedly.
- *   * Hence geometryA is NOT saved by the constructor.
+ * * geometryB is saved for later reference.
  * @internal
  */
 export declare class CurveCurveCloseApproachXY extends NullGeometryHandler {
@@ -23,136 +28,137 @@ export declare class CurveCurveCloseApproachXY extends NullGeometryHandler {
     private _circularArcB;
     private _circularRadiusB;
     private setGeometryB;
-    /** approach larger than this is not interesting.
+    /**
+     * Approach larger than this is not interesting.
      * This is caller defined and can be undefined.
      */
     private _maxDistanceToAccept;
-    /** Squared max distance.  This is private, and is forced to at least small metric distance squared */
+    /** Squared max distance. This is private, and is forced to at least small metric distance squared */
     private _maxDistanceSquared;
+    /**
+     * Start and end points of line segments that meet closest approach criteria, i.e., they are perpendicular to
+     * both curves and their length is smaller
+     * than _maxDistanceToAccept
+     */
     private _results;
+    private static _workPointAA0;
+    private static _workPointAA1;
+    private static _workPointBB0;
+    private static _workPointBB1;
+    private static _workPointBB2;
+    private static _workVectorA;
+    private static _workPointB;
     private reinitialize;
     /**
-     * @param _geometryA first curve for intersection.  This is NOT saved.
-     * @param geometryB second curve for intersection.  Saved for reference by specific handler methods.
+     * Constructor.
+     * @param geometryB second curve for intersection. Saved for reference by specific handler methods.
      */
-    constructor(_geometryA: GeometryQuery | undefined, geometryB: GeometryQuery | undefined);
-    /** Access the (possibly undefined) max distance to accept. */
-    set maxDistanceToAccept(value: number | undefined);
+    constructor(geometryB: GeometryQuery | undefined);
     /** Set the (possibly undefined) max distance to accept. */
+    set maxDistanceToAccept(value: number | undefined);
+    /** Access the (possibly undefined) max distance to accept. */
     get maxDistanceToAccept(): number | undefined;
     /** Ask if the maxDistanceToAccept value is defined and positive */
     get isMaxDistanceSet(): boolean;
     /** Reset the geometry and flags, leaving all other parts unchanged (and preserving accumulated intersections) */
-    resetGeometry(_geometryA: GeometryQuery, geometryB: GeometryQuery): void;
+    resetGeometry(geometryB: GeometryQuery): void;
+    /** @returns whether the `fraction` is in [0,1] within tolerance */
     private acceptFraction;
     /**
-     * * Return the results structure for the intersection calculation, structured as an array of CurveLocationDetailPair
+     * Return the results structure for the intersection calculation, structured as an array of CurveLocationDetailPair.
      * @param reinitialize if true, a new results structure is created for use by later calls.
-     *
      */
     grabPairedResults(reinitialize?: boolean): CurveLocationDetailPair[];
+    /** Returns `true` if `detail` has same curve and fraction. */
     private sameCurveAndFraction;
     private testAndRecordPointPairApproach;
-    /** compute intersection of two line segments.
-     * filter by extension rules.
-     * record with fraction mapping.
+    /**
+     * Compute intersection of two line segments.
+     * Filter by extension rules.
+     * Record with fraction mapping.
      */
     private recordPointWithLocalFractions;
     /**
-     * capture a close approach pair that has point and local fraction but not curve.
-     * record with fraction mapping.
+     * Capture a close approach pair that has point and local fraction but not curve.
+     * Record with fraction mapping.
      */
     private capturePairWithLocalFractions;
     /**
-     * emit recordPoint for multiple pairs (on full curve!)
-     * @param cpA first curve primitive.   (possibly different from curve in detailA, but fraction compatible)
-     * @param cpB second curve primitive.   (possibly different from curve in detailA, but fraction compatible)
+     * Emit recordPoint for multiple pairs (on full curve!)
+     * @param cpA first curve primitive (possibly different from curve in detailA, but fraction compatible)
+     * @param cpB second curve primitive (possibly different from curve in detailA, but fraction compatible)
      * @param pairs array of pairs
      * @param reversed true to have order reversed in final structures.
      */
     recordPairs(cpA: CurvePrimitive, cpB: CurvePrimitive, pairs: CurveLocationDetailPair[] | undefined, reversed: boolean): void;
     /**
-     * record fully assembled (but possibly reversed) detail pair.
+     * Record fully assembled (but possibly reversed) detail pair.
      * @param detailA first detail
      * @param detailB second detail
      * @param reversed true to have order reversed in final structures.
      */
-    captureDetailPair(detailA: CurveLocationDetail | undefined, detailB: CurveLocationDetail | undefined, reversed: boolean): void;
-    /**
-     *
-     * @param fractionA
-     * @param pointA
-     * @param pointB0
-     * @param pointB1
-     * @param fractionB
-     * @param minDistanceSquared
-     * @param closestApproach
-     */
+    private captureDetailPair;
     private static updatePointToSegmentDistance;
     /**
-     * Return fractions of close approach within minDistance between two line segments( a0,a1) and (b0, b1)
-     * * minDistance is assumed positive
+     * Return fractions of close approach within minDistance between two line segments (a0,a1) and (b0, b1).
+     * * minDistanceSquared is assumed positive.
      * Return the fractional (not xy) coordinates in result.x, result.y
      * @param a0 start point of line a
      * @param a1  end point of line a
      * @param b0  start point of line b
      * @param b1 end point of line b
-     * @param result point to receive fractional coordinates of intersection.   result.x is fraction on line a. result.y is fraction on line b.
+     * @param result point to receive fractional coordinates of intersection. result.x is fraction on line a.
+     * result.y is fraction on line b.
      */
     private static segmentSegmentBoundedApproach;
-    /**
-     * Return fractions of close approach within minDistance between two line segments( a0,a1) and (b0, b1)
-     * * minDistance is assumed positive
-     * Return the fractional (not xy) coordinates in result.x, result.y
-     * @param a0 start point of line a
-     * @param a1  end point of line a
-     * @param b0  start point of line b
-     * @param b1 end point of line b
-     * @param result point to receive fractional coordinates of intersection.   result.x is fraction on line a. result.y is fraction on line b.
-     */
     private testAndRecordFractionalPairApproach;
     private testAndRecordProjection;
-    /** compute intersection of two line segments.
-     * filter by extension rules.
-     * record with fraction mapping.
+    /**
+     * Compute intersection of two line segments.
+     * Filter by extension rules.
+     * Record with fraction mapping.
      * * The fraction mappings allow portions of a linestring to be passed here.
      */
     private computeSegmentSegment3D;
     private dispatchSegmentSegment;
     private dispatchSegmentArc;
     private dispatchCircularCircularOrdered;
-    /** Find the fractional point (if any) on an arc, known to be circular and displayed from the center in the direction of a scaled vector.
-     *
+    /**
+     * Find the fractional point (if any) on an arc, known to be circular and displayed from the center in the
+     * direction of a scaled vector.
      */
     private resolveDirectionToArcXYFraction;
     private dispatchArcArc;
     private dispatchArcBsplineCurve3d;
     private dispatchBSplineCurve3dBSplineCurve3d;
-    private static _workPointAA0;
-    private static _workPointAA1;
-    private static _workPointBB0;
-    private static _workPointBB1;
-    private static _workPointBB2;
-    private static _workVectorA;
-    /** low level dispatch of linestring with (beziers of) a bspline curve */
+    /** Low level dispatch of linestring with (beziers of) a bspline curve */
     dispatchLineStringBSplineCurve(lsA: LineString3d, curveB: BSplineCurve3d, reversed: boolean): any;
-    /** low level dispatch of linestring with (beziers of) a bspline curve */
+    /** Low level dispatch of segment with (beziers of) a bspline curve */
     dispatchSegmentBsplineCurve(lsA: LineSegment3d, curveB: BSplineCurve3d, reversed: boolean): any;
     /** Detail computation for segment approaching linestring. */
     computeSegmentLineString(lsA: LineSegment3d, lsB: LineString3d, reversed: boolean): any;
-    /** Detail computation for arcA intersecting lsB. */
+    /** Detail computation for arc approaching linestring. */
     computeArcLineString(arcA: Arc3d, lsB: LineString3d, reversed: boolean): any;
-    private static _workPointB0;
-    /** double dispatch handler for strongly typed segment.. */
+    /** Double dispatch handler for strongly typed segment. */
     handleLineSegment3d(segmentA: LineSegment3d): any;
+    /**
+     * Set bits for comparison to range xy
+     * * bit 0x01 => x smaller than range.low.x
+     * * bit 0x02 => x larger than range.high.x
+     * * bit 0x04 => y smaller than range.low.y
+     * * bit 0x08 => y larger than range.high.y
+     * @param xy point to test
+     * @param range range for comparison
+     */
+    private classifyBitsPointRangeXY;
     private computeLineStringLineString;
-    /** double dispatch handler for strongly typed linestring.. */
+    /** Double dispatch handler for strongly typed linestring. */
     handleLineString3d(lsA: LineString3d): any;
-    /** double dispatch handler for strongly typed arc .. */
+    /** Double dispatch handler for strongly typed arc. */
     handleArc3d(arc0: Arc3d): any;
-    /** double dispatch handler for strongly typed bspline curve .. */
+    /** Double dispatch handler for strongly typed bspline curve. */
     handleBSplineCurve3d(curve: BSplineCurve3d): any;
-    /** double dispatch handler for strongly typed homogeneous bspline curve .. */
+    /** Double dispatch handler for strongly typed homogeneous bspline curve .. */
     handleBSplineCurve3dH(_curve: BSplineCurve3dH): any;
 }
 //# sourceMappingURL=CurveCurveCloseApproachXY.d.ts.map

package/lib/esm/curve/CurveCurveCloseApproachXY.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CurveCurveCloseApproachXY.d.ts","sourceRoot":"","sources":["../../../src/curve/CurveCurveCloseApproachXY.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAsB,MAAM,yBAAyB,CAAC;AAC7E,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAE7D,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AAKpE,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAqB,mBAAmB,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AACxG,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AA0B9C;;;;;;;GAOG;AACH,qBAAa,yBAA0B,SAAQ,mBAAmB;IAMhE,OAAO,CAAC,UAAU,CAA4B;IAC9C,OAAO,CAAC,aAAa,CAAoB;IACzC,OAAO,CAAC,gBAAgB,CAAqB;IAC7C,OAAO,CAAC,YAAY;IAYpB;;OAEG;IACH,OAAO,CAAC,oBAAoB,CAAqB;IACjD,sGAAsG;IACtG,OAAO,CAAC,mBAAmB,CAAS;IACpC,OAAO,CAAC,QAAQ,CAA6B;IAE7C,OAAO,CAAC,YAAY;IAIpB;;;OAGG;gBACgB,UAAU,EAAE,aAAa,GAAG,SAAS,EAAE,SAAS,EAAE,aAAa,GAAG,SAAS;IAQ9F,8DAA8D;IAC9D,IAAW,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAIvD;IACD,2DAA2D;IAC3D,IAAW,mBAAmB,IAAI,MAAM,GAAG,SAAS,CAAsC;IAC1F,mEAAmE;IACnE,IAAW,gBAAgB,IAAI,OAAO,CAAqF;IAC3H,iHAAiH;IAC1G,aAAa,CAAC,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,aAAa;IAIxE,OAAO,CAAC,cAAc;IAOtB;;;;OAIG;IACI,iBAAiB,CAAC,YAAY,GAAE,OAAe,GAAG,uBAAuB,EAAE;IAMlF,OAAO,CAAC,oBAAoB;IAG5B,OAAO,CAAC,8BAA8B;IAYtC;;;OAGG;IACH,OAAO,CAAC,6BAA6B;IAuDrC;;;OAGG;IACH,OAAO,CAAC,6BAA6B;IAmCrC;;;;;;OAMG;IACI,WAAW,CAAC,GAAG,EAAE,cAAc,EAAE,GAAG,EAAE,cAAc,EACzD,KAAK,EAAE,uBAAuB,EAAE,GAAG,SAAS,EAAE,QAAQ,EAAE,OAAO;IAQjE;;;;;OAKG;IACI,iBAAiB,CAAC,OAAO,EAAE,mBAAmB,GAAG,SAAS,EAAE,OAAO,EAAE,mBAAmB,GAAG,SAAS,EAAE,QAAQ,EAAE,OAAO;IAU9H;;;;;;;;;OASG;IACH,OAAO,CAAC,MAAM,CAAC,4BAA4B;IAmB3C;;;;;;;;;OASG;IACH,OAAO,CAAC,MAAM,CAAC,6BAA6B;IA2C5C;;;;;;;;;OASG;IACH,OAAO,CAAC,mCAAmC;IAoB3C,OAAO,CAAC,uBAAuB;IAW/B;;;;OAIG;IACH,OAAO,CAAC,uBAAuB;IAsB/B,OAAO,CAAC,sBAAsB;IAsB9B,OAAO,CAAC,kBAAkB;IA6D1B,OAAO,CAAC,+BAA+B;IA0CvC;;OAEG;IACH,OAAO,CAAC,+BAA+B;IAavC,OAAO,CAAC,cAAc;IAqBtB,OAAO,CAAC,yBAAyB;IAYjC,OAAO,CAAC,oCAAoC;IAY5C,OAAO,CAAC,MAAM,CAAC,aAAa,CAAoB;IAChD,OAAO,CAAC,MAAM,CAAC,aAAa,CAAoB;IAChD,OAAO,CAAC,MAAM,CAAC,aAAa,CAAoB;IAChD,OAAO,CAAC,MAAM,CAAC,aAAa,CAAoB;IAChD,OAAO,CAAC,MAAM,CAAC,aAAa,CAAoB;IAChD,OAAO,CAAC,MAAM,CAAC,YAAY,CAAqB;IAChD,yEAAyE;IAClE,8BAA8B,CAAC,GAAG,EAAE,YAAY,EAAE,MAAM,EAAE,cAAc,EAAE,QAAQ,EAAE,OAAO,GAAG,GAAG;IAKxG,yEAAyE;IAClE,2BAA2B,CAAC,GAAG,EAAE,aAAa,EAAE,MAAM,EAAE,cAAc,EAAE,QAAQ,EAAE,OAAO,GAAG,GAAG;IAKtG,6DAA6D;IACtD,wBAAwB,CAAC,GAAG,EAAE,aAAa,EAAE,GAAG,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,GAAG,GAAG;IA2C9F,oDAAoD;IAC7C,oBAAoB,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,GAAG,GAAG;IAsBnF,OAAO,CAAC,MAAM,CAAC,YAAY,CAAoB;IAE/C,2DAA2D;IAC3C,mBAAmB,CAAC,QAAQ,EAAE,aAAa,GAAG,GAAG;IAiBjE,OAAO,CAAC,2BAA2B;IAmDnC,8DAA8D;IAC9C,kBAAkB,CAAC,GAAG,EAAE,YAAY,GAAG,GAAG;IAa1D,wDAAwD;IACxC,WAAW,CAAC,IAAI,EAAE,KAAK,GAAG,GAAG;IAc7C,kEAAkE;IAClD,oBAAoB,CAAC,KAAK,EAAE,cAAc,GAAG,GAAG;IAYhE,8EAA8E;IAC9D,qBAAqB,CAAC,MAAM,EAAE,eAAe,GAAG,GAAG;CAcpE"}
+{"version":3,"file":"CurveCurveCloseApproachXY.d.ts","sourceRoot":"","sources":["../../../src/curve/CurveCurveCloseApproachXY.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAsB,MAAM,yBAAyB,CAAC;AAC7E,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAE7D,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AAKpE,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAA0C,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AACxG,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAI9C;;;;;;;;;;;;GAYG;AACH,qBAAa,yBAA0B,SAAQ,mBAAmB;IAChE,OAAO,CAAC,UAAU,CAA4B;IAC9C,OAAO,CAAC,aAAa,CAAoB;IACzC,OAAO,CAAC,gBAAgB,CAAqB;IAC7C,OAAO,CAAC,YAAY;IAYpB;;;OAGG;IACH,OAAO,CAAC,oBAAoB,CAAqB;IACjD,qGAAqG;IACrG,OAAO,CAAC,mBAAmB,CAAS;IACpC;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAA6B;IAE7C,OAAO,CAAC,MAAM,CAAC,aAAa,CAAoB;IAChD,OAAO,CAAC,MAAM,CAAC,aAAa,CAAoB;IAChD,OAAO,CAAC,MAAM,CAAC,aAAa,CAAoB;IAChD,OAAO,CAAC,MAAM,CAAC,aAAa,CAAoB;IAChD,OAAO,CAAC,MAAM,CAAC,aAAa,CAAoB;IAChD,OAAO,CAAC,MAAM,CAAC,YAAY,CAAqB;IAChD,OAAO,CAAC,MAAM,CAAC,WAAW,CAAoB;IAE9C,OAAO,CAAC,YAAY;IAGpB;;;OAGG;gBACgB,SAAS,EAAE,aAAa,GAAG,SAAS;IAMvD,2DAA2D;IAC3D,IAAW,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAIvD;IACD,8DAA8D;IAC9D,IAAW,mBAAmB,IAAI,MAAM,GAAG,SAAS,CAEnD;IACD,mEAAmE;IACnE,IAAW,gBAAgB,IAAI,OAAO,CAErC;IACD,iHAAiH;IAC1G,aAAa,CAAC,SAAS,EAAE,aAAa;IAG7C,mEAAmE;IACnE,OAAO,CAAC,cAAc;IAOtB;;;OAGG;IACI,iBAAiB,CAAC,YAAY,GAAE,OAAe,GAAG,uBAAuB,EAAE;IAMlF,8DAA8D;IAC9D,OAAO,CAAC,oBAAoB;IAG5B,OAAO,CAAC,8BAA8B;IAatC;;;;OAIG;IACH,OAAO,CAAC,6BAA6B;IA4DrC;;;OAGG;IACH,OAAO,CAAC,6BAA6B;IAoCrC;;;;;;OAMG;IACI,WAAW,CAChB,GAAG,EAAE,cAAc,EAAE,GAAG,EAAE,cAAc,EAAE,KAAK,EAAE,uBAAuB,EAAE,GAAG,SAAS,EAAE,QAAQ,EAAE,OAAO,GACxG,IAAI;IAQP;;;;;OAKG;IACH,OAAO,CAAC,iBAAiB;IAWzB,OAAO,CAAC,MAAM,CAAC,4BAA4B;IA6B3C;;;;;;;;;;OAUG;IACH,OAAO,CAAC,MAAM,CAAC,6BAA6B;IAoD5C,OAAO,CAAC,mCAAmC;IA4B3C,OAAO,CAAC,uBAAuB;IAY/B;;;;;OAKG;IACH,OAAO,CAAC,uBAAuB;IAuB/B,OAAO,CAAC,sBAAsB;IAqB9B,OAAO,CAAC,kBAAkB;IA4D1B,OAAO,CAAC,+BAA+B;IAoCvC;;;OAGG;IACH,OAAO,CAAC,+BAA+B;IAevC,OAAO,CAAC,cAAc;IAgBtB,OAAO,CAAC,yBAAyB;IAQjC,OAAO,CAAC,oCAAoC;IAS5C,yEAAyE;IAClE,8BAA8B,CAAC,GAAG,EAAE,YAAY,EAAE,MAAM,EAAE,cAAc,EAAE,QAAQ,EAAE,OAAO,GAAG,GAAG;IAKxG,sEAAsE;IAC/D,2BAA2B,CAAC,GAAG,EAAE,aAAa,EAAE,MAAM,EAAE,cAAc,EAAE,QAAQ,EAAE,OAAO,GAAG,GAAG;IAKtG,6DAA6D;IACtD,wBAAwB,CAAC,GAAG,EAAE,aAAa,EAAE,GAAG,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,GAAG,GAAG;IA2C9F,yDAAyD;IAClD,oBAAoB,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,GAAG,GAAG;IAqBnF,0DAA0D;IAC1C,mBAAmB,CAAC,QAAQ,EAAE,aAAa,GAAG,GAAG;IAkBjE;;;;;;;;OAQG;IACH,OAAO,CAAC,wBAAwB;IAahC,OAAO,CAAC,2BAA2B;IAiDnC,6DAA6D;IAC7C,kBAAkB,CAAC,GAAG,EAAE,YAAY,GAAG,GAAG;IAa1D,sDAAsD;IACtC,WAAW,CAAC,IAAI,EAAE,KAAK,GAAG,GAAG;IAc7C,gEAAgE;IAChD,oBAAoB,CAAC,KAAK,EAAE,cAAc,GAAG,GAAG;IAYhE,8EAA8E;IAC9D,qBAAqB,CAAC,MAAM,EAAE,eAAe,GAAG,GAAG;CAgBpE"}