Updated API

This commit is contained in:
Christophe Riccio
2014-11-30 21:57:58 +01:00
parent a1e34d02ff
commit 6285ed64d3
385 changed files with 60361 additions and 60106 deletions

View File

@@ -4,7 +4,7 @@
<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.8"/>
<title>0.9.6: reciprocal.hpp Source File</title>
<title>0.9.6: rotate_normalized_axis.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>
@@ -41,80 +41,48 @@
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_885cc87fac2d91e269af0a5a959fa5f6.html">E:</a></li><li class="navelem"><a class="el" href="dir_153b03dd71a7bff437c38ec53cb2e014.html">Source</a></li><li class="navelem"><a class="el" href="dir_0c6652232a835be54bedd6cfd7502504.html">G-Truc</a></li><li class="navelem"><a class="el" href="dir_e2c7faa62a52820b5be8795affd6e495.html">glm</a></li><li class="navelem"><a class="el" href="dir_5cf96241cdcf6779b80e104875f9716f.html">glm</a></li><li class="navelem"><a class="el" href="dir_8aa733b201d3a9f98631fbccc86ae6c7.html">gtc</a></li> </ul>
<li class="navelem"><a class="el" href="dir_885cc87fac2d91e269af0a5a959fa5f6.html">E:</a></li><li class="navelem"><a class="el" href="dir_153b03dd71a7bff437c38ec53cb2e014.html">Source</a></li><li class="navelem"><a class="el" href="dir_0c6652232a835be54bedd6cfd7502504.html">G-Truc</a></li><li class="navelem"><a class="el" href="dir_e2c7faa62a52820b5be8795affd6e495.html">glm</a></li><li class="navelem"><a class="el" href="dir_5cf96241cdcf6779b80e104875f9716f.html">glm</a></li><li class="navelem"><a class="el" href="dir_5d3642ea3c7f2dae4a957f2cf472c9ae.html">gtx</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">reciprocal.hpp</div> </div>
<div class="title">rotate_normalized_axis.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="a00099.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">#pragma once</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="comment">// Dependencies</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="preprocessor">#include &quot;../detail/setup.hpp&quot;</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="preprocessor">#if(defined(GLM_MESSAGES) &amp;&amp; !defined(GLM_EXT_INCLUDED))</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="preprocessor"># pragma message(&quot;GLM: GLM_GTC_reciprocal extension included&quot;)</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="keyword">namespace </span><a class="code" href="a00146.html">glm</a></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;{</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt; </div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; GLM_FUNC_DECL genType <a class="code" href="a00177.html#gabb6829a472da1cc94d88afa6396bed1f">sec</a>(genType <span class="keyword">const</span> &amp; <a class="code" href="a00175.html#gad4a4448baedb198b2b1e7880d2544dc9">angle</a>);</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt; </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; GLM_FUNC_DECL genType <a class="code" href="a00177.html#ga5df75de99f63e854087a06f538907b2c">csc</a>(genType <span class="keyword">const</span> &amp; <a class="code" href="a00175.html#gad4a4448baedb198b2b1e7880d2544dc9">angle</a>);</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt; </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; GLM_FUNC_DECL genType <a class="code" href="a00177.html#ga2f49e28c2634ae1a212e2fc38c42ad42">cot</a>(genType <span class="keyword">const</span> &amp; <a class="code" href="a00175.html#gad4a4448baedb198b2b1e7880d2544dc9">angle</a>);</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt; </div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; GLM_FUNC_DECL genType <a class="code" href="a00177.html#gac9761980e09149002a466ca131a4bcac">asec</a>(genType <span class="keyword">const</span> &amp; x);</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt; </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; GLM_FUNC_DECL genType <a class="code" href="a00177.html#ga135e8f6b36bb85b5f7d8067e6b890e4d">acsc</a>(genType <span class="keyword">const</span> &amp; x);</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; </div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt; </div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; GLM_FUNC_DECL genType <a class="code" href="a00177.html#ga97d029f989f849b62915b068c264246b">acot</a>(genType <span class="keyword">const</span> &amp; x);</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</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> genType&gt; </div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; GLM_FUNC_DECL genType <a class="code" href="a00177.html#gaaa698b992c63f454a3a1a1baa2773a3c">sech</a>(genType <span class="keyword">const</span> &amp; <a class="code" href="a00175.html#gad4a4448baedb198b2b1e7880d2544dc9">angle</a>);</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt; </div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; GLM_FUNC_DECL genType <a class="code" href="a00177.html#ga00404a9cdf62023792d1d0afedd7f896">csch</a>(genType <span class="keyword">const</span> &amp; <a class="code" href="a00175.html#gad4a4448baedb198b2b1e7880d2544dc9">angle</a>);</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; </div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt; </div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; GLM_FUNC_DECL genType <a class="code" href="a00177.html#gae2f1e6f7c360dda452b88e0c492d6f4d">coth</a>(genType <span class="keyword">const</span> &amp; <a class="code" href="a00175.html#gad4a4448baedb198b2b1e7880d2544dc9">angle</a>);</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt; </div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; GLM_FUNC_DECL genType <a class="code" href="a00177.html#ga450f3bf1c04751198994d26d92ac2a63">asech</a>(genType <span class="keyword">const</span> &amp; x);</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt; </div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; GLM_FUNC_DECL genType <a class="code" href="a00177.html#ga418b31539e1a69c262712f2c7a4f27eb">acsch</a>(genType <span class="keyword">const</span> &amp; x);</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; </div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt; </div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; GLM_FUNC_DECL genType <a class="code" href="a00177.html#gad73911994e6bb6a06cc3ea1bd89201ab">acoth</a>(genType <span class="keyword">const</span> &amp; x);</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;}<span class="comment">//namespace glm</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;<span class="preprocessor">#include &quot;reciprocal.inl&quot;</span></div>
<div class="ttc" id="a00177_html_gaaa698b992c63f454a3a1a1baa2773a3c"><div class="ttname"><a href="a00177.html#gaaa698b992c63f454a3a1a1baa2773a3c">glm::sech</a></div><div class="ttdeci">GLM_FUNC_DECL genType sech(genType const &amp;angle)</div><div class="ttdoc">Secant hyperbolic function. </div></div>
<div class="ttc" id="a00177_html_ga2f49e28c2634ae1a212e2fc38c42ad42"><div class="ttname"><a href="a00177.html#ga2f49e28c2634ae1a212e2fc38c42ad42">glm::cot</a></div><div class="ttdeci">GLM_FUNC_DECL genType cot(genType const &amp;angle)</div><div class="ttdoc">Cotangent function. </div></div>
<div class="ttc" id="a00177_html_ga00404a9cdf62023792d1d0afedd7f896"><div class="ttname"><a href="a00177.html#ga00404a9cdf62023792d1d0afedd7f896">glm::csch</a></div><div class="ttdeci">GLM_FUNC_DECL genType csch(genType const &amp;angle)</div><div class="ttdoc">Cosecant hyperbolic function. </div></div>
<div class="ttc" id="a00177_html_ga450f3bf1c04751198994d26d92ac2a63"><div class="ttname"><a href="a00177.html#ga450f3bf1c04751198994d26d92ac2a63">glm::asech</a></div><div class="ttdeci">GLM_FUNC_DECL genType asech(genType const &amp;x)</div><div class="ttdoc">Inverse secant hyperbolic function. </div></div>
<div class="ttc" id="a00177_html_gac9761980e09149002a466ca131a4bcac"><div class="ttname"><a href="a00177.html#gac9761980e09149002a466ca131a4bcac">glm::asec</a></div><div class="ttdeci">GLM_FUNC_DECL genType asec(genType const &amp;x)</div><div class="ttdoc">Inverse secant function. </div></div>
<div class="ttc" id="a00177_html_ga5df75de99f63e854087a06f538907b2c"><div class="ttname"><a href="a00177.html#ga5df75de99f63e854087a06f538907b2c">glm::csc</a></div><div class="ttdeci">GLM_FUNC_DECL genType csc(genType const &amp;angle)</div><div class="ttdoc">Cosecant function. </div></div>
<div class="ttc" id="a00146_html"><div class="ttname"><a href="a00146.html">glm</a></div><div class="ttdef"><b>Definition:</b> <a href="a00003_source.html#l00031">_noise.hpp:31</a></div></div>
<div class="ttc" id="a00177_html_gabb6829a472da1cc94d88afa6396bed1f"><div class="ttname"><a href="a00177.html#gabb6829a472da1cc94d88afa6396bed1f">glm::sec</a></div><div class="ttdeci">GLM_FUNC_DECL genType sec(genType const &amp;angle)</div><div class="ttdoc">Secant function. </div></div>
<div class="ttc" id="a00177_html_ga97d029f989f849b62915b068c264246b"><div class="ttname"><a href="a00177.html#ga97d029f989f849b62915b068c264246b">glm::acot</a></div><div class="ttdeci">GLM_FUNC_DECL genType acot(genType const &amp;x)</div><div class="ttdoc">Inverse cotangent function. </div></div>
<div class="ttc" id="a00177_html_gad73911994e6bb6a06cc3ea1bd89201ab"><div class="ttname"><a href="a00177.html#gad73911994e6bb6a06cc3ea1bd89201ab">glm::acoth</a></div><div class="ttdeci">GLM_FUNC_DECL genType acoth(genType const &amp;x)</div><div class="ttdoc">Inverse cotangent hyperbolic function. </div></div>
<div class="ttc" id="a00175_html_gad4a4448baedb198b2b1e7880d2544dc9"><div class="ttname"><a href="a00175.html#gad4a4448baedb198b2b1e7880d2544dc9">glm::angle</a></div><div class="ttdeci">GLM_FUNC_DECL T angle(tquat&lt; T, P &gt; const &amp;x)</div><div class="ttdoc">Returns the quaternion rotation angle. </div></div>
<div class="ttc" id="a00177_html_ga135e8f6b36bb85b5f7d8067e6b890e4d"><div class="ttname"><a href="a00177.html#ga135e8f6b36bb85b5f7d8067e6b890e4d">glm::acsc</a></div><div class="ttdeci">GLM_FUNC_DECL genType acsc(genType const &amp;x)</div><div class="ttdoc">Inverse cosecant function. </div></div>
<div class="ttc" id="a00177_html_ga418b31539e1a69c262712f2c7a4f27eb"><div class="ttname"><a href="a00177.html#ga418b31539e1a69c262712f2c7a4f27eb">glm::acsch</a></div><div class="ttdeci">GLM_FUNC_DECL genType acsch(genType const &amp;x)</div><div class="ttdoc">Inverse cosecant hyperbolic function. </div></div>
<div class="ttc" id="a00177_html_gae2f1e6f7c360dda452b88e0c492d6f4d"><div class="ttname"><a href="a00177.html#gae2f1e6f7c360dda452b88e0c492d6f4d">glm::coth</a></div><div class="ttdeci">GLM_FUNC_DECL genType coth(genType const &amp;angle)</div><div class="ttdoc">Cotangent hyperbolic function. </div></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="preprocessor">#pragma once</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="comment">// Dependency:</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="preprocessor">#include &quot;../glm.hpp&quot;</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="preprocessor">#include &quot;../gtc/epsilon.hpp&quot;</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="preprocessor">#include &quot;../gtc/quaternion.hpp&quot;</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="preprocessor">#if(defined(GLM_MESSAGES) &amp;&amp; !defined(GLM_EXT_INCLUDED))</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="preprocessor"># pragma message(&quot;GLM: GLM_GTX_rotate_normalized_axis extension included&quot;)</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="keyword">namespace </span><a class="code" href="a00145.html">glm</a></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;{</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; GLM_FUNC_DECL tmat4x4&lt;T, P&gt; <a class="code" href="a00224.html#ga6c00234d844faef36a6a94669fbd1639">rotateNormalizedAxis</a>(</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; tmat4x4&lt;T, P&gt; <span class="keyword">const</span> &amp; m,</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; T <span class="keyword">const</span> &amp; <a class="code" href="a00174.html#gad4a4448baedb198b2b1e7880d2544dc9">angle</a>,</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; <a class="code" href="a00174.html#ga0b3e87a13b2708154b72259e50789a19">axis</a>);</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</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> T, precision P&gt;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; GLM_FUNC_DECL tquat&lt;T, P&gt; <a class="code" href="a00224.html#ga6c00234d844faef36a6a94669fbd1639">rotateNormalizedAxis</a>(</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; tquat&lt;T, P&gt; <span class="keyword">const</span> &amp; q,</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; T <span class="keyword">const</span> &amp; <a class="code" href="a00174.html#gad4a4448baedb198b2b1e7880d2544dc9">angle</a>,</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; <a class="code" href="a00174.html#ga0b3e87a13b2708154b72259e50789a19">axis</a>);</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;}<span class="comment">//namespace glm</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;<span class="preprocessor">#include &quot;rotate_normalized_axis.inl&quot;</span></div>
<div class="ttc" id="a00174_html_ga0b3e87a13b2708154b72259e50789a19"><div class="ttname"><a href="a00174.html#ga0b3e87a13b2708154b72259e50789a19">glm::axis</a></div><div class="ttdeci">GLM_FUNC_DECL tvec3&lt; T, P &gt; axis(tquat&lt; T, P &gt; const &amp;x)</div><div class="ttdoc">Returns the q rotation axis. </div></div>
<div class="ttc" id="a00174_html_gad4a4448baedb198b2b1e7880d2544dc9"><div class="ttname"><a href="a00174.html#gad4a4448baedb198b2b1e7880d2544dc9">glm::angle</a></div><div class="ttdeci">GLM_FUNC_DECL T angle(tquat&lt; T, P &gt; const &amp;x)</div><div class="ttdoc">Returns the quaternion rotation angle. </div></div>
<div class="ttc" id="a00145_html"><div class="ttname"><a href="a00145.html">glm</a></div><div class="ttdef"><b>Definition:</b> <a href="a00003_source.html#l00039">_noise.hpp:39</a></div></div>
<div class="ttc" id="a00224_html_ga6c00234d844faef36a6a94669fbd1639"><div class="ttname"><a href="a00224.html#ga6c00234d844faef36a6a94669fbd1639">glm::rotateNormalizedAxis</a></div><div class="ttdeci">GLM_FUNC_DECL tquat&lt; T, P &gt; rotateNormalizedAxis(tquat&lt; T, P &gt; const &amp;q, T const &amp;angle, tvec3&lt; T, P &gt; const &amp;axis)</div><div class="ttdoc">Rotates a quaternion from a vector of 3 components normalized axis and an angle. </div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>