vmmlib  1.10.0
Templatized C++ vector and matrix math library
 All Pages
README.md
1 [TOC]
2 
3 # Introduction {#Introduction}
4 
5 A templatized C++ vector and matrix math library.
6 
7 VMMLib includes a vector and a matrix class, with additional
8 functionality for the often-used 3d and 4d vectors and 3x3 and 4x4
9 matrices. More advanced features include solvers, frustum computations
10 and frustum culling classes and spatial data structures.
11 
12 VMMLib is implemented using C++ templates, making it versatile. Being a
13 header-only library, it is very easy to integrate into your libraries
14 and programs. There is no need to build and install a library, just
15 include the headers and you are set. The BSD license allows the usage
16 both in open source and commercial closed source software.
17 
18 # Features {#Features}
19 
20 VMMLib provides the following major classes:
21 * Basic matrix math: vmml::vector, vmml::quaternion, vmml::matrix
22 * OpenGL math: vmml::Frustum, vmml::FrustumCuller, vmml::AABB
23 * Detailed @ref Changelog
24 
25 # Bugs {#Bugs}
26 
27 Please file a [Bug Report](https://github.com/Eyescale/vmmlib/issues) if
28 you find any issue with this software.
29 
30 # Building {#Building}
31 
32 VMMLib is a cross-platform library, designed to run on any modern operating
33 system, including all Unix variants and the Windows operating system. VMMLib
34 uses CMake to create a platform-specific build environment. The following
35 platforms and build environments are tested:
36 
37 * Linux: Ubuntu 14.04, RHEL 6.6 (Makefile, Ninja)
38 * Windows: 7 (Visual Studio 2012)
39 * Mac OS X: 10.8 (Makefile, Ninja)
40 
41 Building from source is as simple as:
42 
43  git clone https://github.com/Eyescale/vmmlib.git
44  mkdir vmmlib/build
45  cd vmmlib/build
46  cmake ..
47  make