index.js 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. // https://en.wikipedia.org/wiki/Rhumb_line
  2. import { degreesToRadians, radiansToDegrees } from "@turf/helpers";
  3. import { getCoord } from "@turf/invariant";
  4. /**
  5. * Takes two {@link Point|points} and finds the bearing angle between them along a Rhumb line
  6. * i.e. the angle measured in degrees start the north line (0 degrees)
  7. *
  8. * @name rhumbBearing
  9. * @param {Coord} start starting Point
  10. * @param {Coord} end ending Point
  11. * @param {Object} [options] Optional parameters
  12. * @param {boolean} [options.final=false] calculates the final bearing if true
  13. * @returns {number} bearing from north in decimal degrees, between -180 and 180 degrees (positive clockwise)
  14. * @example
  15. * var point1 = turf.point([-75.343, 39.984], {"marker-color": "#F00"});
  16. * var point2 = turf.point([-75.534, 39.123], {"marker-color": "#00F"});
  17. *
  18. * var bearing = turf.rhumbBearing(point1, point2);
  19. *
  20. * //addToMap
  21. * var addToMap = [point1, point2];
  22. * point1.properties.bearing = bearing;
  23. * point2.properties.bearing = bearing;
  24. */
  25. function rhumbBearing(start, end, options) {
  26. if (options === void 0) { options = {}; }
  27. var bear360;
  28. if (options.final) {
  29. bear360 = calculateRhumbBearing(getCoord(end), getCoord(start));
  30. }
  31. else {
  32. bear360 = calculateRhumbBearing(getCoord(start), getCoord(end));
  33. }
  34. var bear180 = bear360 > 180 ? -(360 - bear360) : bear360;
  35. return bear180;
  36. }
  37. /**
  38. * Returns the bearing from ‘this’ point to destination point along a rhumb line.
  39. * Adapted from Geodesy: https://github.com/chrisveness/geodesy/blob/master/latlon-spherical.js
  40. *
  41. * @private
  42. * @param {Array<number>} from - origin point.
  43. * @param {Array<number>} to - destination point.
  44. * @returns {number} Bearing in degrees from north.
  45. * @example
  46. * var p1 = new LatLon(51.127, 1.338);
  47. * var p2 = new LatLon(50.964, 1.853);
  48. * var d = p1.rhumbBearingTo(p2); // 116.7 m
  49. */
  50. function calculateRhumbBearing(from, to) {
  51. // φ => phi
  52. // Δλ => deltaLambda
  53. // Δψ => deltaPsi
  54. // θ => theta
  55. var phi1 = degreesToRadians(from[1]);
  56. var phi2 = degreesToRadians(to[1]);
  57. var deltaLambda = degreesToRadians(to[0] - from[0]);
  58. // if deltaLambdaon over 180° take shorter rhumb line across the anti-meridian:
  59. if (deltaLambda > Math.PI) {
  60. deltaLambda -= 2 * Math.PI;
  61. }
  62. if (deltaLambda < -Math.PI) {
  63. deltaLambda += 2 * Math.PI;
  64. }
  65. var deltaPsi = Math.log(Math.tan(phi2 / 2 + Math.PI / 4) / Math.tan(phi1 / 2 + Math.PI / 4));
  66. var theta = Math.atan2(deltaLambda, deltaPsi);
  67. return (radiansToDegrees(theta) + 360) % 360;
  68. }
  69. export default rhumbBearing;