diff --git a/doc_config/Menu.txt b/doc_config/Menu.txt index 7d685cb73c..1a941749ae 100644 --- a/doc_config/Menu.txt +++ b/doc_config/Menu.txt @@ -458,6 +458,7 @@ Group: OpenLayers { File: Tween (no auto-title, OpenLayers/Tween.js) File: Util (no auto-title, OpenLayers/Util.js) + File: Spherical (no auto-title, OpenLayers/Spherical.js) File: Deprecated (no auto-title, deprecated.js) } # Group: OpenLayers diff --git a/lib/OpenLayers.js b/lib/OpenLayers.js index 3ffa1b6a84..78b35da424 100644 --- a/lib/OpenLayers.js +++ b/lib/OpenLayers.js @@ -348,7 +348,8 @@ "OpenLayers/Symbolizer/Text.js", "OpenLayers/Symbolizer/Raster.js", "OpenLayers/Lang.js", - "OpenLayers/Lang/en.js" + "OpenLayers/Lang/en.js", + "OpenLayers/Spherical.js" ]; // etc. } diff --git a/lib/OpenLayers/Spherical.js b/lib/OpenLayers/Spherical.js index ed64c844f8..b19edc8939 100644 --- a/lib/OpenLayers/Spherical.js +++ b/lib/OpenLayers/Spherical.js @@ -3,29 +3,32 @@ * See http://svn.openlayers.org/trunk/openlayers/license.txt for the * full text of the license. */ -/** - * @see http://www.movable-type.co.uk/scripts/latlong.html - * @see http://code.google.com/apis/maps/documentation/javascript/reference.html#spherical - */ - - /** * Namespace: Spherical + * The OpenLayers.Spherical namespace includes utility functions for + * calculations on the basis of a spherical earth (ignoring ellipsoidal + * effects), which is accurate enough for most purposes. + * + * Relevant links: + * * http://www.movable-type.co.uk/scripts/latlong.html + * * http://code.google.com/apis/maps/documentation/javascript/reference.html#spherical */ + OpenLayers.Spherical = OpenLayers.Spherical || {}; - OpenLayers.Spherical.DEFAULT_RADIUS = 6378137; - /** * APIFunction: computeDistanceBetween * Computes the distance between two LonLats. * * Parameters: - * from - {} - * to - {} - * radius - {Float} + * from - {} or {Object} Starting point. A LonLat or + * a JavaScript litteral with lon lat properties. + * to - {} or {Object} Ending point. A LonLat or a + * JavaScript litteral with lon lat properties. + * radius - {Float} The radius. Optional. Defaults to the earth's + * radius, i.e. 6378137 meters. * * Returns: * {Float} The distance in meters. @@ -45,8 +48,10 @@ OpenLayers.Spherical.computeDistanceBetween = function(from, to, radius) { * Computes the heading from one LonLat to another LonLat. * * Parameters: - * from - {} - * to - {} + * from - {} or {Object} Starting point. A LonLat or + * a JavaScript litteral with lon lat properties. + * to - {} or {Object} Ending point. A LonLat or a + * JavaScript litteral with lon lat properties. * * Returns: * {Float} The heading in degrees.