babel-plugin-transfrom-gl-matrix

中文文档

A babel plugin for gl-matrix.

GlMatrix is a high-performance JavaScript matrix library, but its API is not easy to use.

For example, to define a three-dimensional vector, the native API looks like this:

const v = vec3.fromValues(1, 0, 0);

With this plug-in, you can write as follows:

const v = vec3(1, 0, 0);

To add the two vectors together, the native API looks like this:

const v1 = vec3.fromValues(1, 0, 0);
const v2 = vec3.fromValues(0, 1, 0);
const v = vec3.add(vec3.create(), v1, v2);

With this plug-in, you can write as follows:

const v1 = vec3(1, 0, 0);
const v2 = vec3(0, 1, 0);
const v = v1 + v2;

Similarly, calculate the multiplication of two vectors:

const v = vec3.multiply(vec3.create(), v1, v2); // original

const v = v1 * v2; // with plugin

Multiplication of scalars and vectors:

const v = vec3.scale(vec3.create(), v1, n); // original

const v = v1 * n; // with plugin

Matrix transformation of vectors:

const v1 = vec3.fromValues(1, 2, 3);
const m1 = mat3.fromValues(2, 0, 0, 0, 2, 0, 0, 0, 2);

const v = vec3.transformMat3(vec3.create(), v1, m1); // original

const v1 = vec3(1, 2, 3);
const m1 = mat3(2, 0, 0, 0, 2, 0, 0, 0, 2);

const v = m1 * v1; // with plugin

Comparative (version > 0.4)

const v1 = vec3.fromValues(1, 2, 3);
const v2 = vec3.fromValues(1, 2, 3);
const v3 = vec3.fromValues(1, 1, 1);

// original
console.log(vec3.equals(v1, v2), vec3.equals(v1, v3)); // true false

const v1 = vec3(1, 2, 3);
const v2 = vec3(1, 2, 3);
const v3 = vec3(1, 1, 1);

console.log(v1 == v2, v1 != v3); // true, true

Vector Components (version > 1.0)

Supports xyzw, rgba, stpq, the same as glsl.

const v1 = vec3.fromValues(1, 2, 3);
const v2 = vec2.fromValues(v1[0], v1[1]);

const v1 = vec3(1, 2, 3);
const v2 = v1.xy; // with plugin

Note: For all methods whose first parameter is out, when using this plug-in, you should ignore the out and directly get the return value.

Usage

.babelrc

{
  "presets": [
    ["@babel/preset-env",
    {
      "targets": {
        "node": "current"
      }
    }]
  ],
  "plugins": [
    "./src/index.js"
  ]
}