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

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

@@ -0,0 +1,207 @@
+import { Point3d, Vector3d } from "../geometry3d/Point3dVector3d";
+import { Ray3d } from "../geometry3d/Ray3d";
+import { CurvePrimitive } from "./CurvePrimitive";
+/**
+ * An enumeration of special conditions being described by a CurveLocationDetail.
+ * @public
+ */
+export declare enum CurveIntervalRole {
+    /** This point is an isolated point NOT at a primary vertex. */
+    isolated = 0,
+    /**  This point is an isolated vertex hit */
+    isolatedAtVertex = 1,
+    /** This is the beginning of an interval */
+    intervalStart = 10,
+    /** This is an interior point of an interval. */
+    intervalInterior = 11,
+    /** This is the end of an interval */
+    intervalEnd = 12
+}
+/**
+ * Return code for CurvePrimitive method `moveSignedDistanceFromFraction`
+ * @public
+ */
+export declare enum CurveSearchStatus {
+    /** unimplemented or zero length curve  */
+    error = 0,
+    /** complete success of search */
+    success = 1,
+    /** search ended prematurely (e.g. at incomplete distance moved) at start or end of curve */
+    stoppedAtBoundary = 2
+}
+/**
+ * CurveLocationDetail carries point and paramter data about a point evaluated on a curve.
+ * * These are returned by a variety of queries.
+ * * Particular contents can vary among the queries.
+ * @public
+ */
+export declare class CurveLocationDetail {
+    /** The curve being evaluated */
+    curve?: CurvePrimitive;
+    /** optional ray */
+    ray?: Ray3d;
+    /** The fractional position along the curve */
+    fraction: number;
+    /** Detail condition of the role this point has in some context */
+    intervalRole?: CurveIntervalRole;
+    /** The point on the curve */
+    point: Point3d;
+    /** A vector (e.g. tangent vector) in context */
+    vectorInCurveLocationDetail?: Vector3d;
+    /** A context-specific numeric value.  (E.g. a distance) */
+    a: number;
+    /** optional CurveLocationDetail with more detail of location.  For instance, a detail for fractional position within
+     * a CurveChainWithDistanceIndex returns fraction and distance along the chain as its primary data and
+     * further detail of the particular curve within the chain in the childDetail.
+     */
+    childDetail?: CurveLocationDetail;
+    /** A status indicator for certain searches.
+     * * e.g. CurvePrimitive.moveSignedDistanceFromFraction
+     */
+    curveSearchStatus?: CurveSearchStatus;
+    /** (optional) second fraction, e.g. end of interval of coincident curves */
+    fraction1?: number;
+    /** (optional) second point, e.g. end of interval of coincident curves */
+    point1?: Point3d;
+    /** A context-specific additional point */
+    pointQ: Point3d;
+    constructor();
+    /** Set the (optional) intervalRole field */
+    setIntervalRole(value: CurveIntervalRole): void;
+    /** Set the (optional) fraction1 and point1, using direct assignment (capture!) to point1 */
+    captureFraction1Point1(fraction1: number, point1: Point3d): void;
+    /** test if this pair has fraction1 defined */
+    get hasFraction1(): boolean;
+    /** test if this is an isolated point. This is true if intervalRole is any of (undefined, isolated, isolatedAtVertex) */
+    get isIsolated(): boolean;
+    /** return the fraction delta. (0 if no fraction1) */
+    get fractionDelta(): number;
+    /** If (fraction1, point1) are defined, make them the primary (and only) data.
+     * * No action if undefined.
+     */
+    collapseToEnd(): void;
+    /** make (fraction, point) the primary (and only) data.
+     * * No action if undefined.
+     */
+    collapseToStart(): void;
+    /** Return a complete copy, WITH CAVEATS . . .
+     * * curve member is copied as a reference.
+     * * point and vector members are cloned.
+     */
+    clone(result?: CurveLocationDetail): CurveLocationDetail;
+    /**
+     * Updated in this instance.
+     * * Note that if caller omits `vector` and `a`, those fields are updated to the call-list defaults (NOT left as-is)
+     * * point and vector updates are by data copy (not capture of pointers)
+     * @param fraction (required) fraction to install
+     * @param point  (required) point to install
+     * @param vector (optional) vector to install.
+     * @param a (optional) numeric value to install.
+     */
+    setFP(fraction: number, point: Point3d, vector?: Vector3d, a?: number): void;
+    /**
+     * Updated in this instance.
+     * * Note that if caller omits a`, that field is updated to the call-list default (NOT left as-is)
+     * * point and vector updates are by data copy (not capture of the ray members)
+     * @param fraction (required) fraction to install
+     * @param ray  (required) point and vector to install
+     * @param a (optional) numeric value to install.
+     */
+    setFR(fraction: number, ray: Ray3d, a?: number): void;
+    /** Set the CurvePrimitive pointer, leaving all other properties untouched.
+     */
+    setCurve(curve: CurvePrimitive): void;
+    /** record the distance from the CurveLocationDetail's point to the parameter point. */
+    setDistanceTo(point: Point3d): void;
+    /** create with a CurvePrimitive pointer but no coordinate data.
+     */
+    static create(curve?: CurvePrimitive, result?: CurveLocationDetail): CurveLocationDetail;
+    /** create with CurvePrimitive pointer, fraction, and point coordinates.
+     */
+    static createCurveFractionPoint(curve: CurvePrimitive | undefined, fraction: number, point: Point3d, result?: CurveLocationDetail): CurveLocationDetail;
+    /**
+     * Create a new detail with only ray, fraction, and point.
+     */
+    static createRayFractionPoint(ray: Ray3d, fraction: number, point: Point3d, result?: CurveLocationDetail): CurveLocationDetail;
+    /** create with CurvePrimitive pointer, fraction, and point coordinates
+     */
+    static createCurveFractionPointDistanceCurveSearchStatus(curve: CurvePrimitive | undefined, fraction: number, point: Point3d, distance: number, status: CurveSearchStatus, result?: CurveLocationDetail): CurveLocationDetail;
+    /** create with curveSearchStatus affected by allowExtension.
+     * *
+     */
+    static createConditionalMoveSignedDistance(allowExtension: boolean, curve: CurvePrimitive, startFraction: number, endFraction: number, requestedSignedDistance: number, result?: CurveLocationDetail): CurveLocationDetail;
+    /** create with CurvePrimitive pointer and fraction for evaluation.
+     */
+    static createCurveEvaluatedFraction(curve: CurvePrimitive, fraction: number, result?: CurveLocationDetail): CurveLocationDetail;
+    /** create with CurvePrimitive pointer and fraction for evaluation.
+     */
+    static createCurveEvaluatedFractionPointAndDerivative(curve: CurvePrimitive, fraction: number, result?: CurveLocationDetail): CurveLocationDetail;
+    /** create with CurvePrimitive pointer and 2 fractions for evaluation.
+     */
+    static createCurveEvaluatedFractionFraction(curve: CurvePrimitive, fraction0: number, fraction1: number, result?: CurveLocationDetail): CurveLocationDetail;
+    /** create with CurvePrimitive pointer, fraction, and point coordinates.
+     */
+    static createCurveFractionPointDistance(curve: CurvePrimitive, fraction: number, point: Point3d, a: number, result?: CurveLocationDetail): CurveLocationDetail;
+    /** update or create if closer than current contents.
+     * @param curve candidate curve
+     * @param fraction candidate fraction
+     * @param point candidate point
+     * @param a candidate distance
+     * @returns true if the given distance is smaller (and hence this detail was updated.)
+     */
+    updateIfCloserCurveFractionPointDistance(curve: CurvePrimitive, fraction: number, point: Point3d, a: number): boolean;
+    /**
+     * * Exchange the (fraction,fraction1) and (point, point1) pairs.
+     * * (Skip each swap if its "1" value is undefined)
+     */
+    swapFractionsAndPoints(): void;
+    /**
+     * * return the fraction where f falls between fraction and fraction1.
+     * * ASSUME fraction1 defined
+     */
+    inverseInterpolateFraction(f: number, defaultFraction?: number): number;
+    /**
+     * Return the detail with smaller `a` value -- detailA returned if equal.
+     * @param detailA first candidate
+     * @param detailB second candidate
+     */
+    static chooseSmallerA(detailA: CurveLocationDetail | undefined, detailB: CurveLocationDetail | undefined): CurveLocationDetail | undefined;
+}
+/** Enumeration of configurations for intersections and min/max distance-between-curve
+ * @public
+ */
+export declare enum CurveCurveApproachType {
+    /** Intersection at a single point */
+    Intersection = 0,
+    /** Distinct points on the two curves, with each curve's tangent perpendicular to the chord between the points */
+    PerpendicularChord = 1,
+    /** Completely coincident geometry */
+    CoincidentGeometry = 2,
+    /** Completely parallel geometry. */
+    ParallelGeometry = 3
+}
+/** A pair of CurveLocationDetail.
+ * @public
+ */
+export declare class CurveLocationDetailPair {
+    /** The first of the two details ... */
+    detailA: CurveLocationDetail;
+    /** The second of the two details ... */
+    detailB: CurveLocationDetail;
+    /** enumeration of how the detail pairs relate.
+     * * This is set only by certain closeApproach calculations.
+     */
+    approachType?: CurveCurveApproachType;
+    constructor(detailA?: CurveLocationDetail, detailB?: CurveLocationDetail);
+    /** Create a curve detail pair using references to two CurveLocationDetails */
+    static createCapture(detailA: CurveLocationDetail, detailB: CurveLocationDetail, result?: CurveLocationDetailPair): CurveLocationDetailPair;
+    /** Create a curve detail pair using references to two CurveLocationDetails.
+     * * optionally install in reversed positions
+     */
+    static createCaptureOptionalReverse(detailA: CurveLocationDetail, detailB: CurveLocationDetail, reversed: boolean, result?: CurveLocationDetailPair): CurveLocationDetailPair;
+    /** Make a deep copy of this CurveLocationDetailPair */
+    clone(result?: CurveLocationDetailPair): CurveLocationDetailPair;
+    /** Swap the details of A, B */
+    swapDetails(): void;
+}
+//# sourceMappingURL=CurveLocationDetail.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CurveLocationDetail.d.ts","sourceRoot":"","sources":["../../../src/curve/CurveLocationDetail.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAC5C,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD;;;GAGG;AACH,oBAAY,iBAAiB;IAC3B,+DAA+D;IAC/D,QAAQ,IAAI;IACZ,4CAA4C;IAC5C,gBAAgB,IAAI;IACpB,2CAA2C;IAC3C,aAAa,KAAK;IAClB,gDAAgD;IAChD,gBAAgB,KAAK;IACrB,qCAAqC;IACrC,WAAW,KAAK;CACjB;AACD;;;GAGG;AACH,oBAAY,iBAAiB;IAC3B,0CAA0C;IAC1C,KAAK,IAAA;IACL,iCAAiC;IACjC,OAAO,IAAI;IACX,4FAA4F;IAC5F,iBAAiB,IAAI;CACtB;AAeD;;;;;GAKG;AACH,qBAAa,mBAAmB;IAC9B,gCAAgC;IACzB,KAAK,CAAC,EAAE,cAAc,CAAC;IAC9B,mBAAmB;IACZ,GAAG,CAAC,EAAE,KAAK,CAAC;IACnB,8CAA8C;IACvC,QAAQ,EAAE,MAAM,CAAC;IACxB,kEAAkE;IAC3D,YAAY,CAAC,EAAE,iBAAiB,CAAC;IACxC,6BAA6B;IACtB,KAAK,EAAE,OAAO,CAAC;IACtB,gDAAgD;IACzC,2BAA2B,CAAC,EAAE,QAAQ,CAAC;IAC9C,2DAA2D;IACpD,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACI,WAAW,CAAC,EAAE,mBAAmB,CAAC;IACzC;;OAEG;IACI,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;IAC7C,4EAA4E;IACrE,SAAS,CAAC,EAAE,MAAM,CAAC;IAC1B,yEAAyE;IAClE,MAAM,CAAC,EAAE,OAAO,CAAC;IACxB,0CAA0C;IACnC,MAAM,EAAE,OAAO,CAAC;;IAQvB,4CAA4C;IACrC,eAAe,CAAC,KAAK,EAAE,iBAAiB,GAAG,IAAI;IAGtD,4FAA4F;IACrF,sBAAsB,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAG,IAAI;IAKvE,8CAA8C;IAC9C,IAAW,YAAY,IAAI,OAAO,CAEjC;IAED,wHAAwH;IACxH,IAAW,UAAU,IAAI,OAAO,CAI/B;IAED,qDAAqD;IACrD,IAAW,aAAa,IAAI,MAAM,CAEjC;IAED;;OAEG;IACI,aAAa;IAWpB;;OAEG;IACI,eAAe;IAKtB;;;OAGG;IACI,KAAK,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,mBAAmB;IAe/D;;;;;;;;OAQG;IACI,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAE,MAAY;IAOjF;;;;;;;OAOG;IACI,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,GAAE,MAAU;IAGxD;OACG;IACI,QAAQ,CAAC,KAAK,EAAE,cAAc;IAErC,uFAAuF;IAChF,aAAa,CAAC,KAAK,EAAE,OAAO;IAInC;OACG;WACW,MAAM,CAClB,KAAK,CAAC,EAAE,cAAc,EACtB,MAAM,CAAC,EAAE,mBAAmB,GAAG,mBAAmB;IAMpD;OACG;WACW,wBAAwB,CACpC,KAAK,EAAE,cAAc,GAAG,SAAS,EACjC,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,OAAO,EACd,MAAM,CAAC,EAAE,mBAAmB,GAAG,mBAAmB;IAUpD;;OAEG;WACW,sBAAsB,CAAC,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,mBAAmB,GAAG,mBAAmB;IAQrI;OACG;WACW,iDAAiD,CAC7D,KAAK,EAAE,cAAc,GAAG,SAAS,EACjC,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,OAAO,EACd,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,iBAAiB,EACzB,MAAM,CAAC,EAAE,mBAAmB,GAAG,mBAAmB;IAUpD;;OAEG;WACW,mCAAmC,CAC/C,cAAc,EAAE,OAAO,EACvB,KAAK,EAAE,cAAc,EACrB,aAAa,EAAE,MAAM,EACrB,WAAW,EAAE,MAAM,EACnB,uBAAuB,EAAE,MAAM,EAC/B,MAAM,CAAC,EAAE,mBAAmB,GAAG,mBAAmB;IAyBpD;OACG;WACW,4BAA4B,CACxC,KAAK,EAAE,cAAc,EACrB,QAAQ,EAAE,MAAM,EAChB,MAAM,CAAC,EAAE,mBAAmB,GAAG,mBAAmB;IAUpD;OACG;WACW,8CAA8C,CAC1D,KAAK,EAAE,cAAc,EACrB,QAAQ,EAAE,MAAM,EAChB,MAAM,CAAC,EAAE,mBAAmB,GAAG,mBAAmB;IAYpD;OACG;WACW,oCAAoC,CAChD,KAAK,EAAE,cAAc,EACrB,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,mBAAmB,GAAG,mBAAmB;IAapD;OACG;WACW,gCAAgC,CAC5C,KAAK,EAAE,cAAc,EACrB,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,OAAO,EACd,CAAC,EAAE,MAAM,EACT,MAAM,CAAC,EAAE,mBAAmB,GAAG,mBAAmB;IAWpD;;;;;;OAMG;IACI,wCAAwC,CAC7C,KAAK,EAAE,cAAc,EACrB,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,OAAO,EACd,CAAC,EAAE,MAAM,GAAG,OAAO;IAMrB;;;OAGG;IACI,sBAAsB;IAQ7B;;;OAGG;IACI,0BAA0B,CAAC,CAAC,EAAE,MAAM,EAAE,eAAe,GAAE,MAAU,GAAG,MAAM;IAMjF;;;;OAIG;WACW,cAAc,CAAC,OAAO,EAAE,mBAAmB,GAAG,SAAS,EAAE,OAAO,EAAE,mBAAmB,GAAG,SAAS,GAAG,mBAAmB,GAAG,SAAS;CAQlJ;AACD;;GAEG;AACH,oBAAY,sBAAsB;IAChC,qCAAqC;IACrC,YAAY,IAAI;IAChB,iHAAiH;IACjH,kBAAkB,IAAI;IACtB,qCAAqC;IACrC,kBAAkB,IAAI;IACtB,oCAAoC;IACpC,gBAAgB,IAAI;CACrB;AACD;;GAEG;AACH,qBAAa,uBAAuB;IAClC,uCAAuC;IAChC,OAAO,EAAE,mBAAmB,CAAC;IACpC,wCAAwC;IACjC,OAAO,EAAE,mBAAmB,CAAC;IACpC;;OAEG;IACI,YAAY,CAAC,EAAE,sBAAsB,CAAC;gBAE1B,OAAO,CAAC,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,mBAAmB;IAK/E,8EAA8E;WAChE,aAAa,CAAC,OAAO,EAAE,mBAAmB,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,CAAC,EAAE,uBAAuB,GAAG,uBAAuB;IAMlJ;;OAEG;WACW,4BAA4B,CAAC,OAAO,EAAE,mBAAmB,EAAE,OAAO,EAAE,mBAAmB,EACnG,QAAQ,EAAE,OAAO,EACjB,MAAM,CAAC,EAAE,uBAAuB,GAAG,uBAAuB;IAa5D,uDAAuD;IAChD,KAAK,CAAC,MAAM,CAAC,EAAE,uBAAuB,GAAG,uBAAuB;IAOvE,+BAA+B;IACxB,WAAW;CAKnB"}

