@itwin/core-geometry 5.0.0-dev.99 → 5.1.0-dev.1

package/lib/esm/curve/internalContexts/AnnounceTangentStrokeHandler.d.ts

@@ -0,0 +1,71 @@
+/** @packageDocumentation
+ * @module Curve
+ */
+import { IStrokeHandler } from "../../geometry3d/GeometryHandler";
+import { Point3d, Vector3d } from "../../geometry3d/Point3dVector3d";
+import { CurveLocationDetail } from "../CurveLocationDetail";
+import { CurvePrimitive, TangentOptions } from "../CurvePrimitive";
+import { NewtonRtoRStrokeHandler } from "./NewtonRtoRStrokeHandler";
+/**
+ * Context for searching for the tangent(s) to a CurvePrimitive.
+ * @internal
+ */
+export declare class AnnounceTangentStrokeHandler extends NewtonRtoRStrokeHandler implements IStrokeHandler {
+    private _curve;
+    private _announceTangent;
+    private _spacePoint;
+    private _vectorToEye;
+    private _distanceTol;
+    private _distanceTolSquared;
+    private _fractionA;
+    private _functionA;
+    private _fractionB;
+    private _functionB;
+    private _numThisCurve;
+    private _fractionMRU?;
+    private _curveMRU?;
+    private _workRay;
+    private _workDetail?;
+    private _newtonSolver;
+    /** Constructor */
+    constructor(spacePoint: Point3d, announceTangent: (tangent: CurveLocationDetail) => any, options?: TangentOptions);
+    /** Specified by IStrokeHandler. */
+    needPrimaryGeometryForStrokes(): boolean;
+    /** Specified by IStrokeHandler. */
+    startCurvePrimitive(curve: CurvePrimitive | undefined): void;
+    /** Specified by IStrokeHandler. */
+    endCurvePrimitive(): void;
+    /** Specified by IStrokeHandler. */
+    announceIntervalForUniformStepStrokes(cp: CurvePrimitive, numStrokes: number, fraction0: number, fraction1: number): void;
+    private announceCandidate;
+    /** Specified by IStrokeHandler. */
+    announceSegmentInterval(cp: CurvePrimitive, point0: Point3d, point1: Point3d, _numStrokes: number, fraction0: number, fraction1: number): void;
+    /**
+     * Given a function `f` and (unordered) fractions `a` and `b`, search for and announce a root of `f` in this
+     * fractional interval.
+     * * This method searches for a root of `f` if and only if the stroke segment defined by `(a, f(a))` and
+     * `(b, f(b))` has a root. This is a HEURISTIC: given continuous `f` between `a` and `b`, a root of the stroke
+     * segment implies a root of `f`, but not vice-versa. Therefore, if the strokes are not sufficiently dense,
+     * this method can miss a root of `f`.
+     */
+    private searchInterval;
+    private announceSolutionFraction;
+    /**
+     * Evaluate the univariate real-valued function for which we are finding roots.
+     * * For finding the tangents to curve `X` from point `Q` as seen in a view plane with normal `N`, this
+     * function is `f(t) := (Q - X(t)) dot (X'(t) cross N)`. The second vector in the dot product defines a
+     * _tangent plane_ at `X(t)`.
+     * * Either `pointAndDerivative` must be defined, or both `fraction` and `curve`.
+     * @param pointAndDerivative pre-evaluated curve
+     * @param fraction fraction at which to evaluate `curve`
+     * @param curve curve to evaluate at `fraction`
+     * @returns distance of `Q` from the tangent plane at `X(t)`.
+    */
+    private evaluateFunction;
+    /** Specified by NewtonRtoRStrokeHandler. */
+    evaluate(fraction: number): boolean;
+    private announceRay;
+    /** Specified by IStrokeHandler. */
+    announcePointTangent(_point: Point3d, _fraction: number, _tangent: Vector3d): void;
+}
+//# sourceMappingURL=AnnounceTangentStrokeHandler.d.ts.map

package/lib/esm/curve/internalContexts/AnnounceTangentStrokeHandler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnnounceTangentStrokeHandler.d.ts","sourceRoot":"","sources":["../../../../src/curve/internalContexts/AnnounceTangentStrokeHandler.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAClE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAGrE,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnE,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAEpE;;;GAGG;AACH,qBAAa,4BAA6B,SAAQ,uBAAwB,YAAW,cAAc;IACjG,OAAO,CAAC,MAAM,CAA6B;IAC3C,OAAO,CAAC,gBAAgB,CAAwC;IAChE,OAAO,CAAC,WAAW,CAAU;IAC7B,OAAO,CAAC,YAAY,CAAW;IAC/B,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,mBAAmB,CAAS;IAEpC,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,UAAU,CAAa;IAE/B,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,aAAa,CAAa;IAElC,OAAO,CAAC,YAAY,CAAC,CAAS;IAC9B,OAAO,CAAC,SAAS,CAAC,CAAiB;IACnC,OAAO,CAAC,QAAQ,CAAQ;IACxB,OAAO,CAAC,WAAW,CAAC,CAAsB;IAC1C,OAAO,CAAC,aAAa,CAAyC;IAC9D,kBAAkB;gBACC,UAAU,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC,OAAO,EAAE,mBAAmB,KAAK,GAAG,EAAE,OAAO,CAAC,EAAE,cAAc;IAWxH,mCAAmC;IAC5B,6BAA6B;IAGpC,mCAAmC;IAC5B,mBAAmB,CAAC,KAAK,EAAE,cAAc,GAAG,SAAS;IAM5D,mCAAmC;IAC5B,iBAAiB;IAExB,mCAAmC;IAC5B,qCAAqC,CAC1C,EAAE,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAC3E,IAAI;IAWP,OAAO,CAAC,iBAAiB;IAUzB,mCAAmC;IAC5B,uBAAuB,CAC5B,EAAE,EAAE,cAAc,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAC9G,IAAI;IAiBP;;;;;;;OAOG;IACH,OAAO,CAAC,cAAc;IAgBtB,OAAO,CAAC,wBAAwB;IAIhC;;;;;;;;;;MAUE;IACF,OAAO,CAAC,gBAAgB;IAUxB,4CAA4C;IACrC,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAQ1C,OAAO,CAAC,WAAW;IAQnB,mCAAmC;IAC5B,oBAAoB,CAAC,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ;CAGnF"}

package/lib/esm/curve/internalContexts/AnnounceTangentStrokeHandler.js

