Updated documentation
This commit is contained in:
Christophe Riccio
@@ -2,42 +2,31 @@
|
||||
<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"/>
|
||||
<title>func_geometric.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! -->
|
||||
|
||||
|
||||
<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 id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<!-- Generated by Doxygen 1.7.5.1 -->
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.2 -->
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -46,106 +35,108 @@
|
||||
<li><a href="files.html"><span>File List</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="nav-path" class="navpath">
|
||||
<ul>
|
||||
<li class="navelem"><a class="el" href="dir_934f46a345653ef2b3014a1b37a162c1.html">G:</a></li><li class="navelem"><a class="el" href="dir_bf513233250988b6ff3b72f8482c1597.html">Repository</a></li><li class="navelem"><a class="el" href="dir_e217bba5d90990da93f61f0ea8b942dc.html">glm</a></li><li class="navelem"><a class="el" href="dir_a844bf6d5a07b8853f8463b41029861e.html">glm</a></li><li class="navelem"><a class="el" href="dir_61748fa02e1156ca28a06d1638c8a86e.html">core</a></li> </ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">func_geometric.hpp</div> </div>
|
||||
</div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<a href="a00028.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001
|
||||
<a name="l00002"></a>00002
|
||||
<a name="l00003"></a>00003
|
||||
<a name="l00004"></a>00004
|
||||
<a name="l00005"></a>00005
|
||||
<a name="l00006"></a>00006
|
||||
<a name="l00007"></a>00007
|
||||
<a name="l00008"></a>00008
|
||||
<a name="l00009"></a>00009
|
||||
<a name="l00010"></a>00010
|
||||
<a name="l00011"></a>00011
|
||||
<a name="l00012"></a>00012
|
||||
<a name="l00013"></a>00013
|
||||
<a name="l00014"></a>00014
|
||||
<a name="l00015"></a>00015
|
||||
<a name="l00016"></a>00016
|
||||
<a name="l00017"></a>00017
|
||||
<a name="l00018"></a>00018
|
||||
<a name="l00019"></a>00019
|
||||
<a name="l00020"></a>00020
|
||||
<a name="l00021"></a>00021
|
||||
<a name="l00022"></a>00022
|
||||
<a name="l00023"></a>00023
|
||||
<a name="l00024"></a>00024
|
||||
<a name="l00025"></a>00025
|
||||
<a name="l00026"></a>00026
|
||||
<a name="l00027"></a>00027
|
||||
<a name="l00028"></a>00028
|
||||
<a name="l00029"></a>00029
|
||||
<a name="l00030"></a>00030
|
||||
<a name="l00031"></a>00031
|
||||
<a name="l00032"></a>00032
|
||||
<a name="l00033"></a>00033
|
||||
<a name="l00034"></a>00034
|
||||
<a name="l00035"></a>00035
|
||||
<a name="l00036"></a>00036 <span class="preprocessor">#ifndef glm_core_func_geometric</span>
|
||||
<a name="l00037"></a>00037 <span class="preprocessor"></span><span class="preprocessor">#define glm_core_func_geometric GLM_VERSION</span>
|
||||
<a name="l00038"></a>00038 <span class="preprocessor"></span>
|
||||
<a name="l00039"></a>00039 <span class="keyword">namespace </span>glm
|
||||
<a name="l00040"></a>00040 {
|
||||
<a name="l00043"></a>00043
|
||||
<a name="l00050"></a>00050 <span class="keyword">template</span> <<span class="keyword">typename</span> genType>
|
||||
<a name="l00051"></a>00051 <span class="keyword">typename</span> genType::value_type <a class="code" href="a00129.html#ga282360c8bb80b80d3c7f5bc00766d873" title="Returns the length of x, i.e., sqrt(x * x).">length</a>(
|
||||
<a name="l00052"></a>00052 genType <span class="keyword">const</span> & x);
|
||||
<a name="l00053"></a>00053
|
||||
<a name="l00060"></a>00060 <span class="keyword">template</span> <<span class="keyword">typename</span> genType>
|
||||
<a name="l00061"></a>00061 <span class="keyword">typename</span> genType::value_type <a class="code" href="a00129.html#ga3fac0e61144f60184d961dd156709dd3" title="Returns the distance betwwen p0 and p1, i.e., length(p0 - p1).">distance</a>(
|
||||
<a name="l00062"></a>00062 genType <span class="keyword">const</span> & p0,
|
||||
<a name="l00063"></a>00063 genType <span class="keyword">const</span> & p1);
|
||||
<a name="l00064"></a>00064
|
||||
<a name="l00071"></a>00071 <span class="keyword">template</span> <<span class="keyword">typename</span> genType>
|
||||
<a name="l00072"></a>00072 <span class="keyword">typename</span> genType::value_type <a class="code" href="a00129.html#ga7a31d2864eccfe665409e3b44f5e6e8d" title="Returns the dot product of x and y, i.e., result = x * y.">dot</a>(
|
||||
<a name="l00073"></a>00073 genType <span class="keyword">const</span> & x,
|
||||
<a name="l00074"></a>00074 genType <span class="keyword">const</span> & y);
|
||||
<a name="l00075"></a>00075
|
||||
<a name="l00082"></a>00082 <span class="keyword">template</span> <<span class="keyword">typename</span> valType>
|
||||
<a name="l00083"></a>00083 detail::tvec3<valType> <a class="code" href="a00129.html#gaa127ddc9d38f715125f91742d399eb6f" title="Returns the cross product of x and y.">cross</a>(
|
||||
<a name="l00084"></a>00084 detail::tvec3<valType> <span class="keyword">const</span> & x,
|
||||
<a name="l00085"></a>00085 detail::tvec3<valType> <span class="keyword">const</span> & y);
|
||||
<a name="l00086"></a>00086
|
||||
<a name="l00091"></a>00091 <span class="keyword">template</span> <<span class="keyword">typename</span> genType>
|
||||
<a name="l00092"></a>00092 genType <a class="code" href="a00129.html#ga68b931c228750eeba844c273c54ca43d" title="Returns a vector in the same direction as x but with length of 1.">normalize</a>(
|
||||
<a name="l00093"></a>00093 genType <span class="keyword">const</span> & x);
|
||||
<a name="l00094"></a>00094
|
||||
<a name="l00101"></a>00101 <span class="keyword">template</span> <<span class="keyword">typename</span> genType>
|
||||
<a name="l00102"></a>00102 genType <a class="code" href="a00129.html#ga855fc5fd7779df1683482564956c6764" title="If dot(Nref, I) < 0.0, return N, otherwise, return -N.">faceforward</a>(
|
||||
<a name="l00103"></a>00103 genType <span class="keyword">const</span> & N,
|
||||
<a name="l00104"></a>00104 genType <span class="keyword">const</span> & I,
|
||||
<a name="l00105"></a>00105 genType <span class="keyword">const</span> & Nref);
|
||||
<a name="l00106"></a>00106
|
||||
<a name="l00114"></a>00114 <span class="keyword">template</span> <<span class="keyword">typename</span> genType>
|
||||
<a name="l00115"></a>00115 genType <a class="code" href="a00129.html#gabe1fa0bef5f854242eb70ce56e5a7d03" title="For the incident vector I and surface orientation N, returns the reflection direction : result = I - ...">reflect</a>(
|
||||
<a name="l00116"></a>00116 genType <span class="keyword">const</span> & I,
|
||||
<a name="l00117"></a>00117 genType <span class="keyword">const</span> & N);
|
||||
<a name="l00118"></a>00118
|
||||
<a name="l00127"></a>00127 <span class="keyword">template</span> <<span class="keyword">typename</span> genType>
|
||||
<a name="l00128"></a>00128 genType <a class="code" href="a00129.html#gabbb4909d3e99a7a2411cc63252afbbd8" title="For the incident vector I and surface normal N, and the ratio of indices of refraction eta...">refract</a>(
|
||||
<a name="l00129"></a>00129 genType <span class="keyword">const</span> & I,
|
||||
<a name="l00130"></a>00130 genType <span class="keyword">const</span> & N,
|
||||
<a name="l00131"></a>00131 <span class="keyword">typename</span> genType::value_type <span class="keyword">const</span> & eta);
|
||||
<a name="l00132"></a>00132
|
||||
<a name="l00134"></a>00134 }<span class="comment">//namespace glm</span>
|
||||
<a name="l00135"></a>00135
|
||||
<a name="l00136"></a>00136 <span class="preprocessor">#include "func_geometric.inl"</span>
|
||||
<a name="l00137"></a>00137
|
||||
<a name="l00138"></a>00138 <span class="preprocessor">#endif//glm_core_func_geometric</span>
|
||||
</pre></div></div>
|
||||
</div>
|
||||
|
||||
|
||||
<a href="a00028.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div>
|
||||
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> </div>
|
||||
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div>
|
||||
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> </div>
|
||||
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div>
|
||||
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div>
|
||||
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div>
|
||||
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div>
|
||||
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div>
|
||||
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div>
|
||||
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div>
|
||||
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div>
|
||||
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> </div>
|
||||
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div>
|
||||
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div>
|
||||
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div>
|
||||
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div>
|
||||
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div>
|
||||
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div>
|
||||
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div>
|
||||
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div>
|
||||
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div>
|
||||
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div>
|
||||
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div>
|
||||
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div>
|
||||
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div>
|
||||
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div>
|
||||
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div>
|
||||
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div>
|
||||
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div>
|
||||
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div>
|
||||
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div>
|
||||
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div>
|
||||
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div>
|
||||
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div>
|
||||
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#ifndef glm_core_func_geometric</span></div>
|
||||
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor"></span><span class="preprocessor">#define glm_core_func_geometric GLM_VERSION</span></div>
|
||||
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor"></span></div>
|
||||
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">namespace </span>glm</div>
|
||||
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> {</div>
|
||||
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div>
|
||||
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> genType> </div>
|
||||
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">typename</span> genType::value_type <a class="code" href="a00131.html#ga282360c8bb80b80d3c7f5bc00766d873" title="Returns the length of x, i.e., sqrt(x * x).">length</a>(</div>
|
||||
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  genType <span class="keyword">const</span> & x); </div>
|
||||
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div>
|
||||
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> genType> </div>
|
||||
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">typename</span> genType::value_type <a class="code" href="a00131.html#ga3fac0e61144f60184d961dd156709dd3" title="Returns the distance betwwen p0 and p1, i.e., length(p0 - p1).">distance</a>(</div>
|
||||
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  genType <span class="keyword">const</span> & p0, </div>
|
||||
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  genType <span class="keyword">const</span> & p1);</div>
|
||||
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div>
|
||||
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> genType> </div>
|
||||
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">typename</span> genType::value_type <a class="code" href="a00131.html#ga7a31d2864eccfe665409e3b44f5e6e8d" title="Returns the dot product of x and y, i.e., result = x * y.">dot</a>(</div>
|
||||
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  genType <span class="keyword">const</span> & x, </div>
|
||||
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  genType <span class="keyword">const</span> & y);</div>
|
||||
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div>
|
||||
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> valType> </div>
|
||||
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  detail::tvec3<valType> <a class="code" href="a00131.html#gaa127ddc9d38f715125f91742d399eb6f" title="Returns the cross product of x and y.">cross</a>(</div>
|
||||
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  detail::tvec3<valType> <span class="keyword">const</span> & x, </div>
|
||||
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  detail::tvec3<valType> <span class="keyword">const</span> & y);</div>
|
||||
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div>
|
||||
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> genType> </div>
|
||||
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  genType <a class="code" href="a00131.html#ga68b931c228750eeba844c273c54ca43d" title="Returns a vector in the same direction as x but with length of 1.">normalize</a>(</div>
|
||||
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  genType <span class="keyword">const</span> & x);</div>
|
||||
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div>
|
||||
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> genType> </div>
|
||||
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  genType <a class="code" href="a00131.html#ga855fc5fd7779df1683482564956c6764" title="If dot(Nref, I) < 0.0, return N, otherwise, return -N.">faceforward</a>(</div>
|
||||
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  genType <span class="keyword">const</span> & N, </div>
|
||||
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  genType <span class="keyword">const</span> & I, </div>
|
||||
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  genType <span class="keyword">const</span> & Nref);</div>
|
||||
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div>
|
||||
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> genType> </div>
|
||||
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  genType <a class="code" href="a00131.html#gabe1fa0bef5f854242eb70ce56e5a7d03" title="For the incident vector I and surface orientation N, returns the reflection direction : result = I - ...">reflect</a>(</div>
|
||||
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  genType <span class="keyword">const</span> & I, </div>
|
||||
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  genType <span class="keyword">const</span> & N);</div>
|
||||
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div>
|
||||
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> genType> </div>
|
||||
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  genType <a class="code" href="a00131.html#gabbb4909d3e99a7a2411cc63252afbbd8" title="For the incident vector I and surface normal N, and the ratio of indices of refraction eta...">refract</a>(</div>
|
||||
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  genType <span class="keyword">const</span> & I, </div>
|
||||
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  genType <span class="keyword">const</span> & N, </div>
|
||||
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="keyword">typename</span> genType::value_type <span class="keyword">const</span> & eta);</div>
|
||||
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div>
|
||||
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> }<span class="comment">//namespace glm</span></div>
|
||||
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> </div>
|
||||
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="preprocessor">#include "func_geometric.inl"</span></div>
|
||||
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> </div>
|
||||
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="preprocessor">#endif//glm_core_func_geometric</span></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<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.1
|
||||
</a> 1.8.2
|
||||
</small></address>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
||||
Reference in New Issue
Block a user