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

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

@@ -0,0 +1,103 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Curve
+ */
+import { Geometry } from "../../Geometry";
+import { Plane3dByOriginAndVectors } from "../../geometry3d/Plane3dByOriginAndVectors";
+import { Point3d } from "../../geometry3d/Point3dVector3d";
+import { Ray3d } from "../../geometry3d/Ray3d";
+import { Quadrature } from "../../numerics/Quadrature";
+import { SimpleNewton } from "../../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.
+ * @internal
+ */
+export class XYCurveEvaluator {
+    /** Evaluate both X and Y at fractional coordinate, return bundled as a point. */
+    fractionToPoint(fraction, result) {
+        return 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. */
+    fractionToPointAndDerivative(fraction, result) {
+        return 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. */
+    fractionToPointAnd2Derivatives(fraction, result) {
+        return 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);
+    }
+    /**
+     * Return the magnitude of the tangent vector at fraction.
+     * @param fraction fractional position along the curve
+     */
+    fractionToTangentMagnitude(fraction) {
+        const u = this.fractionToDX(fraction);
+        const v = this.fractionToDY(fraction);
+        return Geometry.hypotenuseXY(u, v);
+    }
+    static initWorkSpace() {
+        XYCurveEvaluator._gaussX = new Float64Array(5);
+        XYCurveEvaluator._gaussWeight = new Float64Array(5);
+        XYCurveEvaluator._gaussMapper = Quadrature.setupGauss5;
+    }
+    /**
+     * 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;
+        const gaussWeight = XYCurveEvaluator._gaussWeight;
+        const numEval = XYCurveEvaluator._gaussMapper(fraction0, fraction1, gaussX, gaussWeight);
+        let sum = 0;
+        for (let k = 0; k < numEval; k++) {
+            sum += gaussWeight[k] * this.fractionToTangentMagnitude(gaussX[k]);
+        }
+        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
+     * @param targetDistance intermediate distance.
+     */
+    inverseDistanceFraction(fraction0, fraction1, distance0, distance1, targetDistance) {
+        const startFraction = Geometry.inverseInterpolate(fraction0, distance0, fraction1, distance1, targetDistance);
+        if (startFraction !== undefined) {
+            return SimpleNewton.runNewton1D(startFraction, (fraction) => {
+                const d = this.integrateDistanceBetweenFractions(fraction0, fraction);
+                return distance0 + d - targetDistance;
+            }, (fraction) => this.fractionToTangentMagnitude(fraction));
+        }
+        return undefined;
+    }
+    /**
+     *
+     * @param fraction fractional position along x axis
+     * @param xy xy coordinates of point on the curve
+     * @param d1xy
+     * @param d2xy
+     * @param d3xy
+     */
+    fractionToPointAnd3Derivatives(fraction, xy, d1xy, d2xy, d3xy) {
+        xy.set(this.fractionToX(fraction), this.fractionToY(fraction), 0);
+        if (d1xy)
+            d1xy.set(this.fractionToDX(fraction), this.fractionToDY(fraction), 0);
+        if (d2xy)
+            d2xy.set(this.fractionToDDX(fraction), this.fractionToDDY(fraction), 0);
+        if (d3xy)
+            d3xy.set(this.fractionToD3X(fraction), this.fractionToD3Y(fraction), 0);
+    }
+}
+// at load time, initialize gauss quadrature workspace
+XYCurveEvaluator.initWorkSpace();
+//# sourceMappingURL=XYCurveEvaluator.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"XYCurveEvaluator.js","sourceRoot":"","sources":["../../../../src/curve/spiral/XYCurveEvaluator.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F;;GAEG;AACH,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,yBAAyB,EAAE,MAAM,4CAA4C,CAAC;AACvF,OAAO,EAAE,OAAO,EAAY,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD;;;;;;;GAOG;AACH,MAAM,OAAgB,gBAAgB;IAsBpC,iFAAiF;IAC1E,eAAe,CAAC,QAAgB,EAAE,MAAgB;QACvD,OAAO,OAAO,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,KAAK,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,yBAAyB,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,QAAQ,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACrC,CAAC;IAWM,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,UAAU,CAAC,WAAW,CAAC;IACzD,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;YAChC,GAAG,IAAI,WAAW,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;SACpE;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,QAAQ,CAAC,kBAAkB,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC;QAC9G,IAAI,aAAa,KAAK,SAAS,EAAE;YAC/B,OAAO,YAAY,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;SACpE;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;AACD,sDAAsD;AACtD,gBAAgB,CAAC,aAAa,EAAE,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\n/** @packageDocumentation\r\n * @module Curve\r\n */\r\nimport { Geometry } from \"../../Geometry\";\r\nimport { Plane3dByOriginAndVectors } from \"../../geometry3d/Plane3dByOriginAndVectors\";\r\nimport { Point3d, Vector3d } from \"../../geometry3d/Point3dVector3d\";\r\nimport { Ray3d } from \"../../geometry3d/Ray3d\";\r\nimport { Quadrature } from \"../../numerics/Quadrature\";\r\nimport { SimpleNewton } from \"../../numerics/Newton\";\r\n/**\r\n * XYCurveEvaluator is an abstract with methods for evaluating X and Y parts of a curve parameterized by a fraction.\r\n * * The required methods call for independent X and Y evaluation.\r\n * * Base class methods package those (multiple) calls into point, ray, and plane structures.\r\n *    * A implementation that has evaluation substantial cost that can be shared among x,y parts or between\r\n *       primary functions and derivatives might choose to implement the point and derivative methods directly.\r\n * @internal\r\n */\r\nexport abstract class XYCurveEvaluator {\r\n  /** return a deep copy of the evaluator */\r\n  public abstract clone(): XYCurveEvaluator;\r\n  /** test for near identical evaluator */\r\n  public abstract isAlmostEqual(other: any): boolean;\r\n  /** Evaluate X at fractional position. */\r\n  public abstract fractionToX(fraction: number): number;\r\n  /** Evaluate Y at fractional position. */\r\n  public abstract fractionToY(fraction: number): number;\r\n  /** Evaluate derivative of X with respect to fraction at fractional position. */\r\n  public abstract fractionToDX(fraction: number): number;\r\n  /** Evaluate derivative of Y with respect to fraction at fractional position. */\r\n  public abstract fractionToDY(fraction: number): number;\r\n  /** Evaluate second derivative of X with respect to fraction at fractional position. */\r\n  public abstract fractionToDDX(fraction: number): number;\r\n  /** Evaluate second derivative of Y with respect to fraction at fractional position. */\r\n  public abstract fractionToDDY(fraction: number): number;\r\n  /** Evaluate both X and Y at fractional coordinate, return bundled as a point. */\r\n  /** Evaluate second derivative of X with respect to fraction at fractional position. */\r\n  public abstract fractionToD3X(fraction: number): number;\r\n  /** Evaluate second derivative of Y with respect to fraction at fractional position. */\r\n  public abstract fractionToD3Y(fraction: number): number;\r\n  /** Evaluate both X and Y at fractional coordinate, return bundled as a point. */\r\n  public fractionToPoint(fraction: number, result?: Point3d): Point3d {\r\n    return Point3d.create(this.fractionToX(fraction), this.fractionToY(fraction), 0.0, result);\r\n  }\r\n  /** Evaluate both X and Y and their first derivatives at fractional coordinate, return bundled as origin and (non-unit) direction vector. */\r\n  public fractionToPointAndDerivative(fraction: number, result?: Ray3d): Ray3d {\r\n    return Ray3d.createXYZUVW(this.fractionToX(fraction), this.fractionToY(fraction), 0.0,\r\n      this.fractionToDX(fraction), this.fractionToDY(fraction), 0,\r\n      result);\r\n  }\r\n  /** Evaluate both X and Y and their second derivatives at fractional coordinate, return bundled as origin and (non-unit) vectorU an vectorV. */\r\n  public fractionToPointAnd2Derivatives(fraction: number, result?: Plane3dByOriginAndVectors): Plane3dByOriginAndVectors {\r\n    return Plane3dByOriginAndVectors.createOriginAndVectorsXYZ(\r\n      this.fractionToX(fraction), this.fractionToY(fraction), 0.0,\r\n      this.fractionToDX(fraction), this.fractionToDY(fraction), 0,\r\n      this.fractionToDDX(fraction), this.fractionToDDY(fraction), 0,\r\n      result);\r\n  }\r\n  /**\r\n   * Return the magnitude of the tangent vector at fraction.\r\n   * @param fraction fractional position along the curve\r\n   */\r\n  public fractionToTangentMagnitude(fraction: number): number {\r\n    const u = this.fractionToDX(fraction);\r\n    const v = this.fractionToDY(fraction);\r\n    return Geometry.hypotenuseXY(u, v);\r\n  }\r\n\r\n  /** Invert the fractionToX function for given X. */\r\n\r\n  public abstract xToFraction(x: number): number | undefined;\r\n  /** Initialize class level work arrays for 5 point Gaussian Quadrature. */\r\n  // Class resources for integration . . .\r\n  // These static variables are reused on calls to integrateFromStartFraction\r\n  protected static _gaussX: Float64Array;\r\n  protected static _gaussWeight: Float64Array;\r\n  protected static _gaussMapper: (xA: number, xB: number, arrayX: Float64Array, arrayW: Float64Array) => number;\r\n  public static initWorkSpace() {\r\n    XYCurveEvaluator._gaussX = new Float64Array(5);\r\n    XYCurveEvaluator._gaussWeight = new Float64Array(5);\r\n    XYCurveEvaluator._gaussMapper = Quadrature.setupGauss5;\r\n  }\r\n  /**\r\n   * Integrate between nominal fractions with default gauss rule.\r\n   * * The caller is expected to choose nearby fractions so that the single gauss interval accuracy is good.\r\n   * @param fraction0\r\n   * @param fraction1\r\n   */\r\n  public integrateDistanceBetweenFractions(fraction0: number, fraction1: number): number {\r\n    const gaussX = XYCurveEvaluator._gaussX;\r\n    const gaussWeight = XYCurveEvaluator._gaussWeight;\r\n    const numEval = XYCurveEvaluator._gaussMapper(fraction0, fraction1, gaussX, gaussWeight);\r\n    let sum = 0;\r\n    for (let k = 0; k < numEval; k++) {\r\n      sum += gaussWeight[k] * this.fractionToTangentMagnitude(gaussX[k]);\r\n    }\r\n    return sum;\r\n  }\r\n  /**\r\n   * Inverse integrated distance\r\n   * @param fraction0 start of fraction interval\r\n   * @param fraction1 end of fraction interval\r\n   * @param distance0 distance at start\r\n   * @param distance1 distance at end\r\n   * @param targetDistance intermediate distance.\r\n   */\r\n  public inverseDistanceFraction(fraction0: number, fraction1: number, distance0: number, distance1: number, targetDistance: number): number | undefined {\r\n    const startFraction = Geometry.inverseInterpolate(fraction0, distance0, fraction1, distance1, targetDistance);\r\n    if (startFraction !== undefined) {\r\n      return SimpleNewton.runNewton1D(startFraction,\r\n        (fraction: number) => {\r\n          const d = this.integrateDistanceBetweenFractions(fraction0, fraction);\r\n          return distance0 + d - targetDistance;\r\n        },\r\n        (fraction: number) => this.fractionToTangentMagnitude(fraction));\r\n    }\r\n    return undefined;\r\n  }\r\n\r\n  /**\r\n   *\r\n   * @param fraction fractional position along x axis\r\n   * @param xy xy coordinates of point on the curve\r\n   * @param d1xy\r\n   * @param d2xy\r\n   * @param d3xy\r\n   */\r\n  public fractionToPointAnd3Derivatives(fraction: number, xy: Point3d, d1xy?: Vector3d, d2xy?: Vector3d, d3xy?: Vector3d) {\r\n    xy.set(this.fractionToX(fraction), this.fractionToY(fraction), 0);\r\n    if (d1xy)\r\n      d1xy.set(this.fractionToDX(fraction), this.fractionToDY(fraction), 0);\r\n    if (d2xy)\r\n      d2xy.set(this.fractionToDDX(fraction), this.fractionToDDY(fraction), 0);\r\n    if (d3xy)\r\n      d3xy.set(this.fractionToD3X(fraction), this.fractionToD3Y(fraction), 0);\r\n  }\r\n  /** Apply a uniform scale around the origin. */\r\n  public abstract scaleInPlace(scaleFactor: number): void;\r\n}\r\n// at load time, initialize gauss quadrature workspace\r\nXYCurveEvaluator.initWorkSpace();\r\n"]}

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

@@ -0,0 +1,214 @@
+/** @packageDocumentation
+ * @module CartesianGeometry
+ */
+import { AngleProps, BeJSONFunctions, TrigValues } from "../Geometry";
+/**
+ * An `Angle` carries the numeric value of an angle, with methods to allow (require!) callers to be clear about whether their angle is degrees or radians.
+ * * The numeric value is private, and callers should not know or care whether it is in degrees or radians.
+ * * The various access method are named so that callers can specify whether untyped numbers passed in or out are degrees or radians.
+ * @public
+ */
+export declare class Angle implements BeJSONFunctions {
+    /** maximal accuracy value of pi/4 ( 45 degrees), in radians */
+    static readonly piOver4Radians = 0.7853981633974483;
+    /** maximal accuracy value of pi/2 ( 90 degrees), in radians */
+    static readonly piOver2Radians = 1.5707963267948966;
+    /** maximal accuracy value of pi ( 180 degrees), in radians */
+    static readonly piRadians = 3.141592653589793;
+    /** maximal accuracy value of 2*pi (360 degrees), in radians */
+    static readonly pi2Radians = 6.283185307179586;
+    /** scale factor for converting radians to degrees */
+    static readonly degreesPerRadian: number;
+    /** scale factor for converting degrees to radians */
+    static readonly radiansPerDegree: number;
+    /** maximal accuracy value of pi/12 ( 15 degrees), in radians */
+    static readonly piOver12Radians = 0.26179938779914946;
+    private _radians;
+    private _degrees?;
+    private constructor();
+    /** Return a new angle with the same content. */
+    clone(): Angle;
+    /** Freeze this instance so it is read-only */
+    freeze(): Readonly<this>;
+    /**
+     * Return a new Angle object for angle given in degrees.
+     * @param degrees angle in degrees
+     */
+    static createDegrees(degrees: number): Angle;
+    /**
+     * Return a (new) Angle object for a value given in radians.
+     * @param radians angle in radians
+     */
+    static createRadians(radians: number): Angle;
+    /**
+     * Return a (new) Angle object that is interpolated between two inputs
+     * @param radians angle in radians
+     */
+    static createInterpolate(angle0: Angle, fraction: number, angle1: Angle): Angle;
+    /**
+     * Return a (new) Angle object, with angle scaled from existing angle.
+     * @param scale scale factor to apply to angle.
+     */
+    cloneScaled(scale: number): Angle;
+    /**
+     * Set this angle to a value given in radians.
+     * @param radians angle given in radians
+     */
+    setRadians(radians: number): void;
+    /**
+     * Set this angle to a value given in degrees.
+     * @param degrees angle given in degrees.
+     */
+    setDegrees(degrees: number): void;
+    /** Create an angle for a full circle. */
+    static create360(): Angle;
+    /**
+     * @return a (strongly typed) Angle whose tangent is `numerator/denominator`, using the signs of both in determining the (otherwise ambiguous)
+     * quadrant.
+     * @param numerator numerator for tangent
+     * @param denominator denominator for tangent
+     */
+    static createAtan2(numerator: number, denominator: number): Angle;
+    /**
+     * Copy all contents of `other` to this Angle.
+     * @param other source data
+     */
+    setFrom(other: Angle): void;
+    /**
+     * Create an Angle from a JSON object
+     * @param json object from JSON.parse. If a number, value is in *DEGREES*
+     * @param defaultValRadians if json is undefined, default value in radians.
+     * @return a new Angle
+     */
+    static fromJSON(json?: AngleProps, defaultValRadians?: number): Angle;
+    /**
+     * set an Angle from a JSON object
+     * * A simple number is degrees.
+     * * specified `json.degrees` or `json._degrees` is degree value.
+     * * specified `son.radians` or `json._radians` is radians value.
+     * @param json object from JSON.parse. If a number, value is in *DEGREES*
+     * @param defaultValRadians if json is undefined, default value in radians.
+     */
+    setFromJSON(json?: AngleProps, defaultValRadians?: number): void;
+    /** Convert an Angle to a JSON object as a number in degrees */
+    toJSON(): AngleProps;
+    /** Return a json object with radians keyword, e.g. `{ radians: 0.10}` */
+    toJSONRadians(): AngleProps;
+    /**  Return the angle measured in radians. */
+    get radians(): number;
+    /**  Return the angle measured in degrees. */
+    get degrees(): number;
+    /**
+     * Convert an angle in degrees to radians.
+     * @param degrees angle in degrees
+     */
+    static degreesToRadians(degrees: number): number;
+    /**
+     * Convert an angle in radians to degrees.
+     * @param degrees angle in radians
+     */
+    static radiansToDegrees(radians: number): number;
+    /**
+     * Return the cosine of this Angle object's angle.
+     */
+    cos(): number;
+    /**
+     * Return the sine of this Angle object's angle.
+     */
+    sin(): number;
+    /**
+     * Return the tangent of this Angle object's angle.
+     */
+    tan(): number;
+    /** Test if a radians (absolute) value is nearly 2PI or larger (!) */
+    static isFullCircleRadians(radians: number): boolean;
+    /** Test if the radians value  is a complete circle */
+    static isHalfCircleRadians(radians: number): boolean;
+    /** test if the angle is aa full circle */
+    get isFullCircle(): boolean;
+    /** test if the angle is a half circle (in either direction) */
+    get isHalfCircle(): boolean;
+    /** Adjust a radians value so it is positive in 0..360 */
+    static adjustDegrees0To360(degrees: number): number;
+    /** Adjust a radians value so it is in -180..180 */
+    static adjustDegreesSigned180(degrees: number): number;
+    /** Adjust a radians value so it is positive in 0..2Pi */
+    static adjustRadians0To2Pi(radians: number): number;
+    /** Adjust a radians value so it is positive in -PI..PI */
+    static adjustRadiansMinusPiPlusPi(radians: number): number;
+    /** return a (newly allocated) Angle object with value 0 radians */
+    static zero(): Angle;
+    /** Test if the angle is exactly zero. */
+    get isExactZero(): boolean;
+    /** Test if the angle is almost zero (within tolerance `Geometry.smallAngleRadians`) */
+    get isAlmostZero(): boolean;
+    /** Test if the angle is almost a north or south pole (within tolerance `Geometry.smallAngleRadians`) */
+    get isAlmostNorthOrSouthPole(): boolean;
+    /** Create an angle object with degrees adjusted into 0..360. */
+    static createDegreesAdjustPositive(degrees: number): Angle;
+    /** Create an angle object with degrees adjusted into -180..180. */
+    static createDegreesAdjustSigned180(degrees: number): Angle;
+    /**
+     * Test if two radians values are equivalent, allowing shift by full circle (i.e. by a multiple of `2*PI`)
+     * @param radiansA first radians value
+     * @param radiansB second radians value
+     */
+    static isAlmostEqualRadiansAllowPeriodShift(radiansA: number, radiansB: number): boolean;
+    /**
+     * Test if this angle and other are equivalent, allowing shift by full circle (i.e. by a multiple of 360 degrees)
+     */
+    isAlmostEqualAllowPeriodShift(other: Angle): boolean;
+    /**
+     * Test if two this angle and other are almost equal, NOT allowing shift by full circle multiples of 360 degrees.
+     */
+    isAlmostEqualNoPeriodShift(other: Angle): boolean;
+    /**
+     * Test if two angle (in radians)  almost equal, NOT allowing shift by full circle multiples of `2 * PI`.
+     * * (Same test as isAlmostEqualRadiansNoPeriodShift)
+     */
+    isAlmostEqual(other: Angle): boolean;
+    /**
+     * Test if two angle (in radians)  almost equal, NOT allowing shift by full circle multiples of `2 * PI`.
+     */
+    static isAlmostEqualRadiansNoPeriodShift(radiansA: number, radiansB: number): boolean;
+    /**
+     * Test if dot product values indicate non-zero length perpendicular vectors.
+     * @param dotUU dot product of vectorU with itself
+     * @param dotVV dot product of vectorV with itself
+     * @param dotUV dot product of vectorU with vectorV
+     */
+    static isPerpendicularDotSet(dotUU: number, dotVV: number, dotUV: number): boolean;
+    /**
+     * Return cosine, sine, and radians for the half angle of a cosine,sine pair.
+     * @param rCos2A cosine value (scaled by radius) for initial angle.
+     * @param rSin2A sine value (scaled by radius) for final angle.
+     */
+    static trigValuesToHalfAngleTrigValues(rCos2A: number, rSin2A: number): TrigValues;
+    /** If value is close to -1, -0.5, 0, 0.5, 1, adjust it to the exact value. */
+    static cleanupTrigValue(value: number, tolerance?: number): number;
+    /**
+     * Return the half angle cosine, sine, and radians for given dot products between vectors.
+     * @param dotUU dot product of vectorU with itself
+     * @param dotVV dot product of vectorV with itself
+     * @param dotUV dot product of vectorU with vectorV
+     */
+    static dotProductsToHalfAngleTrigValues(dotUU: number, dotVV: number, dotUV: number, favorZero?: boolean): TrigValues;
+    /**
+     * * Returns the angle between two vectors, with the vectors given as xyz components
+     * * The returned angle is between 0 and PI
+     *
+     * @param ux x component of vector u
+     * @param uy y component of vector u
+     * @param uz z component of vector u
+     * @param vx x component of vector v
+     * @param vy y component of vector v
+     * @param vz z component of vector v
+     */
+    static radiansBetweenVectorsXYZ(ux: number, uy: number, uz: number, vx: number, vy: number, vz: number): number;
+    /**
+     * Add a multiple of a full circle angle (360 degrees, 2PI) in place.
+     * @param multiple multiplier factor
+     */
+    addMultipleOf2PiInPlace(multiple: number): void;
+}
+//# sourceMappingURL=Angle.d.ts.map

package/lib/esm/geometry3d/Angle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Angle.d.ts","sourceRoot":"","sources":["../../../src/geometry3d/Angle.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,eAAe,EAAY,UAAU,EAAE,MAAM,aAAa,CAAC;AAEhF;;;;;GAKG;AACH,qBAAa,KAAM,YAAW,eAAe;IAC3C,+DAA+D;IAC/D,gBAAuB,cAAc,sBAA+B;IACpE,+DAA+D;IAC/D,gBAAuB,cAAc,sBAA+B;IACpE,8DAA8D;IAC9D,gBAAuB,SAAS,qBAA+B;IAC/D,+DAA+D;IAC/D,gBAAuB,UAAU,qBAA+B;IAChE,qDAAqD;IACrD,gBAAuB,gBAAgB,SAAiC;IACxE,qDAAqD;IACrD,gBAAuB,gBAAgB,SAAiC;IACxE,gEAAgE;IAChE,gBAAuB,eAAe,uBAAsC;IAC5E,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,QAAQ,CAAC,CAAS;IAC1B,OAAO;IACP,gDAAgD;IACzC,KAAK,IAAI,KAAK;IACrB,8CAA8C;IACvC,MAAM,IAAI,QAAQ,CAAC,IAAI,CAAC;IAE/B;;;OAGG;WACW,aAAa,CAAC,OAAO,EAAE,MAAM;IAC3C;;;OAGG;WACW,aAAa,CAAC,OAAO,EAAE,MAAM;IAC3C;;;OAGG;WACW,iBAAiB,CAAC,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK;IAG9E;;;OAGG;IACI,WAAW,CAAC,KAAK,EAAE,MAAM;IAEhC;;;OAGG;IACI,UAAU,CAAC,OAAO,EAAE,MAAM;IACjC;;;OAGG;IACI,UAAU,CAAC,OAAO,EAAE,MAAM;IACjC,yCAAyC;WAC3B,SAAS;IACvB;;;;;OAKG;WACW,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,KAAK;IACxE;;;OAGG;IACI,OAAO,CAAC,KAAK,EAAE,KAAK;IAC3B;;;;;OAKG;WACW,QAAQ,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,iBAAiB,CAAC,EAAE,MAAM,GAAG,KAAK;IAK5E;;;;;;;OAOG;IACI,WAAW,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,iBAAiB,CAAC,EAAE,MAAM;IAgBhE,+DAA+D;IACxD,MAAM,IAAI,UAAU;IAC3B,yEAAyE;IAClE,aAAa,IAAI,UAAU;IAClC,6CAA6C;IAC7C,IAAW,OAAO,IAAI,MAAM,CAA0B;IACtD,6CAA6C;IAC7C,IAAW,OAAO,IAAI,MAAM,CAAgG;IAC5H;;;OAGG;WACW,gBAAgB,CAAC,OAAO,EAAE,MAAM;IAC9C;;;OAGG;WACW,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAiBvD;;OAEG;IACI,GAAG,IAAI,MAAM;IACpB;;OAEG;IACI,GAAG,IAAI,MAAM;IACpB;;OAEG;IACI,GAAG,IAAI,MAAM;IACpB,qEAAqE;WACvD,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAG3D,sDAAsD;WACxC,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAG3D,0CAA0C;IAC1C,IAAW,YAAY,IAAI,OAAO,CAAqD;IAEvF,+DAA+D;IAC/D,IAAW,YAAY,IAAI,OAAO,CAAqD;IACvF,yDAAyD;WAC3C,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAe1D,mDAAmD;WACrC,sBAAsB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAc7D,yDAAyD;WAC3C,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAe1D,0DAA0D;WAC5C,0BAA0B,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAcjE,mEAAmE;WACrD,IAAI;IAClB,yCAAyC;IACzC,IAAW,WAAW,YAAiC;IACvD,uFAAuF;IACvF,IAAW,YAAY,YAAkE;IACzF,wGAAwG;IACxG,IAAW,wBAAwB,YAA4D;IAE/F,gEAAgE;WAClD,2BAA2B,CAAC,OAAO,EAAE,MAAM,GAAG,KAAK;IACjE,mEAAmE;WACrD,4BAA4B,CAAC,OAAO,EAAE,MAAM,GAAG,KAAK;IAClE;;;;OAIG;WACW,oCAAoC,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO;IAY/F;;OAEG;IACI,6BAA6B,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO;IAG3D;;OAEG;IACI,0BAA0B,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO;IACxD;;;OAGG;IACI,aAAa,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO;IAC3C;;OAEG;WACW,iCAAiC,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO;IAC5F;;;;;OAKG;WACW,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAK/E;;;;OAIG;WACW,+BAA+B,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,UAAU;IA+BzF,8EAA8E;WAChE,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,GAAE,MAAgB,GAAG,MAAM;IAYlF;;;;;OAKG;WACW,gCAAgC,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,GAAE,OAAc,GAAG,UAAU;IAOlI;;;;;;;;;;OAUG;WACW,wBAAwB,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM;IAMtH;;;OAGG;IACI,uBAAuB,CAAC,QAAQ,EAAE,MAAM;CAQhD"}