In-line documentation of the GeoHelpers.

Author: jondewoo

Assets/UnitySlippyMap/Helpers/GeoHelpers.cs

@@ -25,55 +25,71 @@
 
 namespace UnitySlippyMap
 {
-    // <summary>
-    // Helper class ported mostly from: http://www.maptiler.org/google-maps-coordinates-tile-bounds-projection/
-    // </summary>
+	/// <summary>
+	/// Helper class ported mostly from: http://www.maptiler.org/google-maps-coordinates-tile-bounds-projection/
+	/// </summary>
     public class GeoHelpers
     {
         public static double OriginShift = 2.0 * Math.PI * 6378137.0 / 2.0;
         public static float MetersPerInch = 2.54f / 100.0f;
     	public static double HalfEarthCircumference = 6378137.0 * Math.PI;
 		public static double EarthCircumference = HalfEarthCircumference * 2.0;
 
-        // <summary>
-        // Converts WGS84 LatLon coordinates to OSM tile coordinates.
-        // </summary>
-        public static int[] WGS84ToTile(double lon, double lat, int zoom)
+		/// <summary>
+		/// Converts WGS84 LatLon coordinates to OSM tile coordinates (<see cref="http://wiki.openstreetmap.org/wiki/Slippy_map_tilenames"/>).
+		/// </summary>
+		/// <returns>The tile coordinates.</returns>
+		/// <param name="lon">Longitude in the WGS84 coordinate system.</param>
+		/// <param name="lat">Latitude in the WGS84 coordinate system.</param>
+		/// <param name="zoom">Zoom level.</param>
+        public static int[] WGS84ToTile(double lon, double lat, int zoomLevel)
         {
             int[] p = new int[2];
-            p[0] = (int)((lon + 180.0) / 360.0 * (1 << zoom));
+			p[0] = (int)((lon + 180.0) / 360.0 * (1 << zoomLevel));
             p[1] = (int)((1.0 - Math.Log(Math.Tan(lat * Math.PI / 180.0) +
-                1.0 / Math.Cos(lat * Math.PI / 180.0)) / Math.PI) / 2.0 * (1 << zoom));
+			                             1.0 / Math.Cos(lat * Math.PI / 180.0)) / Math.PI) / 2.0 * (1 << zoomLevel));
 
             return p;
         }
 
-        // <summary>
-        // Converts OSM tile coordinates to WGS84 LatLon coordinates (upper left corner of the tile).
-        // </summary>
-        public static double[] TileToWGS84(int tile_x, int tile_y, int zoom)
+		/// <summary>
+		/// Converts OSM tile coordinates to WGS84 LatLon coordinates (upper left corner of the tile).
+		/// </summary>
+		/// <returns>The tile coordinates in the WGS84 coordinate system.</returns>
+		/// <param name="tile_x">X coordinate of the tile.</param>
+		/// <param name="tile_y">Y coordinate of the tile.</param>
+		/// <param name="zoom">Zoom level.</param>
+		public static double[] TileToWGS84(int tile_x, int tile_y, int zoomLevel)
         {
             double[] p = new double[2];
-            double n = Math.PI - ((2.0 * Math.PI * tile_y) / Math.Pow(2.0, zoom));
+			double n = Math.PI - ((2.0 * Math.PI * tile_y) / Math.Pow(2.0, zoomLevel));
 
-            p[0] = ((tile_x / Math.Pow(2.0, zoom) * 360.0) - 180.0);
+			p[0] = ((tile_x / Math.Pow(2.0, zoomLevel) * 360.0) - 180.0);
             p[1] = (180.0 / Math.PI * Math.Atan(Math.Sinh(n)));
 
             return p;
         }
 
-        // <summary>
-        // Returns the numbers of meters per pixel in respect to the latitude and zoom level of the map.
-        // </summary>
+		/// <summary>
+		/// Returns the number of meters per pixel in respect to the latitude and zoom level of the map.
+		/// </summary>
+		/// <returns>The number of meters per pixel.</returns>
+		/// <param name="latitude">Latitude.</param>
+		/// <param name="zoomLevel">Zoom level.</param>
         public static float MetersPerPixel(float latitude, float zoomLevel)
         {
             double realLengthInMeters = EarthCircumference * Math.Cos(Mathf.Deg2Rad * latitude);
             return (float)(realLengthInMeters / Math.Pow(2.0, zoomLevel + 8));
         }
 
-        // <summary>
-        // Returns the Open Street Map zoom level in respect to the map scale, latitude, tile size and resolution.
-        // </summary>
+		/// <summary>
+		/// Returns the Open Street Map zoom level in respect to the map scale, latitude, tile size and resolution.
+		/// </summary>
+		/// <returns>The scale to osm zoom level.</returns>
+		/// <param name="mapScale">Map scale.</param>
+		/// <param name="latitude">Latitude.</param>
+		/// <param name="tileSize">Tile size.</param>
+		/// <param name="ppi">Pixels per inch.</param>
         public static float MapScaleToOsmZoomLevel(float mapScale, float latitude, float tileSize, float ppi)
         {
             double realLengthInMeters = EarthCircumference * Math.Cos(Mathf.Deg2Rad * latitude);
@@ -82,9 +98,14 @@ public static float MapScaleToOsmZoomLevel(float mapScale, float latitude, float
             return (float)Math.Log(zoomLevelExp, 2.0);
         }
 
-        // <summary>
-        // Returns the map scale in respect to the Open Street Map zoom level, latitude, tile size and resolution.
-        // </summary>
+		/// <summary>
+		/// Returns the map scale in respect to the Open Street Map zoom level, latitude, tile size and resolution.
+		/// </summary>
+		/// <returns>The zoom level to map scale.</returns>
+		/// <param name="zoomLevel">Zoom level.</param>
+		/// <param name="latitude">Latitude.</param>
+		/// <param name="tileSize">Tile size.</param>
+		/// <param name="ppi">Pixels per inch.</param>
         public static float OsmZoomLevelToMapScale(float zoomLevel, float latitude, float tileSize, float ppi)
         {
             double realLengthInMeters = EarthCircumference * Math.Cos(Mathf.Deg2Rad * latitude);
@@ -93,16 +114,13 @@ public static float OsmZoomLevelToMapScale(float zoomLevel, float latitude, floa
 
             return (float)((realLengthInMeters * ppi) / zoomLevelExp / tileSize / MetersPerInch);
         }
-		
-		// <summary>
-		// Returns WGS84 given a RaycastHit and Map instance.
-		// </summary>
-		// <param name='r'>
-		// The RaycastHit
-		// </param>
-		// <param name='m'>
-		// The Map instance
-		// </param>
+
+		/// <summary>
+		/// Returns WGS84 given a RaycastHit and Map instance.
+		/// </summary>
+		/// <returns>The WGS84 coordinates of the point hit.</returns>
+		/// <param name="map"><see cref="UnitySlippyMap.Map"/> instance.</param>
+		/// <param name="r">The red component.</param>
 		public static double[] RaycastHitToWGS84(Map map, RaycastHit r)
 		{
 			double[] RaycastHitToEPSG900913 = new double[]{(map.CenterEPSG900913[0]) + (r.point.x/map.ScaleMultiplier) , (map.CenterEPSG900913[1]) + (r.point.z/map.ScaleMultiplier)};