Updated doxygen documentation

This commit is contained in:
Christophe Riccio
2011-12-07 14:50:15 +00:00
parent a3b5034d4e
commit f18ad6bf2e
389 changed files with 27429 additions and 14460 deletions

View File

@@ -2,22 +2,36 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>matrix_query.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo-mini.png"></td>
<td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
@@ -34,7 +48,7 @@
</div>
<div class="header">
<div class="headertitle">
<h1>matrix_query.hpp</h1> </div>
<div class="title">matrix_query.hpp</div> </div>
</div>
<div class="contents">
<a href="a00074.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001
@@ -79,65 +93,71 @@
<a name="l00040"></a>00040 <span class="preprocessor"></span><span class="preprocessor">#define GLM_GTX_matrix_query GLM_VERSION</span>
<a name="l00041"></a>00041 <span class="preprocessor"></span>
<a name="l00042"></a>00042 <span class="comment">// Dependency:</span>
<a name="l00043"></a>00043 <span class="preprocessor">#include &quot;<a class="code" href="a00050.html" title="OpenGL Mathematics (glm.g-truc.net)">../glm.hpp</a>&quot;</span>
<a name="l00044"></a>00044 <span class="preprocessor">#include &quot;<a class="code" href="a00135.html" title="OpenGL Mathematics (glm.g-truc.net)">../gtx/vector_query.hpp</a>&quot;</span>
<a name="l00045"></a>00045
<a name="l00046"></a>00046 <span class="preprocessor">#if(defined(GLM_MESSAGES) &amp;&amp; !defined(glm_ext))</span>
<a name="l00047"></a>00047 <span class="preprocessor"></span><span class="preprocessor"># pragma message(&quot;GLM: GLM_GTX_matrix_query extension included&quot;)</span>
<a name="l00048"></a>00048 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00049"></a>00049 <span class="preprocessor"></span>
<a name="l00050"></a>00050 <span class="keyword">namespace </span>glm
<a name="l00051"></a>00051 {
<a name="l00054"></a>00054
<a name="l00057"></a>00057 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;
<a name="l00058"></a>00058 <span class="keywordtype">bool</span> <a class="code" href="a00196.html#gabe1d2a5c6cf3ddaafd384c6d3cc272e1" title="Return if a matrix a null matrix.">isNull</a>(
<a name="l00059"></a>00059 detail::tmat2x2&lt;T&gt; <span class="keyword">const</span> &amp; m,
<a name="l00060"></a>00060 T <span class="keyword">const</span> &amp; epsilon = std::numeric_limits&lt;T&gt;::epsilon());
<a name="l00061"></a>00061
<a name="l00064"></a>00064 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;
<a name="l00065"></a>00065 <span class="keywordtype">bool</span> <a class="code" href="a00196.html#gabe1d2a5c6cf3ddaafd384c6d3cc272e1" title="Return if a matrix a null matrix.">isNull</a>(
<a name="l00066"></a>00066 detail::tmat3x3&lt;T&gt; <span class="keyword">const</span> &amp; m,
<a name="l00067"></a>00067 T <span class="keyword">const</span> &amp; epsilon = std::numeric_limits&lt;T&gt;::epsilon());
<a name="l00068"></a>00068
<a name="l00071"></a>00071 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;
<a name="l00072"></a>00072 <span class="keywordtype">bool</span> <a class="code" href="a00196.html#gabe1d2a5c6cf3ddaafd384c6d3cc272e1" title="Return if a matrix a null matrix.">isNull</a>(
<a name="l00073"></a>00073 detail::tmat4x4&lt;T&gt; <span class="keyword">const</span> &amp; m,
<a name="l00074"></a>00074 T <span class="keyword">const</span> &amp; epsilon = std::numeric_limits&lt;T&gt;::epsilon());
<a name="l00075"></a>00075
<a name="l00078"></a>00078 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> genType&gt;
<a name="l00079"></a>00079 <span class="keywordtype">bool</span> <a class="code" href="a00196.html#ga7eb8ec43f9d23deb8a9b2528c3945ce3" title="Return if a matrix an identity matrix.">isIdentity</a>(
<a name="l00080"></a>00080 genType <span class="keyword">const</span> &amp; m,
<a name="l00081"></a>00081 <span class="keyword">typename</span> genType::value_type <span class="keyword">const</span> &amp; epsilon = std::numeric_limits&lt;typename genType::value_type&gt;::epsilon());
<a name="l00082"></a>00082
<a name="l00085"></a>00085 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;
<a name="l00086"></a>00086 <span class="keywordtype">bool</span> <a class="code" href="a00196.html#ga1df4e739802e95eeb4289baaa7150f7a" title="Return if a matrix a normalized matrix.">isNormalized</a>(
<a name="l00087"></a>00087 detail::tmat2x2&lt;T&gt; <span class="keyword">const</span> &amp; m,
<a name="l00088"></a>00088 T <span class="keyword">const</span> &amp; epsilon = std::numeric_limits&lt;T&gt;::epsilon());
<a name="l00089"></a>00089
<a name="l00092"></a>00092 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;
<a name="l00093"></a>00093 <span class="keywordtype">bool</span> <a class="code" href="a00196.html#ga1df4e739802e95eeb4289baaa7150f7a" title="Return if a matrix a normalized matrix.">isNormalized</a>(
<a name="l00094"></a>00094 detail::tmat3x3&lt;T&gt; <span class="keyword">const</span> &amp; m,
<a name="l00095"></a>00095 T <span class="keyword">const</span> &amp; epsilon = std::numeric_limits&lt;T&gt;::epsilon());
<a name="l00096"></a>00096
<a name="l00099"></a>00099 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;
<a name="l00100"></a>00100 <span class="keywordtype">bool</span> <a class="code" href="a00196.html#ga1df4e739802e95eeb4289baaa7150f7a" title="Return if a matrix a normalized matrix.">isNormalized</a>(
<a name="l00101"></a>00101 detail::tmat4x4&lt;T&gt; <span class="keyword">const</span> &amp; m,
<a name="l00102"></a>00102 T <span class="keyword">const</span> &amp; epsilon = std::numeric_limits&lt;T&gt;::epsilon());
<a name="l00103"></a>00103
<a name="l00106"></a>00106 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> genType&gt;
<a name="l00107"></a>00107 <span class="keywordtype">bool</span> <a class="code" href="a00196.html#ga529ee85f60b16cfdb44f1afdc9fe05c7" title="Return if a matrix an orthonormalized matrix.">isOrthogonal</a>(
<a name="l00108"></a>00108 genType <span class="keyword">const</span> &amp; m,
<a name="l00109"></a>00109 <span class="keyword">typename</span> genType::value_type <span class="keyword">const</span> &amp; epsilon = std::numeric_limits&lt;typename genType::value_type&gt;::epsilon());
<a name="l00110"></a>00110
<a name="l00112"></a>00112 }<span class="comment">//namespace glm</span>
<a name="l00113"></a>00113
<a name="l00114"></a>00114 <span class="preprocessor">#include &quot;matrix_query.inl&quot;</span>
<a name="l00115"></a>00115
<a name="l00116"></a>00116 <span class="preprocessor">#endif//GLM_GTX_matrix_query</span>
<a name="l00043"></a>00043 <span class="preprocessor">#include &quot;../glm.hpp&quot;</span>
<a name="l00044"></a>00044 <span class="preprocessor">#include &quot;../gtx/vector_query.hpp&quot;</span>
<a name="l00045"></a>00045 <span class="preprocessor">#include &lt;limits&gt;</span>
<a name="l00046"></a>00046
<a name="l00047"></a>00047 <span class="preprocessor">#if(defined(GLM_MESSAGES) &amp;&amp; !defined(glm_ext))</span>
<a name="l00048"></a>00048 <span class="preprocessor"></span><span class="preprocessor"># pragma message(&quot;GLM: GLM_GTX_matrix_query extension included&quot;)</span>
<a name="l00049"></a>00049 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00050"></a>00050 <span class="preprocessor"></span>
<a name="l00051"></a>00051 <span class="keyword">namespace </span>glm
<a name="l00052"></a>00052 {
<a name="l00055"></a>00055
<a name="l00058"></a>00058 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;
<a name="l00059"></a>00059 <span class="keywordtype">bool</span> <a class="code" href="a00196.html#ga522ba657c5bf6a022c49b5717f2b600c" title="Return whether a matrix a null matrix.">isNull</a>(
<a name="l00060"></a>00060 detail::tmat2x2&lt;T&gt; <span class="keyword">const</span> &amp; m,
<a name="l00061"></a>00061 T <span class="keyword">const</span> &amp; <a class="code" href="a00177.html#ga73bc2500704c8c25dc3cde534134ca20" title="Return the epsilon constant for floating point types.">epsilon</a><span class="comment">/* = std::numeric_limits&lt;T&gt;::epsilon()*/</span>);
<a name="l00062"></a>00062
<a name="l00065"></a>00065 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;
<a name="l00066"></a>00066 <span class="keywordtype">bool</span> <a class="code" href="a00196.html#ga522ba657c5bf6a022c49b5717f2b600c" title="Return whether a matrix a null matrix.">isNull</a>(
<a name="l00067"></a>00067 detail::tmat3x3&lt;T&gt; <span class="keyword">const</span> &amp; m,
<a name="l00068"></a>00068 T <span class="keyword">const</span> &amp; <a class="code" href="a00177.html#ga73bc2500704c8c25dc3cde534134ca20" title="Return the epsilon constant for floating point types.">epsilon</a><span class="comment">/* = std::numeric_limits&lt;T&gt;::epsilon()*/</span>);
<a name="l00069"></a>00069
<a name="l00072"></a>00072 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;
<a name="l00073"></a>00073 <span class="keywordtype">bool</span> <a class="code" href="a00196.html#ga522ba657c5bf6a022c49b5717f2b600c" title="Return whether a matrix a null matrix.">isNull</a>(
<a name="l00074"></a>00074 detail::tmat4x4&lt;T&gt; <span class="keyword">const</span> &amp; m,
<a name="l00075"></a>00075 T <span class="keyword">const</span> &amp; <a class="code" href="a00177.html#ga73bc2500704c8c25dc3cde534134ca20" title="Return the epsilon constant for floating point types.">epsilon</a><span class="comment">/* = std::numeric_limits&lt;T&gt;::epsilon()*/</span>);
<a name="l00076"></a>00076
<a name="l00079"></a>00079 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> genType&gt;
<a name="l00080"></a>00080 <span class="keywordtype">bool</span> <a class="code" href="a00196.html#ga5a899dff905871886d6f31517bd1fe30" title="Return whether a matrix is an identity matrix.">isIdentity</a>(
<a name="l00081"></a>00081 genType <span class="keyword">const</span> &amp; m,
<a name="l00082"></a>00082 <span class="keyword">typename</span> genType::value_type <span class="keyword">const</span> &amp; <a class="code" href="a00177.html#ga73bc2500704c8c25dc3cde534134ca20" title="Return the epsilon constant for floating point types.">epsilon</a><span class="comment">/* = std::numeric_limits&lt;typename genType::value_type&gt;::epsilon()*/</span>);
<a name="l00083"></a>00083
<a name="l00086"></a>00086 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> valType&gt;
<a name="l00087"></a>00087 <span class="keywordtype">bool</span> <a class="code" href="a00196.html#ga4db0eb631e14d23d597b93b80e324c5d" title="Return whether a matrix is a normalized matrix.">isNormalized</a>(
<a name="l00088"></a>00088 detail::tmat2x2&lt;valType&gt; <span class="keyword">const</span> &amp; m,
<a name="l00089"></a>00089 valType <span class="keyword">const</span> &amp; <a class="code" href="a00177.html#ga73bc2500704c8c25dc3cde534134ca20" title="Return the epsilon constant for floating point types.">epsilon</a><span class="comment">/* = std::numeric_limits&lt;valType&gt;::epsilon()*/</span>);
<a name="l00090"></a>00090
<a name="l00093"></a>00093 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> valType&gt;
<a name="l00094"></a>00094 <span class="keywordtype">bool</span> <a class="code" href="a00196.html#ga4db0eb631e14d23d597b93b80e324c5d" title="Return whether a matrix is a normalized matrix.">isNormalized</a>(
<a name="l00095"></a>00095 detail::tmat3x3&lt;valType&gt; <span class="keyword">const</span> &amp; m,
<a name="l00096"></a>00096 valType <span class="keyword">const</span> &amp; <a class="code" href="a00177.html#ga73bc2500704c8c25dc3cde534134ca20" title="Return the epsilon constant for floating point types.">epsilon</a><span class="comment">/* = std::numeric_limits&lt;valType&gt;::epsilon()*/</span>);
<a name="l00097"></a>00097
<a name="l00100"></a>00100 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> valType&gt;
<a name="l00101"></a>00101 <span class="keywordtype">bool</span> <a class="code" href="a00196.html#ga4db0eb631e14d23d597b93b80e324c5d" title="Return whether a matrix is a normalized matrix.">isNormalized</a>(
<a name="l00102"></a>00102 detail::tmat4x4&lt;valType&gt; <span class="keyword">const</span> &amp; m,
<a name="l00103"></a>00103 valType <span class="keyword">const</span> &amp; <a class="code" href="a00177.html#ga73bc2500704c8c25dc3cde534134ca20" title="Return the epsilon constant for floating point types.">epsilon</a><span class="comment">/* = std::numeric_limits&lt;valType&gt;::epsilon()*/</span>);
<a name="l00104"></a>00104
<a name="l00107"></a>00107 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> valType, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>&gt; <span class="keyword">class </span>matType&gt;
<a name="l00108"></a>00108 <span class="keywordtype">bool</span> <a class="code" href="a00196.html#gac8a4309441e4f7a83efb978d58b03248" title="Return whether a matrix is an orthonormalized matrix.">isOrthogonal</a>(
<a name="l00109"></a>00109 matType&lt;valType&gt; <span class="keyword">const</span> &amp; m,
<a name="l00110"></a>00110 valType <span class="keyword">const</span> &amp; <a class="code" href="a00177.html#ga73bc2500704c8c25dc3cde534134ca20" title="Return the epsilon constant for floating point types.">epsilon</a><span class="comment">/* = std::numeric_limits&lt;genType&gt;::epsilon()*/</span>);
<a name="l00111"></a>00111
<a name="l00113"></a>00113 }<span class="comment">//namespace glm</span>
<a name="l00114"></a>00114
<a name="l00115"></a>00115 <span class="preprocessor">#include &quot;matrix_query.inl&quot;</span>
<a name="l00116"></a>00116
<a name="l00117"></a>00117 <span class="preprocessor">#endif//GLM_GTX_matrix_query</span>
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.5
</small></address>
</body>
</html>