/LinearAlgebra

Linear algebra library that supports vectors, matrices and quaternions

Primary LanguageC++

LinearAlgebra Build Status Release License

LinearAlgebra is a linear algebra library, which consists of:

  • Vectors

    • Vector 2D (vec2)
    • Vector 3D (vec3)
    • Vector 4D (vec4)

  • Matrices

    • Matrix 2D (mat2, mat2x2)
    • Matrix 3D (mat3, mat3x3)
    • Matrix 4D (mat4, mat4x4)

  • Quaternion (quat)

  • Dual Quaternion (dualquat)

Since LinearAlgebra was built for use with computer graphics, it contains a few helper classes for especially that:

  • Transform
  • Project (Functionality stored in mat4)
  • MatrixStack

Various methods are implemented such that they can be called by your liking:

vec3 a(1.0f, 2.0f, 3.0f);
vec3 b(4.0f, 5.0f, 6.0f);

float dotProduct = a.dot(b);
// vs
float dotProduct = dot(a, b);
mat4 model = mat4::identity;
// ...

mat3 normalMatrix = model.inverse().transpose();
// vs
mat3 normalMatrix = transpose(inverse(model));

If GCC is used then compiling LinearAlgebra must include -Wno-unknown-pragmas, as various #pragma region's are scattered in LinearAlgebra's implementation.

LinearAlgebra was first created in 2013 for use with OpenGL in Java. Later it was rewritten for C++ and Python, where the C++ version now is the main version.

Mouse to Ray

vec2 mousePos = ...;

ivec4 viewport = ivec4(0, 0, viewportWidth, viewportHeight);

mat4 view = ...;
mat4 projection = ...;

vec3 rayStart = mat4::unproject(vec3(mousePos, 0.0f), view, projection, viewport);
vec3 rayEnd   = mat4::unproject(vec3(mousePos, 1.0f), view, projection, viewport);
vec3 rayDirection = normalize(rayEnd - rayStart);

std::cout & std::cin

To add friend functions for stream purposes, simply make sure to have the iostream header included prior to including linalg.

#include <iostream>
#include "linalg.hpp"

This now allows printing and reading vec, mat and quat.

std::cout << vec4(1.0f, 2.0f, 3.0f, 4.0f) << std::endl;

// Prints:
// vec4(1.0, 2.0, 3.0, 4.0)

std::cout << mat3(
	1.0f, 2.0f, 3.0f,
	4.0f, 5.0f, 6.0f,
	7.0f, 8.0f, 9.0f) << std::endl;

// Prints:
// mat3(1.0, 2.0, 3.0
//      4.0, 5.0, 6.0,
//      7.0, 8.0, 9.0)

License

Copyright (c) 2013-2016 Christian Vallentin <vallentin.source@gmail.com>

This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.

Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:

1. The origin of this software must not be misrepresented; you must not
   claim that you wrote the original software. If you use this software
   in a product, an acknowledgment in the product documentation would be
   appreciated but is not required.

2. Altered source versions must be plainly marked as such, and must not
   be misrepresented as being the original software.

3. This notice may not be removed or altered from any source
   distribution.