Skip to content


Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?


Failed to load latest commit information.
Latest commit message
Commit time
April 16, 2013 22:10
April 24, 2013 08:24
April 16, 2013 22:10
April 16, 2013 22:10
April 16, 2013 22:10

**vector-js** =========

vector.js is a small module to facilitate limited 3D vector arithmetics based on unsigned 8 bit integers (UInt8). The module emulates operator overloading in JavaScript and show its limitations in the context of an included tutorial and well documented sources.

See the documentation to learn more about using and extending vector-js.


There are several demonstrations of how to use vector.js in the tutorial section of vector-js.
You can find these demos here


vector-js was written by @sauerlo


No building steps are required. You can either download the repository from github, or use the npm packager:

sudo npm install -g vector-js

If you run a windows command line with administrator priviledges no sudo prefix is required. You can check if the package installed properly

npm list -g

To get started include vector-op.js in your web-site as follows, and exchange res/js/ with the respective path of your file.

<script type="text/javascript" src="res/js/vector-op.js"></script>

If you use node.js and require you can include the file via:

var vectorop = require('./vector-js')


  • determine the maximum value for the left bitshift operation:
   vectorop.d2b(1 << 31)
   //> "-10000000000000000000000000000000"

   vectorop.d2b(1 << 32)
   //> "1"
   vectorop.d2b(1 << 33%32)
   //> "10"
   vectorop.d2b(1 << 33%32) === vectorop.d2b(1 << 33)
   //> true
  • creating a new vector
   a=new vectorop.Vector(4, 10, 100)
   +a   //invoke a.toString();
   //> [x: 4, y: 10, z: 100]
   //> 6556164

- performing basic vector arithmetics

   var a = vectorop.Vector(0, 3, 0);
   var b = vectorop.Vector(2, 0, 1);
   var c = vectorop.Vector(1, 0, 1);
   var d = vectorop.Vector(a + b - c);
   //> [x: 1, y: 3, z: 0]
   var scalarf = 1.3;
   var e = vectorop.Vector(d * scalarf);
   delete e; // delete the vector instance 'e'
   var a = new vectorop.Vector(10, 20, 30);
   var b = new vectorop.Vector(a/10);
   //> [x: 1, y: 2, z: 3]
  • cross and dot product
   var a = new vectorop.Vector(3, 55, 12);
   var b = new vectorop.Vector(1, 2, 3);
   //> 149
   //> 0        //fails due to UInt8-type constraints
   //> [x: 115, y: 2, z: 49]
   //> 3211891


vector.js is released under the MIT license.

See also


Operators for vectors or other JavaScript objects, just as you are used to. See it in action:







No releases published


No packages published