glm/doc/api/a00147_source.html

128 lines
14 KiB
HTML
Raw Normal View History

2013-12-25 22:48:55 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>GLM: vector_query.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">GLM
&#160;<span id="projectnumber">0.9.5</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_8ceffd4ee35c3518d4e8bdc7e638efe8.html">Users</a></li><li class="navelem"><a class="el" href="dir_968fb7988749a6351e7b3d0c1783dec4.html">Groove</a></li><li class="navelem"><a class="el" href="dir_6e418c18ca640a0404613de005739e2e.html">Documents</a></li><li class="navelem"><a class="el" href="dir_e3ecd7863bd215c92a17f47e2ae3be43.html">GitHub</a></li><li class="navelem"><a class="el" href="dir_edf753475b928be648c1cf1c6443cf63.html">glm</a></li><li class="navelem"><a class="el" href="dir_e50778361fd4ab4de52181ed9eb2b726.html">glm</a></li><li class="navelem"><a class="el" href="dir_a8d99eddac27b2368ab5252ce80ded11.html">gtx</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">vector_query.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="a00147.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="preprocessor">#ifndef GLM_GTX_vector_query</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define GLM_GTX_vector_query</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="comment">// Dependency:</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="preprocessor">#include &quot;../glm.hpp&quot;</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="preprocessor">#include &lt;cfloat&gt;</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="preprocessor">#include &lt;limits&gt;</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="preprocessor">#if(defined(GLM_MESSAGES) &amp;&amp; !defined(GLM_EXT_INCLUDED))</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="preprocessor"></span><span class="preprocessor"># pragma message(&quot;GLM: GLM_GTX_vector_query extension included&quot;)</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="keyword">namespace </span>glm</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;{</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="a00235.html#ga5988c0d52c89370fcc3fee4eaf0a2dd8">areCollinear</a>(</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; genType <span class="keyword">const</span> &amp; v0,</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; genType <span class="keyword">const</span> &amp; v1,</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keyword">typename</span> genType::T <span class="keyword">const</span> &amp; <a class="code" href="a00171.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a>);</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="a00235.html#gac9743adb82a3a94693b1693092ae7dca">areOrthogonal</a>(</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; genType <span class="keyword">const</span> &amp; v0,</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; genType <span class="keyword">const</span> &amp; v1,</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keyword">typename</span> genType::T <span class="keyword">const</span> &amp; <a class="code" href="a00171.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a>);</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="a00210.html#gaeb6ab065655de7ae74220c893181b682">isNormalized</a>(</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; vecType&lt;genType, P&gt; <span class="keyword">const</span> &amp; v,</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; genType <span class="keyword">const</span> &amp; <a class="code" href="a00171.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a>);</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="a00210.html#gaca2ae6e3b473e36c0bf0fcf50d0b972b">isNull</a>(</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; detail::tvec2&lt;T, P&gt; <span class="keyword">const</span> &amp; v,</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; T <span class="keyword">const</span> &amp; <a class="code" href="a00171.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a>);</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="a00210.html#gaca2ae6e3b473e36c0bf0fcf50d0b972b">isNull</a>(</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; detail::tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; v,</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; T <span class="keyword">const</span> &amp; <a class="code" href="a00171.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a>);</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="a00210.html#gaca2ae6e3b473e36c0bf0fcf50d0b972b">isNull</a>(</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; detail::tvec4&lt;T, P&gt; <span class="keyword">const</span> &amp; v,</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; T <span class="keyword">const</span> &amp; <a class="code" href="a00171.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a>);</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="a00235.html#ga3fd2c8a48c2d9d3e208bdfed6aafca6e">areOrthonormal</a>(</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; genType <span class="keyword">const</span> &amp; v0,</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; genType <span class="keyword">const</span> &amp; v1,</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; <span class="keyword">typename</span> genType::T <span class="keyword">const</span> &amp; <a class="code" href="a00171.html#gacb41049b8d22c8aa90e362b96c524feb">epsilon</a>);</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;}<span class="comment">// namespace glm</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;<span class="preprocessor">#include &quot;vector_query.inl&quot;</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;<span class="preprocessor">#endif//GLM_GTX_vector_query</span></div>
<div class="ttc" id="a00171_html_gacb41049b8d22c8aa90e362b96c524feb"><div class="ttname"><a href="a00171.html#gacb41049b8d22c8aa90e362b96c524feb">glm::epsilon</a></div><div class="ttdeci">GLM_FUNC_DECL genType epsilon()</div><div class="ttdoc">Return the epsilon constant for floating point types. </div></div>
<div class="ttc" id="a00210_html_gaeb6ab065655de7ae74220c893181b682"><div class="ttname"><a href="a00210.html#gaeb6ab065655de7ae74220c893181b682">glm::isNormalized</a></div><div class="ttdeci">bool isNormalized(detail::tmat2x2&lt; T, P &gt; const &amp;m, T const &amp;epsilon)</div><div class="ttdoc">Return whether a matrix is a normalized matrix. </div></div>
<div class="ttc" id="a00235_html_gac9743adb82a3a94693b1693092ae7dca"><div class="ttname"><a href="a00235.html#gac9743adb82a3a94693b1693092ae7dca">glm::areOrthogonal</a></div><div class="ttdeci">bool areOrthogonal(genType const &amp;v0, genType const &amp;v1, typename genType::T const &amp;epsilon)</div><div class="ttdoc">Check whether two vectors are orthogonals. </div></div>
<div class="ttc" id="a00210_html_gaca2ae6e3b473e36c0bf0fcf50d0b972b"><div class="ttname"><a href="a00210.html#gaca2ae6e3b473e36c0bf0fcf50d0b972b">glm::isNull</a></div><div class="ttdeci">bool isNull(detail::tmat2x2&lt; T, P &gt; const &amp;m, T const &amp;epsilon)</div><div class="ttdoc">Return whether a matrix a null matrix. </div></div>
<div class="ttc" id="a00235_html_ga5988c0d52c89370fcc3fee4eaf0a2dd8"><div class="ttname"><a href="a00235.html#ga5988c0d52c89370fcc3fee4eaf0a2dd8">glm::areCollinear</a></div><div class="ttdeci">bool areCollinear(genType const &amp;v0, genType const &amp;v1, typename genType::T const &amp;epsilon)</div><div class="ttdoc">Check whether two vectors are collinears. </div></div>
<div class="ttc" id="a00235_html_ga3fd2c8a48c2d9d3e208bdfed6aafca6e"><div class="ttname"><a href="a00235.html#ga3fd2c8a48c2d9d3e208bdfed6aafca6e">glm::areOrthonormal</a></div><div class="ttdeci">bool areOrthonormal(genType const &amp;v0, genType const &amp;v1, typename genType::T const &amp;epsilon)</div><div class="ttdoc">Check whether two vectors are orthonormal. </div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<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.8.5
</small></address>
</body>
</html>