blob: 257f33f1386cd25bbcc2949a06042c650f734e9b [file] [log] [blame]
Tony-LunarGb0b195d2015-05-13 15:01:06 -06001///////////////////////////////////////////////////////////////////////////////////
2/// OpenGL Mathematics (glm.g-truc.net)
3///
4/// Copyright (c) 2005 - 2014 G-Truc Creation (www.g-truc.net)
5/// Permission is hereby granted, free of charge, to any person obtaining a copy
6/// of this software and associated documentation files (the "Software"), to deal
7/// in the Software without restriction, including without limitation the rights
8/// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9/// copies of the Software, and to permit persons to whom the Software is
10/// furnished to do so, subject to the following conditions:
11///
12/// The above copyright notice and this permission notice shall be included in
13/// all copies or substantial portions of the Software.
14///
15/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20/// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21/// THE SOFTWARE.
22///
23/// @ref gtx_matrix_query
24/// @file glm/gtx/matrix_query.hpp
25/// @date 2007-03-05 / 2011-08-28
26/// @author Christophe Riccio
27///
28/// @see core (dependence)
29/// @see gtx_vector_query (dependence)
30///
31/// @defgroup gtx_matrix_query GLM_GTX_matrix_query
32/// @ingroup gtx
33///
34/// @brief Query to evaluate matrix properties
35///
36/// <glm/gtx/matrix_query.hpp> need to be included to use these functionalities.
37///////////////////////////////////////////////////////////////////////////////////
38
39#ifndef GLM_GTX_matrix_query
40#define GLM_GTX_matrix_query
41
42// Dependency:
43#include "../glm.hpp"
44#include "../gtx/vector_query.hpp"
45#include <limits>
46
47#if(defined(GLM_MESSAGES) && !defined(GLM_EXT_INCLUDED))
48# pragma message("GLM: GLM_GTX_matrix_query extension included")
49#endif
50
51namespace glm
52{
53 /// @addtogroup gtx_matrix_query
54 /// @{
55
56 /// Return whether a matrix a null matrix.
57 /// From GLM_GTX_matrix_query extension.
58 template<typename T, precision P>
59 GLM_FUNC_DECL bool isNull(detail::tmat2x2<T, P> const & m, T const & epsilon);
60
61 /// Return whether a matrix a null matrix.
62 /// From GLM_GTX_matrix_query extension.
63 template<typename T, precision P>
64 GLM_FUNC_DECL bool isNull(detail::tmat3x3<T, P> const & m, T const & epsilon);
65
66 /// Return whether a matrix is a null matrix.
67 /// From GLM_GTX_matrix_query extension.
68 template<typename T, precision P>
69 GLM_FUNC_DECL bool isNull(detail::tmat4x4<T, P> const & m, T const & epsilon);
70
71 /// Return whether a matrix is an identity matrix.
72 /// From GLM_GTX_matrix_query extension.
73 template<typename T, precision P, template <typename, precision> class matType>
74 GLM_FUNC_DECL bool isIdentity(matType<T, P> const & m, T const & epsilon);
75
76 /// Return whether a matrix is a normalized matrix.
77 /// From GLM_GTX_matrix_query extension.
78 template<typename T, precision P>
79 GLM_FUNC_DECL bool isNormalized(detail::tmat2x2<T, P> const & m, T const & epsilon);
80
81 /// Return whether a matrix is a normalized matrix.
82 /// From GLM_GTX_matrix_query extension.
83 template<typename T, precision P>
84 GLM_FUNC_DECL bool isNormalized(detail::tmat3x3<T, P> const & m, T const & epsilon);
85
86 /// Return whether a matrix is a normalized matrix.
87 /// From GLM_GTX_matrix_query extension.
88 template<typename T, precision P>
89 GLM_FUNC_DECL bool isNormalized(detail::tmat4x4<T, P> const & m, T const & epsilon);
90
91 /// Return whether a matrix is an orthonormalized matrix.
92 /// From GLM_GTX_matrix_query extension.
93 template<typename T, precision P, template <typename, precision> class matType>
94 GLM_FUNC_DECL bool isOrthogonal(matType<T, P> const & m, T const & epsilon);
95
96 /// @}
97}//namespace glm
98
99#include "matrix_query.inl"
100
101#endif//GLM_GTX_matrix_query