xref: /external/chromium-trace/trace-viewer/third_party/gl-matrix/spec/gl-matrix/mat4-spec.js

/* Copyright (c) 2013, Brandon Jones, Colin MacKenzie IV. All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

  * Redistributions of source code must retain the above copyright notice, this
    list of conditions and the following disclaimer.
  * Redistributions in binary form must reproduce the above copyright notice,
    this list of conditions and the following disclaimer in the documentation
    and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */

describe("mat4", function() {
    var out, matA, matB, identity, result;

    beforeEach(function() {
        // Attempting to portray a semi-realistic transform matrix
        matA = [1, 0, 0, 0,
                0, 1, 0, 0,
                0, 0, 1, 0,
                1, 2, 3, 1];

        matB = [1, 0, 0, 0,
                0, 1, 0, 0,
                0, 0, 1, 0,
                4, 5, 6, 1];

        out =  [0, 0, 0, 0,
                0, 0, 0, 0,
                0, 0, 0, 0,
                0, 0, 0, 0];

        identity = [1, 0, 0, 0,
                    0, 1, 0, 0,
                    0, 0, 1, 0,
                    0, 0, 0, 1];
    });

    describe("create", function() {
        beforeEach(function() { result = mat4.create(); });
        it("should return a 16 element array initialized to a 4x4 identity matrix", function() { expect(result).toBeEqualish(identity); });
    });

    describe("clone", function() {
        beforeEach(function() { result = mat4.clone(matA); });
        it("should return a 16 element array initialized to the values in matA", function() { expect(result).toBeEqualish(matA); });
    });

    describe("copy", function() {
        beforeEach(function() { result = mat4.copy(out, matA); });
        it("should place values into out", function() { expect(out).toBeEqualish(matA); });
        it("should return out", function() { expect(result).toBe(out); });
    });

    describe("identity", function() {
        beforeEach(function() { result = mat4.identity(out); });
        it("should place values into out", function() { expect(result).toBeEqualish(identity); });
        it("should return out", function() { expect(result).toBe(out); });
    });

    describe("transpose", function() {
        describe("with a separate output matrix", function() {
            beforeEach(function() { result = mat4.transpose(out, matA); });

            it("should place values into out", function() {
                expect(out).toBeEqualish([
                    1, 0, 0, 1,
                    0, 1, 0, 2,
                    0, 0, 1, 3,
                    0, 0, 0, 1
                ]);
            });
            it("should return out", function() { expect(result).toBe(out); });
            it("should not modify matA", function() {
                expect(matA).toBeEqualish([
                    1, 0, 0, 0,
                    0, 1, 0, 0,
                    0, 0, 1, 0,
                    1, 2, 3, 1
                ]);
            });
        });

        describe("when matA is the output matrix", function() {
            beforeEach(function() { result = mat4.transpose(matA, matA); });

            it("should place values into matA", function() {
                expect(matA).toBeEqualish([
                    1, 0, 0, 1,
                    0, 1, 0, 2,
                    0, 0, 1, 3,
                    0, 0, 0, 1
                ]);
            });
            it("should return matA", function() { expect(result).toBe(matA); });
        });
    });

    describe("invert", function() {
        describe("with a separate output matrix", function() {
            beforeEach(function() { result = mat4.invert(out, matA); });

            it("should place values into out", function() {
                expect(out).toBeEqualish([
                    1, 0, 0, 0,
                    0, 1, 0, 0,
                    0, 0, 1, 0,
                    -1, -2, -3, 1
                ]);
            });
            it("should return out", function() { expect(result).toBe(out); });
            it("should not modify matA", function() {
                expect(matA).toBeEqualish([
                    1, 0, 0, 0,
                    0, 1, 0, 0,
                    0, 0, 1, 0,
                    1, 2, 3, 1
                ]);
            });
        });

        describe("when matA is the output matrix", function() {
            beforeEach(function() { result = mat4.invert(matA, matA); });

            it("should place values into matA", function() {
                expect(matA).toBeEqualish([
                    1, 0, 0, 0,
                    0, 1, 0, 0,
                    0, 0, 1, 0,
                    -1, -2, -3, 1
                ]);
            });
            it("should return matA", function() { expect(result).toBe(matA); });
        });
    });

    describe("adjoint", function() {
        describe("with a separate output matrix", function() {
            beforeEach(function() { result = mat4.adjoint(out, matA); });

            it("should place values into out", function() {
                expect(out).toBeEqualish([
                    1, 0, 0, 0,
                    0, 1, 0, 0,
                    0, 0, 1, 0,
                    -1, -2, -3, 1
                ]);
            });
            it("should return out", function() { expect(result).toBe(out); });
            it("should not modify matA", function() {
                expect(matA).toBeEqualish([
                    1, 0, 0, 0,
                    0, 1, 0, 0,
                    0, 0, 1, 0,
                    1, 2, 3, 1
                ]);
            });
        });

        describe("when matA is the output matrix", function() {
            beforeEach(function() { result = mat4.adjoint(matA, matA); });

            it("should place values into matA", function() {
                expect(matA).toBeEqualish([
                    1, 0, 0, 0,
                    0, 1, 0, 0,
                    0, 0, 1, 0,
                    -1, -2, -3, 1
                ]);
            });
            it("should return matA", function() { expect(result).toBe(matA); });
        });
    });

    describe("determinant", function() {
        beforeEach(function() { result = mat4.determinant(matA); });

        it("should return the determinant", function() { expect(result).toEqual(1); });
    });

    describe("multiply", function() {
        it("should have an alias called 'mul'", function() { expect(mat4.mul).toEqual(mat4.multiply); });

        describe("with a separate output matrix", function() {
            beforeEach(function() { result = mat4.multiply(out, matA, matB); });

            it("should place values into out", function() {
                expect(out).toBeEqualish([
                    1, 0, 0, 0,
                    0, 1, 0, 0,
                    0, 0, 1, 0,
                    5, 7, 9, 1
                ]);
            });
            it("should return out", function() { expect(result).toBe(out); });
            it("should not modify matA", function() {
                expect(matA).toBeEqualish([
                    1, 0, 0, 0,
                    0, 1, 0, 0,
                    0, 0, 1, 0,
                    1, 2, 3, 1
                ]);
            });
            it("should not modify matB", function() {
                expect(matB).toBeEqualish([
                    1, 0, 0, 0,
                    0, 1, 0, 0,
                    0, 0, 1, 0,
                    4, 5, 6, 1
                ]);
            });
        });

        describe("when matA is the output matrix", function() {
            beforeEach(function() { result = mat4.multiply(matA, matA, matB); });

            it("should place values into matA", function() {
                expect(matA).toBeEqualish([
                    1, 0, 0, 0,
                    0, 1, 0, 0,
                    0, 0, 1, 0,
                    5, 7, 9, 1
                ]);
            });
            it("should return matA", function() { expect(result).toBe(matA); });
            it("should not modify matB", function() {
                expect(matB).toBeEqualish([
                    1, 0, 0, 0,
                    0, 1, 0, 0,
                    0, 0, 1, 0,
                    4, 5, 6, 1
                ]);
            });
        });

        describe("when matB is the output matrix", function() {
            beforeEach(function() { result = mat4.multiply(matB, matA, matB); });

            it("should place values into matB", function() {
                expect(matB).toBeEqualish([
                    1, 0, 0, 0,
                    0, 1, 0, 0,
                    0, 0, 1, 0,
                    5, 7, 9, 1
                ]);
            });
            it("should return matB", function() { expect(result).toBe(matB); });
            it("should not modify matA", function() {
                expect(matA).toBeEqualish([
                    1, 0, 0, 0,
                    0, 1, 0, 0,
                    0, 0, 1, 0,
                    1, 2, 3, 1
                ]);
            });
        });
    });

    describe("translate", function() {
        describe("with a separate output matrix", function() {
            beforeEach(function() { result = mat4.translate(out, matA, [4, 5, 6]); });

            it("should place values into out", function() {
                expect(out).toBeEqualish([
                    1, 0, 0, 0,
                    0, 1, 0, 0,
                    0, 0, 1, 0,
                    5, 7, 9, 1
                ]);
            });
            it("should return out", function() { expect(result).toBe(out); });
            it("should not modify matA", function() {
                expect(matA).toBeEqualish([
                    1, 0, 0, 0,
                    0, 1, 0, 0,
                    0, 0, 1, 0,
                    1, 2, 3, 1
                ]);
            });
        });

        describe("when matA is the output matrix", function() {
            beforeEach(function() { result = mat4.translate(matA, matA, [4, 5, 6]); });

            it("should place values into matA", function() {
                expect(matA).toBeEqualish([
                    1, 0, 0, 0,
                    0, 1, 0, 0,
                    0, 0, 1, 0,
                    5, 7, 9, 1
                ]);
            });
            it("should return matA", function() { expect(result).toBe(matA); });
        });
    });

    describe("scale", function() {
        describe("with a separate output matrix", function() {
            beforeEach(function() { result = mat4.scale(out, matA, [4, 5, 6]); });

            it("should place values into out", function() {
                expect(out).toBeEqualish([
                    4, 0, 0, 0,
                    0, 5, 0, 0,
                    0, 0, 6, 0,
                    1, 2, 3, 1
                ]);
            });
            it("should return out", function() { expect(result).toBe(out); });
            it("should not modify matA", function() {
                expect(matA).toBeEqualish([
                    1, 0, 0, 0,
                    0, 1, 0, 0,
                    0, 0, 1, 0,
                    1, 2, 3, 1
                ]);
            });
        });

        describe("when matA is the output matrix", function() {
            beforeEach(function() { result = mat4.scale(matA, matA, [4, 5, 6]); });

            it("should place values into matA", function() {
                expect(matA).toBeEqualish([
                    4, 0, 0, 0,
                    0, 5, 0, 0,
                    0, 0, 6, 0,
                    1, 2, 3, 1
                ]);
            });
            it("should return matA", function() { expect(result).toBe(matA); });
        });
    });

    describe("rotate", function() {
        var rad = Math.PI * 0.5;
        var axis = [1, 0, 0];

        describe("with a separate output matrix", function() {
            beforeEach(function() { result = mat4.rotate(out, matA, rad, axis); });

            it("should place values into out", function() {
                expect(out).toBeEqualish([
                    1, 0, 0, 0,
                    0, Math.cos(rad), Math.sin(rad), 0,
                    0, -Math.sin(rad), Math.cos(rad), 0,
                    1, 2, 3, 1
                ]);
            });
            it("should return out", function() { expect(result).toBe(out); });
            it("should not modify matA", function() {
                expect(matA).toBeEqualish([
                    1, 0, 0, 0,
                    0, 1, 0, 0,
                    0, 0, 1, 0,
                    1, 2, 3, 1
                ]);
            });
        });

        describe("when matA is the output matrix", function() {
            beforeEach(function() { result = mat4.rotate(matA, matA, rad, axis); });

            it("should place values into matA", function() {
                expect(matA).toBeEqualish([
                    1, 0, 0, 0,
                    0, Math.cos(rad), Math.sin(rad), 0,
                    0, -Math.sin(rad), Math.cos(rad), 0,
                    1, 2, 3, 1
                ]);
            });
            it("should return matA", function() { expect(result).toBe(matA); });
        });
    });

    describe("rotateX", function() {
        var rad = Math.PI * 0.5;

        describe("with a separate output matrix", function() {
            beforeEach(function() { result = mat4.rotateX(out, matA, rad); });

            it("should place values into out", function() {
                expect(out).toBeEqualish([
                    1, 0, 0, 0,
                    0, Math.cos(rad), Math.sin(rad), 0,
                    0, -Math.sin(rad), Math.cos(rad), 0,
                    1, 2, 3, 1
                ]);
            });
            it("should return out", function() { expect(result).toBe(out); });
            it("should not modify matA", function() {
                expect(matA).toBeEqualish([
                    1, 0, 0, 0,
                    0, 1, 0, 0,
                    0, 0, 1, 0,
                    1, 2, 3, 1
                ]);
            });
        });

        describe("when matA is the output matrix", function() {
            beforeEach(function() { result = mat4.rotateX(matA, matA, rad); });

            it("should place values into matA", function() {
                expect(matA).toBeEqualish([
                    1, 0, 0, 0,
                    0, Math.cos(rad), Math.sin(rad), 0,
                    0, -Math.sin(rad), Math.cos(rad), 0,
                    1, 2, 3, 1
                ]);
            });
            it("should return matA", function() { expect(result).toBe(matA); });
        });
    });

    describe("rotateY", function() {
        var rad = Math.PI * 0.5;

        describe("with a separate output matrix", function() {
            beforeEach(function() { result = mat4.rotateY(out, matA, rad); });

            it("should place values into out", function() {
                expect(out).toBeEqualish([
                    Math.cos(rad), 0, -Math.sin(rad), 0,
                    0, 1, 0, 0,
                    Math.sin(rad), 0, Math.cos(rad), 0,
                    1, 2, 3, 1
                ]);
            });
            it("should return out", function() { expect(result).toBe(out); });
            it("should not modify matA", function() {
                expect(matA).toBeEqualish([
                    1, 0, 0, 0,
                    0, 1, 0, 0,
                    0, 0, 1, 0,
                    1, 2, 3, 1
                ]);
            });
        });

        describe("when matA is the output matrix", function() {
            beforeEach(function() { result = mat4.rotateY(matA, matA, rad); });

            it("should place values into matA", function() {
                expect(matA).toBeEqualish([
                    Math.cos(rad), 0, -Math.sin(rad), 0,
                    0, 1, 0, 0,
                    Math.sin(rad), 0, Math.cos(rad), 0,
                    1, 2, 3, 1
                ]);
            });
            it("should return matA", function() { expect(result).toBe(matA); });
        });
    });

    describe("rotateZ", function() {
        var rad = Math.PI * 0.5;

        describe("with a separate output matrix", function() {
            beforeEach(function() { result = mat4.rotateZ(out, matA, rad); });

            it("should place values into out", function() {
                expect(out).toBeEqualish([
                    Math.cos(rad), Math.sin(rad), 0, 0,
                    -Math.sin(rad), Math.cos(rad), 0, 0,
                    0, 0, 1, 0,
                    1, 2, 3, 1
                ]);
            });
            it("should return out", function() { expect(result).toBe(out); });
            it("should not modify matA", function() {
                expect(matA).toBeEqualish([
                    1, 0, 0, 0,
                    0, 1, 0, 0,
                    0, 0, 1, 0,
                    1, 2, 3, 1
                ]);
            });
        });

        describe("when matA is the output matrix", function() {
            beforeEach(function() { result = mat4.rotateZ(matA, matA, rad); });

            it("should place values into matA", function() {
                expect(matA).toBeEqualish([
                    Math.cos(rad), Math.sin(rad), 0, 0,
                    -Math.sin(rad), Math.cos(rad), 0, 0,
                    0, 0, 1, 0,
                    1, 2, 3, 1
                ]);
            });
            it("should return matA", function() { expect(result).toBe(matA); });
        });
    });

    // TODO: fromRotationTranslation

    describe("frustum", function() {
        beforeEach(function() { result = mat4.frustum(out, -1, 1, -1, 1, -1, 1); });
        it("should place values into out", function() { expect(result).toBeEqualish([
                -1, 0, 0, 0,
                0, -1, 0, 0,
                0, 0, 0, -1,
                0, 0, 1, 0
            ]);
        });
        it("should return out", function() { expect(result).toBe(out); });
    });

    describe("perspective", function() {
        var fovy = Math.PI * 0.5;
        beforeEach(function() { result = mat4.perspective(out, fovy, 1, 0, 1); });
        it("should place values into out", function() { expect(result).toBeEqualish([
                1, 0, 0, 0,
                0, 1, 0, 0,
                0, 0, -1, -1,
                0, 0, 0, 0
            ]);
        });
        it("should return out", function() { expect(result).toBe(out); });
    });

    describe("ortho", function() {
        beforeEach(function() { result = mat4.ortho(out, -1, 1, -1, 1, -1, 1); });
        it("should place values into out", function() { expect(result).toBeEqualish([
                1, 0, 0, 0,
                0, 1, 0, 0,
                0, 0, -1, 0,
                0, 0, 0, 1
            ]);
        });
        it("should return out", function() { expect(result).toBe(out); });
    });

    describe("lookAt", function() {
        var eye = [0, 0, 1];
        var center = [0, 0, -1];
        var up = [0, 1, 0];

        beforeEach(function() { result = mat4.lookAt(out, eye, center, up); });
        it("should place values into out", function() { expect(result).toBeEqualish([
                1, 0, 0, 0,
                0, 1, 0, 0,
                0, 0, 1, 0,
                0, 0, -1, 1
            ]);
        });
        it("should return out", function() { expect(result).toBe(out); });
    });

    describe("str", function() {
        beforeEach(function() { result = mat4.str(matA); });

        it("should return a string representation of the matrix", function() { expect(result).toEqual("mat4(1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 1, 2, 3, 1)"); });
    });
});