Skip to content

A lightweight JS library to work with planar ( 2D ) coordinates

Notifications You must be signed in to change notification settings

dejitaiza/PlanarJS

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Build Status

PlanarJS

A lightweight JS library to work with planar ( 2D ) coordinates.

It supports the following coordinate systems :

  • Cartesian ( complete )
  • Polar ( complete )
  • Geographic ( soon )

Running the test suite

PlanarJS uses Mocha for functional testing. To run the tests you need to install mocha globally if you don't have it yet :

npm install -g mocha

Then run the command :

mocha test

Announcements

22/05/2014 17:35 - The library is now usable in a CommonJS environment and is fully test-covered. Version bump to 0.2.0 to reflect the actual implementation design and specs. Check test/spec.js for details on how to use it. The documentation for a proper use is coming soon !

TODO :

  • Write a "How to use" paragraph ;D
  • Simplify the API
  • Provide a wrapper for CommonJS and AMD module formats
  • Provide events for listening to changes in coordinates
  • Add assertions to ensure the validity of the arguments sent to the API
  • DONE - Wrap all coordinate systems in one object
  • DONE - Implement conversion functions between coordinate systems
  • DONE - Implement facilities for computing distances between points

About

A lightweight JS library to work with planar ( 2D ) coordinates

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages