gpml2pvjson/es5/spinoffs/Angle.js

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
var fp_1 = require("lodash/fp");
// based on code drawn from this repo:
// https://github.com/infusion/Angles.js/blob/master/angles.js
var TAU = 2 * Math.PI;
var EPS = 1e-15;
var SCALE = 2 * Math.PI;
var DIRECTIONS = ["N", "NE", "E", "SE", "S", "SW", "W", "NW"];
/**
   * Mathematical modulo
   *
   * @param {number} x
   * @param {number} m
   * @returns {number}
   */
function mod(x, m) {
    return (x % m + m) % m;
}
/**
     * Convert from radians to degrees
     *
     * @param {number} radians
     * @returns {number} degrees
     */
function radiansToDegrees(radians) {
    return 180 / Math.PI * radians;
}
exports.radiansToDegrees = radiansToDegrees;
/**
     * Convert from degrees to radians
     *
     * @param {number} degrees
     * @returns {number} radians
     */
function degreesToRadians(degrees) {
    return Math.PI / 180 * degrees;
}
exports.degreesToRadians = degreesToRadians;
/**
     * Normalize an arbitrary angle to the interval [-180, 180)
     *
     * @param {number} n
     * @returns {number}
     */
function normalizeHalf(n) {
    var h = SCALE / 2;
    return mod(n + h, SCALE) - h;
}
exports.normalizeHalf = normalizeHalf;
/**
     * Normalize an arbitrary angle to the interval [0, 360)
     *
     * @param {number} n
     * @returns {number}
     */
function normalize(n) {
    return mod(n, SCALE);
}
exports.normalize = normalize;
/**
     * Gets the shortest direction to rotate to another angle
     *
     * @param {number} from
     * @param {number} to
     * @returns {number}
     */
function shortestDirection(from, to) {
    var z = from - to;
    // mod(-z, 360) < mod(z, 360) <=> mod(z + 180, 360) < 180       , for all z \ 180
    if (from === to) {
        return 0;
        // if (mod(-z, 360) < mod(z, 360)) {
    }
    else if (normalizeHalf(z) < 0) {
        return -1; // Left
    }
    else {
        return +1; // Right
    }
}
exports.shortestDirection = shortestDirection;
/**
     * Checks if an angle is between two other angles
     *
     * @param {number} n
     * @param {number} a
     * @param {number} b
     * @returns {boolean}
     */
function between(n, a, b) {
    // Check if an angle n is between a and b
    n = mod(n, SCALE);
    a = mod(a, SCALE);
    b = mod(b, SCALE);
    if (a < b)
        return a <= n && n <= b;
    // return 0 <= n && n <= b || a <= n && n < 360;
    return a <= n || n <= b;
}
exports.between = between;
/**
     * Calculates the angular difference between two angles
     * @param {number} a
     * @param {number} b
     * @returns {number}
     */
function diff(a, b) {
    return Math.abs(b - a) % SCALE;
}
exports.diff = diff;
/**
     * Calculate the minimal distance between two angles
     *
     * @param {number} a
     * @param {number} b
     * @returns {number}
     */
function distance(a, b) {
    var h = SCALE / 2;
    // One-Liner:
    //return Math.min(mod(a - b, m), mod(b - a, m));
    var diff = normalizeHalf(a - b);
    if (diff > h)
        diff = diff - SCALE;
    return Math.abs(diff);
}
exports.distance = distance;
/**
     * Calculate radians from current angle
     *
     * @param {number} n
     * @returns {number}
     */
function toRad(n) {
    // https://en.wikipedia.org/wiki/Radian
    return n / SCALE * TAU;
}
exports.toRad = toRad;
/**
     * Calculate degrees from current angle
     *
     * @param {number} n
     * @returns {number}
     */
function toDeg(n) {
    // https://en.wikipedia.org/wiki/Degree_(angle)
    return n / SCALE * 360;
}
exports.toDeg = toDeg;
/**
     * Calculate gons from current angle
     *
     * @param {number} n
     * @returns {number}
     */
