@itwin/core-geometry 5.3.0-dev.9 → 5.4.0-dev.3

package/lib/cjs/curve/spiral/TransitionSpiral3d.js

@@ -16,31 +16,38 @@ const OffsetOptions_1 = require("../OffsetOptions");
 /**
  * TransitionSpiral3d is a base class for multiple variants of spirals.
  * * The menagerie of spiral types have 2 broad categories:
- *   * IntegratedSpiral3d -- a spiral whose direct function for curvature versus distance must be integrated to determine x,y
- *     * The IntegratedSpiral3d types are enumerated in `IntegratedSpiralTypes`
+ *   * IntegratedSpiral3d -- a spiral whose direct function for curvature versus distance must be integrated to
+ * determine x,y.
+ *     * The IntegratedSpiral3d types are enumerated in `IntegratedSpiralTypes`.
  *   * DirectSpiral3d -- a spiral implemented with direct calculation of x,y from fractional position along the spiral.
- *     * The direct spiral types are enumerated in the `DirectSpiralType`
- * * The method set for CurvePrimitive support includes a `handleTransitionSpiral(g: TransitionSpiral3d)` which receives all the spiral types.
+ *     * The direct spiral types are enumerated in the `DirectSpiralType`.
+ * * The method set for CurvePrimitive support includes a `handleTransitionSpiral(g: TransitionSpiral3d)` which receives
+ * all the spiral types.
  * * The spiral class may impose expectations that its inflection is at the origin, with tangent along the x axis.
  *   * This is generally necessary for direct spirals.
  *   * This is not necessary for integrated spirals.
  * @public
  */
 class TransitionSpiral3d extends CurvePrimitive_1.CurvePrimitive {
-    /** string name of spiral type */
+    /** String name of spiral type. */
     _spiralType;
     /** Original defining properties. */
     _designProperties;
-    /** Fractional interval for the "active" part of a containing spiral.
-     * (The radius, angle, and length conditions define a complete spiral, and some portion of it is "active")
+    /** Placement transform. */
+    _localToWorld;
+    /**
+     * Fractional interval for the "active" part of a containing spiral.
+     * (the radius, angle, and length conditions define a complete spiral, and some portion of it is "active")
      */
     _activeFractionInterval;
     /** Return (reference to) the active portion of the reference spiral. */
-    get activeFractionInterval() { return this._activeFractionInterval; }
-    /** Placement transform */
-    _localToWorld;
-    /** (reference to) placement transform. */
-    get localToWorld() { return this._localToWorld; }
+    get activeFractionInterval() {
+        return this._activeFractionInterval;
+    }
+    /** (Reference to) placement transform. */
+    get localToWorld() {
+        return this._localToWorld;
+    }
     constructor(spiralType, localToWorld, activeFractionInterval, designProperties) {
         super();
         this._spiralType = spiralType ? spiralType : "unknownSpiralType";
@@ -48,10 +55,14 @@ class TransitionSpiral3d extends CurvePrimitive_1.CurvePrimitive {
         this._localToWorld = localToWorld;
         this._activeFractionInterval = activeFractionInterval ? activeFractionInterval : Segment1d_1.Segment1d.create(0, 1);
     }
-    get spiralType() { return this._spiralType; }
-    /** Return 1/r with convention that if true zero is given as radius it represents infinite radius (0 curvature, straight line) */
-    static radiusToCurvature(radius) { return (radius === 0.0) ? 0.0 : 1.0 / radius; }
-    /** Return 1/k with convention that if near-zero is given as curvature, its infinite radius is returned as 0 */
+    get spiralType() {
+        return this._spiralType;
+    }
+    /** Return 1/r with convention that exact zero input returns 0 (straight line, zero curvature, infinite radius). */
+    static radiusToCurvature(radius) {
+        return (radius === 0.0) ? 0.0 : 1.0 / radius;
+    }
+    /** Return 1/k with convention that near-zero input returns 0 (straight line, zero curvature, infinite radius). */
     static curvatureToRadius(curvature) {
         if (Math.abs(curvature) < Geometry_1.Geometry.smallAngleRadians)
             return 0.0;
@@ -66,10 +77,10 @@ class TransitionSpiral3d extends CurvePrimitive_1.CurvePrimitive {
         spiralB.refreshComputedProperties();
         return spiralB;
     }
-    /** Clone with a transform applied  */
+    /** Clone with a transform applied.  */
     cloneTransformed(transform) {
         const result = this.clone();
-        result.tryTransformInPlace(transform); // ok, we're confident it will always work.
+        result.tryTransformInPlace(transform); // we're confident it will always work
         return result;
     }
     /** Return the average of the start and end curvatures. */
@@ -77,17 +88,18 @@ class TransitionSpiral3d extends CurvePrimitive_1.CurvePrimitive {
         return 0.5 * (TransitionSpiral3d.radiusToCurvature(radiusLimits.x0) + TransitionSpiral3d.radiusToCurvature(radiusLimits.x1));
     }
     /**
-     * Given two radii (or zeros for 0 curvature) return the average curvature
-     * @param r0 start radius, or 0 for line
-     * @param r1 end radius, or 0 for line
+     * Given two radii (or zeros for 0 curvature) return the average curvature.
+     * @param r0 start radius, or 0 for line.
+     * @param r1 end radius, or 0 for line.
      */
     static averageCurvatureR0R1(r0, r1) {
         return 0.5 * (TransitionSpiral3d.radiusToCurvature(r0) + TransitionSpiral3d.radiusToCurvature(r1));
     }
     /**
-     * Given two radii (or zeros for 0 curvature) return the average curvature
-     * @param r0 start radius, or 0 for line
-     * @param r1 end radius, or 0 for line
+     * Given two radii (or zeros for 0 curvature) return the curvature at the given fraction.
+     * @param r0 start radius, or 0 for line.
+     * @param fraction fractional position between the curvatures defined by r0 and r1.
+     * @param r1 end radius, or 0 for line.
      */
     static interpolateCurvatureR0R1(r0, fraction, r1) {
         return Geometry_1.Geometry.interpolate(TransitionSpiral3d.radiusToCurvature(r0), fraction, TransitionSpiral3d.radiusToCurvature(r1));
@@ -109,9 +121,12 @@ class TransitionSpiral3d extends CurvePrimitive_1.CurvePrimitive {
         return TransitionSpiral3d.curvatureToRadius((2.0 * sweepRadians / arcLength) - TransitionSpiral3d.radiusToCurvature(radius1));
     }
     /** Return the original defining properties (if any) saved by the constructor. */
-    get designProperties() { return this._designProperties; }
+    get designProperties() {
+        return this._designProperties;
+    }
     /**
-     * * If transformA is rigid with uniform scale, apply the rigid part of transformA to the localToWorld transform and return the scale and rigid separation.
+     * * If transformA is rigid with uniform scale, apply the rigid part of transformA to the localToWorld transform and
+     * return the scale and rigid separation.
      * * If not rigid, do nothing and return undefined.
      * * Also apply the scale factor to the designProperties.
      * @param transformA
@@ -120,9 +135,9 @@ class TransitionSpiral3d extends CurvePrimitive_1.CurvePrimitive {
         const rigidData = transformA.matrix.factorRigidWithSignedScale();
         if (rigidData !== undefined) {
             // [sQ a][R b] = [sQ*R sQb+a]
-            // but we save it as [Q*R sQb+a] with spiral data scaled by s.
+            // but we save it as [Q*R sQb+a] with spiral data scaled by s
             const transformC0 = transformA.multiplyTransformTransform(this.localToWorld);
-            // BUT pull the scale part out of the matrix ...
+            // but pull the scale part out of the matrix
             const matrixC = rigidData.rigidAxes.multiplyMatrixMatrix(this.localToWorld.matrix);
             this._localToWorld = Transform_1.Transform.createOriginAndMatrix(transformC0.origin, matrixC);
             if (this.designProperties)
@@ -133,9 +148,9 @@ class TransitionSpiral3d extends CurvePrimitive_1.CurvePrimitive {
     }
     /**
      * Construct an offset of the instance curve as viewed in the xy-plane (ignoring z).
-     * * No attempt is made to join the offsets of smaller constituent primitives. To construct a fully joined offset
-     *   for an aggregate instance (e.g., LineString3d, CurveChainWithDistanceIndex), use RegionOps.constructCurveXYOffset() instead.
-     * @param offsetDistanceOrOptions offset distance (positive to left of the instance curve), or options object
+     * * No attempt is made to join the offsets of smaller constituent primitives. To construct a fully joined offset for an
+     * aggregate instance (e.g., LineString3d, CurveChainWithDistanceIndex), use RegionOps.constructCurveXYOffset() instead.
+     * @param offsetDistanceOrOptions offset distance (positive to left of the instance curve), or options object.
      */
     constructOffsetXY(offsetDistanceOrOptions) {
         const options = OffsetOptions_1.OffsetOptions.create(offsetDistanceOrOptions);
@@ -143,13 +158,13 @@ class TransitionSpiral3d extends CurvePrimitive_1.CurvePrimitive {
         this.emitStrokableParts(handler, options.strokeOptions);
         return handler.claimResult();
     }
-    /** extend the range by the strokes of the spiral */
+    /** Extend the range by the strokes of the spiral. */
     extendRange(rangeToExtend, transform) {
-        const myRange = this.rangeBetweenFractions(0.0, 1.0, transform);
-        rangeToExtend.extendRange(myRange);
+        rangeToExtend.extendRange(this.rangeBetweenFractions(0.0, 1.0, transform));
     }
-    /** return the range of spiral between fractions of the activeStrokes.
-     * * Use activeStrokes point count times interval factor for initial evaluation count, but do at least 5
+    /**
+     * Return the range of spiral between fractions of the activeStrokes.
+     * * Use activeStrokes point count times interval factor for initial evaluation count, but do at least 5.
      */
     rangeBetweenFractions(fractionA, fractionB, transform) {
         const strokes = this.activeStrokes;
@@ -159,10 +174,13 @@ class TransitionSpiral3d extends CurvePrimitive_1.CurvePrimitive {
         count = Geometry_1.Geometry.clamp(5, count, 30);
         return this.rangeBetweenFractionsByCount(fractionA, fractionB, count, transform, 0.5);
     }
-    /** Project instance geometry (via dispatch) onto the given ray, and return the extreme fractional parameters of projection.
+    /**
+     * Project instance geometry (via dispatch) onto the given ray, and return the extreme fractional parameters of
+     * projection.
      * @param ray ray onto which the instance is projected. A `Vector3d` is treated as a `Ray3d` with zero origin.
      * @param lowHigh optional receiver for output
-     * @returns range of fractional projection parameters onto the ray, where 0.0 is start of the ray and 1.0 is the end of the ray.
+     * @returns range of fractional projection parameters onto the ray, where 0.0 is start of the ray and 1.0 is the
+     * end of the ray.
      */
     projectedParameterRange(ray, lowHigh) {
         return PlaneAltitudeRangeContext_1.PlaneAltitudeRangeContext.findExtremeFractionsAlongDirection(this, ray, lowHigh);

package/lib/cjs/curve/spiral/TransitionSpiral3d.js.map

@@ -1 +1 @@
-{"version":3,"file":"TransitionSpiral3d.js","sourceRoot":"","sources":["../../../../src/curve/spiral/TransitionSpiral3d.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAO/F,6CAA0C;AAE1C,kDAA0D;AAC1D,0DAAuD;AACvD,0DAAuD;AACvD,sDAAmD;AACnD,mFAAgF;AAChF,6FAA0F;AAE1F,oDAAiD;AAsCjD;;;;;;;;;;;;GAYG;AACH,MAAsB,kBAAmB,SAAQ,+BAAc;IAC7D,iCAAiC;IACvB,WAAW,CAAS;IAC9B,oCAAoC;IAC1B,iBAAiB,CAA8C;IAEzE;;OAEG;IACO,uBAAuB,CAAY;IAC7C,wEAAwE;IACxE,IAAW,sBAAsB,KAAgB,OAAO,IAAI,CAAC,uBAAuB,CAAC,CAAC,CAAC;IAGvF,0BAA0B;IAChB,aAAa,CAAY;IACnC,0CAA0C;IAC1C,IAAW,YAAY,KAAgB,OAAO,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;IAEnE,YAAsB,UAA8B,EAAE,YAAuB,EAAE,sBAA6C,EAAE,gBAA6D;QACzL,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,mBAAmB,CAAC;QACjE,IAAI,CAAC,iBAAiB,GAAG,gBAAgB,CAAC;QAC1C,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;QAClC,IAAI,CAAC,uBAAuB,GAAG,sBAAsB,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,qBAAS,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC1G,CAAC;IAED,IAAW,UAAU,KAAa,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAC5D,iIAAiI;IAC1H,MAAM,CAAC,iBAAiB,CAAC,MAAc,IAAY,OAAO,CAAC,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC;IAEzG,+GAA+G;IACxG,MAAM,CAAC,iBAAiB,CAAC,SAAiB;QAC/C,IAAI,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,mBAAQ,CAAC,iBAAiB;YAClD,OAAO,GAAG,CAAC;QACb,OAAO,GAAG,GAAG,SAAS,CAAC;IACzB,CAAC;IAQD,sEAAsE;IACtD,iBAAiB,CAAC,SAAiB,EAAE,SAAiB;QACpE,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;QAC7B,MAAM,eAAe,GAAG,IAAI,CAAC,uBAAuB,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;QAChF,MAAM,eAAe,GAAG,IAAI,CAAC,uBAAuB,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;QAChF,OAAO,CAAC,uBAAuB,CAAC,GAAG,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC;QACtE,OAAO,CAAC,yBAAyB,EAAE,CAAC;QACpC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,sCAAsC;IACtB,gBAAgB,CAAC,SAAoB;QACnD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;QAC5B,MAAM,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC,CAAC,2CAA2C;QAClF,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,0DAA0D;IACnD,MAAM,CAAC,gBAAgB,CAAC,YAAuB;QACpD,OAAO,GAAG,GAAG,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,YAAY,CAAC,EAAE,CAAC,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC;IAC/H,CAAC;IACD;;;;OAIG;IACI,MAAM,CAAC,oBAAoB,CAAC,EAAU,EAAE,EAAU;QACvD,OAAO,GAAG,GAAG,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,EAAE,CAAC,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC;IACrG,CAAC;IACD;;;;OAIG;IACI,MAAM,CAAC,wBAAwB,CAAC,EAAU,EAAE,QAAgB,EAAE,EAAU;QAC7E,OAAO,mBAAQ,CAAC,WAAW,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE,kBAAkB,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC;IAC5H,CAAC;IAED,qFAAqF;IAC9E,MAAM,CAAC,mCAAmC,CAAC,OAAe,EAAE,OAAe,EAAE,YAAoB;QACtG,OAAO,IAAI,CAAC,GAAG,CAAC,YAAY,GAAG,kBAAkB,CAAC,oBAAoB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;IAC5F,CAAC;IAED,yEAAyE;IAClE,MAAM,CAAC,gCAAgC,CAAC,OAAe,EAAE,OAAe,EAAE,SAAiB;QAChG,OAAO,kBAAkB,CAAC,oBAAoB,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;IAC/E,CAAC;IAED,sFAAsF;IAC/E,MAAM,CAAC,kCAAkC,CAAC,OAAe,EAAE,SAAiB,EAAE,YAAoB;QACvG,OAAO,kBAAkB,CAAC,iBAAiB,CAAC,CAAC,GAAG,GAAG,YAAY,GAAG,SAAS,CAAC,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;IAChI,CAAC;IACD,sFAAsF;IAC/E,MAAM,CAAC,kCAAkC,CAAC,OAAe,EAAE,SAAiB,EAAE,YAAoB;QACvG,OAAO,kBAAkB,CAAC,iBAAiB,CAAC,CAAC,GAAG,GAAG,YAAY,GAAG,SAAS,CAAC,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;IAChI,CAAC;IACD,iFAAiF;IACjF,IAAW,gBAAgB,KAAkD,OAAO,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAC7G;;;;;OAKG;IACO,yBAAyB,CAAC,UAAqB;QACvD,MAAM,SAAS,GAAG,UAAU,CAAC,MAAM,CAAC,0BAA0B,EAAE,CAAC;QACjE,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,6BAA6B;YAC7B,8DAA8D;YAC9D,MAAM,WAAW,GAAG,UAAU,CAAC,0BAA0B,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAC7E,gDAAgD;YAChD,MAAM,OAAO,GAAG,SAAS,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;YACnF,IAAI,CAAC,aAAa,GAAG,qBAAS,CAAC,qBAAqB,CAAC,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAClF,IAAI,IAAI,CAAC,gBAAgB;gBACvB,IAAI,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;YAE1D,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;OAKG;IACa,iBAAiB,CAAC,uBAA+C;QAC/E,MAAM,OAAO,GAAG,6BAAa,CAAC,MAAM,CAAC,uBAAuB,CAAC,CAAC;QAC9D,MAAM,OAAO,GAAG,IAAI,2CAAoB,CAAC,IAAI,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;QAC3E,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;QACxD,OAAO,OAAO,CAAC,WAAW,EAAE,CAAC;IAC/B,CAAC;IACD,oDAAoD;IACpC,WAAW,CAAC,aAAsB,EAAE,SAAqB;QACvE,MAAM,OAAO,GAAG,IAAI,CAAC,qBAAqB,CAAE,GAAG,EAAE,GAAG,EAAE,SAAS,CAAC,CAAC;QACjE,aAAa,CAAC,WAAW,CAAE,OAAO,CAAC,CAAC;IACtC,CAAC;IAED;;OAEG;IACc,qBAAqB,CAAC,SAAiB,EAAE,SAAiB,EAAE,SAAqB;QAChG,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC;QACnC,IAAI,SAAS,KAAK,OAAO;YACvB,OAAO,eAAO,CAAC,UAAU,EAAG,CAAC;QAC/B,IAAI,KAAK,GAAG,IAAI,CAAC,IAAI,CAAE,OAAO,CAAC,SAAS,EAAE,GAAG,IAAI,CAAC,GAAG,CAAE,SAAS,GAAG,SAAS,CAAC,CAAC,CAAC;QAC/E,KAAK,GAAG,mBAAQ,CAAC,KAAK,CAAE,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC,4BAA4B,CAAE,SAAS,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,CAAC,CAAC;IACzF,CAAC;IACD;;;;OAIG;IACa,uBAAuB,CAAC,GAAqB,EAAE,OAAiB;QAC9E,OAAO,qDAAyB,CAAC,kCAAkC,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IAC1F,CAAC;CACF;AAlKD,gDAkKC","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\n/** @packageDocumentation\n * @module Curve\n */\n\nimport { BSplineCurve3d } from \"../../bspline/BSplineCurve\";\nimport { Geometry } from \"../../Geometry\";\nimport { Matrix3d } from \"../../geometry3d/Matrix3d\";\nimport { Range1d, Range3d } from \"../../geometry3d/Range\";\nimport { Segment1d } from \"../../geometry3d/Segment1d\";\nimport { Transform } from \"../../geometry3d/Transform\";\nimport { CurvePrimitive } from \"../CurvePrimitive\";\nimport { CurveOffsetXYHandler } from \"../internalContexts/CurveOffsetXYHandler\";\nimport { PlaneAltitudeRangeContext } from \"../internalContexts/PlaneAltitudeRangeContext\";\nimport { LineString3d } from \"../LineString3d\";\nimport { OffsetOptions } from \"../OffsetOptions\";\nimport { TransitionConditionalProperties } from \"./TransitionConditionalProperties\";\n\nimport type { Vector3d } from \"../../geometry3d/Point3dVector3d\";\nimport type { Ray3d } from \"../../geometry3d/Ray3d\";\n/**\n * This is the set of valid type names for \"integrated\" spirals\n * * Behavior is expressed by a `NormalizedTransition` snap function.\n * * The snap function varies smoothly from f(0)=0 to f(1)=1\n * * The various snap functions are:\n *   * clothoid: linear\n *   * biquadratic: 2 quadratics pieced together, joining with 1st derivative continuity at f(0.) = 0.5, with zero slope f'(0)=0 and f'(1)= 0\n *   * bloss: A single cubic with zero slope at 0 and 1\n *   * cosine: half of a cosine wave, centered around 0.5\n *   * sine: full period of a sine wave added to the line f(u)=u\n * *\n * @public\n */\nexport type IntegratedSpiralTypeName = \"clothoid\" | \"bloss\" | \"biquadratic\" | \"cosine\" | \"sine\";\n\n/**\n * This is the set of valid type names for \"direct\" spirals.\n * \"Direct\" spirals can evaluate fractionToPoint by direct equations, i.e. not requiring the numeric integrations in \"Integrated\" spiral types.\n * @public\n */\nexport type DirectSpiralTypeName =\n   \"JapaneseCubic\"  // 1 term from each of the X,Y clothoid series expansions:  y = x^3 / (6RL)\n  | \"Arema\"       // 2 terms from each of the X,Y clothoid series expansions.  Identical to ChineseCubic!\n  | \"ChineseCubic\"  // Identical to Arema!\n  | \"HalfCosine\"  // high continuity cosine variation from quadratic.\n  | \"AustralianRailCorp\" // cubic with high accuracy distance series\n  | \"WesternAustralian\"  // simple cubic -- 2 terms of x series, 1 term of y series.\n  | \"Czech\"  // simple cubic with two term distance approximation\n  | \"MXCubicAlongArc\"  // x obtained from fractional distance via 2-terms from series, y = x^3/ (6RL)\n  | \"Polish\"\n  | \"Italian\"\n  ;\n\n/**\n * TransitionSpiral3d is a base class for multiple variants of spirals.\n * * The menagerie of spiral types have 2 broad categories:\n *   * IntegratedSpiral3d -- a spiral whose direct function for curvature versus distance must be integrated to determine x,y\n *     * The IntegratedSpiral3d types are enumerated in `IntegratedSpiralTypes`\n *   * DirectSpiral3d -- a spiral implemented with direct calculation of x,y from fractional position along the spiral.\n *     * The direct spiral types are enumerated in the `DirectSpiralType`\n * * The method set for CurvePrimitive support includes a `handleTransitionSpiral(g: TransitionSpiral3d)` which receives all the spiral types.\n * * The spiral class may impose expectations that its inflection is at the origin, with tangent along the x axis.\n *   * This is generally necessary for direct spirals.\n *   * This is not necessary for integrated spirals.\n * @public\n */\nexport abstract class TransitionSpiral3d extends CurvePrimitive {\n  /** string name of spiral type */\n  protected _spiralType: string;\n  /** Original defining properties. */\n  protected _designProperties: TransitionConditionalProperties | undefined;\n\n  /** Fractional interval for the \"active\" part of a containing spiral.\n   * (The radius, angle, and length conditions define a complete spiral, and some portion of it is \"active\")\n   */\n  protected _activeFractionInterval: Segment1d;\n  /** Return (reference to) the active portion of the reference spiral. */\n  public get activeFractionInterval(): Segment1d { return this._activeFractionInterval; }\n  /** strokes in the active portion */\n  public abstract get activeStrokes(): LineString3d;\n  /** Placement transform */\n  protected _localToWorld: Transform;\n  /** (reference to) placement transform. */\n  public get localToWorld(): Transform { return this._localToWorld; }\n\n  protected constructor(spiralType: string | undefined, localToWorld: Transform, activeFractionInterval: Segment1d | undefined, designProperties: TransitionConditionalProperties | undefined) {\n    super();\n    this._spiralType = spiralType ? spiralType : \"unknownSpiralType\";\n    this._designProperties = designProperties;\n    this._localToWorld = localToWorld;\n    this._activeFractionInterval = activeFractionInterval ? activeFractionInterval : Segment1d.create(0, 1);\n  }\n\n  public get spiralType(): string { return this._spiralType; }\n  /** Return 1/r with convention that if true zero is given as radius it represents infinite radius (0 curvature, straight line) */\n  public static radiusToCurvature(radius: number): number { return (radius === 0.0) ? 0.0 : 1.0 / radius; }\n\n  /** Return 1/k with convention that if near-zero is given as curvature, its infinite radius is returned as 0 */\n  public static curvatureToRadius(curvature: number): number {\n    if (Math.abs(curvature) < Geometry.smallAngleRadians)\n      return 0.0;\n    return 1.0 / curvature;\n  }\n\n  /** Return a deep clone. */\n  public abstract override clone(): TransitionSpiral3d;\n\n  /** Recompute strokes */\n  public abstract refreshComputedProperties(): void;\n\n  /** Return (if possible) a spiral which is a portion of this curve. */\n  public override clonePartialCurve(fractionA: number, fractionB: number): TransitionSpiral3d {\n    const spiralB = this.clone();\n    const globalFractionA = this._activeFractionInterval.fractionToPoint(fractionA);\n    const globalFractionB = this._activeFractionInterval.fractionToPoint(fractionB);\n    spiralB._activeFractionInterval.set(globalFractionA, globalFractionB);\n    spiralB.refreshComputedProperties();\n    return spiralB;\n  }\n\n  /** Clone with a transform applied  */\n  public override cloneTransformed(transform: Transform): TransitionSpiral3d {\n    const result = this.clone();\n    result.tryTransformInPlace(transform); // ok, we're confident it will always work.\n    return result;\n  }\n\n  /** Return the average of the start and end curvatures. */\n  public static averageCurvature(radiusLimits: Segment1d): number {\n    return 0.5 * (TransitionSpiral3d.radiusToCurvature(radiusLimits.x0) + TransitionSpiral3d.radiusToCurvature(radiusLimits.x1));\n  }\n  /**\n   * Given two radii (or zeros for 0 curvature) return the average curvature\n   * @param r0 start radius, or 0 for line\n   * @param r1 end radius, or 0 for line\n   */\n  public static averageCurvatureR0R1(r0: number, r1: number): number {\n    return 0.5 * (TransitionSpiral3d.radiusToCurvature(r0) + TransitionSpiral3d.radiusToCurvature(r1));\n  }\n  /**\n   * Given two radii (or zeros for 0 curvature) return the average curvature\n   * @param r0 start radius, or 0 for line\n   * @param r1 end radius, or 0 for line\n   */\n  public static interpolateCurvatureR0R1(r0: number, fraction: number, r1: number): number {\n    return Geometry.interpolate(TransitionSpiral3d.radiusToCurvature(r0), fraction, TransitionSpiral3d.radiusToCurvature(r1));\n  }\n\n  /** Return the arc length of a transition spiral with given sweep and radius pair. */\n  public static radiusRadiusSweepRadiansToArcLength(radius0: number, radius1: number, sweepRadians: number): number {\n    return Math.abs(sweepRadians / TransitionSpiral3d.averageCurvatureR0R1(radius0, radius1));\n  }\n\n  /** Return the turn angle for spiral of given length between two radii */\n  public static radiusRadiusLengthToSweepRadians(radius0: number, radius1: number, arcLength: number): number {\n    return TransitionSpiral3d.averageCurvatureR0R1(radius0, radius1) * arcLength;\n  }\n\n  /** Return the end radius for spiral of given start radius, length, and turn angle. */\n  public static radius0LengthSweepRadiansToRadius1(radius0: number, arcLength: number, sweepRadians: number) {\n    return TransitionSpiral3d.curvatureToRadius((2.0 * sweepRadians / arcLength) - TransitionSpiral3d.radiusToCurvature(radius0));\n  }\n  /** Return the start radius for spiral of given end radius, length, and turn angle. */\n  public static radius1LengthSweepRadiansToRadius0(radius1: number, arcLength: number, sweepRadians: number) {\n    return TransitionSpiral3d.curvatureToRadius((2.0 * sweepRadians / arcLength) - TransitionSpiral3d.radiusToCurvature(radius1));\n  }\n  /** Return the original defining properties (if any) saved by the constructor. */\n  public get designProperties(): TransitionConditionalProperties | undefined { return this._designProperties; }\n  /**\n   * * If transformA is rigid with uniform scale, apply the rigid part of transformA to the localToWorld transform and return the scale and rigid separation.\n   * * If not rigid, do nothing and return undefined.\n   * * Also apply the scale factor to the designProperties.\n   * @param transformA\n   */\n  protected applyRigidPartOfTransform(transformA: Transform): { rigidAxes: Matrix3d, scale: number } | undefined {\n    const rigidData = transformA.matrix.factorRigidWithSignedScale();\n    if (rigidData !== undefined) {\n      // [sQ a][R b] = [sQ*R sQb+a]\n      // but we save it as [Q*R sQb+a] with spiral data scaled by s.\n      const transformC0 = transformA.multiplyTransformTransform(this.localToWorld);\n      // BUT pull the scale part out of the matrix ...\n      const matrixC = rigidData.rigidAxes.multiplyMatrixMatrix(this.localToWorld.matrix);\n      this._localToWorld = Transform.createOriginAndMatrix(transformC0.origin, matrixC);\n      if (this.designProperties)\n        this.designProperties.applyScaleFactor(rigidData.scale);\n\n      return rigidData;\n    }\n    return undefined;\n  }\n\n  /**\n   * Construct an offset of the instance curve as viewed in the xy-plane (ignoring z).\n   * * No attempt is made to join the offsets of smaller constituent primitives. To construct a fully joined offset\n   *   for an aggregate instance (e.g., LineString3d, CurveChainWithDistanceIndex), use RegionOps.constructCurveXYOffset() instead.\n   * @param offsetDistanceOrOptions offset distance (positive to left of the instance curve), or options object\n   */\n  public override constructOffsetXY(offsetDistanceOrOptions: number | OffsetOptions): BSplineCurve3d | undefined {\n    const options = OffsetOptions.create(offsetDistanceOrOptions);\n    const handler = new CurveOffsetXYHandler(this, options.leftOffsetDistance);\n    this.emitStrokableParts(handler, options.strokeOptions);\n    return handler.claimResult();\n  }\n  /** extend the range by the strokes of the spiral */\n  public override extendRange(rangeToExtend: Range3d, transform?: Transform): void {\n    const myRange = this.rangeBetweenFractions (0.0, 1.0, transform);\n    rangeToExtend.extendRange (myRange);\n  }\n\n  /** return the range of spiral between fractions of the activeStrokes.\n   * * Use activeStrokes point count times interval factor for initial evaluation count, but do at least 5\n   */\n   public override rangeBetweenFractions(fractionA: number, fractionB: number, transform?: Transform): Range3d {\n    const strokes = this.activeStrokes;\n    if (undefined === strokes)\n      return Range3d.createNull ();\n    let count = Math.ceil (strokes.numPoints() * Math.abs (fractionB - fractionA));\n    count = Geometry.clamp (5, count, 30);\n    return this.rangeBetweenFractionsByCount (fractionA, fractionB, count, transform, 0.5);\n  }\n  /** Project instance geometry (via dispatch) onto the given ray, and return the extreme fractional parameters of projection.\n   * @param ray ray onto which the instance is projected. A `Vector3d` is treated as a `Ray3d` with zero origin.\n   * @param lowHigh optional receiver for output\n   * @returns range of fractional projection parameters onto the ray, where 0.0 is start of the ray and 1.0 is the end of the ray.\n   */\n  public override projectedParameterRange(ray: Vector3d | Ray3d, lowHigh?: Range1d): Range1d | undefined {\n    return PlaneAltitudeRangeContext.findExtremeFractionsAlongDirection(this, ray, lowHigh);\n  }\n}\n"]}
+{"version":3,"file":"TransitionSpiral3d.js","sourceRoot":"","sources":["../../../../src/curve/spiral/TransitionSpiral3d.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAO/F,6CAA0C;AAE1C,kDAA0D;AAC1D,0DAAuD;AACvD,0DAAuD;AACvD,sDAAmD;AACnD,mFAAgF;AAChF,6FAA0F;AAE1F,oDAAiD;AAyCjD;;;;;;;;;;;;;;GAcG;AACH,MAAsB,kBAAmB,SAAQ,+BAAc;IAC7D,kCAAkC;IACxB,WAAW,CAAS;IAC9B,oCAAoC;IAC1B,iBAAiB,CAA8C;IACzE,2BAA2B;IACjB,aAAa,CAAY;IACnC;;;OAGG;IACO,uBAAuB,CAAY;IAC7C,wEAAwE;IACxE,IAAW,sBAAsB;QAC/B,OAAO,IAAI,CAAC,uBAAuB,CAAC;IACtC,CAAC;IAGD,0CAA0C;IAC1C,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IACD,YACE,UAA8B,EAC9B,YAAuB,EACvB,sBAA6C,EAC7C,gBAA6D;QAE7D,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,mBAAmB,CAAC;QACjE,IAAI,CAAC,iBAAiB,GAAG,gBAAgB,CAAC;QAC1C,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;QAClC,IAAI,CAAC,uBAAuB,GAAG,sBAAsB,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,qBAAS,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC1G,CAAC;IACD,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IACD,mHAAmH;IAC5G,MAAM,CAAC,iBAAiB,CAAC,MAAc;QAC5C,OAAO,CAAC,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,MAAM,CAAC;IAC/C,CAAC;IACD,kHAAkH;IAC3G,MAAM,CAAC,iBAAiB,CAAC,SAAiB;QAC/C,IAAI,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,mBAAQ,CAAC,iBAAiB;YAClD,OAAO,GAAG,CAAC;QACb,OAAO,GAAG,GAAG,SAAS,CAAC;IACzB,CAAC;IAKD,sEAAsE;IACtD,iBAAiB,CAAC,SAAiB,EAAE,SAAiB;QACpE,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;QAC7B,MAAM,eAAe,GAAG,IAAI,CAAC,uBAAuB,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;QAChF,MAAM,eAAe,GAAG,IAAI,CAAC,uBAAuB,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;QAChF,OAAO,CAAC,uBAAuB,CAAC,GAAG,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC;QACtE,OAAO,CAAC,yBAAyB,EAAE,CAAC;QACpC,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,uCAAuC;IACvB,gBAAgB,CAAC,SAAoB;QACnD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;QAC5B,MAAM,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC,CAAC,sCAAsC;QAC7E,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,0DAA0D;IACnD,MAAM,CAAC,gBAAgB,CAAC,YAAuB;QACpD,OAAO,GAAG,GAAG,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,YAAY,CAAC,EAAE,CAAC,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC;IAC/H,CAAC;IACD;;;;OAIG;IACI,MAAM,CAAC,oBAAoB,CAAC,EAAU,EAAE,EAAU;QACvD,OAAO,GAAG,GAAG,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,EAAE,CAAC,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC;IACrG,CAAC;IACD;;;;;OAKG;IACI,MAAM,CAAC,wBAAwB,CAAC,EAAU,EAAE,QAAgB,EAAE,EAAU;QAC7E,OAAO,mBAAQ,CAAC,WAAW,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE,kBAAkB,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC;IAC5H,CAAC;IACD,qFAAqF;IAC9E,MAAM,CAAC,mCAAmC,CAAC,OAAe,EAAE,OAAe,EAAE,YAAoB;QACtG,OAAO,IAAI,CAAC,GAAG,CAAC,YAAY,GAAG,kBAAkB,CAAC,oBAAoB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;IAC5F,CAAC;IACD,yEAAyE;IAClE,MAAM,CAAC,gCAAgC,CAAC,OAAe,EAAE,OAAe,EAAE,SAAiB;QAChG,OAAO,kBAAkB,CAAC,oBAAoB,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;IAC/E,CAAC;IACD,sFAAsF;IAC/E,MAAM,CAAC,kCAAkC,CAAC,OAAe,EAAE,SAAiB,EAAE,YAAoB;QACvG,OAAO,kBAAkB,CAAC,iBAAiB,CACzC,CAAC,GAAG,GAAG,YAAY,GAAG,SAAS,CAAC,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,OAAO,CAAC,CACjF,CAAC;IACJ,CAAC;IACD,sFAAsF;IAC/E,MAAM,CAAC,kCAAkC,CAAC,OAAe,EAAE,SAAiB,EAAE,YAAoB;QACvG,OAAO,kBAAkB,CAAC,iBAAiB,CACzC,CAAC,GAAG,GAAG,YAAY,GAAG,SAAS,CAAC,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,OAAO,CAAC,CACjF,CAAC;IACJ,CAAC;IACD,iFAAiF;IACjF,IAAW,gBAAgB;QACzB,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAChC,CAAC;IACD;;;;;;OAMG;IACO,yBAAyB,CAAC,UAAqB;QACvD,MAAM,SAAS,GAAG,UAAU,CAAC,MAAM,CAAC,0BAA0B,EAAE,CAAC;QACjE,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,6BAA6B;YAC7B,6DAA6D;YAC7D,MAAM,WAAW,GAAG,UAAU,CAAC,0BAA0B,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAC7E,4CAA4C;YAC5C,MAAM,OAAO,GAAG,SAAS,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;YACnF,IAAI,CAAC,aAAa,GAAG,qBAAS,CAAC,qBAAqB,CAAC,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAClF,IAAI,IAAI,CAAC,gBAAgB;gBACvB,IAAI,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;YAC1D,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD;;;;;OAKG;IACa,iBAAiB,CAAC,uBAA+C;QAC/E,MAAM,OAAO,GAAG,6BAAa,CAAC,MAAM,CAAC,uBAAuB,CAAC,CAAC;QAC9D,MAAM,OAAO,GAAG,IAAI,2CAAoB,CAAC,IAAI,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;QAC3E,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;QACxD,OAAO,OAAO,CAAC,WAAW,EAAE,CAAC;IAC/B,CAAC;IACD,qDAAqD;IACrC,WAAW,CAAC,aAAsB,EAAE,SAAqB;QACvE,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,qBAAqB,CAAC,GAAG,EAAE,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC;IAC7E,CAAC;IACD;;;OAGG;IACa,qBAAqB,CAAC,SAAiB,EAAE,SAAiB,EAAE,SAAqB;QAC/F,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC;QACnC,IAAI,SAAS,KAAK,OAAO;YACvB,OAAO,eAAO,CAAC,UAAU,EAAE,CAAC;QAC9B,IAAI,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,GAAG,SAAS,CAAC,CAAC,CAAC;QAC7E,KAAK,GAAG,mBAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;QACrC,OAAO,IAAI,CAAC,4BAA4B,CAAC,SAAS,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,CAAC,CAAC;IACxF,CAAC;IACD;;;;;;;OAOG;IACa,uBAAuB,CAAC,GAAqB,EAAE,OAAiB;QAC9E,OAAO,qDAAyB,CAAC,kCAAkC,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IAC1F,CAAC;CACF;AA5KD,gDA4KC","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\n/** @packageDocumentation\n * @module Curve\n */\n\nimport { BSplineCurve3d } from \"../../bspline/BSplineCurve\";\nimport { Geometry } from \"../../Geometry\";\nimport { Matrix3d } from \"../../geometry3d/Matrix3d\";\nimport { Range1d, Range3d } from \"../../geometry3d/Range\";\nimport { Segment1d } from \"../../geometry3d/Segment1d\";\nimport { Transform } from \"../../geometry3d/Transform\";\nimport { CurvePrimitive } from \"../CurvePrimitive\";\nimport { CurveOffsetXYHandler } from \"../internalContexts/CurveOffsetXYHandler\";\nimport { PlaneAltitudeRangeContext } from \"../internalContexts/PlaneAltitudeRangeContext\";\nimport { LineString3d } from \"../LineString3d\";\nimport { OffsetOptions } from \"../OffsetOptions\";\nimport { TransitionConditionalProperties } from \"./TransitionConditionalProperties\";\n\nimport type { Vector3d } from \"../../geometry3d/Point3dVector3d\";\nimport type { Ray3d } from \"../../geometry3d/Ray3d\";\n\n/**\n * This is the set of valid type names for \"integrated\" spirals.\n * * Behavior is expressed by a `NormalizedTransition` snap function.\n * * The snap function varies smoothly from f(0) = 0 to f(1) = 1.\n * * The various snap functions are:\n *   * clothoid: linear\n *   * biquadratic: 2 quadratics pieced together, joining with 1st derivative continuity at f(0.5) = 0.5, with zero\n *     slope f'(0) = 0 and f'(1) = 0\n *   * bloss: A single cubic with zero slope at 0 and 1\n *   * cosine: half of a cosine wave, centered around 0.5\n *   * sine: full period of a sine wave added to the line f(u)=u\n * *\n * @public\n */\nexport type IntegratedSpiralTypeName = \"clothoid\" | \"bloss\" | \"biquadratic\" | \"cosine\" | \"sine\";\n\n/**\n * This is the set of valid type names for \"direct\" spirals.\n * \"Direct\" spirals can evaluate fractionToPoint by direct equations, i.e. not requiring the numeric integrations in\n * \"Integrated\" spiral types.\n * @public\n */\nexport type DirectSpiralTypeName =\n  \"JapaneseCubic\"        // 1 term from each of the X,Y clothoid series expansions: y = x^3 / (6RL)\n  | \"Arema\"              // 2 terms from each of the X,Y clothoid series expansions; identical to ChineseCubic\n  | \"ChineseCubic\"       // Identical to Arema\n  | \"HalfCosine\"         // high continuity cosine variation from quadratic\n  | \"AustralianRailCorp\" // cubic with high accuracy distance series\n  | \"WesternAustralian\"  // simple cubic -- 2 terms of x series, 1 term of y series\n  | \"Czech\"              // simple cubic with two term distance approximation\n  | \"MXCubicAlongArc\"    // x obtained from fractional distance via 2-terms from series, y = x^3 / (6RL)\n  | \"Polish\"\n  | \"Italian\"\n  ;\n\n/**\n * TransitionSpiral3d is a base class for multiple variants of spirals.\n * * The menagerie of spiral types have 2 broad categories:\n *   * IntegratedSpiral3d -- a spiral whose direct function for curvature versus distance must be integrated to\n * determine x,y.\n *     * The IntegratedSpiral3d types are enumerated in `IntegratedSpiralTypes`.\n *   * DirectSpiral3d -- a spiral implemented with direct calculation of x,y from fractional position along the spiral.\n *     * The direct spiral types are enumerated in the `DirectSpiralType`.\n * * The method set for CurvePrimitive support includes a `handleTransitionSpiral(g: TransitionSpiral3d)` which receives\n * all the spiral types.\n * * The spiral class may impose expectations that its inflection is at the origin, with tangent along the x axis.\n *   * This is generally necessary for direct spirals.\n *   * This is not necessary for integrated spirals.\n * @public\n */\nexport abstract class TransitionSpiral3d extends CurvePrimitive {\n  /** String name of spiral type. */\n  protected _spiralType: string;\n  /** Original defining properties. */\n  protected _designProperties: TransitionConditionalProperties | undefined;\n  /** Placement transform. */\n  protected _localToWorld: Transform;\n  /**\n   * Fractional interval for the \"active\" part of a containing spiral.\n   * (the radius, angle, and length conditions define a complete spiral, and some portion of it is \"active\")\n   */\n  protected _activeFractionInterval: Segment1d;\n  /** Return (reference to) the active portion of the reference spiral. */\n  public get activeFractionInterval(): Segment1d {\n    return this._activeFractionInterval;\n  }\n  /** Strokes in the active portion. */\n  public abstract get activeStrokes(): LineString3d;\n  /** (Reference to) placement transform. */\n  public get localToWorld(): Transform {\n    return this._localToWorld;\n  }\n  protected constructor(\n    spiralType: string | undefined,\n    localToWorld: Transform,\n    activeFractionInterval: Segment1d | undefined,\n    designProperties: TransitionConditionalProperties | undefined,\n  ) {\n    super();\n    this._spiralType = spiralType ? spiralType : \"unknownSpiralType\";\n    this._designProperties = designProperties;\n    this._localToWorld = localToWorld;\n    this._activeFractionInterval = activeFractionInterval ? activeFractionInterval : Segment1d.create(0, 1);\n  }\n  public get spiralType(): string {\n    return this._spiralType;\n  }\n  /** Return 1/r with convention that exact zero input returns 0 (straight line, zero curvature, infinite radius). */\n  public static radiusToCurvature(radius: number): number {\n    return (radius === 0.0) ? 0.0 : 1.0 / radius;\n  }\n  /** Return 1/k with convention that near-zero input returns 0 (straight line, zero curvature, infinite radius). */\n  public static curvatureToRadius(curvature: number): number {\n    if (Math.abs(curvature) < Geometry.smallAngleRadians)\n      return 0.0;\n    return 1.0 / curvature;\n  }\n  /** Return a deep clone. */\n  public abstract override clone(): TransitionSpiral3d;\n  /** Recompute strokes. */\n  public abstract refreshComputedProperties(): void;\n  /** Return (if possible) a spiral which is a portion of this curve. */\n  public override clonePartialCurve(fractionA: number, fractionB: number): TransitionSpiral3d {\n    const spiralB = this.clone();\n    const globalFractionA = this._activeFractionInterval.fractionToPoint(fractionA);\n    const globalFractionB = this._activeFractionInterval.fractionToPoint(fractionB);\n    spiralB._activeFractionInterval.set(globalFractionA, globalFractionB);\n    spiralB.refreshComputedProperties();\n    return spiralB;\n  }\n  /** Clone with a transform applied.  */\n  public override cloneTransformed(transform: Transform): TransitionSpiral3d {\n    const result = this.clone();\n    result.tryTransformInPlace(transform); // we're confident it will always work\n    return result;\n  }\n  /** Return the average of the start and end curvatures. */\n  public static averageCurvature(radiusLimits: Segment1d): number {\n    return 0.5 * (TransitionSpiral3d.radiusToCurvature(radiusLimits.x0) + TransitionSpiral3d.radiusToCurvature(radiusLimits.x1));\n  }\n  /**\n   * Given two radii (or zeros for 0 curvature) return the average curvature.\n   * @param r0 start radius, or 0 for line.\n   * @param r1 end radius, or 0 for line.\n   */\n  public static averageCurvatureR0R1(r0: number, r1: number): number {\n    return 0.5 * (TransitionSpiral3d.radiusToCurvature(r0) + TransitionSpiral3d.radiusToCurvature(r1));\n  }\n  /**\n   * Given two radii (or zeros for 0 curvature) return the curvature at the given fraction.\n   * @param r0 start radius, or 0 for line.\n   * @param fraction fractional position between the curvatures defined by r0 and r1.\n   * @param r1 end radius, or 0 for line.\n   */\n  public static interpolateCurvatureR0R1(r0: number, fraction: number, r1: number): number {\n    return Geometry.interpolate(TransitionSpiral3d.radiusToCurvature(r0), fraction, TransitionSpiral3d.radiusToCurvature(r1));\n  }\n  /** Return the arc length of a transition spiral with given sweep and radius pair. */\n  public static radiusRadiusSweepRadiansToArcLength(radius0: number, radius1: number, sweepRadians: number): number {\n    return Math.abs(sweepRadians / TransitionSpiral3d.averageCurvatureR0R1(radius0, radius1));\n  }\n  /** Return the turn angle for spiral of given length between two radii */\n  public static radiusRadiusLengthToSweepRadians(radius0: number, radius1: number, arcLength: number): number {\n    return TransitionSpiral3d.averageCurvatureR0R1(radius0, radius1) * arcLength;\n  }\n  /** Return the end radius for spiral of given start radius, length, and turn angle. */\n  public static radius0LengthSweepRadiansToRadius1(radius0: number, arcLength: number, sweepRadians: number) {\n    return TransitionSpiral3d.curvatureToRadius(\n      (2.0 * sweepRadians / arcLength) - TransitionSpiral3d.radiusToCurvature(radius0),\n    );\n  }\n  /** Return the start radius for spiral of given end radius, length, and turn angle. */\n  public static radius1LengthSweepRadiansToRadius0(radius1: number, arcLength: number, sweepRadians: number) {\n    return TransitionSpiral3d.curvatureToRadius(\n      (2.0 * sweepRadians / arcLength) - TransitionSpiral3d.radiusToCurvature(radius1),\n    );\n  }\n  /** Return the original defining properties (if any) saved by the constructor. */\n  public get designProperties(): TransitionConditionalProperties | undefined {\n    return this._designProperties;\n  }\n  /**\n   * * If transformA is rigid with uniform scale, apply the rigid part of transformA to the localToWorld transform and\n   * return the scale and rigid separation.\n   * * If not rigid, do nothing and return undefined.\n   * * Also apply the scale factor to the designProperties.\n   * @param transformA\n   */\n  protected applyRigidPartOfTransform(transformA: Transform): { rigidAxes: Matrix3d, scale: number } | undefined {\n    const rigidData = transformA.matrix.factorRigidWithSignedScale();\n    if (rigidData !== undefined) {\n      // [sQ a][R b] = [sQ*R sQb+a]\n      // but we save it as [Q*R sQb+a] with spiral data scaled by s\n      const transformC0 = transformA.multiplyTransformTransform(this.localToWorld);\n      // but pull the scale part out of the matrix\n      const matrixC = rigidData.rigidAxes.multiplyMatrixMatrix(this.localToWorld.matrix);\n      this._localToWorld = Transform.createOriginAndMatrix(transformC0.origin, matrixC);\n      if (this.designProperties)\n        this.designProperties.applyScaleFactor(rigidData.scale);\n      return rigidData;\n    }\n    return undefined;\n  }\n  /**\n   * Construct an offset of the instance curve as viewed in the xy-plane (ignoring z).\n   * * No attempt is made to join the offsets of smaller constituent primitives. To construct a fully joined offset for an\n   * aggregate instance (e.g., LineString3d, CurveChainWithDistanceIndex), use RegionOps.constructCurveXYOffset() instead.\n   * @param offsetDistanceOrOptions offset distance (positive to left of the instance curve), or options object.\n   */\n  public override constructOffsetXY(offsetDistanceOrOptions: number | OffsetOptions): BSplineCurve3d | undefined {\n    const options = OffsetOptions.create(offsetDistanceOrOptions);\n    const handler = new CurveOffsetXYHandler(this, options.leftOffsetDistance);\n    this.emitStrokableParts(handler, options.strokeOptions);\n    return handler.claimResult();\n  }\n  /** Extend the range by the strokes of the spiral. */\n  public override extendRange(rangeToExtend: Range3d, transform?: Transform): void {\n    rangeToExtend.extendRange(this.rangeBetweenFractions(0.0, 1.0, transform));\n  }\n  /**\n   * Return the range of spiral between fractions of the activeStrokes.\n   * * Use activeStrokes point count times interval factor for initial evaluation count, but do at least 5.\n   */\n  public override rangeBetweenFractions(fractionA: number, fractionB: number, transform?: Transform): Range3d {\n    const strokes = this.activeStrokes;\n    if (undefined === strokes)\n      return Range3d.createNull();\n    let count = Math.ceil(strokes.numPoints() * Math.abs(fractionB - fractionA));\n    count = Geometry.clamp(5, count, 30);\n    return this.rangeBetweenFractionsByCount(fractionA, fractionB, count, transform, 0.5);\n  }\n  /**\n   * Project instance geometry (via dispatch) onto the given ray, and return the extreme fractional parameters of\n   * projection.\n   * @param ray ray onto which the instance is projected. A `Vector3d` is treated as a `Ray3d` with zero origin.\n   * @param lowHigh optional receiver for output\n   * @returns range of fractional projection parameters onto the ray, where 0.0 is start of the ray and 1.0 is the\n   * end of the ray.\n   */\n  public override projectedParameterRange(ray: Vector3d | Ray3d, lowHigh?: Range1d): Range1d | undefined {\n    return PlaneAltitudeRangeContext.findExtremeFractionsAlongDirection(this, ray, lowHigh);\n  }\n}\n"]}

package/lib/cjs/curve/spiral/XYCurveEvaluator.d.ts

@@ -5,14 +5,14 @@ import { Ray3d } from "../../geometry3d/Ray3d";
  * XYCurveEvaluator is an abstract with methods for evaluating X and Y parts of a curve parameterized by a fraction.
  * * The required methods call for independent X and Y evaluation.
  * * Base class methods package those (multiple) calls into point, ray, and plane structures.
- *    * A implementation that has evaluation substantial cost that can be shared among x,y parts or between
- *       primary functions and derivatives might choose to implement the point and derivative methods directly.
+ *    * An implementation that has evaluation substantial cost that can be shared among x,y parts or between
+ *      primary functions and derivatives might choose to implement the point and derivative methods directly.
  * @internal
  */
 export declare abstract class XYCurveEvaluator {
-    /** return a deep copy of the evaluator */
+    /** Return a deep copy of the evaluator. */
     abstract clone(): XYCurveEvaluator;
-    /** test for near identical evaluator */
+    /** Test for near identical evaluator. */
     abstract isAlmostEqual(other: any): boolean;
     /** Evaluate X at fractional position. */
     abstract fractionToX(fraction: number): number;
@@ -26,16 +26,21 @@ export declare abstract class XYCurveEvaluator {
     abstract fractionToDDX(fraction: number): number;
     /** Evaluate second derivative of Y with respect to fraction at fractional position. */
     abstract fractionToDDY(fraction: number): number;
-    /** Evaluate both X and Y at fractional coordinate, return bundled as a point. */
-    /** Evaluate second derivative of X with respect to fraction at fractional position. */
+    /** Evaluate third derivative of X with respect to fraction at fractional position. */
     abstract fractionToD3X(fraction: number): number;
-    /** Evaluate second derivative of Y with respect to fraction at fractional position. */
+    /** Evaluate third derivative of Y with respect to fraction at fractional position. */
     abstract fractionToD3Y(fraction: number): number;
     /** Evaluate both X and Y at fractional coordinate, return bundled as a point. */
     fractionToPoint(fraction: number, result?: Point3d): Point3d;
-    /** Evaluate both X and Y and their first derivatives at fractional coordinate, return bundled as origin and (non-unit) direction vector. */
+    /**
+     * Evaluate both X and Y and their first derivatives at fractional coordinate, return bundled as origin and
+     * (non-unit) direction vector.
+     */
     fractionToPointAndDerivative(fraction: number, result?: Ray3d): Ray3d;
-    /** Evaluate both X and Y and their second derivatives at fractional coordinate, return bundled as origin and (non-unit) vectorU an vectorV. */
+    /**
+     * Evaluate both X and Y and their second derivatives at fractional coordinate, return bundled as origin and
+     * (non-unit) vectorU an vectorV.
+     */
     fractionToPointAnd2Derivatives(fraction: number, result?: Plane3dByOriginAndVectors): Plane3dByOriginAndVectors;
     /**
      * Return the magnitude of the tangent vector at fraction.
@@ -44,34 +49,35 @@ export declare abstract class XYCurveEvaluator {
     fractionToTangentMagnitude(fraction: number): number;
     /** Invert the fractionToX function for given X. */
     abstract xToFraction(x: number): number | undefined;
-    /** Initialize class level work arrays for 5 point Gaussian Quadrature. */
     protected static _gaussX: Float64Array;
     protected static _gaussWeight: Float64Array;
     protected static _gaussMapper: (xA: number, xB: number, arrayX: Float64Array, arrayW: Float64Array) => number;
+    /**
+     * Initialize class level work arrays for 5 point Gaussian quadrature.
+     * * These static variables are reused on calls to [[integrateDistanceBetweenFractions]].
+     */
     static initWorkSpace(): void;
     /**
      * Integrate between nominal fractions with default gauss rule.
      * * The caller is expected to choose nearby fractions so that the single gauss interval accuracy is good.
-     * @param fraction0
-     * @param fraction1
      */
     integrateDistanceBetweenFractions(fraction0: number, fraction1: number): number;
     /**
-     * Inverse integrated distance
-     * @param fraction0 start of fraction interval
-     * @param fraction1 end of fraction interval
-     * @param distance0 distance at start
-     * @param distance1 distance at end
+     * Inverse integrated distance.
+     * @param fraction0 start of fraction interval.
+     * @param fraction1 end of fraction interval.
+     * @param distance0 distance at start.
+     * @param distance1 distance at end.
      * @param targetDistance intermediate distance.
      */
     inverseDistanceFraction(fraction0: number, fraction1: number, distance0: number, distance1: number, targetDistance: number): number | undefined;
     /**
-     *
+     * Get the point and its derivatives at a given fraction.
      * @param fraction fractional position along x axis
      * @param xy xy coordinates of point on the curve
-     * @param d1xy
-     * @param d2xy
-     * @param d3xy
+     * @param d1xy first derivative vector
+     * @param d2xy second derivative vector
+     * @param d3xy third derivative vector
      */
     fractionToPointAnd3Derivatives(fraction: number, xy: Point3d, d1xy?: Vector3d, d2xy?: Vector3d, d3xy?: Vector3d): void;
     /** Apply a uniform scale around the origin. */

package/lib/cjs/curve/spiral/XYCurveEvaluator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"XYCurveEvaluator.d.ts","sourceRoot":"","sources":["../../../../src/curve/spiral/XYCurveEvaluator.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,yBAAyB,EAAE,MAAM,4CAA4C,CAAC;AACvF,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAC;AAG/C;;;;;;;GAOG;AACH,8BAAsB,gBAAgB;IACpC,0CAA0C;aAC1B,KAAK,IAAI,gBAAgB;IACzC,wCAAwC;aACxB,aAAa,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO;IAClD,yCAAyC;aACzB,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IACrD,yCAAyC;aACzB,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IACrD,gFAAgF;aAChE,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IACtD,gFAAgF;aAChE,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IACtD,uFAAuF;aACvE,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IACvD,uFAAuF;aACvE,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IACvD,iFAAiF;IACjF,uFAAuF;aACvE,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IACvD,uFAAuF;aACvE,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IACvD,iFAAiF;IAC1E,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO;IAGnE,4IAA4I;IACrI,4BAA4B,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,KAAK,GAAG,KAAK;IAK5E,+IAA+I;IACxI,8BAA8B,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,yBAAyB,GAAG,yBAAyB;IAOtH;;;OAGG;IACI,0BAA0B,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAM3D,mDAAmD;aAEnC,WAAW,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAC1D,0EAA0E;IAG1E,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE,YAAY,CAAC;IACvC,SAAS,CAAC,MAAM,CAAC,YAAY,EAAE,YAAY,CAAC;IAC5C,SAAS,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY,KAAK,MAAM,CAAC;WAChG,aAAa;IAK3B;;;;;OAKG;IACI,iCAAiC,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM;IAUtF;;;;;;;OAOG;IACI,uBAAuB,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAatJ;;;;;;;OAOG;IACI,8BAA8B,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAE,QAAQ;IAStH,+CAA+C;aAC/B,YAAY,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI;CACxD"}
+{"version":3,"file":"XYCurveEvaluator.d.ts","sourceRoot":"","sources":["../../../../src/curve/spiral/XYCurveEvaluator.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,yBAAyB,EAAE,MAAM,4CAA4C,CAAC;AACvF,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAC;AAI/C;;;;;;;GAOG;AACH,8BAAsB,gBAAgB;IACpC,2CAA2C;aAC3B,KAAK,IAAI,gBAAgB;IACzC,yCAAyC;aACzB,aAAa,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO;IAClD,yCAAyC;aACzB,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IACrD,yCAAyC;aACzB,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IACrD,gFAAgF;aAChE,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IACtD,gFAAgF;aAChE,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IACtD,uFAAuF;aACvE,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IACvD,uFAAuF;aACvE,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IACvD,sFAAsF;aACtE,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IACvD,sFAAsF;aACtE,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IACvD,iFAAiF;IAC1E,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO;IAGnE;;;OAGG;IACI,4BAA4B,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,KAAK,GAAG,KAAK;IAK5E;;;OAGG;IACI,8BAA8B,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,yBAAyB,GAAG,yBAAyB;IAQtH;;;OAGG;IACI,0BAA0B,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAK3D,mDAAmD;aACnC,WAAW,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAC1D,SAAS,CAAC,MAAM,CAAC,OAAO,EAAE,YAAY,CAAC;IACvC,SAAS,CAAC,MAAM,CAAC,YAAY,EAAE,YAAY,CAAC;IAC5C,SAAS,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY,KAAK,MAAM,CAAC;IAC9G;;;OAGG;WACW,aAAa,IAAI,IAAI;IAKnC;;;OAGG;IACI,iCAAiC,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM;IAUtF;;;;;;;OAOG;IACI,uBAAuB,CAC5B,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GACjG,MAAM,GAAG,SAAS;IAYrB;;;;;;;OAOG;IACI,8BAA8B,CACnC,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAE,QAAQ,GAC/E,IAAI;IASP,+CAA+C;aAC/B,YAAY,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI;CACxD"}

package/lib/cjs/curve/spiral/XYCurveEvaluator.js

@@ -18,8 +18,8 @@ const Newton_1 = require("../../numerics/Newton");
  * XYCurveEvaluator is an abstract with methods for evaluating X and Y parts of a curve parameterized by a fraction.
  * * The required methods call for independent X and Y evaluation.
  * * Base class methods package those (multiple) calls into point, ray, and plane structures.
- *    * A implementation that has evaluation substantial cost that can be shared among x,y parts or between
- *       primary functions and derivatives might choose to implement the point and derivative methods directly.
+ *    * An implementation that has evaluation substantial cost that can be shared among x,y parts or between
+ *      primary functions and derivatives might choose to implement the point and derivative methods directly.
  * @internal
  */
 class XYCurveEvaluator {
@@ -27,11 +27,17 @@ class XYCurveEvaluator {
     fractionToPoint(fraction, result) {
         return Point3dVector3d_1.Point3d.create(this.fractionToX(fraction), this.fractionToY(fraction), 0.0, result);
     }
-    /** Evaluate both X and Y and their first derivatives at fractional coordinate, return bundled as origin and (non-unit) direction vector. */
+    /**
+     * Evaluate both X and Y and their first derivatives at fractional coordinate, return bundled as origin and
+     * (non-unit) direction vector.
+     */
     fractionToPointAndDerivative(fraction, result) {
         return Ray3d_1.Ray3d.createXYZUVW(this.fractionToX(fraction), this.fractionToY(fraction), 0.0, this.fractionToDX(fraction), this.fractionToDY(fraction), 0, result);
     }
-    /** Evaluate both X and Y and their second derivatives at fractional coordinate, return bundled as origin and (non-unit) vectorU an vectorV. */
+    /**
+     * Evaluate both X and Y and their second derivatives at fractional coordinate, return bundled as origin and
+     * (non-unit) vectorU an vectorV.
+     */
     fractionToPointAnd2Derivatives(fraction, result) {
         return Plane3dByOriginAndVectors_1.Plane3dByOriginAndVectors.createOriginAndVectorsXYZ(this.fractionToX(fraction), this.fractionToY(fraction), 0.0, this.fractionToDX(fraction), this.fractionToDY(fraction), 0, this.fractionToDDX(fraction), this.fractionToDDY(fraction), 0, result);
     }
@@ -44,12 +50,13 @@ class XYCurveEvaluator {
         const v = this.fractionToDY(fraction);
         return Geometry_1.Geometry.hypotenuseXY(u, v);
     }
-    /** Initialize class level work arrays for 5 point Gaussian Quadrature. */
-    // Class resources for integration . . .
-    // These static variables are reused on calls to integrateFromStartFraction
     static _gaussX;
     static _gaussWeight;
     static _gaussMapper;
+    /**
+     * Initialize class level work arrays for 5 point Gaussian quadrature.
+     * * These static variables are reused on calls to [[integrateDistanceBetweenFractions]].
+     */
     static initWorkSpace() {
         XYCurveEvaluator._gaussX = new Float64Array(5);
         XYCurveEvaluator._gaussWeight = new Float64Array(5);
@@ -58,8 +65,6 @@ class XYCurveEvaluator {
     /**
      * Integrate between nominal fractions with default gauss rule.
      * * The caller is expected to choose nearby fractions so that the single gauss interval accuracy is good.
-     * @param fraction0
-     * @param fraction1
      */
     integrateDistanceBetweenFractions(fraction0, fraction1) {
         const gaussX = XYCurveEvaluator._gaussX;
@@ -72,11 +77,11 @@ class XYCurveEvaluator {
         return sum;
     }
     /**
-     * Inverse integrated distance
-     * @param fraction0 start of fraction interval
-     * @param fraction1 end of fraction interval
-     * @param distance0 distance at start
-     * @param distance1 distance at end
+     * Inverse integrated distance.
+     * @param fraction0 start of fraction interval.
+     * @param fraction1 end of fraction interval.
+     * @param distance0 distance at start.
+     * @param distance1 distance at end.
      * @param targetDistance intermediate distance.
      */
     inverseDistanceFraction(fraction0, fraction1, distance0, distance1, targetDistance) {
@@ -90,12 +95,12 @@ class XYCurveEvaluator {
         return undefined;
     }
     /**
-     *
+     * Get the point and its derivatives at a given fraction.
      * @param fraction fractional position along x axis
      * @param xy xy coordinates of point on the curve
-     * @param d1xy
-     * @param d2xy
-     * @param d3xy
+     * @param d1xy first derivative vector
+     * @param d2xy second derivative vector
+     * @param d3xy third derivative vector
      */
     fractionToPointAnd3Derivatives(fraction, xy, d1xy, d2xy, d3xy) {
         xy.set(this.fractionToX(fraction), this.fractionToY(fraction), 0);

package/lib/cjs/curve/spiral/XYCurveEvaluator.js.map

@@ -1 +1 @@
-{"version":3,"file":"XYCurveEvaluator.js","sourceRoot":"","sources":["../../../../src/curve/spiral/XYCurveEvaluator.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F;;GAEG;AACH,6CAA0C;AAC1C,0FAAuF;AACvF,sEAAqE;AACrE,kDAA+C;AAC/C,0DAAuD;AACvD,kDAAqD;AACrD;;;;;;;GAOG;AACH,MAAsB,gBAAgB;IAsBpC,iFAAiF;IAC1E,eAAe,CAAC,QAAgB,EAAE,MAAgB;QACvD,OAAO,yBAAO,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;IAC7F,CAAC;IACD,4IAA4I;IACrI,4BAA4B,CAAC,QAAgB,EAAE,MAAc;QAClE,OAAO,aAAK,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,GAAG,EACnF,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC,EAC3D,MAAM,CAAC,CAAC;IACZ,CAAC;IACD,+IAA+I;IACxI,8BAA8B,CAAC,QAAgB,EAAE,MAAkC;QACxF,OAAO,qDAAyB,CAAC,yBAAyB,CACxD,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,GAAG,EAC3D,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC,EAC3D,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC,EAC7D,MAAM,CAAC,CAAC;IACZ,CAAC;IACD;;;OAGG;IACI,0BAA0B,CAAC,QAAgB;QAChD,MAAM,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QACtC,MAAM,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QACtC,OAAO,mBAAQ,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACrC,CAAC;IAKD,0EAA0E;IAC1E,wCAAwC;IACxC,2EAA2E;IACjE,MAAM,CAAC,OAAO,CAAe;IAC7B,MAAM,CAAC,YAAY,CAAe;IAClC,MAAM,CAAC,YAAY,CAAiF;IACvG,MAAM,CAAC,aAAa;QACzB,gBAAgB,CAAC,OAAO,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC,CAAC;QAC/C,gBAAgB,CAAC,YAAY,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC,CAAC;QACpD,gBAAgB,CAAC,YAAY,GAAG,CAAC,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,uBAAU,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IACjH,CAAC;IACD;;;;;OAKG;IACI,iCAAiC,CAAC,SAAiB,EAAE,SAAiB;QAC3E,MAAM,MAAM,GAAG,gBAAgB,CAAC,OAAO,CAAC;QACxC,MAAM,WAAW,GAAG,gBAAgB,CAAC,YAAY,CAAC;QAClD,MAAM,OAAO,GAAG,gBAAgB,CAAC,YAAY,CAAC,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;QACzF,IAAI,GAAG,GAAG,CAAC,CAAC;QACZ,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,EAAE,CAAC,EAAE,EAAE,CAAC;YACjC,GAAG,IAAI,WAAW,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QACrE,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IACD;;;;;;;OAOG;IACI,uBAAuB,CAAC,SAAiB,EAAE,SAAiB,EAAE,SAAiB,EAAE,SAAiB,EAAE,cAAsB;QAC/H,MAAM,aAAa,GAAG,mBAAQ,CAAC,kBAAkB,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC;QAC9G,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO,qBAAY,CAAC,WAAW,CAAC,aAAa,EAC3C,CAAC,QAAgB,EAAE,EAAE;gBACnB,MAAM,CAAC,GAAG,IAAI,CAAC,iCAAiC,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;gBACtE,OAAO,SAAS,GAAG,CAAC,GAAG,cAAc,CAAC;YACxC,CAAC,EACD,CAAC,QAAgB,EAAE,EAAE,CAAC,IAAI,CAAC,0BAA0B,CAAC,QAAQ,CAAC,CAAC,CAAC;QACrE,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;;;OAOG;IACI,8BAA8B,CAAC,QAAgB,EAAE,EAAW,EAAE,IAAe,EAAE,IAAe,EAAE,IAAe;QACpH,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;QAClE,IAAI,IAAI;YACN,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;QACxE,IAAI,IAAI;YACN,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;QAC1E,IAAI,IAAI;YACN,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;IAC5E,CAAC;CAGF;AAxHD,4CAwHC;AACD,sDAAsD;AACtD,gBAAgB,CAAC,aAAa,EAAE,CAAC","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\n/** @packageDocumentation\n * @module Curve\n */\nimport { Geometry } from \"../../Geometry\";\nimport { Plane3dByOriginAndVectors } from \"../../geometry3d/Plane3dByOriginAndVectors\";\nimport { Point3d, Vector3d } from \"../../geometry3d/Point3dVector3d\";\nimport { Ray3d } from \"../../geometry3d/Ray3d\";\nimport { Quadrature } from \"../../numerics/Quadrature\";\nimport { SimpleNewton } from \"../../numerics/Newton\";\n/**\n * XYCurveEvaluator is an abstract with methods for evaluating X and Y parts of a curve parameterized by a fraction.\n * * The required methods call for independent X and Y evaluation.\n * * Base class methods package those (multiple) calls into point, ray, and plane structures.\n *    * A implementation that has evaluation substantial cost that can be shared among x,y parts or between\n *       primary functions and derivatives might choose to implement the point and derivative methods directly.\n * @internal\n */\nexport abstract class XYCurveEvaluator {\n  /** return a deep copy of the evaluator */\n  public abstract clone(): XYCurveEvaluator;\n  /** test for near identical evaluator */\n  public abstract isAlmostEqual(other: any): boolean;\n  /** Evaluate X at fractional position. */\n  public abstract fractionToX(fraction: number): number;\n  /** Evaluate Y at fractional position. */\n  public abstract fractionToY(fraction: number): number;\n  /** Evaluate derivative of X with respect to fraction at fractional position. */\n  public abstract fractionToDX(fraction: number): number;\n  /** Evaluate derivative of Y with respect to fraction at fractional position. */\n  public abstract fractionToDY(fraction: number): number;\n  /** Evaluate second derivative of X with respect to fraction at fractional position. */\n  public abstract fractionToDDX(fraction: number): number;\n  /** Evaluate second derivative of Y with respect to fraction at fractional position. */\n  public abstract fractionToDDY(fraction: number): number;\n  /** Evaluate both X and Y at fractional coordinate, return bundled as a point. */\n  /** Evaluate second derivative of X with respect to fraction at fractional position. */\n  public abstract fractionToD3X(fraction: number): number;\n  /** Evaluate second derivative of Y with respect to fraction at fractional position. */\n  public abstract fractionToD3Y(fraction: number): number;\n  /** Evaluate both X and Y at fractional coordinate, return bundled as a point. */\n  public fractionToPoint(fraction: number, result?: Point3d): Point3d {\n    return Point3d.create(this.fractionToX(fraction), this.fractionToY(fraction), 0.0, result);\n  }\n  /** Evaluate both X and Y and their first derivatives at fractional coordinate, return bundled as origin and (non-unit) direction vector. */\n  public fractionToPointAndDerivative(fraction: number, result?: Ray3d): Ray3d {\n    return Ray3d.createXYZUVW(this.fractionToX(fraction), this.fractionToY(fraction), 0.0,\n      this.fractionToDX(fraction), this.fractionToDY(fraction), 0,\n      result);\n  }\n  /** Evaluate both X and Y and their second derivatives at fractional coordinate, return bundled as origin and (non-unit) vectorU an vectorV. */\n  public fractionToPointAnd2Derivatives(fraction: number, result?: Plane3dByOriginAndVectors): Plane3dByOriginAndVectors {\n    return Plane3dByOriginAndVectors.createOriginAndVectorsXYZ(\n      this.fractionToX(fraction), this.fractionToY(fraction), 0.0,\n      this.fractionToDX(fraction), this.fractionToDY(fraction), 0,\n      this.fractionToDDX(fraction), this.fractionToDDY(fraction), 0,\n      result);\n  }\n  /**\n   * Return the magnitude of the tangent vector at fraction.\n   * @param fraction fractional position along the curve\n   */\n  public fractionToTangentMagnitude(fraction: number): number {\n    const u = this.fractionToDX(fraction);\n    const v = this.fractionToDY(fraction);\n    return Geometry.hypotenuseXY(u, v);\n  }\n\n  /** Invert the fractionToX function for given X. */\n\n  public abstract xToFraction(x: number): number | undefined;\n  /** Initialize class level work arrays for 5 point Gaussian Quadrature. */\n  // Class resources for integration . . .\n  // These static variables are reused on calls to integrateFromStartFraction\n  protected static _gaussX: Float64Array;\n  protected static _gaussWeight: Float64Array;\n  protected static _gaussMapper: (xA: number, xB: number, arrayX: Float64Array, arrayW: Float64Array) => number;\n  public static initWorkSpace() {\n    XYCurveEvaluator._gaussX = new Float64Array(5);\n    XYCurveEvaluator._gaussWeight = new Float64Array(5);\n    XYCurveEvaluator._gaussMapper = (xA, xB, xMapped, wMapped) => Quadrature.setupGauss5(xA, xB, xMapped, wMapped);\n  }\n  /**\n   * Integrate between nominal fractions with default gauss rule.\n   * * The caller is expected to choose nearby fractions so that the single gauss interval accuracy is good.\n   * @param fraction0\n   * @param fraction1\n   */\n  public integrateDistanceBetweenFractions(fraction0: number, fraction1: number): number {\n    const gaussX = XYCurveEvaluator._gaussX;\n    const gaussWeight = XYCurveEvaluator._gaussWeight;\n    const numEval = XYCurveEvaluator._gaussMapper(fraction0, fraction1, gaussX, gaussWeight);\n    let sum = 0;\n    for (let k = 0; k < numEval; k++) {\n      sum += gaussWeight[k] * this.fractionToTangentMagnitude(gaussX[k]);\n    }\n    return sum;\n  }\n  /**\n   * Inverse integrated distance\n   * @param fraction0 start of fraction interval\n   * @param fraction1 end of fraction interval\n   * @param distance0 distance at start\n   * @param distance1 distance at end\n   * @param targetDistance intermediate distance.\n   */\n  public inverseDistanceFraction(fraction0: number, fraction1: number, distance0: number, distance1: number, targetDistance: number): number | undefined {\n    const startFraction = Geometry.inverseInterpolate(fraction0, distance0, fraction1, distance1, targetDistance);\n    if (startFraction !== undefined) {\n      return SimpleNewton.runNewton1D(startFraction,\n        (fraction: number) => {\n          const d = this.integrateDistanceBetweenFractions(fraction0, fraction);\n          return distance0 + d - targetDistance;\n        },\n        (fraction: number) => this.fractionToTangentMagnitude(fraction));\n    }\n    return undefined;\n  }\n\n  /**\n   *\n   * @param fraction fractional position along x axis\n   * @param xy xy coordinates of point on the curve\n   * @param d1xy\n   * @param d2xy\n   * @param d3xy\n   */\n  public fractionToPointAnd3Derivatives(fraction: number, xy: Point3d, d1xy?: Vector3d, d2xy?: Vector3d, d3xy?: Vector3d) {\n    xy.set(this.fractionToX(fraction), this.fractionToY(fraction), 0);\n    if (d1xy)\n      d1xy.set(this.fractionToDX(fraction), this.fractionToDY(fraction), 0);\n    if (d2xy)\n      d2xy.set(this.fractionToDDX(fraction), this.fractionToDDY(fraction), 0);\n    if (d3xy)\n      d3xy.set(this.fractionToD3X(fraction), this.fractionToD3Y(fraction), 0);\n  }\n  /** Apply a uniform scale around the origin. */\n  public abstract scaleInPlace(scaleFactor: number): void;\n}\n// at load time, initialize gauss quadrature workspace\nXYCurveEvaluator.initWorkSpace();\n"]}
+{"version":3,"file":"XYCurveEvaluator.js","sourceRoot":"","sources":["../../../../src/curve/spiral/XYCurveEvaluator.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F;;GAEG;AACH,6CAA0C;AAC1C,0FAAuF;AACvF,sEAAqE;AACrE,kDAA+C;AAC/C,0DAAuD;AACvD,kDAAqD;AAErD;;;;;;;GAOG;AACH,MAAsB,gBAAgB;IAqBpC,iFAAiF;IAC1E,eAAe,CAAC,QAAgB,EAAE,MAAgB;QACvD,OAAO,yBAAO,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;IAC7F,CAAC;IACD;;;OAGG;IACI,4BAA4B,CAAC,QAAgB,EAAE,MAAc;QAClE,OAAO,aAAK,CAAC,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,GAAG,EACnF,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC,EAC3D,MAAM,CAAC,CAAC;IACZ,CAAC;IACD;;;OAGG;IACI,8BAA8B,CAAC,QAAgB,EAAE,MAAkC;QACxF,OAAO,qDAAyB,CAAC,yBAAyB,CACxD,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,GAAG,EAC3D,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC,EAC3D,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC,EAC7D,MAAM,CACP,CAAC;IACJ,CAAC;IACD;;;OAGG;IACI,0BAA0B,CAAC,QAAgB;QAChD,MAAM,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QACtC,MAAM,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QACtC,OAAO,mBAAQ,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACrC,CAAC;IAGS,MAAM,CAAC,OAAO,CAAe;IAC7B,MAAM,CAAC,YAAY,CAAe;IAClC,MAAM,CAAC,YAAY,CAAiF;IAC9G;;;OAGG;IACI,MAAM,CAAC,aAAa;QACzB,gBAAgB,CAAC,OAAO,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC,CAAC;QAC/C,gBAAgB,CAAC,YAAY,GAAG,IAAI,YAAY,CAAC,CAAC,CAAC,CAAC;QACpD,gBAAgB,CAAC,YAAY,GAAG,CAAC,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,uBAAU,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IACjH,CAAC;IACD;;;OAGG;IACI,iCAAiC,CAAC,SAAiB,EAAE,SAAiB;QAC3E,MAAM,MAAM,GAAG,gBAAgB,CAAC,OAAO,CAAC;QACxC,MAAM,WAAW,GAAG,gBAAgB,CAAC,YAAY,CAAC;QAClD,MAAM,OAAO,GAAG,gBAAgB,CAAC,YAAY,CAAC,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;QACzF,IAAI,GAAG,GAAG,CAAC,CAAC;QACZ,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,EAAE,CAAC,EAAE,EAAE,CAAC;YACjC,GAAG,IAAI,WAAW,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QACrE,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IACD;;;;;;;OAOG;IACI,uBAAuB,CAC5B,SAAiB,EAAE,SAAiB,EAAE,SAAiB,EAAE,SAAiB,EAAE,cAAsB;QAElG,MAAM,aAAa,GAAG,mBAAQ,CAAC,kBAAkB,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC;QAC9G,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO,qBAAY,CAAC,WAAW,CAAC,aAAa,EAC3C,CAAC,QAAgB,EAAE,EAAE;gBACnB,MAAM,CAAC,GAAG,IAAI,CAAC,iCAAiC,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;gBACtE,OAAO,SAAS,GAAG,CAAC,GAAG,cAAc,CAAC;YACxC,CAAC,EACD,CAAC,QAAgB,EAAE,EAAE,CAAC,IAAI,CAAC,0BAA0B,CAAC,QAAQ,CAAC,CAAC,CAAC;QACrE,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD;;;;;;;OAOG;IACI,8BAA8B,CACnC,QAAgB,EAAE,EAAW,EAAE,IAAe,EAAE,IAAe,EAAE,IAAe;QAEhF,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;QAClE,IAAI,IAAI;YACN,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;QACxE,IAAI,IAAI;YACN,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;QAC1E,IAAI,IAAI;YACN,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;IAC5E,CAAC;CAGF;AA9HD,4CA8HC;AACD,sDAAsD;AACtD,gBAAgB,CAAC,aAAa,EAAE,CAAC","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\n/** @packageDocumentation\n * @module Curve\n */\nimport { Geometry } from \"../../Geometry\";\nimport { Plane3dByOriginAndVectors } from \"../../geometry3d/Plane3dByOriginAndVectors\";\nimport { Point3d, Vector3d } from \"../../geometry3d/Point3dVector3d\";\nimport { Ray3d } from \"../../geometry3d/Ray3d\";\nimport { Quadrature } from \"../../numerics/Quadrature\";\nimport { SimpleNewton } from \"../../numerics/Newton\";\n\n/**\n * XYCurveEvaluator is an abstract with methods for evaluating X and Y parts of a curve parameterized by a fraction.\n * * The required methods call for independent X and Y evaluation.\n * * Base class methods package those (multiple) calls into point, ray, and plane structures.\n *    * An implementation that has evaluation substantial cost that can be shared among x,y parts or between\n *      primary functions and derivatives might choose to implement the point and derivative methods directly.\n * @internal\n */\nexport abstract class XYCurveEvaluator {\n  /** Return a deep copy of the evaluator. */\n  public abstract clone(): XYCurveEvaluator;\n  /** Test for near identical evaluator. */\n  public abstract isAlmostEqual(other: any): boolean;\n  /** Evaluate X at fractional position. */\n  public abstract fractionToX(fraction: number): number;\n  /** Evaluate Y at fractional position. */\n  public abstract fractionToY(fraction: number): number;\n  /** Evaluate derivative of X with respect to fraction at fractional position. */\n  public abstract fractionToDX(fraction: number): number;\n  /** Evaluate derivative of Y with respect to fraction at fractional position. */\n  public abstract fractionToDY(fraction: number): number;\n  /** Evaluate second derivative of X with respect to fraction at fractional position. */\n  public abstract fractionToDDX(fraction: number): number;\n  /** Evaluate second derivative of Y with respect to fraction at fractional position. */\n  public abstract fractionToDDY(fraction: number): number;\n  /** Evaluate third derivative of X with respect to fraction at fractional position. */\n  public abstract fractionToD3X(fraction: number): number;\n  /** Evaluate third derivative of Y with respect to fraction at fractional position. */\n  public abstract fractionToD3Y(fraction: number): number;\n  /** Evaluate both X and Y at fractional coordinate, return bundled as a point. */\n  public fractionToPoint(fraction: number, result?: Point3d): Point3d {\n    return Point3d.create(this.fractionToX(fraction), this.fractionToY(fraction), 0.0, result);\n  }\n  /**\n   * Evaluate both X and Y and their first derivatives at fractional coordinate, return bundled as origin and\n   * (non-unit) direction vector.\n   */\n  public fractionToPointAndDerivative(fraction: number, result?: Ray3d): Ray3d {\n    return Ray3d.createXYZUVW(this.fractionToX(fraction), this.fractionToY(fraction), 0.0,\n      this.fractionToDX(fraction), this.fractionToDY(fraction), 0,\n      result);\n  }\n  /**\n   * Evaluate both X and Y and their second derivatives at fractional coordinate, return bundled as origin and\n   * (non-unit) vectorU an vectorV.\n   */\n  public fractionToPointAnd2Derivatives(fraction: number, result?: Plane3dByOriginAndVectors): Plane3dByOriginAndVectors {\n    return Plane3dByOriginAndVectors.createOriginAndVectorsXYZ(\n      this.fractionToX(fraction), this.fractionToY(fraction), 0.0,\n      this.fractionToDX(fraction), this.fractionToDY(fraction), 0,\n      this.fractionToDDX(fraction), this.fractionToDDY(fraction), 0,\n      result,\n    );\n  }\n  /**\n   * Return the magnitude of the tangent vector at fraction.\n   * @param fraction fractional position along the curve\n   */\n  public fractionToTangentMagnitude(fraction: number): number {\n    const u = this.fractionToDX(fraction);\n    const v = this.fractionToDY(fraction);\n    return Geometry.hypotenuseXY(u, v);\n  }\n  /** Invert the fractionToX function for given X. */\n  public abstract xToFraction(x: number): number | undefined;\n  protected static _gaussX: Float64Array;\n  protected static _gaussWeight: Float64Array;\n  protected static _gaussMapper: (xA: number, xB: number, arrayX: Float64Array, arrayW: Float64Array) => number;\n  /**\n   * Initialize class level work arrays for 5 point Gaussian quadrature.\n   * * These static variables are reused on calls to [[integrateDistanceBetweenFractions]].\n   */\n  public static initWorkSpace(): void {\n    XYCurveEvaluator._gaussX = new Float64Array(5);\n    XYCurveEvaluator._gaussWeight = new Float64Array(5);\n    XYCurveEvaluator._gaussMapper = (xA, xB, xMapped, wMapped) => Quadrature.setupGauss5(xA, xB, xMapped, wMapped);\n  }\n  /**\n   * Integrate between nominal fractions with default gauss rule.\n   * * The caller is expected to choose nearby fractions so that the single gauss interval accuracy is good.\n   */\n  public integrateDistanceBetweenFractions(fraction0: number, fraction1: number): number {\n    const gaussX = XYCurveEvaluator._gaussX;\n    const gaussWeight = XYCurveEvaluator._gaussWeight;\n    const numEval = XYCurveEvaluator._gaussMapper(fraction0, fraction1, gaussX, gaussWeight);\n    let sum = 0;\n    for (let k = 0; k < numEval; k++) {\n      sum += gaussWeight[k] * this.fractionToTangentMagnitude(gaussX[k]);\n    }\n    return sum;\n  }\n  /**\n   * Inverse integrated distance.\n   * @param fraction0 start of fraction interval.\n   * @param fraction1 end of fraction interval.\n   * @param distance0 distance at start.\n   * @param distance1 distance at end.\n   * @param targetDistance intermediate distance.\n   */\n  public inverseDistanceFraction(\n    fraction0: number, fraction1: number, distance0: number, distance1: number, targetDistance: number,\n  ): number | undefined {\n    const startFraction = Geometry.inverseInterpolate(fraction0, distance0, fraction1, distance1, targetDistance);\n    if (startFraction !== undefined) {\n      return SimpleNewton.runNewton1D(startFraction,\n        (fraction: number) => {\n          const d = this.integrateDistanceBetweenFractions(fraction0, fraction);\n          return distance0 + d - targetDistance;\n        },\n        (fraction: number) => this.fractionToTangentMagnitude(fraction));\n    }\n    return undefined;\n  }\n  /**\n   * Get the point and its derivatives at a given fraction.\n   * @param fraction fractional position along x axis\n   * @param xy xy coordinates of point on the curve\n   * @param d1xy first derivative vector\n   * @param d2xy second derivative vector\n   * @param d3xy third derivative vector\n   */\n  public fractionToPointAnd3Derivatives(\n    fraction: number, xy: Point3d, d1xy?: Vector3d, d2xy?: Vector3d, d3xy?: Vector3d,\n  ): void {\n    xy.set(this.fractionToX(fraction), this.fractionToY(fraction), 0);\n    if (d1xy)\n      d1xy.set(this.fractionToDX(fraction), this.fractionToDY(fraction), 0);\n    if (d2xy)\n      d2xy.set(this.fractionToDDX(fraction), this.fractionToDDY(fraction), 0);\n    if (d3xy)\n      d3xy.set(this.fractionToD3X(fraction), this.fractionToD3Y(fraction), 0);\n  }\n  /** Apply a uniform scale around the origin. */\n  public abstract scaleInPlace(scaleFactor: number): void;\n}\n// at load time, initialize gauss quadrature workspace\nXYCurveEvaluator.initWorkSpace();\n"]}