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

package/lib/cjs/curve/Arc3d.js

@@ -4,7 +4,8 @@
 * See LICENSE.md in the project root for license terms and full copyright notice.
 *--------------------------------------------------------------------------------------------*/
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Arc3d = void 0;
+exports.Arc3d = exports.EllipticalArcApproximationOptions = exports.EllipticalArcSampleMethod = void 0;
+const Constant_1 = require("../Constant");
 const Geometry_1 = require("../Geometry");
 const Angle_1 = require("../geometry3d/Angle");
 const AngleSweep_1 = require("../geometry3d/AngleSweep");
@@ -18,24 +19,134 @@ const CurveExtendMode_1 = require("./CurveExtendMode");
 const CurveLocationDetail_1 = require("./CurveLocationDetail");
 const CurvePrimitive_1 = require("./CurvePrimitive");
 const CurveOffsetXYHandler_1 = require("./internalContexts/CurveOffsetXYHandler");
+const EllipticalArcApproximationContext_1 = require("./internalContexts/EllipticalArcApproximationContext");
 const PlaneAltitudeRangeContext_1 = require("./internalContexts/PlaneAltitudeRangeContext");
+const LineSegment3d_1 = require("./LineSegment3d");
 const LineString3d_1 = require("./LineString3d");
 const OffsetOptions_1 = require("./OffsetOptions");
+const Path_1 = require("./Path");
 const StrokeOptions_1 = require("./StrokeOptions");
