| import * as Util from '../core/Util'; | |
| import {Earth} from './crs/CRS.Earth'; | |
| import {toLatLngBounds} from './LatLngBounds'; | |
| /* @class LatLng | |
| * @aka L.LatLng | |
| * | |
| * Represents a geographical point with a certain latitude and longitude. | |
| * | |
| * @example | |
| * | |
| * ``` | |
| * var latlng = L.latLng(50.5, 30.5); | |
| * ``` | |
| * | |
| * All Leaflet methods that accept LatLng objects also accept them in a simple Array form and simple object form (unless noted otherwise), so these lines are equivalent: | |
| * | |
| * ``` | |
| * map.panTo([50, 30]); | |
| * map.panTo({lon: 30, lat: 50}); | |
| * map.panTo({lat: 50, lng: 30}); | |
| * map.panTo(L.latLng(50, 30)); | |
| * ``` | |
| * | |
| * Note that `LatLng` does not inherit from Leaflet's `Class` object, | |
| * which means new classes can't inherit from it, and new methods | |
| * can't be added to it with the `include` function. | |
| */ | |
| export function LatLng(lat, lng, alt) { | |
| if (isNaN(lat) || isNaN(lng)) { | |
| throw new Error('Invalid LatLng object: (' + lat + ', ' + lng + ')'); | |
| } | |
| // @property lat: Number | |
| // Latitude in degrees | |
| this.lat = +lat; | |
| // @property lng: Number | |
| // Longitude in degrees | |
| this.lng = +lng; | |
| // @property alt: Number | |
| // Altitude in meters (optional) | |
| if (alt !== undefined) { | |
| this.alt = +alt; | |
| } | |
| } | |
| LatLng.prototype = { | |
| // @method equals(otherLatLng: LatLng, maxMargin?: Number): Boolean | |
| // Returns `true` if the given `LatLng` point is at the same position (within a small margin of error). The margin of error can be overridden by setting `maxMargin` to a small number. | |
| equals: function (obj, maxMargin) { | |
| if (!obj) { return false; } | |
| obj = toLatLng(obj); | |
| var margin = Math.max( | |
| Math.abs(this.lat - obj.lat), | |
| Math.abs(this.lng - obj.lng)); | |
| return margin <= (maxMargin === undefined ? 1.0E-9 : maxMargin); | |
| }, | |
| // @method toString(): String | |
| // Returns a string representation of the point (for debugging purposes). | |
| toString: function (precision) { | |
| return 'LatLng(' + | |
| Util.formatNum(this.lat, precision) + ', ' + | |
| Util.formatNum(this.lng, precision) + ')'; | |
| }, | |
| // @method distanceTo(otherLatLng: LatLng): Number | |
| // Returns the distance (in meters) to the given `LatLng` calculated using the [Spherical Law of Cosines](https://en.wikipedia.org/wiki/Spherical_law_of_cosines). | |
| distanceTo: function (other) { | |
| return Earth.distance(this, toLatLng(other)); | |
| }, | |
| // @method wrap(): LatLng | |
| // Returns a new `LatLng` object with the longitude wrapped so it's always between -180 and +180 degrees. | |
| wrap: function () { | |
| return Earth.wrapLatLng(this); | |
| }, | |
| // @method toBounds(sizeInMeters: Number): LatLngBounds | |
| // Returns a new `LatLngBounds` object in which each boundary is `sizeInMeters/2` meters apart from the `LatLng`. | |
| toBounds: function (sizeInMeters) { | |
| var latAccuracy = 180 * sizeInMeters / 40075017, | |
| lngAccuracy = latAccuracy / Math.cos((Math.PI / 180) * this.lat); | |
| return toLatLngBounds( | |
| [this.lat - latAccuracy, this.lng - lngAccuracy], | |
| [this.lat + latAccuracy, this.lng + lngAccuracy]); | |
| }, | |
| clone: function () { | |
| return new LatLng(this.lat, this.lng, this.alt); | |
| } | |
| }; | |
| // @factory L.latLng(latitude: Number, longitude: Number, altitude?: Number): LatLng | |
| // Creates an object representing a geographical point with the given latitude and longitude (and optionally altitude). | |
| // @alternative | |
| // @factory L.latLng(coords: Array): LatLng | |
| // Expects an array of the form `[Number, Number]` or `[Number, Number, Number]` instead. | |
| // @alternative | |
| // @factory L.latLng(coords: Object): LatLng | |
| // Expects an plain object of the form `{lat: Number, lng: Number}` or `{lat: Number, lng: Number, alt: Number}` instead. | |
| export function toLatLng(a, b, c) { | |
| if (a instanceof LatLng) { | |
| return a; | |
| } | |
| if (Util.isArray(a) && typeof a[0] !== 'object') { | |
| if (a.length === 3) { | |
| return new LatLng(a[0], a[1], a[2]); | |
| } | |
| if (a.length === 2) { | |
| return new LatLng(a[0], a[1]); | |
| } | |
| return null; | |
| } | |
| if (a === undefined || a === null) { | |
| return a; | |
| } | |
| if (typeof a === 'object' && 'lat' in a) { | |
| return new LatLng(a.lat, 'lng' in a ? a.lng : a.lon, a.alt); | |
| } | |
| if (b === undefined) { | |
| return null; | |
| } | |
| return new LatLng(a, b, c); | |
| } | |