@@ -0,0 +1,177 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Curve
+ */
+import { assert } from "@itwin/core-bentley";
+import { Geometry } from "../../Geometry";
+import { Vector3d } from "../../geometry3d/Point3dVector3d";
+import { Ray3d } from "../../geometry3d/Ray3d";
+import { Newton1dUnboundedApproximateDerivative } from "../../numerics/Newton";
+import { CurveLocationDetail } from "../CurveLocationDetail";
+import { NewtonRtoRStrokeHandler } from "./NewtonRtoRStrokeHandler";
+/**
+ * Context for searching for the tangent(s) to a CurvePrimitive.
+ * @internal
+ */
+export class AnnounceTangentStrokeHandler extends NewtonRtoRStrokeHandler {
+    _curve;
+    _announceTangent;
+    _spacePoint;
+    _vectorToEye;
+    _distanceTol;
+    _distanceTolSquared;
+    // fraction and function value on one side of an interval that may bracket a root
+    _fractionA = 0;
+    _functionA = 0;
+    // fraction and function value on the other side of an interval that may bracket a root
+    _fractionB = 0;
+    _functionB = 0;
+    _numThisCurve = 0;
+    // scratch vars to use within methods
+    _fractionMRU;
+    _curveMRU;
+    _workRay;
+    _workDetail;
+    _newtonSolver;
+    /** Constructor */
+    constructor(spacePoint, announceTangent, options) {
+        super();
+        this._announceTangent = announceTangent;
+        this._spacePoint = spacePoint;
+        this._vectorToEye = options?.vectorToEye ?? Vector3d.unitZ();
+        this._distanceTol = options?.distanceTol ?? Geometry.smallMetricDistance;
+        this._distanceTolSquared = this._distanceTol * this._distanceTol;
+        this._workRay = Ray3d.createZero();
+        this.startCurvePrimitive(undefined);
+        this._newtonSolver = new Newton1dUnboundedApproximateDerivative(this);
+    }
+    /** Specified by IStrokeHandler. */
+    needPrimaryGeometryForStrokes() {
+        return true;
+    }
+    /** Specified by IStrokeHandler. */
+    startCurvePrimitive(curve) {
+        this._curve = curve;
+        this._fractionA = 0.0;
+        this._numThisCurve = 0;
+        this._functionA = 0.0;
+    }
+    /** Specified by IStrokeHandler. */
+    endCurvePrimitive() {
+    }
+    /** Specified by IStrokeHandler. */
+    announceIntervalForUniformStepStrokes(cp, numStrokes, fraction0, fraction1) {
+        this.startCurvePrimitive(cp);
+        if (numStrokes < 1)
+            numStrokes = 1;
+        const df = 1.0 / numStrokes;
+        for (let i = 0; i <= numStrokes; i++) {
+            const fraction = Geometry.interpolate(fraction0, i * df, fraction1);
+            cp.fractionToPointAndDerivative(fraction, this._workRay);
+            this.announceRay(fraction, this._workRay);
+        }
+    }
+    announceCandidate(cp, fraction, point) {
+        if (this._parentCurvePrimitive)
+            cp = this._parentCurvePrimitive;
+        if (this._curveMRU === cp && Geometry.isAlmostEqualOptional(this._fractionMRU, fraction, Geometry.smallFloatingPoint))
+            return; // avoid announcing duplicate tangents in succession (e.g., at interior stroke point)
+        this._workDetail = CurveLocationDetail.createCurveFractionPoint(cp, fraction, point, this._workDetail);
+        this._announceTangent(this._workDetail);
+        this._fractionMRU = fraction;
+        this._curveMRU = cp;
+    }
+    /** Specified by IStrokeHandler. */
+    announceSegmentInterval(cp, point0, point1, _numStrokes, fraction0, fraction1) {
+        let fraction;
+        let point;
+        const distance0 = this._spacePoint.distanceSquared(point0);
+        const distance1 = this._spacePoint.distanceSquared(point1);
+        if (distance0 < distance1) {
+            fraction = fraction0;
+            point = point0;
+        }
+        else {
+            fraction = fraction1;
+            point = point1;
+        }
+        // evaluate at midpoint; the endpoints may be at corners, which have ambiguous tangent
+        const value = this.evaluateFunction(undefined, (fraction0 + fraction1) / 2, cp);
+        if (value !== undefined && Geometry.isDistanceWithinTol(value, this._distanceTol))
+            this.announceCandidate(cp, fraction, point);
+    }
+    /**
+     * Given a function `f` and (unordered) fractions `a` and `b`, search for and announce a root of `f` in this
+     * fractional interval.
+     * * This method searches for a root of `f` if and only if the stroke segment defined by `(a, f(a))` and
+     * `(b, f(b))` has a root. This is a HEURISTIC: given continuous `f` between `a` and `b`, a root of the stroke
+     * segment implies a root of `f`, but not vice-versa. Therefore, if the strokes are not sufficiently dense,
+     * this method can miss a root of `f`.
+     */
+    searchInterval() {
+        // directly announce at endpoint if we are extra certain it's a root; Newton can miss it if it has multiplicity > 1
+        if (Geometry.isDistanceWithinTol(this._functionA, this._distanceTolSquared))
+            this.announceSolutionFraction(this._fractionA);
+        if (Geometry.isDistanceWithinTol(this._functionB, this._distanceTolSquared))
+            this.announceSolutionFraction(this._fractionB);
+        if (this._functionA * this._functionB < 0) {
+            // by the Intermediate Value Theorem, a root lies between fractionA and fractionB; use Newton to find it.
+            const fraction = Geometry.inverseInterpolate(this._fractionA, this._functionA, this._fractionB, this._functionB);
+            if (fraction) {
+                this._newtonSolver.setX(fraction);
+                if (this._newtonSolver.runIterations())
+                    this.announceSolutionFraction(this._newtonSolver.getX());
+            }
+        }
+    }
+    announceSolutionFraction(fraction) {
+        if (this._curve)
+            this.announceCandidate(this._curve, fraction, this._curve.fractionToPoint(fraction));
+    }
+    /**
+     * Evaluate the univariate real-valued function for which we are finding roots.
+     * * For finding the tangents to curve `X` from point `Q` as seen in a view plane with normal `N`, this
+     * function is `f(t) := (Q - X(t)) dot (X'(t) cross N)`. The second vector in the dot product defines a
+     * _tangent plane_ at `X(t)`.
+     * * Either `pointAndDerivative` must be defined, or both `fraction` and `curve`.
+     * @param pointAndDerivative pre-evaluated curve
+     * @param fraction fraction at which to evaluate `curve`
+     * @param curve curve to evaluate at `fraction`
+     * @returns distance of `Q` from the tangent plane at `X(t)`.
+    */
+    evaluateFunction(pointAndDerivative, fraction, curve) {
+        if (pointAndDerivative)
+            this._workRay.setFrom(pointAndDerivative);
+        else if (fraction !== undefined && curve)
+            this._workRay = curve.fractionToPointAndDerivative(fraction, this._workRay);
+        else
+            return undefined;
+        const cross = this._vectorToEye.unitCrossProduct(this._workRay.direction); // normalized so we return true distance
+        return cross ? cross.dotProductStartEnd(this._workRay.origin, this._spacePoint) : undefined;
+    }
+    /** Specified by NewtonRtoRStrokeHandler. */
+    evaluate(fraction) {
+        const curve = this._parentCurvePrimitive ?? this._curve;
+        const value = this.evaluateFunction(undefined, fraction, curve);
+        if (value === undefined)
+            return false;
+        this.currentF = value;
+        return true;
+    }
+    announceRay(fraction, data) {
+        this._functionB = this.evaluateFunction(data);
+        this._fractionB = fraction;
+        if (this._numThisCurve++ > 0) // after the first stroke point, a stroke segment is defined, so we have an interval
+            this.searchInterval();
+        this._functionA = this._functionB;
+        this._fractionA = this._fractionB;
+    }
+    /** Specified by IStrokeHandler. */
+    announcePointTangent(_point, _fraction, _tangent) {
+        assert(false, "No callers expected. IStrokeHandler probably didn't need to specify this method.");
+    }
+}
+//# sourceMappingURL=AnnounceTangentStrokeHandler.js.map