+/**
+ * Enumeration of methods used to sample an elliptical arc in [[Arc3d.constructCircularArcChainApproximation]].
+ * * Because ellipses have two axes of symmetry, samples are computed for one quadrant and reflected across each
+ * axis to the other quadrants. Any samples that fall outside the arc sweep are filtered out.
+ * @public
+ */
+var EllipticalArcSampleMethod;
+(function (EllipticalArcSampleMethod) {
+    /** Generate n samples uniformly interpolated between the min and max parameters of a full ellipse quadrant. */
+    EllipticalArcSampleMethod[EllipticalArcSampleMethod["UniformParameter"] = 0] = "UniformParameter";
+    /** Generate n samples uniformly interpolated between the min and max curvatures of a full ellipse quadrant. */
+    EllipticalArcSampleMethod[EllipticalArcSampleMethod["UniformCurvature"] = 1] = "UniformCurvature";
+    /**
+     * Generate n samples interpolated between the min and max curvatures of a full ellipse quadrant, using a
+     * [[FractionMapper]] callback to generate the interpolation weights.
+     */
+    EllipticalArcSampleMethod[EllipticalArcSampleMethod["NonUniformCurvature"] = 2] = "NonUniformCurvature";
+    /**
+     * Generate samples by subdividing parameter space until the approximation has less than a given max
+     * distance to the elliptical arc.
+     */
+    EllipticalArcSampleMethod[EllipticalArcSampleMethod["AdaptiveSubdivision"] = 3] = "AdaptiveSubdivision";
+})(EllipticalArcSampleMethod || (exports.EllipticalArcSampleMethod = EllipticalArcSampleMethod = {}));
+/**
+ * Options for generating samples for the construction of an approximation to an elliptical arc.
+ * * Used by [[Arc3d.constructCircularArcChainApproximation]].
+ * @public
+ */
+class EllipticalArcApproximationOptions {
+    constructor(method, numSamplesInQuadrant, maxError, remapFunction, forcePath) {
+        this._sampleMethod = method;
+        this._numSamplesInQuadrant = numSamplesInQuadrant;
+        this._maxError = maxError;
+        this._remapFunction = remapFunction;
+        this._forcePath = forcePath;
+    }
+    /**
+     * Construct options with optional defaults.
+     * @param method sample method, default [[EllipticalArcSampleMethod.AdaptiveSubdivision]].
+     * @param numSamplesInQuadrant samples in each full quadrant for interpolation methods, default 4.
+     * @param maxError positive maximum distance to ellipse for the subdivision method, default 1cm.
+     * @param remapFunction optional callback to remap fraction space for [[EllipticalArcSampleMethod.NonUniformCurvature]],
+     * default quadratic. For best results, this function should be a bijection.
+     * @param forcePath whether to return a [[Path]] instead of a [[Loop]] when approximating a full elliptical arc,
+     * default false.
+     */
+    static create(method = EllipticalArcSampleMethod.AdaptiveSubdivision, numSamplesInQuadrant = 4, maxError = this.defaultMaxError, remapFunction = (x) => x * x, forcePath = false) {
+        if (numSamplesInQuadrant < 2)
+            numSamplesInQuadrant = 2;
+        if (maxError <= 0)
+            maxError = this.defaultMaxError;
+        return new EllipticalArcApproximationOptions(method, numSamplesInQuadrant, maxError, remapFunction, forcePath);
+    }
+    /** Clone the options. */
+    clone() {
+        return new EllipticalArcApproximationOptions(this.sampleMethod, this.numSamplesInQuadrant, this.maxError, this.remapFunction, this.forcePath);
+    }
+    /** Method used to sample the elliptical arc. */
+    get sampleMethod() {
+        return this._sampleMethod;
+    }
+    set sampleMethod(method) {
+        this._sampleMethod = method;
+    }
+    /**
+     * Number of samples to return in each full quadrant, including endpoint(s).
+     * * Used by interpolation sample methods.
+     * * In general, for n samples, the approximating [[Path]] consists of n-1 primitives,
+     * and the approximating [[Loop]] consists of n primitives.
+     * * Minimum value is 2.
+     */
+    get numSamplesInQuadrant() {
+        return this._numSamplesInQuadrant;
+    }
+    set numSamplesInQuadrant(numSamples) {
+        this._numSamplesInQuadrant = numSamples;
+    }
+    /**
+     * Maximum distance (in meters) of the computed approximation to the elliptical arc.
+     * * Used by [[EllipticalArcSampleMethod.AdaptiveSubdivision]].
+     */
+    get maxError() {
+        return this._maxError;
+    }
+    set maxError(error) {
+        this._maxError = error;
+    }
+    /**
+     * Callback function to remap fraction space to fraction space.
+     * * Used by [[EllipticalArcSampleMethod.NonUniformCurvature]].
+     */
+    get remapFunction() {
+        return this._remapFunction;
+    }
+    set remapFunction(f) {
+        this._remapFunction = f;
+    }
+    /** Whether to return a [[Path]] instead of a [[Loop]] when approximating a full (closed) ellipse. */
+    get forcePath() {
+        return this._forcePath;
+    }
+    set forcePath(value) {
+        this._forcePath = value;
+    }
+}
+exports.EllipticalArcApproximationOptions = EllipticalArcApproximationOptions;
+/** Default error tolerance. */
+EllipticalArcApproximationOptions.defaultMaxError = Constant_1.Constant.oneCentimeter;
 /**
  * Circular or elliptic arc.
  * * The angle to point equation is:
- * * `X = center + cos(theta) * vector0 + sin(theta) * vector90`
+ *   * `X = center + cos(theta) * vector0 + sin(theta) * vector90`
  * * When the two vectors are perpendicular and have equal length, it is a true circle.
  * * Non-perpendicular vectors are always elliptic.
  * * Vectors of unequal length are always elliptic.
  * * To create an ellipse in the common "major and minor axis" form of an ellipse:
- * ** vector0 is the vector from the center to the major axis extreme.
- * ** vector90 is the vector from the center to the minor axis extreme.
- * ** note that constructing the vectors to the extreme points makes them perpendicular.
- * * The method toScaledMatrix3d() can be called to convert the unrestricted vector0,vector90 to perpendicular form.
- * * The unrestricted form is much easier to work with for common calculations -- stroking, projection to 2d,
- * intersection with plane.
+ *   * vector0 is the vector from the center to the major axis extreme.
+ *   * vector90 is the vector from the center to the minor axis extreme.
+ *   * Note that constructing these vectors to the extreme points makes them perpendicular.
+ * * The method toScaledMatrix3d() can be called to convert the unrestricted vector0, vector90 to perpendicular form.
+ * * The unrestricted form is much easier to work with for common calculations: stroking, projection to 2d, intersection with plane.
  * @public
  */
 class Arc3d extends CurvePrimitive_1.CurvePrimitive {
@@ -170,7 +281,7 @@ class Arc3d extends CurvePrimitive_1.CurvePrimitive {
      * @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
+     * @param sweep sweep limits (default full sweep)
      * @param result optional preallocated result
      */
     static create(center, vector0, vector90, sweep, result) {
@@ -179,12 +290,12 @@ class Arc3d extends CurvePrimitive_1.CurvePrimitive {
         return Arc3d.createRefs(center !== undefined ? center.clone() : Point3dVector3d_1.Point3d.create(0, 0, 0), matrix, sweep ? sweep.clone() : AngleSweep_1.AngleSweep.create360(), result);
     }
     /**
-     * Create an arc from three points on the ellipse: two points on an axis and one in between.
+     * 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 semicircle from `point0` to `point2` passing through `point1`, pass `AngleSweep.createStartEndDegrees(0,180)`.
+     *  For a half-ellipse from `point0` to `point2` passing through `point1`, pass `AngleSweep.createStartEndDegrees(0,180)`.
      *  Default value is full sweep to create the entire ellipse.
      * @param result optional preallocated result
      * @returns elliptical arc, or undefined if construction impossible.
@@ -207,6 +318,68 @@ class Arc3d extends CurvePrimitive_1.CurvePrimitive {
         vector90.scaleInPlace(v90Len);
         return Arc3d.create(center, vector0, vector90, sweep, result);
     }
+    /**
+     * 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.
+     */
+    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 = Point3dVector3d_1.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_1.LineSegment3d.create(start, start.plusScaled(tangentPerp, 1));
+            const lineSeg2 = LineSegment3d_1.LineSegment3d.create(midPoint, midPoint.plusScaled(vectorPerp, 1));
+            const intersection = LineSegment3d_1.LineSegment3d.closestApproach(lineSeg1, true, lineSeg2, true);
+            if (intersection) {
+                const center = intersection.detailA.point;
+                const vector0 = Point3dVector3d_1.Vector3d.createStartEnd(center, start);
+                const vector90 = normal.crossProduct(vector0);
+                const endVector = Point3dVector3d_1.Vector3d.createStartEnd(center, end);
+                const sweep = AngleSweep_1.AngleSweep.create(vector0.signedAngleTo(endVector, normal));
+                return Arc3d.create(center, vector0, vector90, sweep, result);
+            }
+        }
+        return LineSegment3d_1.LineSegment3d.create(start, end);
+    }
+    /**
+     * 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
+     */
+    static createCircularStartEndRadius(start, end, radius, helper) {
+        // Construct a line segment from start to end. It is a chord of the circle,
+        // so the circle center is on its perpendicular bisector.
+        const semiChordLen2 = 0.25 * start.distanceSquared(end);
+        const radius2 = radius * radius;
+        if (radius2 < semiChordLen2)
+            return undefined;
+        const height = Math.sqrt(radius2 - semiChordLen2); // Pythagoras gives us distance from chord to center
+        const normal = Point3dVector3d_1.Vector3d.createZero(this._workVectorU);
+        const vecToCenter = Point3dVector3d_1.Vector3d.createZero(this._workVectorV);
+        // the helper gives us the circle normal
+        if (helper instanceof Point3dVector3d_1.Point3d)
+            start.crossProductToPoints(helper, end, normal);
+        else
+            normal.setFrom(helper);
+        // the normal and chord direction give us the side of the chord on which the center resides
+        if (!normal.normalizeInPlace() || !normal.crossProductStartEnd(start, end, vecToCenter).scaleToLength(height, vecToCenter))
+            return undefined;
+        const center = Point3dVector3d_1.Point3d.createZero();
+        start.interpolate(0.5, end, center).addInPlace(vecToCenter);
+        const vector0 = Point3dVector3d_1.Vector3d.createStartEnd(center, start, this._workVectorW);
+        const endVector = Point3dVector3d_1.Vector3d.createStartEnd(center, end, this._workVectorV); // reuse static
+        const sweep = AngleSweep_1.AngleSweep.create(vector0.signedAngleTo(endVector, normal));
+        const vector90 = normal.crossProduct(vector0, this._workVectorV); // has length radius (reuse static)
+        return Arc3d.createRefs(center, Matrix3d_1.Matrix3d.createColumns(vector0, vector90, normal), sweep);
+    }
     /**
      * Return a clone of this arc, projected to given z value.
      * * If `z` is omitted, the clone is at the z of the center.
@@ -250,10 +423,10 @@ class Arc3d extends CurvePrimitive_1.CurvePrimitive {
         const ac2 = vectorAC.magnitudeSquared();
         const normal = vectorAB.sizedCrossProduct(vectorAC, Math.sqrt(Math.sqrt(ab2 * ac2)));
         if (normal) {
-            const vectorToCenter = Polynomials_1.SmallSystem.linearSystem3d(normal.x, normal.y, normal.z, vectorAB.x, vectorAB.y, vectorAB.z, vectorAC.x, vectorAC.y, vectorAC.z, 0, // vectorToCenter DOT normal = 0
-            0.5 * ab2, // vectorToCenter DOT vectorAB = 0.5 * vectorAB DOT vectorAB (Rayleigh quotient)
+            const vectorToCenter = Polynomials_1.SmallSystem.linearSystem3d(normal.x, normal.y, normal.z, vectorAB.x, vectorAB.y, vectorAB.z, vectorAC.x, vectorAC.y, vectorAC.z, 0, // vectorToCenter DOT normal = 0 (ensure normal is perp to the plane of the 3 points)
+            0.5 * ab2, // vectorToCenter DOT vectorAB = ab2 / 2 (ensure the projection of vectorToCenter on AB bisects AB)
             0.5 * ac2);
-            if (vectorToCenter) {
+            if (vectorToCenter) { // i.e., the negative of vectorX
                 const center = Point3dVector3d_1.Point3d.create(pointA.x, pointA.y, pointA.z).plus(vectorToCenter);
                 const vectorX = Point3dVector3d_1.Vector3d.createStartEnd(center, pointA);
                 const vectorY = Point3dVector3d_1.Vector3d.createRotateVectorAroundVector(vectorX, normal, Angle_1.Angle.createDegrees(90));
@@ -337,7 +510,7 @@ class Arc3d extends CurvePrimitive_1.CurvePrimitive {
         return result;
     }
     /**
-     * Evaluate the point and derivative with respect to the angle (in radians)
+     * Evaluate the point with respect to the angle (in radians)
      * @param radians angular position
      * @param result optional preallocated ray.
      */
@@ -379,14 +552,14 @@ class Arc3d extends CurvePrimitive_1.CurvePrimitive {
         return result;
     }
     /**
-     * Return the start point tof the arc.
+     * Return the start point of the arc.
      * @param result optional preallocated result
      */
     startPoint(result) {
         return this.fractionToPoint(0.0, result);
     }
     /**
-     * Return the end point tof the arc.
+     * Return the end point of the arc.
      * @param result optional preallocated result
      */
     endPoint(result) {
@@ -474,19 +647,19 @@ class Arc3d extends CurvePrimitive_1.CurvePrimitive {
         return CurveLocationDetail_1.CurveLocationDetail.createConditionalMoveSignedDistance(allowExtension, this, startFraction, startFraction + signedFractionMove, signedDistance, result);
     }
     /**
-     * Return all angles (in radians) where the ellipse tangent is perpendicular to the vector to a spacePoint.
+     * 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 _extend (NOT SUPPORTED -- ALWAYS ACTS AS "true")
-     * @param _endpoints if true, force the end radians into the result.
+     * @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.
      */
-    allPerpendicularAngles(spacePoint, _extend = true, _endpoints = false) {
+    allPerpendicularAngles(spacePoint, _extend = true, endpoints = false) {
         const radians = [];
         const vectorQ = spacePoint.vectorTo(this.center);
         const uu = this._matrix.columnXMagnitudeSquared();
         const uv = this._matrix.columnXDotColumnY();
         const vv = this._matrix.columnYMagnitudeSquared();
         Polynomials_1.TrigPolynomial.solveUnitCircleImplicitQuadricIntersection(uv, vv - uu, -uv, this._matrix.dotColumnY(vectorQ), -this._matrix.dotColumnX(vectorQ), 0.0, radians);
-        if (_endpoints) {
+        if (endpoints) {
             radians.push(this.sweep.startRadians);
             radians.push(this.sweep.endRadians);
         }
@@ -682,7 +855,7 @@ class Arc3d extends CurvePrimitive_1.CurvePrimitive {
         result.set(plane.altitude(this._center), plane.velocityXYZ(this._matrix.coffs[0], this._matrix.coffs[3], this._matrix.coffs[6]), plane.velocityXYZ(this._matrix.coffs[1], this._matrix.coffs[4], this._matrix.coffs[7]));
         return result;
     }
-    /** Create a new arc which is a unit circle centered at the origin. */
+    /** Create a new arc which is a unit circle in the xy-plane centered at the origin. */
     static createUnitCircle() {
         return Arc3d.createRefs(Point3dVector3d_1.Point3d.create(0, 0, 0), Matrix3d_1.Matrix3d.createIdentity(), AngleSweep_1.AngleSweep.create360());
     }
@@ -693,7 +866,7 @@ class Arc3d extends CurvePrimitive_1.CurvePrimitive {
      * @param sweep sweep limits.  defaults to full circle.
      */
     static createXY(center, radius, sweep = AngleSweep_1.AngleSweep.create360()) {
-        return new Arc3d(center.clone(), Matrix3d_1.Matrix3d.createScale(radius, radius, 1.0), sweep);
+        return new Arc3d(center.clone(), Matrix3d_1.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
@@ -703,7 +876,7 @@ class Arc3d extends CurvePrimitive_1.CurvePrimitive {
      * @param sweep angle sweep
      */
     static createXYEllipse(center, radiusA, radiusB, sweep = AngleSweep_1.AngleSweep.create360()) {
-        return new Arc3d(center.clone(), Matrix3d_1.Matrix3d.createScale(radiusA, radiusB, 1.0), sweep);
+        return new Arc3d(center.clone(), Matrix3d_1.Matrix3d.createScale(radiusA, radiusB, 1.0), sweep.clone());
     }
     /**
      * Replace the arc's 0 and 90 degree vectors.
@@ -720,8 +893,8 @@ class Arc3d extends CurvePrimitive_1.CurvePrimitive {
         const vector90A = this._matrix.multiplyXY(-angleData.s, angleData.c);
         const axes = Matrix3d_1.Matrix3d.createRigidFromColumns(vector0A, vector90A, Geometry_1.AxisOrder.XYZ);
         return {
+            center: this._center.clone(),
             axes: (axes ? axes : Matrix3d_1.Matrix3d.createIdentity()),
-            center: this._center,
             r0: vector0A.magnitude(),
             r90: vector90A.magnitude(),
             sweep: this.sweep.cloneMinusRadians(angleData.radians),
@@ -730,10 +903,10 @@ class Arc3d extends CurvePrimitive_1.CurvePrimitive {
     /** Return the arc definition with center, two vectors, and angle sweep; */
     toVectors() {
         return {
-            center: this.center,
+            center: this.center.clone(),
             vector0: this._matrix.columnX(),
             vector90: this._matrix.columnY(),
-            sweep: this.sweep,
+            sweep: this.sweep.clone(),
         };
     }
     /** Return the arc definition with center, two vectors, and angle sweep, optionally transformed. */
@@ -742,13 +915,13 @@ class Arc3d extends CurvePrimitive_1.CurvePrimitive {
             center: transform.multiplyPoint3d(this._center),
             vector0: transform.multiplyVector(this._matrix.columnX()),
             vector90: transform.multiplyVector(this._matrix.columnY()),
-            sweep: this.sweep,
+            sweep: this.sweep.clone(),
         }
             : {
                 center: this._center.clone(),
                 vector0: this._matrix.columnX(),
                 vector90: this._matrix.columnY(),
-                sweep: this.sweep,
+                sweep: this.sweep.clone(),
             };
     }
     /** Return the arc definition with center, two vectors, and angle sweep, transformed to 4d points. */
@@ -757,7 +930,7 @@ class Arc3d extends CurvePrimitive_1.CurvePrimitive {
             center: matrix.multiplyPoint3d(this._center, 1.0),
             vector0: matrix.multiplyPoint3d(this._matrix.columnX(), 0.0),
             vector90: matrix.multiplyPoint3d(this._matrix.columnY(), 0.0),
-            sweep: this.sweep,
+            sweep: this.sweep.clone(),
         };
     }
     /**
@@ -997,6 +1170,20 @@ class Arc3d extends CurvePrimitive_1.CurvePrimitive {
     projectedParameterRange(ray, lowHigh) {
         return PlaneAltitudeRangeContext_1.PlaneAltitudeRangeContext.findExtremeFractionsAlongDirection(this, ray, lowHigh);
     }
+    /**
+     * 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)
+     * @returns the approximating curve chain, the circular instance, or undefined if construction fails.
+     */
+    constructCircularArcChainApproximation(options) {
+        if (!options)
+            options = EllipticalArcApproximationOptions.create();
+        const context = EllipticalArcApproximationContext_1.EllipticalArcApproximationContext.create(this);
+        const result = context.constructCircularArcChainApproximation(options);
+        if (!result && this.isCircular)
+            return (this.sweep.isFullCircle && options.forcePath) ? Path_1.Path.create(this) : this;
+        return result;
+    }
 }
 exports.Arc3d = Arc3d;
 Arc3d._workPointA = Point3dVector3d_1.Point3d.create();
@@ -1004,6 +1191,7 @@ Arc3d._workPointB = Point3dVector3d_1.Point3d.create();
 Arc3d._workPointC = Point3dVector3d_1.Point3d.create();
 Arc3d._workVectorU = Point3dVector3d_1.Vector3d.create();
 Arc3d._workVectorV = Point3dVector3d_1.Vector3d.create();
+Arc3d._workVectorW = Point3dVector3d_1.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) */