function toGon(n) {
    // https://en.wikipedia.org/wiki/Gradian
    return n / SCALE * 400;
}
exports.toGon = toGon;
/**
     * Given the sine and cosine of an angle, what is the original angle?
     *
     * @param {number} sin
     * @param {number} cos
     * @returns {number}
     */
function fromSinCos(sin, cos) {
    var angle = (1 + Math.acos(cos) / TAU) * SCALE;
    if (sin < 0) {
        angle = SCALE - angle;
    }
    return mod(angle, SCALE);
}
exports.fromSinCos = fromSinCos;
/**
     * What is the angle of two points making a line
     *
     * @param {Array} p1
     * @param {Array} p2
     * @returns {number}
     */
function fromSlope(p1, p2) {
    var angle = (TAU + Math.atan2(p2[1] - p1[1], p2[0] - p1[0])) % TAU;
    return angle / TAU * SCALE;
}
exports.fromSlope = fromSlope;
/**
     * Returns the quadrant
     *
     * @param {number} x The point x-coordinate
     * @param {number} y The point y-coordinate
     * @param {number=} k The optional number of regions in the coordinate-system
     * @param {number=} shift An optional angle to rotate the coordinate system
     * @returns {number}
     */
function quadrant(x, y, k, shift) {
    if (fp_1.isUndefined(k))
        k = 4; // How many regions? 4 = quadrant, 8 = octant, ...
    if (fp_1.isUndefined(shift))
        shift = 0; // Rotate the coordinate system by shift° (positiv = counter-clockwise)
    /* shift = PI / k, k = 4:
           *   I) 45-135
           *  II) 135-225
           * III) 225-315
           *  IV) 315-360
           */
    /* shift = 0, k = 4:
           *   I) 0-90
           *  II) 90-180
           * III) 180-270
           *  IV) 270-360
           */
    var phi = (Math.atan2(y, x) + TAU) / TAU;
    if (Math.abs(phi * SCALE % (SCALE / k)) < EPS) {
        return 0;
    }
    return 1 + mod(Math.floor(k * shift / SCALE + k * phi), k);
}
exports.quadrant = quadrant;
/**
     * Calculates the compass direction of the given angle
     *
     * @param {number} angle
     * @returns {string}
     */
function compass(course) {
    // 0° = N
    // 90° = E
    // 180° = S
    // 270° = W
    var k = DIRECTIONS.length;
    var dir = Math.round(course / SCALE * k);
    return DIRECTIONS[mod(dir, k)];
}
exports.compass = compass;
/**
     * Calculates the linear interpolation of two angles
     *
     * @param {number} a Angle one
     * @param {number} b Angle two
     * @param {number} p Percentage
     * @param {number} dir Direction (either 1 [=CW] or -1 [=CCW])
     * @returns {number}
     */
