v1.0.0

AUTHORS

@@ -0,0 +1,2 @@
+Jon Atkins <github@jonatkins.com> (http://www.jonatkins.com/)
+AJ ONeal <coolaj86@gmail.com> (https://coolaj86.com)

LICENSE

@@ -0,0 +1,8 @@
+ISC License (ISC)
+
+Copyright (c) 2012-2016, Jon Atkins <github@jonatkins.com>
+Copyright (c) 2016, AJ ONeal <coolaj86@gmail.com>
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

README.md

@@ -1,19 +1,19 @@
-s2-geometry-javascript
+s2-geometry (JavaScript/ES5.1)
 ======================
 
-Porting Google's S2 Geometry Library to Javascript
-
+A pure JavaScript/ES5.1 port of Google/Niantic's S2 Geometry library (used by Ingress, Pokemon GO)
 
 Currently contains basic support for S2Cell
 
-More details and examples to come later.
-
-What you need to know for Pokemon GO clients:
+Simple Examples
+---------------
 
 ```javascript
-var cell = S2.S2Cell.FromLatLng({ lat: 40.2574448, lng: -111.7089464 }, 15);
+var level = 15;
+var latlng = { lat: 40.2574448, lng: -111.7089464 };
+var cell = S2.S2Cell.FromLatLng(latlng, level);
 
-cell.getNeighbors(); // [ cellLeft, cellDown, cellRight, cellUp ]
+cell.getNeighbors();  // [ cellLeft, cellDown, cellRight, cellUp ]
 
-cell.getLatLng(); // { lat: 40.2574448, lng: -111.7089464 }
+cell.getLatLng();     // { lat: 40.2574448, lng: -111.7089464 }
 ```

package.json

@@ -0,0 +1,36 @@
+{
+  "name": "s2-geometry",
+  "version": "1.0.0",
+  "description": "A pure JavaScript/ES5.1 port of Google/Niantic's S2 Geometry library (used by Ingress, Pokemon GO)",
+  "main": "src/s2geometry.js",
+  "scripts": {
+    "test": "node tests/cellid.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/coolaj86/s2-geometry-javascript.git"
+  },
+  "keywords": [
+    "s2",
+    "geometry",
+    "s2geometry",
+    "Niantic",
+    "Ingress",
+    "Pokemon",
+    "GO",
+    "PokemonGO",
+    "cellid",
+    "s2cell",
+    "s2cellid",
+    "latitude",
+    "longitude",
+    "lat",
+    "lng"
+  ],
+  "author": "AJ ONeal <coolaj86@gmail.com> (https://coolaj86.com/)",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/coolaj86/s2-geometry-javascript/issues"
+  },
+  "homepage": "https://github.com/coolaj86/s2-geometry-javascript#readme"
+}

src/s2geometry.js

@@ -22,10 +22,10 @@
 // - i,j: they always use 30 bits, adjusting as needed. we use 0 to (1<<level)-1 instead
 //        (so GetSizeIJ for a cell is always 1)
 
-(function() {
+(function(exports) {
 'use strict';
 
-window.S2 = {};
+var S2 = exports.S2 = {};
 
 var LatLngToXYZ = function(latLng) {
   var d2r = S2.L.LatLng.DEG_TO_RAD;
@@ -76,11 +76,11 @@ var faceXYZToUV = function(face,xyz) {
     case 3: u =  xyz[2]/xyz[0]; v =  xyz[1]/xyz[0]; break;
     case 4: u =  xyz[2]/xyz[1]; v = -xyz[0]/xyz[1]; break;
     case 5: u = -xyz[1]/xyz[2]; v = -xyz[0]/xyz[2]; break;
-    default: throw {error: 'Invalid face'}; break;
+    default: throw {error: 'Invalid face'};
   }
 
   return [u,v];
-}
+};
 
 
 
@@ -112,30 +112,27 @@ var FaceUVToXYZ = function(face,uv) {
   }
 };
 
+var singleSTtoUV = function(st) {
+  if (st >= 0.5) {
+    return (1/3.0) * (4*st*st - 1);
+  } else {
+    return (1/3.0) * (1 - (4*(1-st)*(1-st)));
+  }
+};
 
 var STToUV = function(st) {
-  var singleSTtoUV = function(st) {
-    if (st >= 0.5) {
-      return (1/3.0) * (4*st*st - 1);
-    } else {
-      return (1/3.0) * (1 - (4*(1-st)*(1-st)));
-    }
-  }
-
   return [singleSTtoUV(st[0]), singleSTtoUV(st[1])];
 };
 
 
-
-var UVToST = function(uv) {
-  var singleUVtoST = function(uv) {
-    if (uv >= 0) {
-      return 0.5 * Math.sqrt (1 + 3*uv);
-    } else {
-      return 1 - 0.5 * Math.sqrt (1 - 3*uv);
-    }
+var singleUVtoST = function(uv) {
+  if (uv >= 0) {
+    return 0.5 * Math.sqrt (1 + 3*uv);
+  } else {
+    return 1 - 0.5 * Math.sqrt (1 - 3*uv);
   }
-
+};
+var UVToST = function(uv) {
   return [singleUVtoST(uv[0]), singleUVtoST(uv[1])];
 };
 
@@ -159,7 +156,7 @@ var IJToST = function(ij,order,offsets) {
     (ij[0]+offsets[0])/maxSize,
     (ij[1]+offsets[1])/maxSize
   ];
-}
+};
 
 // hilbert space-filling curve
 // based on http://blog.notdot.net/2009/11/Damn-Cool-Algorithms-Spatial-indexing-with-Quadtrees-and-Hilbert-Curves
@@ -212,8 +209,6 @@ S2.S2Cell.FromLatLng = function(latLng,level) {
   var ij = STToIJ(st,level);
 
   return S2.S2Cell.FromFaceIJ (faceuv[0], ij, level);
-
-  return result;
 };
 
 S2.S2Cell.FromFaceIJ = function(face,ij,level) {
@@ -304,14 +299,20 @@ S2.S2Cell.prototype.getNeighbors = function() {
 };
 
 
-})();
+})('undefined' !== typeof window ? window : module.exports);
 
