tsgeo/Bearing/BearingInterface.d.ts

TsGeo provides abstractions to geographical coordinates (including support for different ellipsoids) and allows you to calculate geographical distances between coordinates with high precision.

/**
 * Interface for Distance Calculator Classes
 *
 * @author    clemdesign <contact@clemdesign.fr>
 * @license   https://opensource.org/licenses/MIT
 * @link
  */
import { Coordinate } from "../Coordinate";
export interface BearingInterface {
    /**
     * This method calculates the initial bearing between the
     * two points.
     *
     * @param {Coordinate} point1
     * @param {Coordinate} point2
     * @returns {number}
     */
    calculateBearing(point1: Coordinate, point2: Coordinate): number;
    /**
     * Calculates the final bearing between the two points.
     *
     * @param {Coordinate} point1
     * @param {Coordinate} point2
     * @returns {number}
     */
    calculateFinalBearing(point1: Coordinate, point2: Coordinate): number;
    /**
     * Calculates a destination point for the given point, bearing angle,
     * and distance.
     *
     * @param {Coordinate} point
     * @param {number} bearing the bearing angle between 0 and 360 degrees
     * @param {number} distance the distance to the destination point in meters
     * @returns {Coordinate}
     */
    calculateDestination(point: Coordinate, bearing: number, distance: number): Coordinate;
}