function lerp(a, b, p, dir) {
    a = mod(a, SCALE);
    b = mod(b, SCALE);
    if (a === b)
        return a;
    // dir becomes an offset if we have to add a full revolution (=scale)
    if (!dir)
        dir = -SCALE;
    else if (dir === 1 === a < b)
        dir *= SCALE;
    else
        dir = 0;
    return mod(a + p * (b - a - dir), SCALE);
}
exports.lerp = lerp;
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiQW5nbGUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvc3Bpbm9mZnMvQW5nbGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSxnQ0FBd0M7QUFFeEMsc0NBQXNDO0FBQ3RDLDhEQUE4RDtBQUU5RCxJQUFNLEdBQUcsR0FBRyxDQUFDLEdBQUcsSUFBSSxDQUFDLEVBQUUsQ0FBQztBQUN4QixJQUFNLEdBQUcsR0FBRyxLQUFLLENBQUM7QUFDbEIsSUFBTSxLQUFLLEdBQUcsQ0FBQyxHQUFHLElBQUksQ0FBQyxFQUFFLENBQUM7QUFDMUIsSUFBTSxVQUFVLEdBQUcsQ0FBQyxHQUFHLEVBQUUsSUFBSSxFQUFFLEdBQUcsRUFBRSxJQUFJLEVBQUUsR0FBRyxFQUFFLElBQUksRUFBRSxHQUFHLEVBQUUsSUFBSSxDQUFDLENBQUM7QUFFaEU7Ozs7OztLQU1LO0FBQ0wsYUFBYSxDQUFDLEVBQUUsQ0FBQztJQUNmLE1BQU0sQ0FBQyxDQUFDLENBQUMsR0FBRyxDQUFDLEdBQUcsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDO0FBQ3pCLENBQUM7QUFFRDs7Ozs7T0FLSTtBQUNKLDBCQUFpQyxPQUFlO0lBQzlDLE1BQU0sQ0FBQyxHQUFHLEdBQUcsSUFBSSxDQUFDLEVBQUUsR0FBRyxPQUFPLENBQUM7QUFDakMsQ0FBQztBQUZELDRDQUVDO0FBRUQ7Ozs7O09BS0k7QUFDSiwwQkFBaUMsT0FBZTtJQUM5QyxNQUFNLENBQUMsSUFBSSxDQUFDLEVBQUUsR0FBRyxHQUFHLEdBQUcsT0FBTyxDQUFDO0FBQ2pDLENBQUM7QUFGRCw0Q0FFQztBQUVEOzs7OztPQUtJO0FBQ0osdUJBQThCLENBQUM7SUFDN0IsSUFBSSxDQUFDLEdBQUcsS0FBSyxHQUFHLENBQUMsQ0FBQztJQUVsQixNQUFNLENBQUMsR0FBRyxDQUFDLENBQUMsR0FBRyxDQUFDLEVBQUUsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFDO0FBQy9CLENBQUM7QUFKRCxzQ0FJQztBQUVEOzs7OztPQUtJO0FBQ0osbUJBQTBCLENBQUM7SUFDekIsTUFBTSxDQUFDLEdBQUcsQ0FBQyxDQUFDLEVBQUUsS0FBSyxDQUFDLENBQUM7QUFDdkIsQ0FBQztBQUZELDhCQUVDO0FBRUQ7Ozs7OztPQU1JO0FBQ0osMkJBQWtDLElBQUksRUFBRSxFQUFFO0lBQ3hDLElBQUksQ0FBQyxHQUFHLElBQUksR0FBRyxFQUFFLENBQUM7SUFDbEIsaUZBQWlGO0lBRWpGLEVBQUUsQ0FBQyxDQUFDLElBQUksS0FBSyxFQUFFLENBQUMsQ0FBQyxDQUFDO1FBQ2hCLE1BQU0sQ0FBQyxDQUFDLENBQUM7UUFDVCxvQ0FBb0M7SUFDdEMsQ0FBQztJQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsQ0FBQyxhQUFhLENBQUMsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsQ0FBQztRQUNoQyxNQUFNLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxPQUFPO0lBQ3BCLENBQUM7SUFBQyxJQUFJLENBQUMsQ0FBQztRQUNOLE1BQU0sQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLFFBQVE7SUFDckIsQ0FBQztBQUNILENBQUM7QUFaRCw4Q0FZQztBQUVEOzs7Ozs7O09BT0k7QUFDSixpQkFBd0IsQ0FBQyxFQUFFLENBQUMsRUFBRSxDQUFDO0lBQzdCLHlDQUF5QztJQUV6QyxDQUFDLEdBQUcsR0FBRyxDQUFDLENBQUMsRUFBRSxLQUFLLENBQUMsQ0FBQztJQUNsQixDQUFDLEdBQUcsR0FBRyxDQUFDLENBQUMsRUFBRSxLQUFLLENBQUMsQ0FBQztJQUNsQixDQUFDLEdBQUcsR0FBRyxDQUFDLENBQUMsRUFBRSxLQUFLLENBQUMsQ0FBQztJQUVsQixFQUFFLENBQUMsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDO1FBQUMsTUFBTSxDQUFDLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUNuQyxnREFBZ0Q7SUFDaEQsTUFBTSxDQUFDLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztBQUMxQixDQUFDO0FBVkQsMEJBVUM7QUFFRDs7Ozs7T0FLSTtBQUNKLGNBQXFCLENBQUMsRUFBRSxDQUFDO0lBQ3ZCLE1BQU0sQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsR0FBRyxLQUFLLENBQUM7QUFDakMsQ0FBQztBQUZELG9CQUVDO0FBRUQ7Ozs7OztPQU1JO0FBQ0osa0JBQXlCLENBQUMsRUFBRSxDQUFDO0lBQzNCLElBQUksQ0FBQyxHQUFHLEtBQUssR0FBRyxDQUFDLENBQUM7SUFFbEIsYUFBYTtJQUNiLGdEQUFnRDtJQUVoRCxJQUFJLElBQUksR0FBRyxhQUFhLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDO0lBRWhDLEVBQUUsQ0FBQyxDQUFDLElBQUksR0FBRyxDQUFDLENBQUM7UUFBQyxJQUFJLEdBQUcsSUFBSSxHQUFHLEtBQUssQ0FBQztJQUVsQyxNQUFNLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsQ0FBQztBQUN4QixDQUFDO0FBWEQsNEJBV0M7QUFFRDs7Ozs7T0FLSTtBQUNKLGVBQXNCLENBQUM7SUFDckIsdUNBQXVDO0lBQ3ZDLE1BQU0sQ0FBQyxDQUFDLEdBQUcsS0FBSyxHQUFHLEdBQUcsQ0FBQztBQUN6QixDQUFDO0FBSEQsc0JBR0M7QUFFRDs7Ozs7T0FLSTtBQUNKLGVBQXNCLENBQUM7SUFDckIsK0NBQStDO0lBQy9DLE1BQU0sQ0FBQyxDQUFDLEdBQUcsS0FBSyxHQUFHLEdBQUcsQ0FBQztBQUN6QixDQUFDO0FBSEQsc0JBR0M7QUFFRDs7Ozs7T0FLSTtBQUNKLGVBQXNCLENBQUM7SUFDckIsd0NBQXdDO0lBQ3hDLE1BQU0sQ0FBQyxDQUFDLEdBQUcsS0FBSyxHQUFHLEdBQUcsQ0FBQztBQUN6QixDQUFDO0FBSEQsc0JBR0M7QUFFRDs7Ozs7O09BTUk7QUFDSixvQkFBMkIsR0FBRyxFQUFFLEdBQUc7SUFDakMsSUFBSSxLQUFLLEdBQUcsQ0FBQyxDQUFDLEdBQUcsSUFBSSxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsR0FBRyxHQUFHLENBQUMsR0FBRyxLQUFLLENBQUM7SUFFL0MsRUFBRSxDQUFDLENBQUMsR0FBRyxHQUFHLENBQUMsQ0FBQyxDQUFDLENBQUM7UUFDWixLQUFLLEdBQUcsS0FBSyxHQUFHLEtBQUssQ0FBQztJQUN4QixDQUFDO0lBQ0QsTUFBTSxDQUFDLEdBQUcsQ0FBQyxLQUFLLEVBQUUsS0FBSyxDQUFDLENBQUM7QUFDM0IsQ0FBQztBQVBELGdDQU9DO0FBRUQ7Ozs7OztPQU1JO0FBQ0osbUJBQTBCLEVBQUUsRUFBRSxFQUFFO0lBQzlCLElBQUksS0FBSyxHQUFHLENBQUMsR0FBRyxHQUFHLElBQUksQ0FBQyxLQUFLLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQyxHQUFHLEVBQUUsQ0FBQyxDQUFDLENBQUMsRUFBRSxFQUFFLENBQUMsQ0FBQyxDQUFDLEdBQUcsRUFBRSxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsR0FBRyxHQUFHLENBQUM7SUFFbkUsTUFBTSxDQUFDLEtBQUssR0FBRyxHQUFHLEdBQUcsS0FBSyxDQUFDO0FBQzdCLENBQUM7QUFKRCw4QkFJQztBQUVEOzs7Ozs7OztPQVFJO0FBQ0osa0JBQXlCLENBQUMsRUFBRSxDQUFDLEVBQUUsQ0FBQyxFQUFFLEtBQUs7SUFDckMsRUFBRSxDQUFDLENBQUMsZ0JBQVcsQ0FBQyxDQUFDLENBQUMsQ0FBQztRQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxrREFBa0Q7SUFFN0UsRUFBRSxDQUFDLENBQUMsZ0JBQVcsQ0FBQyxLQUFLLENBQUMsQ0FBQztRQUFDLEtBQUssR0FBRyxDQUFDLENBQUMsQ0FBQyx1RUFBdUU7SUFFMUc7Ozs7O2FBS0c7SUFFSDs7Ozs7YUFLRztJQUVILElBQUksR0FBRyxHQUFHLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxDQUFDLEVBQUUsQ0FBQyxDQUFDLEdBQUcsR0FBRyxDQUFDLEdBQUcsR0FBRyxDQUFDO0lBRXpDLEVBQUUsQ0FBQyxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsR0FBRyxHQUFHLEtBQUssR0FBRyxDQUFDLEtBQUssR0FBRyxDQUFDLENBQUMsQ0FBQyxHQUFHLEdBQUcsQ0FBQyxDQUFDLENBQUM7UUFDOUMsTUFBTSxDQUFDLENBQUMsQ0FBQztJQUNYLENBQUM7SUFFRCxNQUFNLENBQUMsQ0FBQyxHQUFHLEdBQUcsQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLENBQUMsR0FBRyxLQUFLLEdBQUcsS0FBSyxHQUFHLENBQUMsR0FBRyxHQUFHLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQztBQUM3RCxDQUFDO0FBMUJELDRCQTBCQztBQUVEOzs7OztPQUtJO0FBQ0osaUJBQXdCLE1BQU07SUFDNUIsU0FBUztJQUNULFVBQVU7SUFDVixXQUFXO0lBQ1gsV0FBVztJQUVYLElBQUksQ0FBQyxHQUFHLFVBQVUsQ0FBQyxNQUFNLENBQUM7SUFFMUIsSUFBSSxHQUFHLEdBQUcsSUFBSSxDQUFDLEtBQUssQ0FBQyxNQUFNLEdBQUcsS0FBSyxHQUFHLENBQUMsQ0FBQyxDQUFDO0lBRXpDLE1BQU0sQ0FBQyxVQUFVLENBQUMsR0FBRyxDQUFDLEdBQUcsRUFBRSxDQUFDLENBQUMsQ0FBQyxDQUFDO0FBQ2pDLENBQUM7QUFYRCwwQkFXQztBQUVEOzs7Ozs7OztPQVFJO0FBQ0osY0FBcUIsQ0FBQyxFQUFFLENBQUMsRUFBRSxDQUFDLEVBQUUsR0FBRztJQUMvQixDQUFDLEdBQUcsR0FBRyxDQUFDLENBQUMsRUFBRSxLQUFLLENBQUMsQ0FBQztJQUNsQixDQUFDLEdBQUcsR0FBRyxDQUFDLENBQUMsRUFBRSxLQUFLLENBQUMsQ0FBQztJQUVsQixFQUFFLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQyxDQUFDO1FBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQztJQUV0QixxRUFBcUU7SUFDckUsRUFBRSxDQUFDLENBQUMsQ0FBQyxHQUFHLENBQUM7UUFBQyxHQUFHLEdBQUcsQ0FBQyxLQUFLLENBQUM7SUFDdkIsSUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFDLEdBQUcsS0FBSyxDQUFDLEtBQUssQ0FBQyxHQUFHLENBQUMsQ0FBQztRQUFDLEdBQUcsSUFBSSxLQUFLLENBQUM7SUFDM0MsSUFBSTtRQUFDLEdBQUcsR0FBRyxDQUFDLENBQUM7SUFFYixNQUFNLENBQUMsR0FBRyxDQUFDLENBQUMsR0FBRyxDQUFDLEdBQUcsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxHQUFHLEdBQUcsQ0FBQyxFQUFFLEtBQUssQ0FBQyxDQUFDO0FBQzNDLENBQUM7QUFaRCxvQkFZQyJ9