package/lib/esm/curve/CurveLocationDetail.js

@@ -0,0 +1,392 @@
+/*---------------------------------------------------------------------------------------------
+* 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 { Geometry } from "../Geometry";
+import { Point3d } from "../geometry3d/Point3dVector3d";
+/**
+ * An enumeration of special conditions being described by a CurveLocationDetail.
+ * @public
+ */
+export var CurveIntervalRole;
+(function (CurveIntervalRole) {
+    /** This point is an isolated point NOT at a primary vertex. */
+    CurveIntervalRole[CurveIntervalRole["isolated"] = 0] = "isolated";
+    /**  This point is an isolated vertex hit */
+    CurveIntervalRole[CurveIntervalRole["isolatedAtVertex"] = 1] = "isolatedAtVertex";
+    /** This is the beginning of an interval */
+    CurveIntervalRole[CurveIntervalRole["intervalStart"] = 10] = "intervalStart";
+    /** This is an interior point of an interval. */
+    CurveIntervalRole[CurveIntervalRole["intervalInterior"] = 11] = "intervalInterior";
+    /** This is the end of an interval */
+    CurveIntervalRole[CurveIntervalRole["intervalEnd"] = 12] = "intervalEnd";
+})(CurveIntervalRole || (CurveIntervalRole = {}));
+/**
+ * Return code for CurvePrimitive method `moveSignedDistanceFromFraction`
+ * @public
+ */
+export var CurveSearchStatus;
+(function (CurveSearchStatus) {
+    /** unimplemented or zero length curve  */
+    CurveSearchStatus[CurveSearchStatus["error"] = 0] = "error";
+    /** complete success of search */
+    CurveSearchStatus[CurveSearchStatus["success"] = 1] = "success";
+    /** search ended prematurely (e.g. at incomplete distance moved) at start or end of curve */
+    CurveSearchStatus[CurveSearchStatus["stoppedAtBoundary"] = 2] = "stoppedAtBoundary";
+})(CurveSearchStatus || (CurveSearchStatus = {}));
+/**
+ * use to update a vector in case where source and prior result are both possibly undefined.
+ * * Any undefined source returns undefined.
+ * * For defined source, reuse optional result if available.
+ * @param source optional source
+ * @param result optional result
+ */
+function optionalVectorUpdate(source, result) {
+    if (source) {
+        return source.clone(result);
+    }
+    return undefined;
+}
+/**
+ * CurveLocationDetail carries point and paramter data about a point evaluated on a curve.
+ * * These are returned by a variety of queries.
+ * * Particular contents can vary among the queries.
+ * @public
+ */
+export class CurveLocationDetail {
+    constructor() {
+        this.pointQ = Point3d.createZero();
+        this.fraction = 0;
+        this.point = Point3d.createZero();
+        this.a = 0.0;
+    }
+    /** Set the (optional) intervalRole field */
+    setIntervalRole(value) {
+        this.intervalRole = value;
+    }
+    /** Set the (optional) fraction1 and point1, using direct assignment (capture!) to point1 */
+    captureFraction1Point1(fraction1, point1) {
+        this.fraction1 = fraction1;
+        this.point1 = point1;
+    }
+    /** test if this pair has fraction1 defined */
+    get hasFraction1() {
+        return this.fraction1 !== undefined;
+    }
+    /** test if this is an isolated point. This is true if intervalRole is any of (undefined, isolated, isolatedAtVertex) */
+    get isIsolated() {
+        return this.intervalRole === undefined
+            || this.intervalRole === CurveIntervalRole.isolated
+            || this.intervalRole === CurveIntervalRole.isolatedAtVertex;
+    }
+    /** return the fraction delta. (0 if no fraction1) */
+    get fractionDelta() {
+        return this.fraction1 !== undefined ? this.fraction1 - this.fraction : 0.0;
+    }
+    /** If (fraction1, point1) are defined, make them the primary (and only) data.
+     * * No action if undefined.
+     */
+    collapseToEnd() {
+        if (this.fraction1 !== undefined) {
+            this.fraction = this.fraction1;
+            this.fraction1 = undefined;
+        }
+        if (this.point1) {
+            this.point = this.point1;
+            this.point1 = undefined;
+        }
+    }
+    /** make (fraction, point) the primary (and only) data.
+     * * No action if undefined.
+     */
+    collapseToStart() {
+        this.fraction1 = undefined;
+        this.point1 = undefined;
+    }
+    /** Return a complete copy, WITH CAVEATS . . .
+     * * curve member is copied as a reference.
+     * * point and vector members are cloned.
+     */
+    clone(result) {
+        if (result === this)
+            return result;
+        result = result ? result : new CurveLocationDetail();
+        result.curve = this.curve;
+        result.fraction = this.fraction;
+        result.fraction1 = this.fraction1;
+        result.point1 = this.point1;
+        result.point.setFromPoint3d(this.point);
+        result.vectorInCurveLocationDetail = optionalVectorUpdate(this.vectorInCurveLocationDetail, result.vectorInCurveLocationDetail);
+        result.a = this.a;
+        result.curveSearchStatus = this.curveSearchStatus;
+        return result;
+    }
+    /**
+     * Updated in this instance.
+     * * Note that if caller omits `vector` and `a`, those fields are updated to the call-list defaults (NOT left as-is)
+     * * point and vector updates are by data copy (not capture of pointers)
+     * @param fraction (required) fraction to install
+     * @param point  (required) point to install
+     * @param vector (optional) vector to install.
+     * @param a (optional) numeric value to install.
+     */
+    setFP(fraction, point, vector, a = 0.0) {
+        this.fraction = fraction;
+        this.point.setFrom(point);
+        this.vectorInCurveLocationDetail = optionalVectorUpdate(vector, this.vectorInCurveLocationDetail);
+        this.a = a;
+    }
+    /**
+     * Updated in this instance.
+     * * Note that if caller omits a`, that field is updated to the call-list default (NOT left as-is)
+     * * point and vector updates are by data copy (not capture of the ray members)
+     * @param fraction (required) fraction to install
+     * @param ray  (required) point and vector to install
+     * @param a (optional) numeric value to install.
+     */
+    setFR(fraction, ray, a = 0) {
+        return this.setFP(fraction, ray.origin, ray.direction, a);
+    }
+    /** Set the CurvePrimitive pointer, leaving all other properties untouched.
+     */
+    setCurve(curve) { this.curve = curve; }
+    /** record the distance from the CurveLocationDetail's point to the parameter point. */
+    setDistanceTo(point) {
+        this.a = this.point.distance(point);
+    }
+    /** create with a CurvePrimitive pointer but no coordinate data.
+     */
+    static create(curve, result) {
+        result = result ? result : new CurveLocationDetail();
+        result.curve = curve;
+        return result;
+    }
+    /** create with CurvePrimitive pointer, fraction, and point coordinates.
+     */
+    static createCurveFractionPoint(curve, fraction, point, result) {
+        result = result ? result : new CurveLocationDetail();
+        result.curve = curve;
+        result.fraction = fraction;
+        result.point.setFromPoint3d(point);
+        result.vectorInCurveLocationDetail = undefined;
+        result.a = 0.0;
+        result.curveSearchStatus = undefined;
+        return result;
+    }
+    /**
+     * Create a new detail with only ray, fraction, and point.
+     */
+    static createRayFractionPoint(ray, fraction, point, result) {
+        result = result ? result : new CurveLocationDetail();
+        result.fraction = fraction;
+        result.ray = ray;
+        result.point.setFromPoint3d(point);
+        return result;
+    }
+    /** create with CurvePrimitive pointer, fraction, and point coordinates
+     */
+    static createCurveFractionPointDistanceCurveSearchStatus(curve, fraction, point, distance, status, result) {
+        result = result ? result : new CurveLocationDetail();
+        result.curve = curve;
+        result.fraction = fraction;
+        result.point.setFromPoint3d(point);
+        result.vectorInCurveLocationDetail = undefined;
+        result.a = distance;
+        result.curveSearchStatus = status;
+        return result;
+    }
+    /** create with curveSearchStatus affected by allowExtension.
+     * *
+     */
+    static createConditionalMoveSignedDistance(allowExtension, curve, startFraction, endFraction, requestedSignedDistance, result) {
+        let a = requestedSignedDistance;
+        let status = CurveSearchStatus.success;
+        if (!allowExtension && !Geometry.isIn01(endFraction)) {
+            // cap the movement at the endpoint
+            if (endFraction < 0.0) {
+                a = -curve.curveLengthBetweenFractions(startFraction, 0.0);
+                endFraction = 0.0;
+                status = CurveSearchStatus.stoppedAtBoundary;
+            }
+            else if (endFraction > 1.0) {
+                endFraction = 1.0;
+                a = curve.curveLengthBetweenFractions(startFraction, 1.0);
+                status = CurveSearchStatus.stoppedAtBoundary;
+            }
+        }
+        result = result ? result : new CurveLocationDetail();
+        result.curve = curve;
+        result.fraction = endFraction;
+        result.point = curve.fractionToPoint(endFraction, result.point);
+        result.vectorInCurveLocationDetail = undefined;
+        result.a = a;
+        result.curveSearchStatus = status;
+        return result;
+    }
+    /** create with CurvePrimitive pointer and fraction for evaluation.
+     */
+    static createCurveEvaluatedFraction(curve, fraction, result) {
+        result = result ? result : new CurveLocationDetail();
+        result.curve = curve;
+        result.fraction = fraction;
+        result.point = curve.fractionToPoint(fraction);
+        result.vectorInCurveLocationDetail = undefined;
+        result.curveSearchStatus = undefined;
+        result.a = 0.0;
+        return result;
+    }
+    /** create with CurvePrimitive pointer and fraction for evaluation.
+     */
+    static createCurveEvaluatedFractionPointAndDerivative(curve, fraction, result) {
+        result = result ? result : new CurveLocationDetail();
+        result.curve = curve;
+        result.fraction = fraction;
+        const ray = curve.fractionToPointAndDerivative(fraction);
+        result.point = ray.origin;
+        result.vectorInCurveLocationDetail = ray.direction;
+        result.curveSearchStatus = undefined;
+        result.a = 0.0;
+        return result;
+    }
+    /** create with CurvePrimitive pointer and 2 fractions for evaluation.
+     */
+    static createCurveEvaluatedFractionFraction(curve, fraction0, fraction1, result) {
+        result = result ? result : new CurveLocationDetail();
+        result.curve = curve;
+        result.fraction = fraction0;
+        result.point = curve.fractionToPoint(fraction0);
+        result.fraction1 = fraction1;
+        result.point1 = curve.fractionToPoint(fraction1);
+        result.vectorInCurveLocationDetail = undefined;
+        result.curveSearchStatus = undefined;
+        result.a = 0.0;
+        return result;
+    }
+    /** create with CurvePrimitive pointer, fraction, and point coordinates.
+     */
+    static createCurveFractionPointDistance(curve, fraction, point, a, result) {
+        result = result ? result : new CurveLocationDetail();
+        result.curve = curve;
+        result.fraction = fraction;
+        result.point.setFromPoint3d(point);
+        result.vectorInCurveLocationDetail = undefined;
+        result.a = a;
+        result.curveSearchStatus = undefined;
+        return result;
+    }
+    /** update or create if closer than current contents.
+     * @param curve candidate curve
+     * @param fraction candidate fraction
+     * @param point candidate point
+     * @param a candidate distance
+     * @returns true if the given distance is smaller (and hence this detail was updated.)
+     */
+    updateIfCloserCurveFractionPointDistance(curve, fraction, point, a) {
+        if (this.a < a)
+            return false;
+        CurveLocationDetail.createCurveFractionPointDistance(curve, fraction, point, a, this);
+        return true;
+    }
+    /**
+     * * Exchange the (fraction,fraction1) and (point, point1) pairs.
+     * * (Skip each swap if its "1" value is undefined)
+     */
+    swapFractionsAndPoints() {
+        if (this.fraction1 !== undefined) {
+            const f = this.fraction;
+            this.fraction = this.fraction1;
+            this.fraction1 = f;
+        }
+        if (this.point1 !== undefined) {
+            const p = this.point;
+            this.point = this.point1;
+            this.point1 = p;
+        }
+    }
+    /**
+     * * return the fraction where f falls between fraction and fraction1.
+     * * ASSUME fraction1 defined
+     */
+    inverseInterpolateFraction(f, defaultFraction = 0) {
+        const a = Geometry.inverseInterpolate01(this.fraction, this.fraction1, f);
+        if (a === undefined)
+            return defaultFraction;
+        return a;
+    }
+    /**
+     * Return the detail with smaller `a` value -- detailA returned if equal.
+     * @param detailA first candidate
+     * @param detailB second candidate
+     */
+    static chooseSmallerA(detailA, detailB) {
+        if (detailA) {
+            if (!detailB)
+                return detailA;
+            return detailA.a <= detailB.a ? detailA : detailB;
+        }
+        return detailB;
+    }
+}
+/** Enumeration of configurations for intersections and min/max distance-between-curve
+ * @public
+ */
+export var CurveCurveApproachType;
+(function (CurveCurveApproachType) {
+    /** Intersection at a single point */
+    CurveCurveApproachType[CurveCurveApproachType["Intersection"] = 0] = "Intersection";
+    /** Distinct points on the two curves, with each curve's tangent perpendicular to the chord between the points */
+    CurveCurveApproachType[CurveCurveApproachType["PerpendicularChord"] = 1] = "PerpendicularChord";
+    /** Completely coincident geometry */
+    CurveCurveApproachType[CurveCurveApproachType["CoincidentGeometry"] = 2] = "CoincidentGeometry";
+    /** Completely parallel geometry. */
+    CurveCurveApproachType[CurveCurveApproachType["ParallelGeometry"] = 3] = "ParallelGeometry";
+})(CurveCurveApproachType || (CurveCurveApproachType = {}));
+/** A pair of CurveLocationDetail.
+ * @public
+ */
+export class CurveLocationDetailPair {
+    constructor(detailA, detailB) {
+        this.detailA = detailA ? detailA : new CurveLocationDetail();
+        this.detailB = detailB ? detailB : new CurveLocationDetail();
+    }
+    /** Create a curve detail pair using references to two CurveLocationDetails */
+    static createCapture(detailA, detailB, result) {
+        result = result ? result : new CurveLocationDetailPair();
+        result.detailA = detailA;
+        result.detailB = detailB;
+        return result;
+    }
+    /** Create a curve detail pair using references to two CurveLocationDetails.
+     * * optionally install in reversed positions
+     */
+    static createCaptureOptionalReverse(detailA, detailB, reversed, result) {
+        result = result ? result : new CurveLocationDetailPair();
+        if (reversed) {
+            result.detailA = detailA;
+            result.detailB = detailB;
+        }
+        else {
+            result.detailA = detailA;
+            result.detailB = detailB;
+        }
+        return result;
+    }
+    /** Make a deep copy of this CurveLocationDetailPair */
+    clone(result) {
+        result = result ? result : new CurveLocationDetailPair();
+        result.detailA = this.detailA.clone();
+        result.detailB = this.detailB.clone();
+        result.approachType = this.approachType;
+        return result;
+    }
+    /** Swap the details of A, B */
+    swapDetails() {
+        const q = this.detailA;
+        this.detailA = this.detailB;
+        this.detailB = q;
+    }
+}
+//# sourceMappingURL=CurveLocationDetail.js.map