Updated doxygen documentation
This commit is contained in:
Christophe Riccio
@@ -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>vector_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 Page</span></a></li>
|
||||
@@ -34,7 +48,7 @@
|
||||
</div>
|
||||
<div class="header">
|
||||
<div class="headertitle">
|
||||
<h1>vector_query.hpp</h1> </div>
|
||||
<div class="title">vector_query.hpp</div> </div>
|
||||
</div>
|
||||
<div class="contents">
|
||||
<a href="a00135.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001
|
||||
@@ -78,7 +92,7 @@
|
||||
<a name="l00039"></a>00039 <span class="preprocessor"></span><span class="preprocessor">#define GLM_GTX_vector_query GLM_VERSION</span>
|
||||
<a name="l00040"></a>00040 <span class="preprocessor"></span>
|
||||
<a name="l00041"></a>00041 <span class="comment">// Dependency:</span>
|
||||
<a name="l00042"></a>00042 <span class="preprocessor">#include "<a class="code" href="a00050.html" title="OpenGL Mathematics (glm.g-truc.net)">../glm.hpp</a>"</span>
|
||||
<a name="l00042"></a>00042 <span class="preprocessor">#include "../glm.hpp"</span>
|
||||
<a name="l00043"></a>00043 <span class="preprocessor">#include <cfloat></span>
|
||||
<a name="l00044"></a>00044 <span class="preprocessor">#include <limits></span>
|
||||
<a name="l00045"></a>00045
|
||||
@@ -90,54 +104,57 @@
|
||||
<a name="l00051"></a>00051 {
|
||||
<a name="l00054"></a>00054
|
||||
<a name="l00057"></a>00057 <span class="keyword">template</span> <<span class="keyword">typename</span> genType>
|
||||
<a name="l00058"></a>00058 <span class="keywordtype">bool</span> <a class="code" href="a00226.html#gad8cbdc94434483bd27fc98c81370c6a4" title="Check if two vectors are collinears.">areCollinear</a>(
|
||||
<a name="l00058"></a>00058 <span class="keywordtype">bool</span> <a class="code" href="a00226.html#ga516c25a0d2c46c64fb5afca5eb24daab" title="Check whether two vectors are collinears.">areCollinear</a>(
|
||||
<a name="l00059"></a>00059 genType <span class="keyword">const</span> & v0,
|
||||
<a name="l00060"></a>00060 genType <span class="keyword">const</span> & v1,
|
||||
<a name="l00061"></a>00061 <span class="keyword">typename</span> genType::value_type <span class="keyword">const</span> & epsilon = std::numeric_limits<typename genType::value_type>::epsilon());
|
||||
<a name="l00061"></a>00061 <span class="keyword">typename</span> genType::value_type <span class="keyword">const</span> & <a class="code" href="a00177.html#ga73bc2500704c8c25dc3cde534134ca20" title="Return the epsilon constant for floating point types.">epsilon</a><span class="comment">/* = std::numeric_limits<typename genType::value_type>::epsilon()*/</span>);
|
||||
<a name="l00062"></a>00062
|
||||
<a name="l00065"></a>00065 <span class="keyword">template</span> <<span class="keyword">typename</span> genType>
|
||||
<a name="l00066"></a>00066 <span class="keywordtype">bool</span> <a class="code" href="a00226.html#ga3f143fe8a29d0f6da52c4fd9dab37670" title="Check if two vectors are opposites.">areOpposite</a>(
|
||||
<a name="l00066"></a>00066 <span class="keywordtype">bool</span> <a class="code" href="a00226.html#ga0cba4a48074a8b8b8474538385a709e7" title="Check whether two vectors are orthogonals.">areOrthogonal</a>(
|
||||
<a name="l00067"></a>00067 genType <span class="keyword">const</span> & v0,
|
||||
<a name="l00068"></a>00068 genType <span class="keyword">const</span> & v1,
|
||||
<a name="l00069"></a>00069 <span class="keyword">typename</span> genType::value_type <span class="keyword">const</span> & epsilon = std::numeric_limits<typename genType::value_type>::epsilon());
|
||||
<a name="l00070"></a>00070
|
||||
<a name="l00073"></a>00073 <span class="keyword">template</span> <<span class="keyword">typename</span> genType>
|
||||
<a name="l00074"></a>00074 <span class="keywordtype">bool</span> <a class="code" href="a00226.html#ga23c33409784c17815ddc167d41f433f7" title="Check if two vectors are orthogonals.">areOrthogonal</a>(
|
||||
<a name="l00075"></a>00075 genType <span class="keyword">const</span> & v0,
|
||||
<a name="l00076"></a>00076 genType <span class="keyword">const</span> & v1,
|
||||
<a name="l00077"></a>00077 <span class="keyword">typename</span> genType::value_type <span class="keyword">const</span> & epsilon = std::numeric_limits<typename genType::value_type>::epsilon());
|
||||
<a name="l00078"></a>00078
|
||||
<a name="l00081"></a>00081 <span class="keyword">template</span> <<span class="keyword">typename</span> genType>
|
||||
<a name="l00082"></a>00082 <span class="keywordtype">bool</span> <a class="code" href="a00196.html#ga1df4e739802e95eeb4289baaa7150f7a" title="Return if a matrix a normalized matrix.">isNormalized</a>(
|
||||
<a name="l00083"></a>00083 genType <span class="keyword">const</span> & v,
|
||||
<a name="l00084"></a>00084 <span class="keyword">typename</span> genType::value_type <span class="keyword">const</span> & epsilon = std::numeric_limits<typename genType::value_type>::epsilon());
|
||||
<a name="l00085"></a>00085
|
||||
<a name="l00088"></a>00088 <span class="keyword">template</span> <<span class="keyword">typename</span> genType>
|
||||
<a name="l00089"></a>00089 <span class="keywordtype">bool</span> <a class="code" href="a00196.html#gabe1d2a5c6cf3ddaafd384c6d3cc272e1" title="Return if a matrix a null matrix.">isNull</a>(
|
||||
<a name="l00090"></a>00090 genType <span class="keyword">const</span> & v,
|
||||
<a name="l00091"></a>00091 <span class="keyword">typename</span> genType::value_type <span class="keyword">const</span> & epsilon = std::numeric_limits<typename genType::value_type>::epsilon());
|
||||
<a name="l00092"></a>00092
|
||||
<a name="l00095"></a>00095 <span class="keyword">template</span> <<span class="keyword">typename</span> genType>
|
||||
<a name="l00096"></a>00096 <span class="keywordtype">bool</span> <a class="code" href="a00226.html#ga6b09053f3ea17b22635a5776c1cf5bf2" title="Check if two vectors are orthonormal.">areOrthonormal</a>(
|
||||
<a name="l00097"></a>00097 genType <span class="keyword">const</span> & v0,
|
||||
<a name="l00098"></a>00098 genType <span class="keyword">const</span> & v1,
|
||||
<a name="l00099"></a>00099 <span class="keyword">typename</span> genType::value_type <span class="keyword">const</span> & epsilon = std::numeric_limits<typename genType::value_type>::epsilon());
|
||||
<a name="l00100"></a>00100
|
||||
<a name="l00103"></a>00103 <span class="keyword">template</span> <<span class="keyword">typename</span> genType>
|
||||
<a name="l00104"></a>00104 <span class="keywordtype">bool</span> <a class="code" href="a00226.html#ga71773d62e0d315bec16542e69b5203e6" title="Check if two vectors are similar.">areSimilar</a>(
|
||||
<a name="l00105"></a>00105 genType <span class="keyword">const</span> & v0,
|
||||
<a name="l00106"></a>00106 genType <span class="keyword">const</span> & v1,
|
||||
<a name="l00107"></a>00107 <span class="keyword">typename</span> genType::value_type <span class="keyword">const</span> & epsilon = std::numeric_limits<typename genType::value_type>::epsilon());
|
||||
<a name="l00108"></a>00108
|
||||
<a name="l00110"></a>00110 }<span class="comment">// namespace glm</span>
|
||||
<a name="l00069"></a>00069 <span class="keyword">typename</span> genType::value_type <span class="keyword">const</span> & <a class="code" href="a00177.html#ga73bc2500704c8c25dc3cde534134ca20" title="Return the epsilon constant for floating point types.">epsilon</a><span class="comment">/* = std::numeric_limits<typename genType::value_type>::epsilon()*/</span>);
|
||||
<a name="l00070"></a>00070
|
||||
<a name="l00073"></a>00073 <span class="keyword">template</span> <<span class="keyword">typename</span> genType, <span class="keyword">template</span> <<span class="keyword">typename</span>> <span class="keyword">class </span>vecType>
|
||||
<a name="l00074"></a>00074 <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="l00075"></a>00075 vecType<genType> <span class="keyword">const</span> & v,
|
||||
<a name="l00076"></a>00076 genType <span class="keyword">const</span> & <a class="code" href="a00177.html#ga73bc2500704c8c25dc3cde534134ca20" title="Return the epsilon constant for floating point types.">epsilon</a><span class="comment">/* = std::numeric_limits<genType>::epsilon()*/</span>);
|
||||
<a name="l00077"></a>00077
|
||||
<a name="l00080"></a>00080 <span class="keyword">template</span> <<span class="keyword">typename</span> valType>
|
||||
<a name="l00081"></a>00081 <span class="keywordtype">bool</span> <a class="code" href="a00196.html#ga522ba657c5bf6a022c49b5717f2b600c" title="Return whether a matrix a null matrix.">isNull</a>(
|
||||
<a name="l00082"></a>00082 detail::tvec2<valType> <span class="keyword">const</span> & v,
|
||||
<a name="l00083"></a>00083 valType <span class="keyword">const</span> & <a class="code" href="a00177.html#ga73bc2500704c8c25dc3cde534134ca20" title="Return the epsilon constant for floating point types.">epsilon</a><span class="comment">/* = std::numeric_limits<typename genType::value_type>::epsilon()*/</span>);
|
||||
<a name="l00084"></a>00084
|
||||
<a name="l00087"></a>00087 <span class="keyword">template</span> <<span class="keyword">typename</span> valType>
|
||||
<a name="l00088"></a>00088 <span class="keywordtype">bool</span> <a class="code" href="a00196.html#ga522ba657c5bf6a022c49b5717f2b600c" title="Return whether a matrix a null matrix.">isNull</a>(
|
||||
<a name="l00089"></a>00089 detail::tvec3<valType> <span class="keyword">const</span> & v,
|
||||
<a name="l00090"></a>00090 valType <span class="keyword">const</span> & <a class="code" href="a00177.html#ga73bc2500704c8c25dc3cde534134ca20" title="Return the epsilon constant for floating point types.">epsilon</a><span class="comment">/* = std::numeric_limits<typename genType::value_type>::epsilon()*/</span>);
|
||||
<a name="l00091"></a>00091
|
||||
<a name="l00094"></a>00094 <span class="keyword">template</span> <<span class="keyword">typename</span> valType>
|
||||
<a name="l00095"></a>00095 <span class="keywordtype">bool</span> <a class="code" href="a00196.html#ga522ba657c5bf6a022c49b5717f2b600c" title="Return whether a matrix a null matrix.">isNull</a>(
|
||||
<a name="l00096"></a>00096 detail::tvec4<valType> <span class="keyword">const</span> & v,
|
||||
<a name="l00097"></a>00097 valType <span class="keyword">const</span> & <a class="code" href="a00177.html#ga73bc2500704c8c25dc3cde534134ca20" title="Return the epsilon constant for floating point types.">epsilon</a><span class="comment">/* = std::numeric_limits<typename genType::value_type>::epsilon()*/</span>);
|
||||
<a name="l00098"></a>00098
|
||||
<a name="l00101"></a>00101 <span class="keyword">template</span> <<span class="keyword">typename</span> genType>
|
||||
<a name="l00102"></a>00102 <span class="keywordtype">bool</span> <a class="code" href="a00226.html#gab6b9a4e79fb7b34e8817ae9c870eb06e" title="Check whether two vectors are orthonormal.">areOrthonormal</a>(
|
||||
<a name="l00103"></a>00103 genType <span class="keyword">const</span> & v0,
|
||||
<a name="l00104"></a>00104 genType <span class="keyword">const</span> & v1,
|
||||
<a name="l00105"></a>00105 <span class="keyword">typename</span> genType::value_type <span class="keyword">const</span> & <a class="code" href="a00177.html#ga73bc2500704c8c25dc3cde534134ca20" title="Return the epsilon constant for floating point types.">epsilon</a><span class="comment">/* = std::numeric_limits<typename genType::value_type>::epsilon()*/</span>);
|
||||
<a name="l00106"></a>00106
|
||||
<a name="l00108"></a>00108 }<span class="comment">// namespace glm</span>
|
||||
<a name="l00109"></a>00109
|
||||
<a name="l00110"></a>00110 <span class="preprocessor">#include "vector_query.inl"</span>
|
||||
<a name="l00111"></a>00111
|
||||
<a name="l00112"></a>00112 <span class="preprocessor">#include "vector_query.inl"</span>
|
||||
<a name="l00113"></a>00113
|
||||
<a name="l00114"></a>00114 <span class="preprocessor">#endif//GLM_GTX_vector_query</span>
|
||||
<a name="l00112"></a>00112 <span class="preprocessor">#endif//GLM_GTX_vector_query</span>
|
||||
</pre></div></div>
|
||||
</div>
|
||||
<hr class="footer"/><address class="footer"><small>Generated by 
|
||||
<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  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.7.5
|
||||
</small></address>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
||||
Reference in New Issue
Block a user