phnod/gmtk

The Graphics/Math Toolkit

Graphics/Math Toolkit (GMTK)

Also known as GMath

GMTK is a C++ library that provides efficient and flexible math utility for the purpose of graphics programming, game programming, and fields with similar requirements. The toolkit boasts matrix and vector classes which are templated by value type and by dimension. The entire library is defined in header files, and math code is implemented generically in a manner which allows for efficient runtime calculations. The entire library is free-to-use under the terms of the MIT License.

Features

• Angles
• Half-Precision Floating Point Numbers
• Matrices (Column-Major)
  • Dimension-Templated
  • Type-Templated
  • Perspective/Orthographic Projections
  • 2D, 3D, 3D Homogeneous Transformations
  • Linear Algebra Operations
  • Matrix Product
  • Matrix-Vector Product
  • All GLSL Matrix Operations
  • Catmull-Rom and Bezier Matrices
  • Row-Major Conversion
  • Eigenvector and Eigenvalue
• Vectors
  • Dimension-Templated
  • Type-Templated
  • Dot and Cross Product
  • All GLSL Vector Operations
  • Vector Swizzling
• Generic Quaternions
  • Type-Templated
  • Quaternion SLERP
  • Axis-Angle Representation
  • 3D Vector Transformation
  • Matrix Conversion
• Generic Scene Graph
• Simple General OpenGL Classes
• Tensors

License

GMTK uses the following version of the MIT License:

Copyright (c) 2015-2019 Dan Yeomans

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Code Sample

#include <iostream>

// change the namespace to suit your project (default is gmtk)
#define GMTK_NAMESPACE gm

// one header gets the entire library, no hassle!
#include "gmtk.h"

int main()
{
	// define a 3d float vector
	// synonymous with gm::vec3, gm::vec3f, and gm::vec<3>
	gm::vec<3, float> vecA;

	// initialize a 3d float matrix
	// synonymous with gm::mat3 and gm::mat3f, and gm::mat<3>
	gm::mat<3, 3, float> matA(1, 0, 1,
				2, 4, 0,
				3, 5, 6);

	// initialize a 3d float matrix as the inverse of matA
	gm::mat3 matB = gm::inverse(matA);

	// initialize a homogeneous transformation matrix (rotation and position)
	gm::mat4 matH(gm::mat3::rotatex(1.5_rad), gm::vec3(1, 2, 3));

	// fast invert the homogeneous transformation matrix
	gm::mat4 imatH = gm::fastinverse(matH);

	// retrieve the first column of matB as a 3d vector and store it in vecA
	vecA = matB[0];

	// initialize sclA the first column, last row of matA
	float sclA = matA[0][2];

	// define a perspective transformation matrix (openGL)
	gm::mat4::perspective(
		90_deg, // y-axis field of view, in degrees (gm::ang)
		16 / (float)9, // aspect ratio
		0.01, // near clipping range for z-axis
		10000 // far clipping range for z-axis
	);

	// output our results
	std::cout << matA * matB << std::endl << std::endl
		<< matH * imatH << std::endl << std::endl
		<< 45_deg << std::endl;

	// constructs a column-major 3d float matrix from rows, using 3d float vectors
	gm::mat3::fromrows(
		gm::vec3(0, 1, 2),
		gm::vec3(3, 4, 5),
		gm::vec3(4, 5, 6)
	);

	// pi constant, change to d_pi for double precision
	// all commonly used constants supported
	gm::f_pi;
}