-(function () {
+(function (exports) {
 'use strict';
 
   // Adapted from Leafletjs https://searchcode.com/codesearch/view/42525008/
 
   var L = {};
+  var S2 = exports.S2;
+
+  if (!exports.L) {
+    exports.L = L;
+  }
+  S2.L = L;
 
   L.LatLng = function (/*Number*/ rawLat, /*Number*/ rawLng, /*Boolean*/ noWrap) {
     var lat = parseFloat(rawLat, 10);
@@ -331,9 +332,4 @@ S2.S2Cell.prototype.getNeighbors = function() {
 
   L.LatLng.DEG_TO_RAD = Math.PI / 180;
   L.LatLng.RAD_TO_DEG = 180 / Math.PI;
-  
-  if (!window.L) {
-    window.L = L;
-  }
-  S2.L = L;
-})();
+})('undefined' !== typeof window ? window : module.exports);

tests/cellid.js

@@ -0,0 +1,21 @@
+'use strict';
+
+var S2 = require('../src/s2geometry.js').S2;
+
+var level = 15;
+var latlng = { lat: 40.2574448, lng: -111.7089464 };
+var cell = S2.S2Cell.FromLatLng(latlng, level);
+
+cell.getNeighbors();  // [ cellLeft, cellDown, cellRight, cellUp ]
+
+latlng = cell.getLatLng();     // { lat: 40.2574448, lng: -111.7089464 }
+
+if (40 === Math.round(latlng.lat) && -112 === Math.round(latlng.lng)) {
+  console.log('OK');
+  process.exit(0);
+}
+else {
+  console.log('[ERROR] latitude and longitude were not the expected values:');
+  console.log(latlng);
+  process.exit(1);
+}