MatrixDefinitions.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
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.
 
Library: Base
File: MatrixDefinitions
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "Matrix.hpp"
#include "Vertex.hpp"
#ifdef _WIN32
#undef far//MS name polution
#undef near
#endif
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief Provides common definitions for creating 4x4 matrices of certain types.
    **/
    template<class t_type>
    struct MatrixDefinitions
    {
        static constexpr Matrix<t_type> FrustumTransform(
            t_type left
            , t_type right
            , t_type bottom
            , t_type top
            , t_type near
            , t_type far)
        {
            return Matrix<t_type>(
                2 * near / (right - left), cast<t_type>(0), cast<t_type>(0), cast<t_type>(0)
                , cast<t_type>(0), 2 * near / (top - bottom), cast<t_type>(0), cast<t_type>(0)
                , (right + left) / (right - left), (top + bottom) / (top - bottom), -(far + near) / (far - near), cast<t_type>(-1)
                , cast<t_type>(0), cast<t_type>(0), -(2 * far * near) / (far - near), cast<t_type>(0));
        }
        static constexpr Matrix<t_type> FrustumTransform( {…}
        static constexpr Matrix<t_type> createOrtho(t_type left, t_type right, t_type bottom, t_type top, t_type near_plane, t_type far_plane)
        {
            return Matrix<t_type>(
                2 / (right - left), cast<t_type>(0), cast<t_type>(0), cast<t_type>(0)
                , cast<t_type>(0), 2 / (top - bottom), cast<t_type>(0), cast<t_type>(0)
                , cast<t_type>(0), cast<t_type>(0), cast<t_type>(0), cast<t_type>(1) / (far_plane - near_plane)
                , cast<t_type>(0), cast<t_type>(0), cast<t_type>(0), cast<t_type>(1));
        }
        static constexpr Matrix<t_type> createOrtho(t_type left, t_type right, t_type bottom, t_type top, t_type near_plane, t_type far_plane) {…}
        template<class t_angle_type>
        static constexpr Matrix<t_type> FrustumTransform(Angle< t_angle_type> y_field_of_view, t_type aspect_ratio, t_type near, t_type far)
        {
            t_type height = near * tan(y_field_of_view / 2);
            t_type width = height * aspect_ratio;
            return FrustumTransform(-width, width, -height, height, near, far);
        }
        static constexpr Matrix<t_type> FrustumTransform(Angle< t_angle_type> y_field_of_view, t_type aspect_ratio, t_type near, t_type far) {…}
 
        static constexpr Matrix<t_type> OrthoFrustum(const Vector<2, t_type>& span, t_type n, t_type f)
        {
            Matrix<t_type> mat;
            mat[0][0] = cast<t_type>(2) / span[X];
            mat[1][1] = cast<t_type>(2) / span[Y];
            mat[2][2] = -cast<t_type>(2) / (f - n);
 
            mat[3][0] = 0;
            mat[3][1] = 0;
            mat[3][2] = -(f + n) / (f - n);
            mat[3][3] = cast<t_type>(1);
 
            Matrix<t_type> to_vulkan;
            to_vulkan[0][0] = 1.0f;
            to_vulkan[1][1] = -1.0f;
            to_vulkan[2][2] = 0.5f;
            to_vulkan[3][2] = 0.5f;
            to_vulkan[3][3] = 1.0f;
            return to_vulkan * mat;
        }
        static constexpr Matrix<t_type> OrthoFrustum(const Vector<2, t_type>& span, t_type n, t_type f) {…}
        static constexpr Matrix<t_type> ViewMatrix(const Vector<3, t_type>& location, const Vector<3, t_type>& lookat, const Vector<3, t_type>& up)
        {
            const Vector<3, t_type> f = lookat.template normalized<t_type>();
            Vector<3, t_type> s = cross(f, up).template normalized<t_type>();
            if (IsInvalid(s))
                s = Vector<3, t_type>(0, 1, 0);
            Vector<3, t_type> u = cross(s, f).template normalized<t_type>();
            if (IsInvalid(u))
                u = Vector<3, t_type>(-1, 0, 0);
            return Matrix<t_type>(
                s[X], u[X], -f[X], cast<t_type>(0)
                , s[Y], u[Y], -f[Y], cast<t_type>(0)
                , s[Z], u[Z], -f[Z], cast<t_type>(0)
                , dot(-s, location), dot(-u, location), dot(f, location), cast<t_type>(1));
        };
        static constexpr Matrix<t_type> ViewMatrix(const Vector<3, t_type>& location, const Vector<3, t_type>& lookat, const Vector<3, t_type>& up) {…}
        static constexpr Matrix<t_type> RotationMatrix(const Vector<3, t_type>& lookat, const Vector<3, t_type>& up)
        {
            const Vector<3, t_type> f = lookat.template normalized<t_type>();
            Vector<3, t_type> s = cross(f, up).template normalized<t_type>();
            if (IsInvalid(s))
                s = Vector<3, t_type>(0, 1, 0);
            Vector<3, t_type> u = cross(s, f).template normalized<t_type>();
            if (IsInvalid(u))
                u = Vector<3, t_type>(-1, 0, 0);
            return Matrix<t_type>(
                s[X], u[X], -f[X], cast<t_type>(0)
                , s[Y], u[Y], -f[Y], cast<t_type>(0)
                , s[Z], u[Z], -f[Z], cast<t_type>(0)
                , 0, 0, 0, cast<t_type>(1));
        };
        static constexpr Matrix<t_type> RotationMatrix(const Vector<3, t_type>& lookat, const Vector<3, t_type>& up) {…}
 
        constexpr static Matrix<t_type> Perspective(t_type fovy, t_type aspect, t_type near_plane, t_type far_plane)
        {
            return Matrix<t_type>(
                fovy / aspect, 0, 0, 0
                , 0, fovy, 0, 0
                , 0, 0, (far_plane + near_plane) / (near_plane - far_plane), (2 * near_plane * far_plane) / (near_plane - far_plane)
                , 0, 0, -1, 0);
        }
        constexpr static Matrix<t_type> Perspective(t_type fovy, t_type aspect, t_type near_plane, t_type far_plane) {…}
    };
    struct MatrixDefinitions {…};
    
}