math.gl

math.gl | Docs

math.gl

math.gl is an Array-based JavaScript 3D math library. In spite of its name it has no hard WebGL dependencies, but however both API and design are focused on focused on the needs of typical WebGL applications

Features

This is a short list of feature high-lights to show what math.gl is about.

• Array-based Classes - All math.gl classes (like Vector3, Matrix4) are subclasses of the built-in JavaScript Array class. This means that they can be used directly with any Javascript function that e.g. expects plain JavaScript Array arguments for Vectors, which is increasingly common.

• Debug Friendly - JavaScript math can be frustrating to code and debug. math.gl offers optional error checking after every math operation which makes quick work of locating coding errors and bad data. Also, strong "printing support" (toString) simplifies debugging.

• WebGL Support - Matrices are stored internally in the format required by WebGL (array of contiguous values in column-major order), while exposing the more "natural" row-major API to the JavaScript programmer (e.g. through accessors, printing using toString() etc).

• Documentation - Some JavaScript 3D math libraries come with reference documentation only. If you are new to 3D programming it can be hard to know where to start. math.gl comes with articles that try to show you the big picture and get you quickly up-to-speed on the mathematical concepts and the math.gl classes that support them.

• Size Conscious - A math library can quickly get big as a various classed and functions keep getting added. But for many 3D applications, only a few basic operations are necessary. math.gl has made a choices to restrict itself to a set of classes and functions that are likely to be most important in WebGL applications. The intention is to position math.gl as a "mid-size" 3D math library: reasonably full featured, but small enough that unless you are targeting a very small final bundle for your application, its size should not be a big concern.

Supported Browsers and Node Versions

math.gl is only supported on "evergreen" browsers, such as Chrome, Safari, Firefox, Edge etc. While not evergreen, IE11 should support the math.gl distribution's transpiled code, but Internet Explorer < 10 will not work. math.gl also works on recent versions of Node.js (tested on v6+).

Disclaimer: These restrictions are both due to real technical limitations with math.gl's Arraysubclassing approach, as well as a conscious decision by the maintainers to limit the support matrix for the library. So, if your application needs to support non-evergreen browsers, math.gl is unlikely to be the right choice for you. A good alternative option could be to use e.g. gl-matrix directly.

History

math.gl was developed as a companion 3D math library for the luma.gl and deck.gl WebGL frameworks, and the precursors of the math.gl classes were in fact part of luma.gl v4.0, but have now been broken out in this separate library.

In spite of its roots, the intention is that math.gl should be able to serve a general purpose 3D math library, and be used either directly or as a "starting point" by other projects with similar needs.

Attribution

math.gl heavily inspired by, and includes code, documentation and ideas from some of the most proven open source JavaScript math libraries, the awesome gl-matrix and the THREE.js math library. Those libraries encouraged reuse which enabled math.gl to be built, and naturally math.gl does the same!

License

MIT license. The libraries that math.gl are built on are also all open source and MIT licensed.

Changelog

v1.1.0 - Apr 16, 2018

• Upgrade to babel 7 (#19)
• Add Polygon class implementing Shoelace algorithm (#18)
• Improve error messages (#17)
• Add back Euler as experimental export
• Size reduction: Shared code moved from Vector* to Vector etc.
• Size reduction: Experimental Euler class no longer exported in index.js
• Size reduction: yarn test-size command
• Size reduction: new esnext main field, with untranspiled code.
• THREE.js Compatibility - doc and mew methods (experimental)
• THREE.js Compability - add test suites, run "unmodified" on math.gl classes

v1.0