package/lib/esm/curve/internalContexts/AnnounceTangentStrokeHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AnnounceTangentStrokeHandler.js","sourceRoot":"","sources":["../../../../src/curve/internalContexts/AnnounceTangentStrokeHandler.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C,OAAO,EAAW,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAC;AAC/C,OAAO,EAAE,sCAAsC,EAAE,MAAM,uBAAuB,CAAC;AAC/E,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAE7D,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAEpE;;;GAGG;AACH,MAAM,OAAO,4BAA6B,SAAQ,uBAAuB;IAC/D,MAAM,CAA6B;IACnC,gBAAgB,CAAwC;IACxD,WAAW,CAAU;IACrB,YAAY,CAAW;IACvB,YAAY,CAAS;IACrB,mBAAmB,CAAS;IACpC,iFAAiF;IACzE,UAAU,GAAW,CAAC,CAAC;IACvB,UAAU,GAAW,CAAC,CAAC;IAC/B,uFAAuF;IAC/E,UAAU,GAAW,CAAC,CAAC;IACvB,UAAU,GAAW,CAAC,CAAC;IACvB,aAAa,GAAW,CAAC,CAAC;IAClC,qCAAqC;IAC7B,YAAY,CAAU;IACtB,SAAS,CAAkB;IAC3B,QAAQ,CAAQ;IAChB,WAAW,CAAuB;IAClC,aAAa,CAAyC;IAC9D,kBAAkB;IAClB,YAAmB,UAAmB,EAAE,eAAsD,EAAE,OAAwB;QACtH,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAC;QACxC,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,YAAY,GAAG,OAAO,EAAE,WAAW,IAAI,QAAQ,CAAC,KAAK,EAAE,CAAC;QAC7D,IAAI,CAAC,YAAY,GAAG,OAAO,EAAE,WAAW,IAAI,QAAQ,CAAC,mBAAmB,CAAC;QACzE,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QACjE,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,UAAU,EAAE,CAAC;QACnC,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;QACpC,IAAI,CAAC,aAAa,GAAG,IAAI,sCAAsC,CAAC,IAAI,CAAC,CAAC;IACxE,CAAC;IACD,mCAAmC;IAC5B,6BAA6B;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IACD,mCAAmC;IAC5B,mBAAmB,CAAC,KAAiC;QAC1D,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;QACtB,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC;QACvB,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;IACxB,CAAC;IACD,mCAAmC;IAC5B,iBAAiB;IACxB,CAAC;IACD,mCAAmC;IAC5B,qCAAqC,CAC1C,EAAkB,EAAE,UAAkB,EAAE,SAAiB,EAAE,SAAiB;QAE5E,IAAI,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAC;QAC7B,IAAI,UAAU,GAAG,CAAC;YAChB,UAAU,GAAG,CAAC,CAAC;QACjB,MAAM,EAAE,GAAG,GAAG,GAAG,UAAU,CAAC;QAC5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,UAAU,EAAE,CAAC,EAAE,EAAE,CAAC;YACrC,MAAM,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,SAAS,EAAE,CAAC,GAAG,EAAE,EAAE,SAAS,CAAC,CAAC;YACpE,EAAE,CAAC,4BAA4B,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YACzD,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IACO,iBAAiB,CAAC,EAAkB,EAAE,QAAgB,EAAE,KAAc;QAC5E,IAAI,IAAI,CAAC,qBAAqB;YAC5B,EAAE,GAAG,IAAI,CAAC,qBAAqB,CAAC;QAClC,IAAI,IAAI,CAAC,SAAS,KAAK,EAAE,IAAI,QAAQ,CAAC,qBAAqB,CAAC,IAAI,CAAC,YAAY,EAAE,QAAQ,EAAE,QAAQ,CAAC,kBAAkB,CAAC;YACnH,OAAO,CAAC,qFAAqF;QAC/F,IAAI,CAAC,WAAW,GAAG,mBAAmB,CAAC,wBAAwB,CAAC,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACvG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACxC,IAAI,CAAC,YAAY,GAAG,QAAQ,CAAC;QAC7B,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;IACtB,CAAC;IACD,mCAAmC;IAC5B,uBAAuB,CAC5B,EAAkB,EAAE,MAAe,EAAE,MAAe,EAAE,WAAmB,EAAE,SAAiB,EAAE,SAAiB;QAE/G,IAAI,QAAgB,CAAC;QACrB,IAAI,KAAc,CAAC;QACnB,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAC3D,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAC3D,IAAI,SAAS,GAAG,SAAS,EAAE,CAAC;YAC1B,QAAQ,GAAG,SAAS,CAAC;YACrB,KAAK,GAAG,MAAM,CAAC;QACjB,CAAC;aAAM,CAAC;YACN,QAAQ,GAAG,SAAS,CAAC;YACrB,KAAK,GAAG,MAAM,CAAC;QACjB,CAAC;QACD,sFAAsF;QACtF,MAAM,KAAK,GAAG,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,SAAS,GAAG,SAAS,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC;QAChF,IAAI,KAAK,KAAK,SAAS,IAAI,QAAQ,CAAC,mBAAmB,CAAC,KAAK,EAAE,IAAI,CAAC,YAAY,CAAC;YAC/E,IAAI,CAAC,iBAAiB,CAAC,EAAE,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;IAChD,CAAC;IACD;;;;;;;OAOG;IACK,cAAc;QACpB,mHAAmH;QACnH,IAAI,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,mBAAmB,CAAC;YACzE,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACjD,IAAI,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,mBAAmB,CAAC;YACzE,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACjD,IAAI,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,GAAG,CAAC,EAAE,CAAC;YAC1C,yGAAyG;YACzG,MAAM,QAAQ,GAAG,QAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;YACjH,IAAI,QAAQ,EAAE,CAAC;gBACb,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAClC,IAAI,IAAI,CAAC,aAAa,CAAC,aAAa,EAAE;oBACpC,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,CAAC;YAC7D,CAAC;QACH,CAAC;IACH,CAAC;IACO,wBAAwB,CAAC,QAAgB;QAC/C,IAAI,IAAI,CAAC,MAAM;YACb,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC;IACzF,CAAC;IACD;;;;;;;;;;MAUE;IACM,gBAAgB,CAAC,kBAA0B,EAAE,QAAiB,EAAE,KAAsB;QAC5F,IAAI,kBAAkB;YACpB,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;aACvC,IAAI,QAAQ,KAAK,SAAS,IAAI,KAAK;YACtC,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,4BAA4B,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;;YAE5E,OAAO,SAAS,CAAC;QACnB,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,wCAAwC;QACnH,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC9F,CAAC;IACD,4CAA4C;IACrC,QAAQ,CAAC,QAAgB;QAC9B,MAAM,KAAK,GAAG,IAAI,CAAC,qBAAqB,IAAI,IAAI,CAAC,MAAM,CAAC;QACxD,MAAM,KAAK,GAAG,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;QAChE,IAAI,KAAK,KAAK,SAAS;YACrB,OAAO,KAAK,CAAC;QACf,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IACO,WAAW,CAAC,QAAgB,EAAE,IAAW;QAC/C,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAE,CAAC;QAC/C,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC;QAC3B,IAAI,IAAI,CAAC,aAAa,EAAE,GAAG,CAAC,EAAE,oFAAoF;YAChH,IAAI,CAAC,cAAc,EAAE,CAAC;QACxB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QAClC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;IACpC,CAAC;IACD,mCAAmC;IAC5B,oBAAoB,CAAC,MAAe,EAAE,SAAiB,EAAE,QAAkB;QAChF,MAAM,CAAC,KAAK,EAAE,kFAAkF,CAAC,CAAC;IACpG,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Curve\n */\n\nimport { assert } from \"@itwin/core-bentley\";\nimport { Geometry } from \"../../Geometry\";\nimport { IStrokeHandler } from \"../../geometry3d/GeometryHandler\";\nimport { Point3d, Vector3d } from \"../../geometry3d/Point3dVector3d\";\nimport { Ray3d } from \"../../geometry3d/Ray3d\";\nimport { Newton1dUnboundedApproximateDerivative } from \"../../numerics/Newton\";\nimport { CurveLocationDetail } from \"../CurveLocationDetail\";\nimport { CurvePrimitive, TangentOptions } from \"../CurvePrimitive\";\nimport { NewtonRtoRStrokeHandler } from \"./NewtonRtoRStrokeHandler\";\n\n/**\n * Context for searching for the tangent(s) to a CurvePrimitive.\n * @internal\n */\nexport class AnnounceTangentStrokeHandler extends NewtonRtoRStrokeHandler implements IStrokeHandler {\n  private _curve: CurvePrimitive | undefined;\n  private _announceTangent: (tangent: CurveLocationDetail) => any;\n  private _spacePoint: Point3d;\n  private _vectorToEye: Vector3d;\n  private _distanceTol: number;\n  private _distanceTolSquared: number;\n  // fraction and function value on one side of an interval that may bracket a root\n  private _fractionA: number = 0;\n  private _functionA: number = 0;\n  // fraction and function value on the other side of an interval that may bracket a root\n  private _fractionB: number = 0;\n  private _functionB: number = 0;\n  private _numThisCurve: number = 0;\n  // scratch vars to use within methods\n  private _fractionMRU?: number;\n  private _curveMRU?: CurvePrimitive;\n  private _workRay: Ray3d;\n  private _workDetail?: CurveLocationDetail;\n  private _newtonSolver: Newton1dUnboundedApproximateDerivative;\n  /** Constructor */\n  public constructor(spacePoint: Point3d, announceTangent: (tangent: CurveLocationDetail) => any, options?: TangentOptions) {\n    super();\n    this._announceTangent = announceTangent;\n    this._spacePoint = spacePoint;\n    this._vectorToEye = options?.vectorToEye ?? Vector3d.unitZ();\n    this._distanceTol = options?.distanceTol ?? Geometry.smallMetricDistance;\n    this._distanceTolSquared = this._distanceTol * this._distanceTol;\n    this._workRay = Ray3d.createZero();\n    this.startCurvePrimitive(undefined);\n    this._newtonSolver = new Newton1dUnboundedApproximateDerivative(this);\n  }\n  /** Specified by IStrokeHandler. */\n  public needPrimaryGeometryForStrokes() {\n    return true;\n  }\n  /** Specified by IStrokeHandler. */\n  public startCurvePrimitive(curve: CurvePrimitive | undefined) {\n    this._curve = curve;\n    this._fractionA = 0.0;\n    this._numThisCurve = 0;\n    this._functionA = 0.0;\n  }\n  /** Specified by IStrokeHandler. */\n  public endCurvePrimitive() {\n  }\n  /** Specified by IStrokeHandler. */\n  public announceIntervalForUniformStepStrokes(\n    cp: CurvePrimitive, numStrokes: number, fraction0: number, fraction1: number,\n  ): void {\n    this.startCurvePrimitive(cp);\n    if (numStrokes < 1)\n      numStrokes = 1;\n    const df = 1.0 / numStrokes;\n    for (let i = 0; i <= numStrokes; i++) {\n      const fraction = Geometry.interpolate(fraction0, i * df, fraction1);\n      cp.fractionToPointAndDerivative(fraction, this._workRay);\n      this.announceRay(fraction, this._workRay);\n    }\n  }\n  private announceCandidate(cp: CurvePrimitive, fraction: number, point: Point3d) {\n    if (this._parentCurvePrimitive)\n      cp = this._parentCurvePrimitive;\n    if (this._curveMRU === cp && Geometry.isAlmostEqualOptional(this._fractionMRU, fraction, Geometry.smallFloatingPoint))\n      return; // avoid announcing duplicate tangents in succession (e.g., at interior stroke point)\n    this._workDetail = CurveLocationDetail.createCurveFractionPoint(cp, fraction, point, this._workDetail);\n    this._announceTangent(this._workDetail);\n    this._fractionMRU = fraction;\n    this._curveMRU = cp;\n  }\n  /** Specified by IStrokeHandler. */\n  public announceSegmentInterval(\n    cp: CurvePrimitive, point0: Point3d, point1: Point3d, _numStrokes: number, fraction0: number, fraction1: number,\n  ): void {\n    let fraction: number;\n    let point: Point3d;\n    const distance0 = this._spacePoint.distanceSquared(point0);\n    const distance1 = this._spacePoint.distanceSquared(point1);\n    if (distance0 < distance1) {\n      fraction = fraction0;\n      point = point0;\n    } else {\n      fraction = fraction1;\n      point = point1;\n    }\n    // evaluate at midpoint; the endpoints may be at corners, which have ambiguous tangent\n    const value = this.evaluateFunction(undefined, (fraction0 + fraction1) / 2, cp);\n    if (value !== undefined && Geometry.isDistanceWithinTol(value, this._distanceTol))\n      this.announceCandidate(cp, fraction, point);\n  }\n  /**\n   * Given a function `f` and (unordered) fractions `a` and `b`, search for and announce a root of `f` in this\n   * fractional interval.\n   * * This method searches for a root of `f` if and only if the stroke segment defined by `(a, f(a))` and\n   * `(b, f(b))` has a root. This is a HEURISTIC: given continuous `f` between `a` and `b`, a root of the stroke\n   * segment implies a root of `f`, but not vice-versa. Therefore, if the strokes are not sufficiently dense,\n   * this method can miss a root of `f`.\n   */\n  private searchInterval() {\n    // directly announce at endpoint if we are extra certain it's a root; Newton can miss it if it has multiplicity > 1\n    if (Geometry.isDistanceWithinTol(this._functionA, this._distanceTolSquared))\n      this.announceSolutionFraction(this._fractionA);\n    if (Geometry.isDistanceWithinTol(this._functionB, this._distanceTolSquared))\n      this.announceSolutionFraction(this._fractionB);\n    if (this._functionA * this._functionB < 0) {\n      // by the Intermediate Value Theorem, a root lies between fractionA and fractionB; use Newton to find it.\n      const fraction = Geometry.inverseInterpolate(this._fractionA, this._functionA, this._fractionB, this._functionB);\n      if (fraction) {\n        this._newtonSolver.setX(fraction);\n        if (this._newtonSolver.runIterations())\n          this.announceSolutionFraction(this._newtonSolver.getX());\n      }\n    }\n  }\n  private announceSolutionFraction(fraction: number) {\n    if (this._curve)\n      this.announceCandidate(this._curve, fraction, this._curve.fractionToPoint(fraction));\n  }\n  /**\n   * Evaluate the univariate real-valued function for which we are finding roots.\n   * * For finding the tangents to curve `X` from point `Q` as seen in a view plane with normal `N`, this\n   * function is `f(t) := (Q - X(t)) dot (X'(t) cross N)`. The second vector in the dot product defines a\n   * _tangent plane_ at `X(t)`.\n   * * Either `pointAndDerivative` must be defined, or both `fraction` and `curve`.\n   * @param pointAndDerivative pre-evaluated curve\n   * @param fraction fraction at which to evaluate `curve`\n   * @param curve curve to evaluate at `fraction`\n   * @returns distance of `Q` from the tangent plane at `X(t)`.\n  */\n  private evaluateFunction(pointAndDerivative?: Ray3d, fraction?: number, curve?: CurvePrimitive): number | undefined {\n    if (pointAndDerivative)\n      this._workRay.setFrom(pointAndDerivative);\n    else if (fraction !== undefined && curve)\n      this._workRay = curve.fractionToPointAndDerivative(fraction, this._workRay);\n    else\n      return undefined;\n    const cross = this._vectorToEye.unitCrossProduct(this._workRay.direction); // normalized so we return true distance\n    return cross ? cross.dotProductStartEnd(this._workRay.origin, this._spacePoint) : undefined;\n  }\n  /** Specified by NewtonRtoRStrokeHandler. */\n  public evaluate(fraction: number): boolean {\n    const curve = this._parentCurvePrimitive ?? this._curve;\n    const value = this.evaluateFunction(undefined, fraction, curve);\n    if (value === undefined)\n      return false;\n    this.currentF = value;\n    return true;\n  }\n  private announceRay(fraction: number, data: Ray3d): void {\n    this._functionB = this.evaluateFunction(data)!;\n    this._fractionB = fraction;\n    if (this._numThisCurve++ > 0) // after the first stroke point, a stroke segment is defined, so we have an interval\n      this.searchInterval();\n    this._functionA = this._functionB;\n    this._fractionA = this._fractionB;\n  }\n  /** Specified by IStrokeHandler. */\n  public announcePointTangent(_point: Point3d, _fraction: number, _tangent: Vector3d) {\n    assert(false, \"No callers expected. IStrokeHandler probably didn't need to specify this method.\");\n  }\n}\n"]}

