@itwin/core-geometry 4.10.0-dev.9 → 5.0.0-dev.0

package/lib/esm/curve/Arc3d.js

@@ -11,7 +11,8 @@ import { Plane3dByOriginAndVectors } from "../geometry3d/Plane3dByOriginAndVecto
 import { Point3d, Vector3d } from "../geometry3d/Point3dVector3d";
 import { Range1d, Range3d } from "../geometry3d/Range";
 import { Ray3d } from "../geometry3d/Ray3d";
-import { SineCosinePolynomial, SmallSystem, TrigPolynomial } from "../numerics/Polynomials";
+import { SineCosinePolynomial, TrigPolynomial } from "../numerics/Polynomials";
+import { SmallSystem } from "../numerics/SmallSystem";
 import { CurveExtendMode, CurveExtendOptions } from "./CurveExtendMode";
 import { CurveIntervalRole, CurveLocationDetail, CurveSearchStatus } from "./CurveLocationDetail";
 import { CurvePrimitive } from "./CurvePrimitive";
@@ -150,15 +151,15 @@ export class Arc3d extends CurvePrimitive {
     isSameGeometryClass(other) {
         return other instanceof Arc3d;
     }
-    /** Read property for (clone of) center */
+    /** Read property for (clone of) center. */
     get center() {
         return this._center.clone();
     }
-    /** Read property for (clone of) vector0 */
+    /** Read property for (clone of) vector0. */
     get vector0() {
         return this._matrix.columnX();
     }
-    /** Read property for (clone of) vector90 */
+    /** Read property for (clone of) vector90. */
     get vector90() {
         return this._matrix.columnY();
     }
@@ -166,11 +167,11 @@ export class Arc3d extends CurvePrimitive {
     get perpendicularVector() {
         return this._matrix.columnZ();
     }
-    /** Read property for (clone of) matrix of vector0, vector90, unit normal */
+    /** Read property for (clone of) matrix of vector0, vector90, unit normal. */
     matrixClone() {
         return this._matrix.clone();
     }
-    /** Read property for (reference to) matrix of vector0, vector90, unit normal */
+    /** Read property for (reference to) matrix of vector0, vector90, unit normal. */
     get matrixRef() {
         return this._matrix;
     }
@@ -181,21 +182,21 @@ export class Arc3d extends CurvePrimitive {
     set sweep(value) {
         this._sweep.setFrom(value);
     }
-    /** An Arc3d extends along its complete elliptic arc */
+    /** An Arc3d extends along its complete elliptic arc. */
     get isExtensibleFractionSpace() {
         return true;
     }
     // constructor copies the pointers
     constructor(center, matrix, sweep) {
         super();
-        /** String name for schema properties */
+        /** String name for schema properties. */
         this.curvePrimitiveType = "arc";
         this._center = center;
         this._matrix = matrix;
         this._sweep = sweep;
     }
     /**
-     * Return a clone of the arc, with transform applied
+     * Return a clone of the arc, with transform applied.
      * @param transform
      */
     cloneTransformed(transform) {
@@ -205,9 +206,9 @@ export class Arc3d extends CurvePrimitive {
     }
     /**
      * Redefine the arc with (captured references to) given data.
-     * @param center arc center
-     * @param matrix matrix with columns vector0, vector 90, and their unit cross product
-     * @param sweep angle sweep
+     * @param center arc center.
+     * @param matrix matrix with columns vector0, vector 90, and their unit cross product.
+     * @param sweep angle sweep.
      */
     setRefs(center, matrix, sweep) {
         this._center = center;
@@ -216,14 +217,14 @@ export class Arc3d extends CurvePrimitive {
     }
     /**
      * Redefine the arc with (clones of) given data.
-     * @param center arc center
-     * @param matrix matrix with columns vector0, vector 90, and their unit cross product
-     * @param sweep angle sweep
+     * @param center arc center.
+     * @param matrix matrix with columns vector0, vector 90, and their unit cross product.
+     * @param sweep angle sweep.
      */
     set(center, matrix, sweep) {
         this.setRefs(center.clone(), matrix.clone(), sweep ? sweep.clone() : AngleSweep.create360());
     }
-    /** Copy center, matrix, and sweep from other Arc3d */
+    /** Copy center, matrix, and sweep from other Arc3d. */
     setFrom(other) {
         this._center.setFrom(other._center);
         this._matrix.setFrom(other._matrix);
@@ -235,9 +236,9 @@ export class Arc3d extends CurvePrimitive {
     }
     /**
      * Create an arc, capturing references to center, matrix and sweep.
-     * @param center center point
-     * @param matrix matrix with columns vector0, vector90, and unit cross product
-     * @param sweep sweep limits
+     * @param center center point.
+     * @param matrix matrix with columns vector0, vector90, and unit cross product.
+     * @param sweep sweep limits.
      * @param result optional preallocated result.
      */
     static createRefs(center, matrix, sweep, result) {
@@ -249,11 +250,11 @@ export class Arc3d extends CurvePrimitive {
     }
     /**
      * Create an arc from center, x column to be scaled, and y column to be scaled.
-     * @param center center of ellipse
-     * @param matrix matrix whose x and y columns are unit vectors to be scaled by radius0 and radius90
+     * @param center center of ellipse.
+     * @param matrix matrix whose x and y columns are scaled by radius0 and radius90.
      * @param radius0 radius in x direction.
      * @param radius90 radius in y direction.
-     * @param sweep sweep limits
+     * @param sweep sweep limits.
      * @param result optional preallocated result.
      */
     static createScaledXYColumns(center, matrix, radius0, radius90, sweep, result) {
@@ -262,9 +263,9 @@ export class Arc3d extends CurvePrimitive {
         return Arc3d.create(center, vector0.scale(radius0, vector0), vector90.scale(radius90, vector90), sweep, result);
     }
     /**
-     * Create a (full circular) arc from center, normal and radius
-     * @param center center of ellipse.  If undefined, center at 000
-     * @param normal normal vector
+     * Create a (full circular) arc from center, normal and radius.
+     * @param center center of ellipse. If undefined, center at 000.
+     * @param normal normal vector.
      * @param radius radius in x direction.
      * @param result optional preallocated result.
      */
@@ -274,11 +275,11 @@ export class Arc3d extends CurvePrimitive {
     }
     /**
      * Create an arc by center with vectors to points at 0 and 90 degrees in parameter space.
-     * @param center arc center
-     * @param vector0 vector to 0 degrees (commonly major axis)
-     * @param vector90 vector to 90 degree point (commonly minor axis)
-     * @param sweep sweep limits (default full sweep)
-     * @param result optional preallocated result
+     * @param center arc center.
+     * @param vector0 vector to 0 degrees (commonly major axis).
+     * @param vector90 vector to 90 degree point (commonly minor axis).
+     * @param sweep sweep limits; defaults to full sweep.
+     * @param result optional preallocated result.
      */
     static create(center, vector0, vector90, sweep, result) {
         const normal = vector0.unitCrossProductWithDefault(vector90, 0, 0, 0); // normal will be 000 for degenerate case
@@ -287,19 +288,19 @@ export class Arc3d extends CurvePrimitive {
     }
     /**
      * Create an elliptical arc from three points on the ellipse: two points on an axis and one in between.
-     * @param point0 start of arc, on an axis
-     * @param point1 point on arc somewhere between `point0` and `point2`
-     * @param point2 point on arc directly opposite `point0`
-     * @param sweep angular sweep, measured from `point0` in the direction of `point1`.
-     *  For a half-ellipse from `point0` to `point2` passing through `point1`, pass `AngleSweep.createStartEndDegrees(0,180)`.
+     * @param start start of arc, on an axis.
+     * @param middle point on arc somewhere between `start` and `end`.
+     * @param end point on arc directly opposite `start`.
+     * @param sweep angular sweep, measured from `start` in the direction of `middle`.
+     *  For a half-ellipse from `start` to `end` passing through `middle`, pass `AngleSweep.createStartEndDegrees(0,180)`.
      *  Default value is full sweep to create the entire ellipse.
-     * @param result optional preallocated result
+     * @param result optional preallocated result.
      * @returns elliptical arc, or undefined if construction impossible.
      */
-    static createStartMiddleEnd(point0, point1, point2, sweep, result) {
-        const center = Point3d.createAdd2Scaled(point0, 0.5, point2, 0.5);
-        const vector0 = Vector3d.createStartEnd(center, point0);
-        const vector1 = Vector3d.createStartEnd(center, point1);
+    static createStartMiddleEnd(start, middle, end, sweep, result) {
+        const center = Point3d.createAdd2Scaled(start, 0.5, end, 0.5);
+        const vector0 = Vector3d.createStartEnd(center, start);
+        const vector1 = Vector3d.createStartEnd(center, middle);
         const v0DotV1 = vector0.dotProduct(vector1);
         const v0Len2 = vector0.magnitudeSquared();
         if (Math.abs(v0DotV1) >= v0Len2)
@@ -307,7 +308,7 @@ export class Arc3d extends CurvePrimitive {
         const normal = vector0.crossProduct(vector1);
         const vector90 = normal.unitCrossProductWithDefault(vector0, 0, 0, 0);
         const v1DotV90 = vector1.dotProduct(vector90);
-        // Solve the standard ellipse equation for the unknown axis length, given local coords of point1 (v0.v1/||v0||, v90.v1)
+        // solve the standard ellipse equation for the unknown axis length, given local coords of middle (v0.v1/||v0||, v90.v1)
         const v90Len = Geometry.safeDivideFraction(v0Len2 * v1DotV90, Math.sqrt(v0Len2 * v0Len2 - v0DotV1 * v0DotV1), 0);
         if (Geometry.isSmallMetricDistanceSquared(v90Len))
             return undefined;
@@ -316,39 +317,61 @@ export class Arc3d extends CurvePrimitive {
     }
     /**
      * Create a circular arc defined by start point, tangent at start point, and end point.
-     * If tangent is parallel to line segment from start to end, return the line segment.
+     * * The circular arc is swept from `start` to `end` in the direction of `tangentAtStart`.
+     * * If `tangentAtStart` is parallel to the line segment from `start` to `end`, return the line segment.
      */
     static createCircularStartTangentEnd(start, tangentAtStart, end, result) {
-        // To find the circle passing through start and end with tangentAtStart at start:
-        //      - find line 1: the perpendicular bisector of the line from start to end.
-        //      - find line 2: the perpendicular to the tangentAtStart.
-        //      - intersection of the two lines would be the circle center.
-        const vector = Vector3d.createStartEnd(start, end);
-        const normal = tangentAtStart.crossProduct(vector).normalize();
-        if (normal) {
-            const vectorPerp = normal.crossProduct(vector);
-            const tangentPerp = normal.crossProduct(tangentAtStart);
-            const midPoint = start.plusScaled(vector, 0.5);
-            const lineSeg1 = LineSegment3d.create(start, start.plusScaled(tangentPerp, 1));
-            const lineSeg2 = LineSegment3d.create(midPoint, midPoint.plusScaled(vectorPerp, 1));
-            const intersection = LineSegment3d.closestApproach(lineSeg1, true, lineSeg2, true);
-            if (intersection) {
-                const center = intersection.detailA.point;
-                const vector0 = Vector3d.createStartEnd(center, start);
-                const vector90 = normal.crossProduct(vector0);
-                const endVector = Vector3d.createStartEnd(center, end);
-                const sweep = AngleSweep.create(vector0.signedAngleTo(endVector, normal));
+        // see itwinjs-core\core\geometry\internaldocs\Arc3d.md to clarify below algorithm
+        const startToEnd = Vector3d.createStartEnd(start, end);
+        const frame = Matrix3d.createRigidFromColumns(tangentAtStart, startToEnd, AxisOrder.XYZ);
+        if (frame !== undefined) {
+            const vv = startToEnd.dotProduct(startToEnd);
+            const vw = frame.dotColumnY(startToEnd);
+            const radius = Geometry.conditionalDivideCoordinate(vv, 2 * vw);
+            if (radius !== undefined) {
+                const vector0 = frame.columnY();
+                vector0.scaleInPlace(-radius); // center to start
+                const vector90 = frame.columnX();
+                vector90.scaleInPlace(radius);
+                const centerToEnd = vector0.plus(startToEnd);
+                const sweepAngle = vector0.angleTo(centerToEnd);
+                let sweepRadians = sweepAngle.radians; // always positive and less than PI
+                if (tangentAtStart.dotProduct(centerToEnd) < 0.0) // sweepRadians is the wrong way
+                    sweepRadians = 2.0 * Math.PI - sweepRadians;
+                const center = start.plusScaled(vector0, -1.0);
+                const sweep = AngleSweep.createStartEndRadians(0.0, sweepRadians);
                 return Arc3d.create(center, vector0, vector90, sweep, result);
             }
         }
         return LineSegment3d.create(start, end);
     }
+    /**
+     * Create a circular arc from start point, tangent at start, radius, optional plane normal, arc sweep.
+     * * The vector from start point to center is in the direction of upVector crossed with tangentA.
+     * @param start start point.
+     * @param tangentAtStart vector in tangent direction at the start.
+     * @param radius signed radius.
+     * @param upVector optional out-of-plane vector. Defaults to positive Z.
+     * @param sweep angular range. If single `Angle` is given, start angle is at 0 degrees (the start point).
+     */
+    static createCircularStartTangentRadius(start, tangentAtStart, radius, upVector, sweep) {
+        if (upVector === undefined)
+            upVector = Vector3d.unitZ();
+        const vector0 = upVector.unitCrossProduct(tangentAtStart);
+        if (vector0 === undefined)
+            return undefined;
+        const center = start.plusScaled(vector0, radius);
+        // reverse the A-to-center vector and bring it up to scale
+        vector0.scaleInPlace(-radius);
+        const vector90 = tangentAtStart.scaleToLength(Math.abs(radius)); // cannot fail; prior unitCrossProduct would have failed first
+        return Arc3d.create(center, vector0, vector90, AngleSweep.create(sweep));
+    }
     /**
      * Create a circular arc defined by start and end points and radius.
-     * @param start start point of the arc
-     * @param end end point of the arc
-     * @param helper a third point near the arc in its plane, or a vector in the direction of the arc normal
-     * @returns the constructed arc, or undefined if desired arc cannot be constructed
+     * @param start start point of the arc.
+     * @param end end point of the arc.
+     * @param helper a third point near the arc in its plane, or a vector in the direction of the arc normal.
+     * @returns the constructed arc, or undefined if desired arc cannot be constructed.
      */
     static createCircularStartEndRadius(start, end, radius, helper) {
         // Construct a line segment from start to end. It is a chord of the circle,
@@ -380,7 +403,7 @@ export class Arc3d extends CurvePrimitive {
      * Return a clone of this arc, projected to given z value.
      * * If `z` is omitted, the clone is at the z of the center.
      * * This function projects the arc into a plane parallel to xy-plane.
-     * * Note that projection to fixed z can change circle into ellipse (and (rarely) ellipse to circle)
+     * * Note that projection to fixed z can change circle into ellipse (and (rarely) ellipse to circle).
      */
     cloneAtZ(z) {
         if (z === undefined)
@@ -390,7 +413,7 @@ export class Arc3d extends CurvePrimitive {
     /**
      * Create an arc by center (cx,cy,xz) with vectors (ux,uy,uz) and (vx,vy,vz) to points at 0 and 90 degrees in
      * parameter space.
-     * @param result optional preallocated result
+     * @param result optional preallocated result.
      */
     static createXYZXYZXYZ(cx, cy, cz, ux, uy, uz, vx, vy, vz, sweep, result) {
         return Arc3d.create(Point3d.create(cx, cy, cz), Vector3d.create(ux, uy, uz), Vector3d.create(vx, vy, vz), sweep, result);
@@ -445,18 +468,18 @@ export class Arc3d extends CurvePrimitive {
         return undefined;
     }
     /**
-     * Convert a fractional position to xyz coordinates
-     * @param fraction fractional position on arc
-     * @param result optional preallocated result
+     * Convert a fractional position to xyz coordinates.
+     * @param fraction fractional position on arc.
+     * @param result optional preallocated result.
      */
     fractionToPoint(fraction, result) {
         const radians = this._sweep.fractionToRadians(fraction);
         return this._matrix.originPlusMatrixTimesXY(this._center, Math.cos(radians), Math.sin(radians), result);
     }
     /**
-     * Convert fractional arc and radial positions to xyz coordinates
-     * @param fraction fractional position on arc
-     * @param result optional preallocated result
+     * Convert fractional arc and radial positions to xyz coordinates.
+     * @param fraction fractional position on arc.
+     * @param result optional preallocated result.
      */
     fractionAndRadialFractionToPoint(arcFraction, radialFraction, result) {
         const radians = this._sweep.fractionToRadians(arcFraction);
@@ -464,8 +487,8 @@ export class Arc3d extends CurvePrimitive {
     }
     /**
      * Convert a fractional position to xyz coordinates and derivative with respect to fraction.
-     * @param fraction fractional position on arc
-     * @param result optional preallocated result
+     * @param fraction fractional position on arc.
+     * @param result optional preallocated result.
      */
     fractionToPointAndDerivative(fraction, result) {
         result = this.radiansToPointAndDerivative(this._sweep.fractionToRadians(fraction), result);
@@ -474,10 +497,10 @@ export class Arc3d extends CurvePrimitive {
     }
     /**
      * Construct a plane with
-     * * origin at the fractional position along the arc
-     * * x axis is the first derivative, i.e. tangent along the arc
+     * * origin at the fractional position along the arc.
+     * * x axis is the first derivative, i.e. tangent along the arc.
      * * y axis is the second derivative, i.e. in the plane and on the center side of the tangent.
-     * If the arc is circular, the second derivative is directly towards the center
+     * If the arc is circular, the second derivative is directly towards the center.
      */
     fractionToPointAnd2Derivatives(fraction, result) {
         const radians = this._sweep.fractionToRadians(fraction);
@@ -493,8 +516,8 @@ export class Arc3d extends CurvePrimitive {
         return result;
     }
     /**
-     * Evaluate the point and derivative with respect to the angle (in radians)
-     * @param radians angular position
+     * Evaluate the point and derivative with respect to the angle (in radians).
+     * @param radians angular position.
      * @param result optional preallocated ray.
      */
     radiansToPointAndDerivative(radians, result) {
@@ -506,8 +529,8 @@ export class Arc3d extends CurvePrimitive {
         return result;
     }
     /**
-     * Evaluate the point with respect to the angle (in radians)
-     * @param radians angular position
+     * Evaluate the point with respect to the angle (in radians).
+     * @param radians angular position.
      * @param result optional preallocated ray.
      */
     radiansToPoint(radians, result) {
@@ -519,11 +542,11 @@ export class Arc3d extends CurvePrimitive {
     }
     /**
      * Return a parametric plane with
-     * * origin at arc center
-     * * vectorU from center to arc at angle (in radians)
+     * * origin at arc center.
+     * * vectorU from center to arc at angle (in radians).
      * * vectorV from center to arc at 90 degrees past the angle.
-     * @param radians angular position
-     * @param result optional preallocated plane
+     * @param radians angular position.
+     * @param result optional preallocated plane.
      */
     radiansToRotatedBasis(radians, result) {
         result = result ? result : Plane3dByOriginAndVectors.createXYPlane();
@@ -535,8 +558,8 @@ export class Arc3d extends CurvePrimitive {
         return result;
     }
     /**
-     * Evaluate the point and derivative with respect to the angle (in radians)
-     * @param theta angular position
+     * Evaluate the point and derivative with respect to the angle (in radians).
+     * @param theta angular position.
      * @param result optional preallocated ray.
      */
     angleToPointAndDerivative(theta, result) {
@@ -549,14 +572,14 @@ export class Arc3d extends CurvePrimitive {
     }
     /**
      * Return the start point of the arc.
-     * @param result optional preallocated result
+     * @param result optional preallocated result.
      */
     startPoint(result) {
         return this.fractionToPoint(0.0, result);
     }
     /**
      * Return the end point of the arc.
-     * @param result optional preallocated result
+     * @param result optional preallocated result.
      */
     endPoint(result) {
         return this.fractionToPoint(1.0, result);
@@ -628,9 +651,9 @@ export class Arc3d extends CurvePrimitive {
         return chordSum * factor;
     }
     /**
-     * * See extended comments on `CurvePrimitive.moveSignedDistanceFromFraction`
-     * * A zero length line generates `CurveSearchStatus.error`
-     * * Nonzero length line generates `CurveSearchStatus.success` or `CurveSearchStatus.stoppedAtBoundary`
+     * * See extended comments on `CurvePrimitive.moveSignedDistanceFromFraction`.
+     * * A zero length line generates `CurveSearchStatus.error`.
+     * * Nonzero length line generates `CurveSearchStatus.success` or `CurveSearchStatus.stoppedAtBoundary`.
      */
     moveSignedDistanceFromFraction(startFraction, signedDistance, allowExtension, result) {
         if (!this.isCircular) // suppress extension !!!
@@ -644,7 +667,7 @@ export class Arc3d extends CurvePrimitive {
     }
     /**
      * Return all radian angles where the ellipse tangent is perpendicular to the vector to a spacePoint.
-     * @param spacePoint point of origin of vectors to the ellipse
+     * @param spacePoint point of origin of vectors to the ellipse.
      * @param _extend always true. Sweep is ignored: perpendiculars for the full ellipse are returned.
      * @param endpoints if true, force the end radians into the result.
      */
@@ -713,7 +736,7 @@ export class Arc3d extends CurvePrimitive {
     /**
      * Apply a transform to the arc basis vectors.
      * * nonuniform (i.e. skewing) transforms are allowed.
-     * * The transformed vector0 and vector90 are NOT squared up as major minor axes.  (This is a good feature!!)
+     * * The transformed vector0 and vector90 are NOT squared up as major minor axes (this is a good feature).
      */
     tryTransformInPlace(transform) {
         this._center = transform.multiplyPoint3d(this._center, this._center);
@@ -722,10 +745,7 @@ export class Arc3d extends CurvePrimitive {
         this.setVector0Vector90(this._matrix.columnX(), this._matrix.columnY());
         return true;
     }
-    /**
-     * Return true if the ellipse center and basis vectors are in the plane
-     * @param plane
-     */
+    /** Return true if the ellipse center and basis vectors are in the plane. */
     isInPlane(plane) {
         const normal = plane.getNormalRef();
         // The ellipse vectors are full-length  -- true distance comparisons say things.
@@ -753,17 +773,17 @@ export class Arc3d extends CurvePrimitive {
             return Geometry.hypotenuseXY(ux, uy);
         return undefined;
     }
-    /** If the arc is circular, return its radius. Otherwise return undefined */
+    /** If the arc is circular, return its radius. Otherwise return undefined. */
     circularRadius() {
         return this.isCircular ? this._matrix.columnXMagnitude() : undefined;
     }
-    /** Return the larger of the two defining vectors. */
+    /** Return the larger length of the two defining vectors. */
     maxVectorLength() {
         return Math.max(this._matrix.columnXMagnitude(), this._matrix.columnYMagnitude());
     }
     /**
      * Compute intersections with a plane.
-     * @param plane plane to intersect
+     * @param plane plane to intersect.
      * @param result array of locations on the curve.
      */
     appendPlaneIntersectionPoints(plane, result) {
@@ -826,8 +846,8 @@ export class Arc3d extends CurvePrimitive {
         range.extend(highPoint);
     }
     /**
-     * Returns a (high accuracy) range of the curve between fractional positions
-     * * Default implementation returns teh range of the curve from clonePartialCurve
+     * Returns a (high accuracy) range of the curve between fractional positions.
+     * * Default implementation returns teh range of the curve from clonePartialCurve.
      */
     rangeBetweenFractions(fraction0, fraction1, transform) {
         const sweep = AngleSweep.createStartEndRadians(this.sweep.fractionToRadians(fraction0), this.sweep.fractionToRadians(fraction1));
@@ -837,7 +857,7 @@ export class Arc3d extends CurvePrimitive {
     }
     /**
      * Set up a SineCosinePolynomial as the function c+u*cos(theta)+v*sin(theta) where
-     *  c,u,v are coefficients obtained by evaluating altitude and velocity relative to the plane.
+     * c,u,v are coefficients obtained by evaluating altitude and velocity relative to the plane.
      * @param plane plane for altitude calculation.
      * @param result optional result.
      * @internal
@@ -857,32 +877,32 @@ export class Arc3d extends CurvePrimitive {
     }
     /**
      * Create a new arc which is parallel to the xy plane, with given center and radius and optional angle sweep.
-     * @param center center of arc
-     * @param radius radius of arc
-     * @param sweep sweep limits.  defaults to full circle.
+     * @param center center of arc.
+     * @param radius radius of arc.
+     * @param sweep sweep limits; defaults to full circle.
      */
     static createXY(center, radius, sweep = AngleSweep.create360()) {
         return new Arc3d(center.clone(), Matrix3d.createScale(radius, radius, 1.0), sweep.clone());
     }
     /**
      * Create a new arc which is parallel to the xy plane, with given center and x,y radii, and optional angle sweep
-     * @param center center of ellipse
-     * @param radiusA x axis radius
-     * @param radiusB y axis radius
-     * @param sweep angle sweep
+     * @param center center of ellipse.
+     * @param radiusA x axis radius.
+     * @param radiusB y axis radius.
+     * @param sweep angle sweep.
      */
     static createXYEllipse(center, radiusA, radiusB, sweep = AngleSweep.create360()) {
         return new Arc3d(center.clone(), Matrix3d.createScale(radiusA, radiusB, 1.0), sweep.clone());
     }
     /**
      * Replace the arc's 0 and 90 degree vectors.
-     * @param vector0 vector from center to ellipse point at 0 degrees in parameter space
-     * @param vector90 vector from center to ellipse point at 90 degrees in parameter space
+     * @param vector0 vector from center to ellipse point at 0 degrees in parameter space.
+     * @param vector90 vector from center to ellipse point at 90 degrees in parameter space.
      */
     setVector0Vector90(vector0, vector90) {
         this._matrix.setColumns(vector0, vector90, vector0.unitCrossProductWithDefault(vector90, 0, 0, 0));
     }
-    /** Return the arc definition with rigid matrix form with axis radii */
+    /** Return the arc definition with rigid matrix form with axis radii. */
     toScaledMatrix3d() {
         const angleData = Angle.dotProductsToHalfAngleTrigValues(this._matrix.columnXMagnitudeSquared(), this._matrix.columnYMagnitudeSquared(), this._matrix.columnXDotColumnY(), true);
         const vector0A = this._matrix.multiplyXY(angleData.c, angleData.s);
@@ -896,7 +916,7 @@ export class Arc3d extends CurvePrimitive {
             sweep: this.sweep.cloneMinusRadians(angleData.radians),
         };
     }
-    /** Return the arc definition with center, two vectors, and angle sweep; */
+    /** Return the arc definition with center, two vectors, and angle sweep. */
     toVectors() {
         return {
             center: this.center.clone(),
@@ -931,9 +951,9 @@ export class Arc3d extends CurvePrimitive {
     }
     /**
      * Set this arc from a json object with these values:
-     * * center center point
-     * * vector0 vector from center to 0 degree point in parameter space (commonly but not always the major axis vector)
-     * * vector90 vector from center to 90 degree point in parameter space (commonly but not always the minor axis vector)
+     * * center center point.
+     * * vector0 vector from center to 0 degree point in parameter space (commonly but not always the major axis vector).
+     * * vector90 vector from center to 90 degree point in parameter space (commonly but not always the minor axis vector).
      * @param json
      */
     setFromJSON(json) {
@@ -964,22 +984,22 @@ export class Arc3d extends CurvePrimitive {
             vector90: this._matrix.columnY().toJSON(),
         };
     }
-    /** Test if this arc is almost equal to another GeometryQuery object */
-    isAlmostEqual(otherGeometry) {
+    /** Test if this arc is almost equal to another GeometryQuery object. */
+    isAlmostEqual(otherGeometry, distanceTol = Geometry.smallMetricDistance, radianTol = Geometry.smallAngleRadians) {
         if (otherGeometry instanceof Arc3d) {
             const other = otherGeometry;
-            return this._center.isAlmostEqual(other._center)
-                && this._matrix.isAlmostEqual(other._matrix)
-                && this._sweep.isAlmostEqualAllowPeriodShift(other._sweep);
+            return this._center.isAlmostEqual(other._center, distanceTol)
+                && this._matrix.isAlmostEqual(other._matrix, distanceTol)
+                && this._sweep.isAlmostEqualAllowPeriodShift(other._sweep, radianTol);
         }
         return false;
     }
-    /** Emit strokes to caller-supplied linestring */
+    /** Emit strokes to caller-supplied linestring. */
     emitStrokes(dest, options) {
         const numStrokes = this.computeStrokeCountForOptions(options);
         dest.appendFractionalStrokePoints(this, numStrokes, 0.0, 1.0, true);
     }
-    /** Emit strokes to caller-supplied handler */
+    /** Emit strokes to caller-supplied handler. */
     emitStrokableParts(handler, options) {
         const numStrokes = this.computeStrokeCountForOptions(options);
         handler.startCurvePrimitive(this);
@@ -988,7 +1008,7 @@ export class Arc3d extends CurvePrimitive {
     }
     /**
      * Return the stroke count required for given options.
-     * @param options StrokeOptions that determine count
+     * @param options StrokeOptions that determine count.
      */
     computeStrokeCountForOptions(options) {
         let numStroke;
@@ -1001,14 +1021,14 @@ export class Arc3d extends CurvePrimitive {
         }
         return numStroke;
     }
-    /** Second step of double dispatch:  call `handler.handleArc3d(this)` */
+    /** Second step of double dispatch: call `handler.handleArc3d(this)` */
     dispatchToGeometryHandler(handler) {
         return handler.handleArc3d(this);
     }
     /**
      * Return (if possible) an arc which is a portion of this curve.
-     * @param fractionA [in] start fraction
-     * @param fractionB [in] end fraction
+     * @param fractionA start fraction.
+     * @param fractionB end fraction.
      */
     clonePartialCurve(fractionA, fractionB) {
         if (fractionB < fractionA) {
@@ -1022,8 +1042,8 @@ export class Arc3d extends CurvePrimitive {
     }
     /**
      * Return an arc whose basis vectors are rotated by given angle within the current basis space.
-     * * the result arc will have its zero-degree point (new `vector0`) at the current
-     * `vector0 * cos(theta) + vector90 * sin(theta)`
+     * * the result arc will have its zero-degree point (new `vector0`) at the current.
+     * `vector0 * cos(theta) + vector90 * sin(theta)`.
      * * the result sweep is adjusted so all fractional coordinates (e.g. start and end) evaluate to the same xyz.
      *   * Specifically, theta is subtracted from the original start and end angles.
      * @param theta the angle (in the input arc space) which is to become the 0-degree point in the new arc.
@@ -1038,10 +1058,10 @@ export class Arc3d extends CurvePrimitive {
         return arcB;
     }
     /**
-     * Find intervals of this CurvePrimitive that are interior to a clipper
-     * @param clipper clip structure (e.g.clip planes)
-     * @param announce(optional) function to be called announcing fractional intervals"
-     * ` announce(fraction0, fraction1, curvePrimitive)`
+     * Find intervals of this CurvePrimitive that are interior to a clipper.
+     * @param clipper clip structure (e.g.clip planes).
+     * @param announce (optional) function to be called announcing fractional intervals
+     * `announce(fraction0, fraction1, curvePrimitive)`.
      * @returns true if any "in" segments are announced.
      */
     announceClipIntervals(clipper, announce) {
@@ -1053,7 +1073,12 @@ export class Arc3d extends CurvePrimitive {
         const otherVector0 = this._matrix.multiplyInverse(other.vector0);
         const otherVector90 = this._matrix.multiplyInverse(other.vector90);
         if (otherOrigin && otherVector0 && otherVector90) {
-            return { center: otherOrigin, vector0: otherVector0, vector90: otherVector90, sweep: this.sweep.clone() };
+            return {
+                center: otherOrigin,
+                vector0: otherVector0,
+                vector90: otherVector90,
+                sweep: this.sweep.clone(),
+            };
         }
         return undefined;
     }
@@ -1061,20 +1086,20 @@ export class Arc3d extends CurvePrimitive {
      * Determine an arc "at a point of inflection" of a point sequence.
      * * Return the arc along with the fractional positions of the tangency points.
      * * In the returned object:
-     *   * `arc` is the (bounded) arc
+     *   * `arc` is the (bounded) arc.
      *   * `fraction10` is the tangency point's position as an interpolating fraction of the line segment from
-     * `point1` (backwards) to `point0`
+     * `point1` (backwards) to `point0`.
      *   * `fraction12` is the tangency point's position as an interpolating fraction of the line segment from
-     * `point1` (forward) to `point2`
+     * `point1` (forward) to `point2`.
      *   * `point` is the `point1` input.
      * * If unable to construct the arc:
      *   * `point` is the `point1` input.
-     *   * both fractions are zero
+     *   * both fractions are zero.
      *   * `arc` is undefined.
-     * @param point0 first point of path. (the point before the point of inflection)
-     * @param point1 second point of path (the point of inflection)
-     * @param point2 third point of path (the point after the point of inflection)
-     * @param radius arc radius
+     * @param point0 first point of path (the point before the point of inflection).
+     * @param point1 second point of path (the point of inflection).
+     * @param point2 third point of path (the point after the point of inflection).
+     * @param radius arc radius.
      *
      */
     static createFilletArc(point0, point1, point2, radius) {
@@ -1109,11 +1134,11 @@ export class Arc3d extends CurvePrimitive {
         }
         return { fraction10: 0.0, fraction12: 0.0, point: point1.clone() };
     }
-    /** Scale the vector0 and vector90 vectors by `scaleFactor` */
+    /** Scale the vector0 and vector90 vectors by `scaleFactor`. */
     scaleAboutCenterInPlace(scaleFactor) {
         this._matrix.scaleColumnsInPlace(scaleFactor, scaleFactor, 1.0);
     }
-    /** Return the (signed!) area between (a fractional portion of) the arc and the chord between those points */
+    /** Return the (signed!) area between (a fractional portion of) the arc and the chord between those points. */
     areaToChordXY(fraction0, fraction1) {
         let detJ = Geometry.crossProductXYXY(this._matrix.coffs[0], this._matrix.coffs[3], this._matrix.coffs[1], this._matrix.coffs[4]);
         // areas in arc of unit circle with radians limits
@@ -1128,7 +1153,7 @@ export class Arc3d extends CurvePrimitive {
     }
     /**
      * Construct an offset of the instance curve as viewed in the xy-plane (ignoring z).
-     * @param offsetDistanceOrOptions offset distance (positive to left of the instance curve), or options object
+     * @param offsetDistanceOrOptions offset distance (positive to left of the instance curve), or options object.
      */
     constructOffsetXY(offsetDistanceOrOptions) {
         const options = OffsetOptions.create(offsetDistanceOrOptions);
@@ -1160,7 +1185,7 @@ export class Arc3d extends CurvePrimitive {
     /**
      * 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
+     * @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.
      */
     projectedParameterRange(ray, lowHigh) {
@@ -1168,7 +1193,7 @@ export class Arc3d extends CurvePrimitive {
     }
     /**
      * Construct a circular arc chain approximation to the instance elliptical arc.
-     * @param options bundle of options for sampling an elliptical arc (use default options if undefined)
+     * @param options bundle of options for sampling an elliptical arc (use default options if undefined).
      * @returns the approximating curve chain, the circular instance, or undefined if construction fails.
      */
     constructCircularArcChainApproximation(options) {
@@ -1189,8 +1214,8 @@ Arc3d._workVectorV = Vector3d.create();
 Arc3d._workVectorW = Vector3d.create();
 // !! misspelled Gauss in the published static !! Declare it ok.
 // cspell::word Guass
-/** Gauss point quadrature count for evaluating curve length. (The number of intervals is adjusted to the arc sweep) */
+/** Gauss point quadrature count for evaluating curve length. (The number of intervals is adjusted to the arc sweep). */
 Arc3d.quadratureGuassCount = 5;
-/** In quadrature for arc length, use this interval (divided by quickEccentricity) */
+/** In quadrature for arc length, use this interval (divided by quickEccentricity). */
 Arc3d.quadratureIntervalAngleDegrees = 10.0;
 //# sourceMappingURL=Arc3d.js.map