glm/doc/api/a00034_source.html

130 lines
15 KiB
HTML
Raw Normal View History

<!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"/>
2012-11-18 13:05:52 +00:00
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
2013-12-25 22:48:55 +00:00
<meta name="generator" content="Doxygen 1.8.5"/>
<title>GLM: func_geometric.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
2012-11-18 13:05:52 +00:00
<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>
2012-11-18 13:05:52 +00:00
<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;">
2013-12-25 22:48:55 +00:00
<td style="padding-left: 0.5em;">
<div id="projectname">GLM
&#160;<span id="projectnumber">0.9.5</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
2012-11-18 13:05:52 +00:00
<!-- end header part -->
2013-12-25 22:48:55 +00:00
<!-- 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>
2013-12-25 22:48:55 +00:00
<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>
2012-11-18 13:05:52 +00:00
<div id="nav-path" class="navpath">
<ul>
2013-12-25 22:48:55 +00:00
<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_4d1ca7e3aefdd5b86b5dba8da1c3d503.html">detail</a></li> </ul>
2012-11-18 13:05:52 +00:00
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
2013-12-25 22:48:55 +00:00
<div class="title">func_geometric.hpp</div> </div>
2012-11-18 13:05:52 +00:00
</div><!--header-->
<div class="contents">
2013-12-25 22:48:55 +00:00
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="preprocessor">#ifndef glm_core_func_geometric</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define glm_core_func_geometric</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="preprocessor">#include &quot;type_vec3.hpp&quot;</span></div>
2012-11-18 13:05:52 +00:00
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div>
2013-12-25 22:48:55 +00:00
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="keyword">namespace </span>glm</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;{</div>
2012-11-18 13:05:52 +00:00
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div>
2013-12-25 22:48:55 +00:00
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt; </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; GLM_FUNC_DECL <span class="keyword">typename</span> genType::value_type <a class="code" href="a00157.html#ga03b2831439defb8922832b540b91b8a7">length</a>(</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; genType <span class="keyword">const</span> &amp; x); </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt; </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; GLM_FUNC_DECL <span class="keyword">typename</span> genType::value_type <a class="code" href="a00157.html#ga00716eae37e8ae2a76ca7799f9c75682">distance</a>(</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; genType <span class="keyword">const</span> &amp; p0, </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; genType <span class="keyword">const</span> &amp; p1);</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</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> T, 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; GLM_FUNC_DECL T <a class="code" href="a00157.html#ga7dada304da2ba7dd3376ab4f178c3f6b">dot</a>(</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; x,</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; y);</div>
2014-01-11 22:35:39 +00:00
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; GLM_FUNC_DECL genType <a class="code" href="a00157.html#ga7dada304da2ba7dd3376ab4f178c3f6b">dot</a>(</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; genType <span class="keyword">const</span> &amp; x,</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; genType <span class="keyword">const</span> &amp; y);</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;</div>
2013-12-25 22:48:55 +00:00
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; GLM_FUNC_DECL detail::tvec3&lt;T, P&gt; <a class="code" href="a00157.html#ga89b91c2a256cfb62ecbc589d1ee36d3c">cross</a>(</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; detail::tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; x,</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; detail::tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; y);</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; GLM_FUNC_DECL genType <a class="code" href="a00157.html#ga15aa87101457e41663b08a8dcc3357f8">normalize</a>(</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; genType <span class="keyword">const</span> &amp; x);</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; GLM_FUNC_DECL genType <a class="code" href="a00157.html#ga4bbb036ef9527ee9f67384233029ed9b">faceforward</a>(</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; genType <span class="keyword">const</span> &amp; N,</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; genType <span class="keyword">const</span> &amp; I,</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; genType <span class="keyword">const</span> &amp; Nref);</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160;</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; GLM_FUNC_DECL genType <a class="code" href="a00157.html#gab63646fc36b81cf69d3ce123a72f76f2">reflect</a>(</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; genType <span class="keyword">const</span> &amp; I,</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; genType <span class="keyword">const</span> &amp; N);</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, 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="l00141"></a><span class="lineno"> 141</span>&#160; GLM_FUNC_DECL vecType&lt;T, P&gt; <a class="code" href="a00157.html#ga99d8ddb244b129892babaca9778206d0">refract</a>(</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; I,</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; N,</div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; T <span class="keyword">const</span> &amp; eta);</div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160;</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160;}<span class="comment">//namespace glm</span></div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160;</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160;<span class="preprocessor">#include &quot;func_geometric.inl&quot;</span></div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160;</div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160;<span class="preprocessor">#endif//glm_core_func_geometric</span></div>
<div class="ttc" id="a00157_html_ga4bbb036ef9527ee9f67384233029ed9b"><div class="ttname"><a href="a00157.html#ga4bbb036ef9527ee9f67384233029ed9b">glm::faceforward</a></div><div class="ttdeci">GLM_FUNC_DECL genType faceforward(genType const &amp;N, genType const &amp;I, genType const &amp;Nref)</div><div class="ttdoc">If dot(Nref, I) &amp;lt; 0.0, return N, otherwise, return -N. </div></div>
<div class="ttc" id="a00157_html_ga7dada304da2ba7dd3376ab4f178c3f6b"><div class="ttname"><a href="a00157.html#ga7dada304da2ba7dd3376ab4f178c3f6b">glm::dot</a></div><div class="ttdeci">GLM_FUNC_DECL T dot(vecType&lt; T, P &gt; const &amp;x, vecType&lt; T, P &gt; const &amp;y)</div><div class="ttdoc">Returns the dot product of x and y, i.e., result = x * y. </div></div>
<div class="ttc" id="a00157_html_ga89b91c2a256cfb62ecbc589d1ee36d3c"><div class="ttname"><a href="a00157.html#ga89b91c2a256cfb62ecbc589d1ee36d3c">glm::cross</a></div><div class="ttdeci">GLM_FUNC_DECL detail::tvec3&lt; T, P &gt; cross(detail::tvec3&lt; T, P &gt; const &amp;x, detail::tvec3&lt; T, P &gt; const &amp;y)</div><div class="ttdoc">Returns the cross product of x and y. </div></div>
<div class="ttc" id="a00157_html_ga15aa87101457e41663b08a8dcc3357f8"><div class="ttname"><a href="a00157.html#ga15aa87101457e41663b08a8dcc3357f8">glm::normalize</a></div><div class="ttdeci">GLM_FUNC_DECL genType normalize(genType const &amp;x)</div><div class="ttdoc">Returns a vector in the same direction as x but with length of 1. </div></div>
<div class="ttc" id="a00157_html_ga03b2831439defb8922832b540b91b8a7"><div class="ttname"><a href="a00157.html#ga03b2831439defb8922832b540b91b8a7">glm::length</a></div><div class="ttdeci">GLM_FUNC_DECL genType::value_type length(genType const &amp;x)</div><div class="ttdoc">Returns the length of x, i.e., sqrt(x * x). </div></div>
<div class="ttc" id="a00157_html_ga99d8ddb244b129892babaca9778206d0"><div class="ttname"><a href="a00157.html#ga99d8ddb244b129892babaca9778206d0">glm::refract</a></div><div class="ttdeci">GLM_FUNC_DECL vecType&lt; T, P &gt; refract(vecType&lt; T, P &gt; const &amp;I, vecType&lt; T, P &gt; const &amp;N, T const &amp;eta)</div><div class="ttdoc">For the incident vector I and surface normal N, and the ratio of indices of refraction eta...</div></div>
<div class="ttc" id="a00157_html_gab63646fc36b81cf69d3ce123a72f76f2"><div class="ttname"><a href="a00157.html#gab63646fc36b81cf69d3ce123a72f76f2">glm::reflect</a></div><div class="ttdeci">GLM_FUNC_DECL genType reflect(genType const &amp;I, genType const &amp;N)</div><div class="ttdoc">For the incident vector I and surface orientation N, returns the reflection direction : result = I - ...</div></div>
<div class="ttc" id="a00157_html_ga00716eae37e8ae2a76ca7799f9c75682"><div class="ttname"><a href="a00157.html#ga00716eae37e8ae2a76ca7799f9c75682">glm::distance</a></div><div class="ttdeci">GLM_FUNC_DECL genType::value_type distance(genType const &amp;p0, genType const &amp;p1)</div><div class="ttdoc">Returns the distance betwwen p0 and p1, i.e., length(p0 - p1). </div></div>
2012-11-18 13:05:52 +00:00
</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"/>
2013-12-25 22:48:55 +00:00
</a> 1.8.5
</small></address>
</body>
</html>