package/lib/esm/curve/internalContexts/ClosestPointStrokeHandler.d.ts

@@ -3,7 +3,6 @@
  */
 import { IStrokeHandler } from "../../geometry3d/GeometryHandler";
 import { Point3d, Vector3d } from "../../geometry3d/Point3dVector3d";
-import { Ray3d } from "../../geometry3d/Ray3d";
 import { VariantCurveExtendParameter } from "../CurveExtendMode";
 import { CurveLocationDetail } from "../CurveLocationDetail";
 import { CurvePrimitive } from "../CurvePrimitive";
@@ -19,13 +18,14 @@ export declare class ClosestPointStrokeHandler extends NewtonRtoRStrokeHandler i
     private _extend;
     private _fractionA;
     private _functionA;
-    private _functionB;
     private _fractionB;
+    private _functionB;
     private _numThisCurve;
     private _workPoint;
     private _workRay;
     private _newtonSolver;
-    constructor(spacePoint: Point3d, extend: VariantCurveExtendParameter, result?: CurveLocationDetail);
+    /** Constructor */
+    constructor(spacePoint: Point3d, extend?: VariantCurveExtendParameter, result?: CurveLocationDetail);
     claimResult(): CurveLocationDetail | undefined;
     needPrimaryGeometryForStrokes(): boolean;
     startCurvePrimitive(curve: CurvePrimitive | undefined): void;
@@ -33,11 +33,27 @@ export declare class ClosestPointStrokeHandler extends NewtonRtoRStrokeHandler i
     announceIntervalForUniformStepStrokes(cp: CurvePrimitive, numStrokes: number, fraction0: number, fraction1: number): void;
     private announceCandidate;
     announceSegmentInterval(cp: CurvePrimitive, point0: Point3d, point1: Point3d, _numStrokes: number, fraction0: number, fraction1: number): void;
+    /**
+     * Given a function `f` and (unordered) fractions `a` and `b`, search for and announce a root of `f` in this
+     * fractional interval.
+     * * This method searches for a root of `f` if and only if the stroke segment defined by `(a, f(a))` and
+     * `(b, f(b))` has a root. This is a HEURISTIC: given continuous `f` between `a` and `b`, a root of the stroke
+     * segment implies a root of `f`, but not vice-versa. Therefore, if the strokes are not sufficiently dense,
+     * this method can miss a root of `f`.
+     */
     private searchInterval;
-    private evaluateB;
     private announceSolutionFraction;
+    /**
+     * Evaluate the univariate real-valued function for which we are finding roots.
+     * * For finding the closest point to curve X from point Q, this function is `f(t) := Q-X(t) dot X'(t)`.
+     * * Either `pointAndDerivative` must be defined, or both `fraction` and `curve`.
+     * @param pointAndDerivative pre-evaluated curve
+     * @param fraction fraction at which to evaluate `curve`
+     * @param curve curve to evaluate at `fraction`
+     */
+    private evaluateFunction;
     evaluate(fraction: number): boolean;
-    announceRay(fraction: number, data: Ray3d): void;
+    private announceRay;
     announcePointTangent(point: Point3d, fraction: number, tangent: Vector3d): void;
 }
 //# sourceMappingURL=ClosestPointStrokeHandler.d.ts.map

