rename to ray-aabb and work up readme

LICENSE.txt

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+Copyright © 2015 Elijah Insua <tmpvar@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the “Software”), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,58 @@
+# ray-aabb
+
+test if a ray intersects an aabb in 3d space
+
+ported from http://www.cs.utah.edu/~awilliam/box/
+
+> Amy Williams, Steve Barrus, R. Keith Morley, and Peter Shirley
+> "An Efficient and Robust Ray-Box Intersection Algorithm"
+> Journal of graphics tools, 10(1):49-54, 2005
+
+
+## install
+
+`npm install ray-aabb`
+
+## use
+
+```javascript
+var intersectRayAABB = require('ray-aabb');
+
+// setup an interval in which the ray is valid (i.e. inside the frustnum of a 3d scene)
+var near = 0;
+var far = 10;
+
+/*
+                     _______
+                    /      /|
+                   /______/ |
+                  | |_____|_|
+(-1, 1, 0) ---->  | /     | /
+                  |/______|/
+*/
+
+var origin = [-1, 1, 0];
+var box = [
+  [0, 0, 0],
+  [2, 2, 2]
+];
+var direction = [1, 0, 0];
+
+// this needs to be computed outside `ray-aabb` to avoid recomputing on every ray cast
+var inv_direction = [
+  1/direction[0],
+  1/direction[1],
+  1/direction[2]
+];
+
+console.log(intersectRayAABB(origin, direction, inv_direction, box, near, far));
+// outputs: true
+```
+
+## api surface
+
+
+
+## license
+
+[MIT](LICENSE.txt)

package.json

@@ -1,20 +1,21 @@
 {
-  "name": "ray-box",
+  "name": "ray-aabb",
   "version": "1.0.0",
-  "description": "test if a ray intersects a box in 3d space",
-  "main": "ray-box.js",
+  "description": "test if a ray intersects an aabb in 3d space",
+  "main": "ray-aabb.js",
   "scripts": {
     "test": "tape test.js"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/tmpvar/ray-box.git"
+    "url": "https://github.com/tmpvar/ray-aabb.git"
   },
   "keywords": [
     "geometry",
     "3d",
     "ray",
-    "ray-box",
+    "ray-aabb",
+    "aabb",
     "box",
     "intersection",
     "collision",
@@ -24,9 +25,9 @@
   "author": "Elijah Insua <tmpvar@gmail.com>",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/tmpvar/ray-box/issues"
+    "url": "https://github.com/tmpvar/ray-aabb/issues"
   },
-  "homepage": "https://github.com/tmpvar/ray-box",
+  "homepage": "https://github.com/tmpvar/ray-aabb",
   "devDependencies": {
     "gl-vec3": "^1.0.2",
     "tape": "^3.4.0"

ray-box.js → ray-aabb.js

@@ -1,8 +1,8 @@
-module.exports = intersectRayBox;
+module.exports = intersectRayAABB;
 
 var sign = [0, 0, 0];
 
-function intersectRayBox(origin, direction, inv_direction, box, near, far) {
+function intersectRayAABB(origin, direction, inv_direction, box, near, far) {
   var tmin, tmax, tymin, tymax, tzmin, tzmax;
 
   sign[0] = inv_direction[0] < 0 ? 1 : 0;

test.js

@@ -1,5 +1,5 @@
 var test = require('tape');
-var isect = require('./ray-box');
+var isect = require('./ray-aabb');
 var vec3 = require('gl-vec3');
 
 test('simple case - intersects (0, 0, 1)', function(t) {