package/lib/esm/curve/internalContexts/ClosestPointStrokeHandler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ClosestPointStrokeHandler.d.ts","sourceRoot":"","sources":["../../../../src/curve/internalContexts/ClosestPointStrokeHandler.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAClE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAC;AAE/C,OAAO,EAAsB,2BAA2B,EAAE,MAAM,oBAAoB,CAAC;AACrF,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAEpE;;;GAGG;AACH,qBAAa,yBAA0B,SAAQ,uBAAwB,YAAW,cAAc;IAC9F,OAAO,CAAC,MAAM,CAA6B;IAC3C,OAAO,CAAC,aAAa,CAAkC;IACvD,OAAO,CAAC,WAAW,CAAU;IAC7B,OAAO,CAAC,OAAO,CAA8B;IAC7C,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,aAAa,CAAa;IAElC,OAAO,CAAC,UAAU,CAAU;IAC5B,OAAO,CAAC,QAAQ,CAAQ;IACxB,OAAO,CAAC,aAAa,CAAyC;gBAE3C,UAAU,EAAE,OAAO,EAAE,MAAM,EAAE,2BAA2B,EAAE,MAAM,CAAC,EAAE,mBAAmB;IAWlG,WAAW,IAAI,mBAAmB,GAAG,SAAS;IAa9C,6BAA6B;IAI7B,mBAAmB,CAAC,KAAK,EAAE,cAAc,GAAG,SAAS;IAOrD,iBAAiB;IAGjB,qCAAqC,CAAC,EAAE,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAahI,OAAO,CAAC,iBAAiB;IAUlB,uBAAuB,CAAC,EAAE,EAAE,cAAc,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAgBrJ,OAAO,CAAC,cAAc;IActB,OAAO,CAAC,SAAS;IAKjB,OAAO,CAAC,wBAAwB;IAKzB,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAYnC,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,GAAG,IAAI;IAOhD,oBAAoB,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ;CAIhF"}
+{"version":3,"file":"ClosestPointStrokeHandler.d.ts","sourceRoot":"","sources":["../../../../src/curve/internalContexts/ClosestPointStrokeHandler.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC;AAClE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAGrE,OAAO,EAAsB,2BAA2B,EAAE,MAAM,oBAAoB,CAAC;AACrF,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAEpE;;;GAGG;AACH,qBAAa,yBAA0B,SAAQ,uBAAwB,YAAW,cAAc;IAC9F,OAAO,CAAC,MAAM,CAA6B;IAC3C,OAAO,CAAC,aAAa,CAAkC;IACvD,OAAO,CAAC,WAAW,CAAU;IAC7B,OAAO,CAAC,OAAO,CAA8B;IAE7C,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,UAAU,CAAa;IAE/B,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,aAAa,CAAa;IAElC,OAAO,CAAC,UAAU,CAAU;IAC5B,OAAO,CAAC,QAAQ,CAAQ;IACxB,OAAO,CAAC,aAAa,CAAyC;IAC9D,kBAAkB;gBACC,UAAU,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,2BAA2B,EAAE,MAAM,CAAC,EAAE,mBAAmB;IAUnG,WAAW,IAAI,mBAAmB,GAAG,SAAS;IAY9C,6BAA6B;IAG7B,mBAAmB,CAAC,KAAK,EAAE,cAAc,GAAG,SAAS;IAMrD,iBAAiB;IAEjB,qCAAqC,CAC1C,EAAE,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAC3E,IAAI;IAaP,OAAO,CAAC,iBAAiB;IASlB,uBAAuB,CAC5B,EAAE,EAAE,cAAc,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAC9G,IAAI;IAeP;;;;;;;OAOG;IACH,OAAO,CAAC,cAAc;IAiBtB,OAAO,CAAC,wBAAwB;IAIhC;;;;;;;OAOG;IACH,OAAO,CAAC,gBAAgB;IASjB,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAU1C,OAAO,CAAC,WAAW;IAQZ,oBAAoB,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ;CAIhF"}

package/lib/esm/curve/internalContexts/ClosestPointStrokeHandler.js

@@ -21,22 +21,25 @@ export class ClosestPointStrokeHandler extends NewtonRtoRStrokeHandler {
     _closestPoint;
     _spacePoint;
     _extend;
+    // fraction and function value on one side of an interval that may bracket a root
     _fractionA = 0;
     _functionA = 0;
-    _functionB = 0;
+    // fraction and function value on the other side of an interval that may bracket a root
     _fractionB = 0;
+    _functionB = 0;
     _numThisCurve = 0;
-    // scratch vars for use within methods.
+    // scratch vars to use within methods
     _workPoint;
     _workRay;
     _newtonSolver;
+    /** Constructor */
     constructor(spacePoint, extend, result) {
         super();
         this._spacePoint = spacePoint;
         this._workPoint = Point3d.create();
         this._workRay = Ray3d.createZero();
         this._closestPoint = result;
-        this._extend = extend;
+        this._extend = extend ?? false;
         this.startCurvePrimitive(undefined);
         this._newtonSolver = new Newton1dUnboundedApproximateDerivative(this);
     }
@@ -87,7 +90,7 @@ export class ClosestPointStrokeHandler extends NewtonRtoRStrokeHandler {
     }
     announceSegmentInterval(cp, point0, point1, _numStrokes, fraction0, fraction1) {
         let localFraction = this._spacePoint.fractionOfProjectionToLine(point0, point1, 0.0);
-        // only consider extending the segment if the immediate caller says we are at endpoints ...
+        // only consider extending the segment if the immediate caller says we are at endpoints
         if (!this._extend)
             localFraction = Geometry.clampToStartEnd(localFraction, 0.0, 1.0);
         else {
@@ -100,13 +103,22 @@ export class ClosestPointStrokeHandler extends NewtonRtoRStrokeHandler {
         const globalFraction = Geometry.interpolate(fraction0, localFraction, fraction1);
         this.announceCandidate(cp, globalFraction, this._workPoint);
     }
+    /**
+     * Given a function `f` and (unordered) fractions `a` and `b`, search for and announce a root of `f` in this
+     * fractional interval.
+     * * This method searches for a root of `f` if and only if the stroke segment defined by `(a, f(a))` and
+     * `(b, f(b))` has a root. This is a HEURISTIC: given continuous `f` between `a` and `b`, a root of the stroke
+     * segment implies a root of `f`, but not vice-versa. Therefore, if the strokes are not sufficiently dense,
+     * this method can miss a root of `f`.
+     */
     searchInterval() {
         if (this._functionA * this._functionB > 0)
-            return;
+            return; // stroke segment has no root; ASSUME the function has no root either
         if (this._functionA === 0)
             this.announceSolutionFraction(this._fractionA);
         if (this._functionB === 0)
             this.announceSolutionFraction(this._fractionB);
+        // by the Intermediate Value Theorem, a root lies between fractionA and fractionB; use Newton to find it.
         if (this._functionA * this._functionB < 0) {
             const fraction = Geometry.inverseInterpolate(this._fractionA, this._functionA, this._fractionB, this._functionB);
             if (fraction) {
@@ -116,28 +128,41 @@ export class ClosestPointStrokeHandler extends NewtonRtoRStrokeHandler {
             }
         }
     }
-    evaluateB(fractionB, dataB) {
-        this._functionB = dataB.dotProductToPoint(this._spacePoint);
-        this._fractionB = fractionB;
-    }
     announceSolutionFraction(fraction) {
         if (this._curve)
             this.announceCandidate(this._curve, fraction, this._curve.fractionToPoint(fraction));
     }
+    /**
+     * Evaluate the univariate real-valued function for which we are finding roots.
+     * * For finding the closest point to curve X from point Q, this function is `f(t) := Q-X(t) dot X'(t)`.
+     * * Either `pointAndDerivative` must be defined, or both `fraction` and `curve`.
+     * @param pointAndDerivative pre-evaluated curve
+     * @param fraction fraction at which to evaluate `curve`
+     * @param curve curve to evaluate at `fraction`
+     */
+    evaluateFunction(pointAndDerivative, fraction, curve) {
+        if (pointAndDerivative)
+            this._workRay.setFrom(pointAndDerivative);
+        else if (fraction !== undefined && curve)
+            this._workRay = curve.fractionToPointAndDerivative(fraction, this._workRay);
+        else
+            return undefined;
+        return this._workRay.dotProductToPoint(this._spacePoint);
+    }
     evaluate(fraction) {
         let curve = this._curve;
         if (this._parentCurvePrimitive)
             curve = this._parentCurvePrimitive;
-        if (curve) {
-            this._workRay = curve.fractionToPointAndDerivative(fraction, this._workRay);
-            this.currentF = this._workRay.dotProductToPoint(this._spacePoint);
-            return true;
-        }
-        return false;
+        const value = this.evaluateFunction(undefined, fraction, curve);
+        if (value === undefined)
+            return false;
+        this.currentF = value;
+        return true;
     }
     announceRay(fraction, data) {
-        this.evaluateB(fraction, data);
-        if (this._numThisCurve++ > 0)
+        this._functionB = this.evaluateFunction(data);
+        this._fractionB = fraction;
+        if (this._numThisCurve++ > 0) // after the first stroke point, a stroke segment is defined, so we have an interval
             this.searchInterval();
         this._functionA = this._functionB;
         this._fractionA = this._fractionB;

package/lib/esm/curve/internalContexts/ClosestPointStrokeHandler.js.map

@@ -1 +1 @@
-{"version":3,"file":"ClosestPointStrokeHandler.js","sourceRoot":"","sources":["../../../../src/curve/internalContexts/ClosestPointStrokeHandler.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C,OAAO,EAAE,OAAO,EAAY,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAC;AAC/C,OAAO,EAAE,sCAAsC,EAAE,MAAM,uBAAuB,CAAC;AAC/E,OAAO,EAAE,kBAAkB,EAA+B,MAAM,oBAAoB,CAAC;AACrF,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAE7D,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAEpE;;;GAGG;AACH,MAAM,OAAO,yBAA0B,SAAQ,uBAAuB;IAC5D,MAAM,CAA6B;IACnC,aAAa,CAAkC;IAC/C,WAAW,CAAU;IACrB,OAAO,CAA8B;IACrC,UAAU,GAAW,CAAC,CAAC;IACvB,UAAU,GAAW,CAAC,CAAC;IACvB,UAAU,GAAW,CAAC,CAAC;IACvB,UAAU,GAAW,CAAC,CAAC;IACvB,aAAa,GAAW,CAAC,CAAC;IAClC,uCAAuC;IAC/B,UAAU,CAAU;IACpB,QAAQ,CAAQ;IAChB,aAAa,CAAyC;IAE9D,YAAmB,UAAmB,EAAE,MAAmC,EAAE,MAA4B;QACvG,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;QACnC,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,UAAU,EAAE,CAAC;QACnC,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC;QAC5B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;QACpC,IAAI,CAAC,aAAa,GAAG,IAAI,sCAAsC,CAAC,IAAI,CAAC,CAAC;IACxE,CAAC;IAEM,WAAW;QAChB,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;YACrD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC;YACvC,IAAI,IAAI,CAAC,aAAa,CAAC,aAAa,EAAE,EAAE,CAAC;gBACvC,IAAI,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC;gBACzC,QAAQ,GAAG,kBAAkB,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;gBACtE,IAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC;YAC1C,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAEM,6BAA6B;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,mBAAmB,CAAC,KAAiC;QAC1D,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;QACtB,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC;QACvB,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;IACxB,CAAC;IAEM,iBAAiB;IACxB,CAAC;IAEM,qCAAqC,CAAC,EAAkB,EAAE,UAAkB,EAAE,SAAiB,EAAE,SAAiB;QACvH,IAAI,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAC;QAC7B,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC,CAAC,8BAA8B;QAClE,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC,CAAC,4BAA4B;QAChE,IAAI,UAAU,GAAG,CAAC;YAAE,UAAU,GAAG,CAAC,CAAC;QACnC,MAAM,EAAE,GAAG,GAAG,GAAG,UAAU,CAAC;QAC5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,UAAU,EAAE,CAAC,EAAE,EAAE,CAAC;YACrC,MAAM,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,SAAS,EAAE,CAAC,GAAG,EAAE,EAAE,SAAS,CAAC,CAAC;YACpE,EAAE,CAAC,4BAA4B,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YACzD,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IAEO,iBAAiB,CAAC,EAAkB,EAAE,QAAgB,EAAE,KAAc;QAC5E,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAClD,IAAI,IAAI,CAAC,aAAa,IAAI,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC;YACvD,OAAO;QACT,IAAI,CAAC,aAAa,GAAG,mBAAmB,CAAC,wBAAwB,CAAC,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QAC3G,IAAI,CAAC,aAAa,CAAC,CAAC,GAAG,QAAQ,CAAC;QAChC,IAAI,IAAI,CAAC,qBAAqB,KAAK,SAAS;YAC1C,IAAI,CAAC,aAAa,CAAC,KAAK,GAAG,IAAI,CAAC,qBAAqB,CAAC;IAC1D,CAAC;IAEM,uBAAuB,CAAC,EAAkB,EAAE,MAAe,EAAE,MAAe,EAAE,WAAmB,EAAE,SAAiB,EAAE,SAAiB;QAC5I,IAAI,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC,0BAA0B,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC;QACrF,2FAA2F;QAC3F,IAAI,CAAC,IAAI,CAAC,OAAO;YACf,aAAa,GAAG,QAAQ,CAAC,eAAe,CAAC,aAAa,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;aAC/D,CAAC;YACJ,IAAI,SAAS,KAAK,GAAG;gBACnB,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;YAC/C,IAAI,SAAS,KAAK,GAAG;gBACnB,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;QACjD,CAAC;QACD,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,WAAW,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;QAC5D,MAAM,cAAc,GAAG,QAAQ,CAAC,WAAW,CAAC,SAAS,EAAE,aAAa,EAAE,SAAS,CAAC,CAAC;QACjF,IAAI,CAAC,iBAAiB,CAAC,EAAE,EAAE,cAAc,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IAC9D,CAAC;IAEO,cAAc;QACpB,IAAI,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,GAAG,CAAC;YAAE,OAAO;QAClD,IAAI,IAAI,CAAC,UAAU,KAAK,CAAC;YAAE,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC1E,IAAI,IAAI,CAAC,UAAU,KAAK,CAAC;YAAE,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC1E,IAAI,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,GAAG,CAAC,EAAE,CAAC;YAC1C,MAAM,QAAQ,GAAG,QAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;YACjH,IAAI,QAAQ,EAAE,CAAC;gBACb,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAClC,IAAI,IAAI,CAAC,aAAa,CAAC,aAAa,EAAE;oBACpC,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,CAAC;YAC7D,CAAC;QACH,CAAC;IACH,CAAC;IAEO,SAAS,CAAC,SAAiB,EAAE,KAAY;QAC/C,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,iBAAiB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC5D,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC9B,CAAC;IAEO,wBAAwB,CAAC,QAAgB;QAC/C,IAAI,IAAI,CAAC,MAAM;YACb,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC;IACzF,CAAC;IAEM,QAAQ,CAAC,QAAgB;QAC9B,IAAI,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC;QACxB,IAAI,IAAI,CAAC,qBAAqB;YAC5B,KAAK,GAAG,IAAI,CAAC,qBAAqB,CAAC;QACrC,IAAI,KAAK,EAAE,CAAC;YACV,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,4BAA4B,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC5E,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAClE,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,WAAW,CAAC,QAAgB,EAAE,IAAW;QAC9C,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAC/B,IAAI,IAAI,CAAC,aAAa,EAAE,GAAG,CAAC;YAAE,IAAI,CAAC,cAAc,EAAE,CAAC;QACpD,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QAClC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;IACpC,CAAC;IAEM,oBAAoB,CAAC,KAAc,EAAE,QAAgB,EAAE,OAAiB;QAC7E,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAClC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC5C,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Curve\n */\n\nimport { Geometry } from \"../../Geometry\";\nimport { IStrokeHandler } from \"../../geometry3d/GeometryHandler\";\nimport { Point3d, Vector3d } from \"../../geometry3d/Point3dVector3d\";\nimport { Ray3d } from \"../../geometry3d/Ray3d\";\nimport { Newton1dUnboundedApproximateDerivative } from \"../../numerics/Newton\";\nimport { CurveExtendOptions, VariantCurveExtendParameter } from \"../CurveExtendMode\";\nimport { CurveLocationDetail } from \"../CurveLocationDetail\";\nimport { CurvePrimitive } from \"../CurvePrimitive\";\nimport { NewtonRtoRStrokeHandler } from \"./NewtonRtoRStrokeHandler\";\n\n/**\n * Context for searching for the closest point to a CurvePrimitive.\n * @internal\n */\nexport class ClosestPointStrokeHandler extends NewtonRtoRStrokeHandler implements IStrokeHandler {\n  private _curve: CurvePrimitive | undefined;\n  private _closestPoint: CurveLocationDetail | undefined;\n  private _spacePoint: Point3d;\n  private _extend: VariantCurveExtendParameter;\n  private _fractionA: number = 0;\n  private _functionA: number = 0;\n  private _functionB: number = 0;\n  private _fractionB: number = 0;\n  private _numThisCurve: number = 0;\n  // scratch vars for use within methods.\n  private _workPoint: Point3d;\n  private _workRay: Ray3d;\n  private _newtonSolver: Newton1dUnboundedApproximateDerivative;\n\n  public constructor(spacePoint: Point3d, extend: VariantCurveExtendParameter, result?: CurveLocationDetail) {\n    super();\n    this._spacePoint = spacePoint;\n    this._workPoint = Point3d.create();\n    this._workRay = Ray3d.createZero();\n    this._closestPoint = result;\n    this._extend = extend;\n    this.startCurvePrimitive(undefined);\n    this._newtonSolver = new Newton1dUnboundedApproximateDerivative(this);\n  }\n\n  public claimResult(): CurveLocationDetail | undefined {\n    if (this._closestPoint) {\n      this._newtonSolver.setX(this._closestPoint.fraction);\n      this._curve = this._closestPoint.curve;\n      if (this._newtonSolver.runIterations()) {\n        let fraction = this._newtonSolver.getX();\n        fraction = CurveExtendOptions.correctFraction(this._extend, fraction);\n        this.announceSolutionFraction(fraction);\n      }\n    }\n    return this._closestPoint;\n  }\n\n  public needPrimaryGeometryForStrokes() {\n    return true;\n  }\n\n  public startCurvePrimitive(curve: CurvePrimitive | undefined) {\n    this._curve = curve;\n    this._fractionA = 0.0;\n    this._numThisCurve = 0;\n    this._functionA = 0.0;\n  }\n\n  public endCurvePrimitive() {\n  }\n\n  public announceIntervalForUniformStepStrokes(cp: CurvePrimitive, numStrokes: number, fraction0: number, fraction1: number): void {\n    this.startCurvePrimitive(cp);\n    this.announceSolutionFraction(0.0); // test start point as closest\n    this.announceSolutionFraction(1.0); // test end point as closest\n    if (numStrokes < 1) numStrokes = 1;\n    const df = 1.0 / numStrokes;\n    for (let i = 0; i <= numStrokes; i++) {\n      const fraction = Geometry.interpolate(fraction0, i * df, fraction1);\n      cp.fractionToPointAndDerivative(fraction, this._workRay);\n      this.announceRay(fraction, this._workRay);\n    }\n  }\n\n  private announceCandidate(cp: CurvePrimitive, fraction: number, point: Point3d) {\n    const distance = this._spacePoint.distance(point);\n    if (this._closestPoint && distance > this._closestPoint.a)\n      return;\n    this._closestPoint = CurveLocationDetail.createCurveFractionPoint(cp, fraction, point, this._closestPoint);\n    this._closestPoint.a = distance;\n    if (this._parentCurvePrimitive !== undefined)\n      this._closestPoint.curve = this._parentCurvePrimitive;\n  }\n\n  public announceSegmentInterval(cp: CurvePrimitive, point0: Point3d, point1: Point3d, _numStrokes: number, fraction0: number, fraction1: number): void {\n    let localFraction = this._spacePoint.fractionOfProjectionToLine(point0, point1, 0.0);\n    // only consider extending the segment if the immediate caller says we are at endpoints ...\n    if (!this._extend)\n      localFraction = Geometry.clampToStartEnd(localFraction, 0.0, 1.0);\n    else {\n      if (fraction0 !== 0.0)\n        localFraction = Math.max(localFraction, 0.0);\n      if (fraction1 !== 1.0)\n        localFraction = Math.min(localFraction, 1.0);\n    }\n    this._workPoint = point0.interpolate(localFraction, point1);\n    const globalFraction = Geometry.interpolate(fraction0, localFraction, fraction1);\n    this.announceCandidate(cp, globalFraction, this._workPoint);\n  }\n\n  private searchInterval() {\n    if (this._functionA * this._functionB > 0) return;\n    if (this._functionA === 0) this.announceSolutionFraction(this._fractionA);\n    if (this._functionB === 0) this.announceSolutionFraction(this._fractionB);\n    if (this._functionA * this._functionB < 0) {\n      const fraction = Geometry.inverseInterpolate(this._fractionA, this._functionA, this._fractionB, this._functionB);\n      if (fraction) {\n        this._newtonSolver.setX(fraction);\n        if (this._newtonSolver.runIterations())\n          this.announceSolutionFraction(this._newtonSolver.getX());\n      }\n    }\n  }\n\n  private evaluateB(fractionB: number, dataB: Ray3d) {\n    this._functionB = dataB.dotProductToPoint(this._spacePoint);\n    this._fractionB = fractionB;\n  }\n\n  private announceSolutionFraction(fraction: number) {\n    if (this._curve)\n      this.announceCandidate(this._curve, fraction, this._curve.fractionToPoint(fraction));\n  }\n\n  public evaluate(fraction: number): boolean {\n    let curve = this._curve;\n    if (this._parentCurvePrimitive)\n      curve = this._parentCurvePrimitive;\n    if (curve) {\n      this._workRay = curve.fractionToPointAndDerivative(fraction, this._workRay);\n      this.currentF = this._workRay.dotProductToPoint(this._spacePoint);\n      return true;\n    }\n    return false;\n  }\n\n  public announceRay(fraction: number, data: Ray3d): void {\n    this.evaluateB(fraction, data);\n    if (this._numThisCurve++ > 0) this.searchInterval();\n    this._functionA = this._functionB;\n    this._fractionA = this._fractionB;\n  }\n\n  public announcePointTangent(point: Point3d, fraction: number, tangent: Vector3d) {\n    this._workRay.set(point, tangent);\n    this.announceRay(fraction, this._workRay);\n  }\n}\n"]}
+{"version":3,"file":"ClosestPointStrokeHandler.js","sourceRoot":"","sources":["../../../../src/curve/internalContexts/ClosestPointStrokeHandler.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C,OAAO,EAAE,OAAO,EAAY,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAC;AAC/C,OAAO,EAAE,sCAAsC,EAAE,MAAM,uBAAuB,CAAC;AAC/E,OAAO,EAAE,kBAAkB,EAA+B,MAAM,oBAAoB,CAAC;AACrF,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAE7D,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAEpE;;;GAGG;AACH,MAAM,OAAO,yBAA0B,SAAQ,uBAAuB;IAC5D,MAAM,CAA6B;IACnC,aAAa,CAAkC;IAC/C,WAAW,CAAU;IACrB,OAAO,CAA8B;IAC7C,iFAAiF;IACzE,UAAU,GAAW,CAAC,CAAC;IACvB,UAAU,GAAW,CAAC,CAAC;IAC/B,uFAAuF;IAC/E,UAAU,GAAW,CAAC,CAAC;IACvB,UAAU,GAAW,CAAC,CAAC;IACvB,aAAa,GAAW,CAAC,CAAC;IAClC,qCAAqC;IAC7B,UAAU,CAAU;IACpB,QAAQ,CAAQ;IAChB,aAAa,CAAyC;IAC9D,kBAAkB;IAClB,YAAmB,UAAmB,EAAE,MAAoC,EAAE,MAA4B;QACxG,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;QACnC,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,UAAU,EAAE,CAAC;QACnC,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC;QAC5B,IAAI,CAAC,OAAO,GAAG,MAAM,IAAI,KAAK,CAAC;QAC/B,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;QACpC,IAAI,CAAC,aAAa,GAAG,IAAI,sCAAsC,CAAC,IAAI,CAAC,CAAC;IACxE,CAAC;IACM,WAAW;QAChB,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;YACrD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC;YACvC,IAAI,IAAI,CAAC,aAAa,CAAC,aAAa,EAAE,EAAE,CAAC;gBACvC,IAAI,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC;gBACzC,QAAQ,GAAG,kBAAkB,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;gBACtE,IAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC;YAC1C,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IACM,6BAA6B;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IACM,mBAAmB,CAAC,KAAiC;QAC1D,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;QACtB,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC;QACvB,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;IACxB,CAAC;IACM,iBAAiB;IACxB,CAAC;IACM,qCAAqC,CAC1C,EAAkB,EAAE,UAAkB,EAAE,SAAiB,EAAE,SAAiB;QAE5E,IAAI,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAC;QAC7B,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC,CAAC,8BAA8B;QAClE,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC,CAAC,4BAA4B;QAChE,IAAI,UAAU,GAAG,CAAC;YAChB,UAAU,GAAG,CAAC,CAAC;QACjB,MAAM,EAAE,GAAG,GAAG,GAAG,UAAU,CAAC;QAC5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,UAAU,EAAE,CAAC,EAAE,EAAE,CAAC;YACrC,MAAM,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,SAAS,EAAE,CAAC,GAAG,EAAE,EAAE,SAAS,CAAC,CAAC;YACpE,EAAE,CAAC,4BAA4B,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YACzD,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IACO,iBAAiB,CAAC,EAAkB,EAAE,QAAgB,EAAE,KAAc;QAC5E,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAClD,IAAI,IAAI,CAAC,aAAa,IAAI,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC;YACvD,OAAO;QACT,IAAI,CAAC,aAAa,GAAG,mBAAmB,CAAC,wBAAwB,CAAC,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QAC3G,IAAI,CAAC,aAAa,CAAC,CAAC,GAAG,QAAQ,CAAC;QAChC,IAAI,IAAI,CAAC,qBAAqB,KAAK,SAAS;YAC1C,IAAI,CAAC,aAAa,CAAC,KAAK,GAAG,IAAI,CAAC,qBAAqB,CAAC;IAC1D,CAAC;IACM,uBAAuB,CAC5B,EAAkB,EAAE,MAAe,EAAE,MAAe,EAAE,WAAmB,EAAE,SAAiB,EAAE,SAAiB;QAE/G,IAAI,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC,0BAA0B,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC;QACrF,uFAAuF;QACvF,IAAI,CAAC,IAAI,CAAC,OAAO;YACf,aAAa,GAAG,QAAQ,CAAC,eAAe,CAAC,aAAa,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;aAC/D,CAAC;YACJ,IAAI,SAAS,KAAK,GAAG;gBACnB,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;YAC/C,IAAI,SAAS,KAAK,GAAG;gBACnB,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;QACjD,CAAC;QACD,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,WAAW,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;QAC5D,MAAM,cAAc,GAAG,QAAQ,CAAC,WAAW,CAAC,SAAS,EAAE,aAAa,EAAE,SAAS,CAAC,CAAC;QACjF,IAAI,CAAC,iBAAiB,CAAC,EAAE,EAAE,cAAc,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IAC9D,CAAC;IACD;;;;;;;OAOG;IACK,cAAc;QACpB,IAAI,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,GAAG,CAAC;YACvC,OAAO,CAAC,qEAAqE;QAC/E,IAAI,IAAI,CAAC,UAAU,KAAK,CAAC;YACvB,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACjD,IAAI,IAAI,CAAC,UAAU,KAAK,CAAC;YACvB,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACjD,yGAAyG;QACzG,IAAI,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,GAAG,CAAC,EAAE,CAAC;YAC1C,MAAM,QAAQ,GAAG,QAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;YACjH,IAAI,QAAQ,EAAE,CAAC;gBACb,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAClC,IAAI,IAAI,CAAC,aAAa,CAAC,aAAa,EAAE;oBACpC,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,CAAC;YAC7D,CAAC;QACH,CAAC;IACH,CAAC;IACO,wBAAwB,CAAC,QAAgB;QAC/C,IAAI,IAAI,CAAC,MAAM;YACb,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC;IACzF,CAAC;IACD;;;;;;;OAOG;IACK,gBAAgB,CAAC,kBAA0B,EAAE,QAAiB,EAAE,KAAsB;QAC5F,IAAI,kBAAkB;YACpB,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;aACvC,IAAI,QAAQ,KAAK,SAAS,IAAI,KAAK;YACtC,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,4BAA4B,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;;YAE5E,OAAO,SAAS,CAAC;QACnB,OAAO,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAC3D,CAAC;IACM,QAAQ,CAAC,QAAgB;QAC9B,IAAI,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC;QACxB,IAAI,IAAI,CAAC,qBAAqB;YAC5B,KAAK,GAAG,IAAI,CAAC,qBAAqB,CAAC;QACrC,MAAM,KAAK,GAAG,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;QAChE,IAAI,KAAK,KAAK,SAAS;YACrB,OAAO,KAAK,CAAC;QACf,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IACO,WAAW,CAAC,QAAgB,EAAE,IAAW;QAC/C,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAE,CAAC;QAC/C,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC;QAC3B,IAAI,IAAI,CAAC,aAAa,EAAE,GAAG,CAAC,EAAE,oFAAoF;YAChH,IAAI,CAAC,cAAc,EAAE,CAAC;QACxB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QAClC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;IACpC,CAAC;IACM,oBAAoB,CAAC,KAAc,EAAE,QAAgB,EAAE,OAAiB;QAC7E,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAClC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC5C,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Curve\n */\n\nimport { Geometry } from \"../../Geometry\";\nimport { IStrokeHandler } from \"../../geometry3d/GeometryHandler\";\nimport { Point3d, Vector3d } from \"../../geometry3d/Point3dVector3d\";\nimport { Ray3d } from \"../../geometry3d/Ray3d\";\nimport { Newton1dUnboundedApproximateDerivative } from \"../../numerics/Newton\";\nimport { CurveExtendOptions, VariantCurveExtendParameter } from \"../CurveExtendMode\";\nimport { CurveLocationDetail } from \"../CurveLocationDetail\";\nimport { CurvePrimitive } from \"../CurvePrimitive\";\nimport { NewtonRtoRStrokeHandler } from \"./NewtonRtoRStrokeHandler\";\n\n/**\n * Context for searching for the closest point to a CurvePrimitive.\n * @internal\n */\nexport class ClosestPointStrokeHandler extends NewtonRtoRStrokeHandler implements IStrokeHandler {\n  private _curve: CurvePrimitive | undefined;\n  private _closestPoint: CurveLocationDetail | undefined;\n  private _spacePoint: Point3d;\n  private _extend: VariantCurveExtendParameter;\n  // fraction and function value on one side of an interval that may bracket a root\n  private _fractionA: number = 0;\n  private _functionA: number = 0;\n  // fraction and function value on the other side of an interval that may bracket a root\n  private _fractionB: number = 0;\n  private _functionB: number = 0;\n  private _numThisCurve: number = 0;\n  // scratch vars to use within methods\n  private _workPoint: Point3d;\n  private _workRay: Ray3d;\n  private _newtonSolver: Newton1dUnboundedApproximateDerivative;\n  /** Constructor */\n  public constructor(spacePoint: Point3d, extend?: VariantCurveExtendParameter, result?: CurveLocationDetail) {\n    super();\n    this._spacePoint = spacePoint;\n    this._workPoint = Point3d.create();\n    this._workRay = Ray3d.createZero();\n    this._closestPoint = result;\n    this._extend = extend ?? false;\n    this.startCurvePrimitive(undefined);\n    this._newtonSolver = new Newton1dUnboundedApproximateDerivative(this);\n  }\n  public claimResult(): CurveLocationDetail | undefined {\n    if (this._closestPoint) {\n      this._newtonSolver.setX(this._closestPoint.fraction);\n      this._curve = this._closestPoint.curve;\n      if (this._newtonSolver.runIterations()) {\n        let fraction = this._newtonSolver.getX();\n        fraction = CurveExtendOptions.correctFraction(this._extend, fraction);\n        this.announceSolutionFraction(fraction);\n      }\n    }\n    return this._closestPoint;\n  }\n  public needPrimaryGeometryForStrokes() {\n    return true;\n  }\n  public startCurvePrimitive(curve: CurvePrimitive | undefined) {\n    this._curve = curve;\n    this._fractionA = 0.0;\n    this._numThisCurve = 0;\n    this._functionA = 0.0;\n  }\n  public endCurvePrimitive() {\n  }\n  public announceIntervalForUniformStepStrokes(\n    cp: CurvePrimitive, numStrokes: number, fraction0: number, fraction1: number,\n  ): void {\n    this.startCurvePrimitive(cp);\n    this.announceSolutionFraction(0.0); // test start point as closest\n    this.announceSolutionFraction(1.0); // test end point as closest\n    if (numStrokes < 1)\n      numStrokes = 1;\n    const df = 1.0 / numStrokes;\n    for (let i = 0; i <= numStrokes; i++) {\n      const fraction = Geometry.interpolate(fraction0, i * df, fraction1);\n      cp.fractionToPointAndDerivative(fraction, this._workRay);\n      this.announceRay(fraction, this._workRay);\n    }\n  }\n  private announceCandidate(cp: CurvePrimitive, fraction: number, point: Point3d) {\n    const distance = this._spacePoint.distance(point);\n    if (this._closestPoint && distance > this._closestPoint.a)\n      return;\n    this._closestPoint = CurveLocationDetail.createCurveFractionPoint(cp, fraction, point, this._closestPoint);\n    this._closestPoint.a = distance;\n    if (this._parentCurvePrimitive !== undefined)\n      this._closestPoint.curve = this._parentCurvePrimitive;\n  }\n  public announceSegmentInterval(\n    cp: CurvePrimitive, point0: Point3d, point1: Point3d, _numStrokes: number, fraction0: number, fraction1: number,\n  ): void {\n    let localFraction = this._spacePoint.fractionOfProjectionToLine(point0, point1, 0.0);\n    // only consider extending the segment if the immediate caller says we are at endpoints\n    if (!this._extend)\n      localFraction = Geometry.clampToStartEnd(localFraction, 0.0, 1.0);\n    else {\n      if (fraction0 !== 0.0)\n        localFraction = Math.max(localFraction, 0.0);\n      if (fraction1 !== 1.0)\n        localFraction = Math.min(localFraction, 1.0);\n    }\n    this._workPoint = point0.interpolate(localFraction, point1);\n    const globalFraction = Geometry.interpolate(fraction0, localFraction, fraction1);\n    this.announceCandidate(cp, globalFraction, this._workPoint);\n  }\n  /**\n   * Given a function `f` and (unordered) fractions `a` and `b`, search for and announce a root of `f` in this\n   * fractional interval.\n   * * This method searches for a root of `f` if and only if the stroke segment defined by `(a, f(a))` and\n   * `(b, f(b))` has a root. This is a HEURISTIC: given continuous `f` between `a` and `b`, a root of the stroke\n   * segment implies a root of `f`, but not vice-versa. Therefore, if the strokes are not sufficiently dense,\n   * this method can miss a root of `f`.\n   */\n  private searchInterval() {\n    if (this._functionA * this._functionB > 0)\n      return; // stroke segment has no root; ASSUME the function has no root either\n    if (this._functionA === 0)\n      this.announceSolutionFraction(this._fractionA);\n    if (this._functionB === 0)\n      this.announceSolutionFraction(this._fractionB);\n    // by the Intermediate Value Theorem, a root lies between fractionA and fractionB; use Newton to find it.\n    if (this._functionA * this._functionB < 0) {\n      const fraction = Geometry.inverseInterpolate(this._fractionA, this._functionA, this._fractionB, this._functionB);\n      if (fraction) {\n        this._newtonSolver.setX(fraction);\n        if (this._newtonSolver.runIterations())\n          this.announceSolutionFraction(this._newtonSolver.getX());\n      }\n    }\n  }\n  private announceSolutionFraction(fraction: number) {\n    if (this._curve)\n      this.announceCandidate(this._curve, fraction, this._curve.fractionToPoint(fraction));\n  }\n  /**\n   * Evaluate the univariate real-valued function for which we are finding roots.\n   * * For finding the closest point to curve X from point Q, this function is `f(t) := Q-X(t) dot X'(t)`.\n   * * Either `pointAndDerivative` must be defined, or both `fraction` and `curve`.\n   * @param pointAndDerivative pre-evaluated curve\n   * @param fraction fraction at which to evaluate `curve`\n   * @param curve curve to evaluate at `fraction`\n   */\n  private evaluateFunction(pointAndDerivative?: Ray3d, fraction?: number, curve?: CurvePrimitive): number | undefined {\n    if (pointAndDerivative)\n      this._workRay.setFrom(pointAndDerivative);\n    else if (fraction !== undefined && curve)\n      this._workRay = curve.fractionToPointAndDerivative(fraction, this._workRay);\n    else\n      return undefined;\n    return this._workRay.dotProductToPoint(this._spacePoint);\n  }\n  public evaluate(fraction: number): boolean {\n    let curve = this._curve;\n    if (this._parentCurvePrimitive)\n      curve = this._parentCurvePrimitive;\n    const value = this.evaluateFunction(undefined, fraction, curve);\n    if (value === undefined)\n      return false;\n    this.currentF = value;\n    return true;\n  }\n  private announceRay(fraction: number, data: Ray3d): void {\n    this._functionB = this.evaluateFunction(data)!;\n    this._fractionB = fraction;\n    if (this._numThisCurve++ > 0) // after the first stroke point, a stroke segment is defined, so we have an interval\n      this.searchInterval();\n    this._functionA = this._functionB;\n    this._fractionA = this._fractionB;\n  }\n  public announcePointTangent(point: Point3d, fraction: number, tangent: Vector3d) {\n    this._workRay.set(point, tangent);\n    this.announceRay(fraction, this._workRay);\n  }\n}\n"]}

package/lib/esm/curve/internalContexts/NewtonRtoRStrokeHandler.d.ts

@@ -3,16 +3,18 @@
  */
 import { NewtonEvaluatorRtoR } from "../../numerics/Newton";
 import { CurvePrimitive } from "../CurvePrimitive";
-/** Intermediate class for managing the parentCurve announcements from an IStrokeHandler.
+/**
+ * Intermediate class for managing the parentCurve announcements from an IStrokeHandler.
  * @internal
  */
 export declare abstract class NewtonRtoRStrokeHandler extends NewtonEvaluatorRtoR {
     protected _parentCurvePrimitive: CurvePrimitive | undefined;
     constructor();
-    /** retain the parentCurvePrimitive.
+    /**
+     * Retain the parentCurvePrimitive.
      * * Calling this method tells the handler that the parent curve is to be used for detail searches.
      * * Example: Transition spiral search is based on linestring first, then the exact spiral.
-     * * Example: CurveChainWithDistanceIndex does NOT do this announcement -- the constituents act independently.
+     * * Example: CurveChainWithDistanceIndex does NOT do this announcement; the constituents act independently.
      */
     startParentCurvePrimitive(curve: CurvePrimitive | undefined): void;
     /** Forget the parentCurvePrimitive */

package/lib/esm/curve/internalContexts/NewtonRtoRStrokeHandler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"NewtonRtoRStrokeHandler.d.ts","sourceRoot":"","sources":["../../../../src/curve/internalContexts/NewtonRtoRStrokeHandler.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAEnD;;GAEG;AACH,8BAAsB,uBAAwB,SAAQ,mBAAmB;IACvE,SAAS,CAAC,qBAAqB,EAAE,cAAc,GAAG,SAAS,CAAC;;IAO5D;;;;OAIG;IACI,yBAAyB,CAAC,KAAK,EAAE,cAAc,GAAG,SAAS;IAIlE,sCAAsC;IAC/B,uBAAuB,CAAC,MAAM,EAAE,cAAc,GAAG,SAAS;CAGlE"}
+{"version":3,"file":"NewtonRtoRStrokeHandler.d.ts","sourceRoot":"","sources":["../../../../src/curve/internalContexts/NewtonRtoRStrokeHandler.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAEnD;;;GAGG;AACH,8BAAsB,uBAAwB,SAAQ,mBAAmB;IACvE,SAAS,CAAC,qBAAqB,EAAE,cAAc,GAAG,SAAS,CAAC;;IAK5D;;;;;OAKG;IACI,yBAAyB,CAAC,KAAK,EAAE,cAAc,GAAG,SAAS,GAAG,IAAI;IAGzE,sCAAsC;IAC/B,uBAAuB,CAAC,MAAM,EAAE,cAAc,GAAG,SAAS,GAAG,IAAI;CAGzE"}

package/lib/esm/curve/internalContexts/NewtonRtoRStrokeHandler.js

@@ -6,7 +6,8 @@
  * @module Curve
  */
 import { NewtonEvaluatorRtoR } from "../../numerics/Newton";
-/** Intermediate class for managing the parentCurve announcements from an IStrokeHandler.
+/**
+ * Intermediate class for managing the parentCurve announcements from an IStrokeHandler.
  * @internal
  */
 export class NewtonRtoRStrokeHandler extends NewtonEvaluatorRtoR {
@@ -15,10 +16,11 @@ export class NewtonRtoRStrokeHandler extends NewtonEvaluatorRtoR {
         super();
         this._parentCurvePrimitive = undefined;
     }
-    /** retain the parentCurvePrimitive.
+    /**
+     * Retain the parentCurvePrimitive.
      * * Calling this method tells the handler that the parent curve is to be used for detail searches.
      * * Example: Transition spiral search is based on linestring first, then the exact spiral.
-     * * Example: CurveChainWithDistanceIndex does NOT do this announcement -- the constituents act independently.
+     * * Example: CurveChainWithDistanceIndex does NOT do this announcement; the constituents act independently.
      */
     startParentCurvePrimitive(curve) {
         this._parentCurvePrimitive = curve;

package/lib/esm/curve/internalContexts/NewtonRtoRStrokeHandler.js.map

@@ -1 +1 @@
-{"version":3,"file":"NewtonRtoRStrokeHandler.js","sourceRoot":"","sources":["../../../../src/curve/internalContexts/NewtonRtoRStrokeHandler.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAG5D;;GAEG;AACH,MAAM,OAAgB,uBAAwB,SAAQ,mBAAmB;IAC7D,qBAAqB,CAA6B;IAE5D;QACE,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,qBAAqB,GAAG,SAAS,CAAC;IACzC,CAAC;IAED;;;;OAIG;IACI,yBAAyB,CAAC,KAAiC;QAChE,IAAI,CAAC,qBAAqB,GAAG,KAAK,CAAC;IACrC,CAAC;IAED,sCAAsC;IAC/B,uBAAuB,CAAC,MAAkC;QAC/D,IAAI,CAAC,qBAAqB,GAAG,SAAS,CAAC;IACzC,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Curve\n */\n\nimport { NewtonEvaluatorRtoR } from \"../../numerics/Newton\";\nimport { CurvePrimitive } from \"../CurvePrimitive\";\n\n/** Intermediate class for managing the parentCurve announcements from an IStrokeHandler.\n * @internal\n */\nexport abstract class NewtonRtoRStrokeHandler extends NewtonEvaluatorRtoR {\n  protected _parentCurvePrimitive: CurvePrimitive | undefined;\n\n  constructor() {\n    super();\n    this._parentCurvePrimitive = undefined;\n  }\n\n  /** retain the parentCurvePrimitive.\n   * * Calling this method tells the handler that the parent curve is to be used for detail searches.\n   * * Example: Transition spiral search is based on linestring first, then the exact spiral.\n   * * Example: CurveChainWithDistanceIndex does NOT do this announcement -- the constituents act independently.\n   */\n  public startParentCurvePrimitive(curve: CurvePrimitive | undefined) {\n    this._parentCurvePrimitive = curve;\n  }\n\n  /** Forget the parentCurvePrimitive */\n  public endParentCurvePrimitive(_curve: CurvePrimitive | undefined) {\n    this._parentCurvePrimitive = undefined;\n  }\n}\n"]}
+{"version":3,"file":"NewtonRtoRStrokeHandler.js","sourceRoot":"","sources":["../../../../src/curve/internalContexts/NewtonRtoRStrokeHandler.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAG5D;;;GAGG;AACH,MAAM,OAAgB,uBAAwB,SAAQ,mBAAmB;IAC7D,qBAAqB,CAA6B;IAC5D;QACE,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,qBAAqB,GAAG,SAAS,CAAC;IACzC,CAAC;IACD;;;;;OAKG;IACI,yBAAyB,CAAC,KAAiC;QAChE,IAAI,CAAC,qBAAqB,GAAG,KAAK,CAAC;IACrC,CAAC;IACD,sCAAsC;IAC/B,uBAAuB,CAAC,MAAkC;QAC/D,IAAI,CAAC,qBAAqB,GAAG,SAAS,CAAC;IACzC,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Curve\n */\n\nimport { NewtonEvaluatorRtoR } from \"../../numerics/Newton\";\nimport { CurvePrimitive } from \"../CurvePrimitive\";\n\n/**\n * Intermediate class for managing the parentCurve announcements from an IStrokeHandler.\n * @internal\n */\nexport abstract class NewtonRtoRStrokeHandler extends NewtonEvaluatorRtoR {\n  protected _parentCurvePrimitive: CurvePrimitive | undefined;\n  constructor() {\n    super();\n    this._parentCurvePrimitive = undefined;\n  }\n  /**\n   * Retain the parentCurvePrimitive.\n   * * Calling this method tells the handler that the parent curve is to be used for detail searches.\n   * * Example: Transition spiral search is based on linestring first, then the exact spiral.\n   * * Example: CurveChainWithDistanceIndex does NOT do this announcement; the constituents act independently.\n   */\n  public startParentCurvePrimitive(curve: CurvePrimitive | undefined): void {\n    this._parentCurvePrimitive = curve;\n  }\n  /** Forget the parentCurvePrimitive */\n  public endParentCurvePrimitive(_curve: CurvePrimitive | undefined): void {\n    this._parentCurvePrimitive = undefined;\n  }\n}\n"]}

package/lib/esm/geometry3d/AngleSweep.d.ts

@@ -119,7 +119,7 @@ export declare class AngleSweep implements BeJSONFunctions {
     /** Convert fractional position in the sweep to strongly typed Angle object. */
     fractionToAngle(fraction: number): Angle;
     /**
-     * Return 2PI divided by the sweep radians (i.e. 360 degrees divided by sweep angle).
+     * Return 2PI divided by the sweep radians.
      * * This is the number of fractional intervals required to cover a whole circle.
      * @returns period of the sweep, or 1 if sweep is empty.
      */