Updated API documentation

This commit is contained in:
Christophe Riccio
2016-09-11 12:44:33 +02:00
parent 9f0110f5b0
commit 454d480ceb
395 changed files with 58950 additions and 58068 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.10"/>
<title>0.9.7: matrix_interpolation.hpp Source File</title>
<title>0.9.8: mixed_product.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>
@@ -18,7 +18,7 @@
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">0.9.7
<div id="projectname">0.9.8
</div>
</td>
</tr>
@@ -46,53 +46,33 @@
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">matrix_interpolation.hpp</div> </div>
<div class="title">mixed_product.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="a00072.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="l00042"></a><span class="lineno"> 42</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="comment">// Dependency:</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="preprocessor">#include &quot;../glm.hpp&quot;</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="preprocessor">#if(defined(GLM_MESSAGES) &amp;&amp; !defined(GLM_EXT_INCLUDED))</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="preprocessor"># pragma message(&quot;GLM: GLM_GTX_matrix_interpolation extension included&quot;)</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="preprocessor">#endif</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="keyword">namespace </span><a class="code" href="a00146.html">glm</a></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;{</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; GLM_FUNC_DECL <span class="keywordtype">void</span> <a class="code" href="a00209.html#ga9aef292eb5f29bdbb58a53ef4281af92">axisAngle</a>(</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; tmat4x4&lt;T, P&gt; <span class="keyword">const</span> &amp; mat,</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; tvec3&lt;T, P&gt; &amp; <a class="code" href="a00177.html#ga0b3e87a13b2708154b72259e50789a19">axis</a>,</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; T &amp; <a class="code" href="a00177.html#gad4a4448baedb198b2b1e7880d2544dc9">angle</a>);</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; GLM_FUNC_DECL tmat4x4&lt;T, P&gt; <a class="code" href="a00209.html#ga82d4bc058e9628cb2ea1d4e117a0cf39">axisAngleMatrix</a>(</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; <a class="code" href="a00177.html#ga0b3e87a13b2708154b72259e50789a19">axis</a>,</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; T <span class="keyword">const</span> <a class="code" href="a00177.html#gad4a4448baedb198b2b1e7880d2544dc9">angle</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> T, precision P&gt;</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; GLM_FUNC_DECL tmat4x4&lt;T, P&gt; <a class="code" href="a00209.html#ga6b8170aa4cf43caf81400696ebb38afe">extractMatrixRotation</a>(</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; tmat4x4&lt;T, P&gt; <span class="keyword">const</span> &amp; mat);</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</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; GLM_FUNC_DECL tmat4x4&lt;T, P&gt; <a class="code" href="a00209.html#ga45099a92c5c704503565619ac2bcd5c6">interpolate</a>(</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; tmat4x4&lt;T, P&gt; <span class="keyword">const</span> &amp; m1,</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; tmat4x4&lt;T, P&gt; <span class="keyword">const</span> &amp; m2,</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; T <span class="keyword">const</span> delta);</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;}<span class="comment">//namespace glm</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;<span class="preprocessor">#include &quot;matrix_interpolation.inl&quot;</span></div>
<div class="ttc" id="a00209_html_ga6b8170aa4cf43caf81400696ebb38afe"><div class="ttname"><a href="a00209.html#ga6b8170aa4cf43caf81400696ebb38afe">glm::extractMatrixRotation</a></div><div class="ttdeci">GLM_FUNC_DECL tmat4x4&lt; T, P &gt; extractMatrixRotation(tmat4x4&lt; T, P &gt; const &amp;mat)</div><div class="ttdoc">Extracts the rotation part of a matrix. </div></div>
<div class="ttc" id="a00209_html_ga45099a92c5c704503565619ac2bcd5c6"><div class="ttname"><a href="a00209.html#ga45099a92c5c704503565619ac2bcd5c6">glm::interpolate</a></div><div class="ttdeci">GLM_FUNC_DECL tmat4x4&lt; T, P &gt; interpolate(tmat4x4&lt; T, P &gt; const &amp;m1, tmat4x4&lt; T, P &gt; const &amp;m2, T const delta)</div><div class="ttdoc">Build a interpolation of 4 * 4 matrixes. </div></div>
<div class="ttc" id="a00177_html_ga0b3e87a13b2708154b72259e50789a19"><div class="ttname"><a href="a00177.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="a00146_html"><div class="ttname"><a href="a00146.html">glm</a></div><div class="ttdef"><b>Definition:</b> <a href="a00003_source.html#l00040">_noise.hpp:40</a></div></div>
<div class="ttc" id="a00209_html_ga9aef292eb5f29bdbb58a53ef4281af92"><div class="ttname"><a href="a00209.html#ga9aef292eb5f29bdbb58a53ef4281af92">glm::axisAngle</a></div><div class="ttdeci">GLM_FUNC_DECL void axisAngle(tmat4x4&lt; T, P &gt; const &amp;mat, tvec3&lt; T, P &gt; &amp;axis, T &amp;angle)</div><div class="ttdoc">Get the axis and angle of the rotation from a matrix. </div></div>
<div class="ttc" id="a00177_html_gad4a4448baedb198b2b1e7880d2544dc9"><div class="ttname"><a href="a00177.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="a00209_html_ga82d4bc058e9628cb2ea1d4e117a0cf39"><div class="ttname"><a href="a00209.html#ga82d4bc058e9628cb2ea1d4e117a0cf39">glm::axisAngleMatrix</a></div><div class="ttdeci">GLM_FUNC_DECL tmat4x4&lt; T, P &gt; axisAngleMatrix(tvec3&lt; T, P &gt; const &amp;axis, T const angle)</div><div class="ttdoc">Build a matrix from axis and angle. </div></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">// Dependency:</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &quot;../glm.hpp&quot;</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#if GLM_MESSAGES == GLM_MESSAGES_ENABLED &amp;&amp; !defined(GLM_EXT_INCLUDED)</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor"># pragma message(&quot;GLM: GLM_GTX_mixed_product extension included&quot;)</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="keyword">namespace </span><a class="code" href="a00141.html">glm</a></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;{</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt; </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; GLM_FUNC_DECL T <a class="code" href="a00210.html#gaaee4cf80d69cb86de80f12af88b3c3af">mixedProduct</a>(</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; v1, </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; v2, </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; v3);</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;}<span class="comment">// namespace glm</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="preprocessor">#include &quot;mixed_product.inl&quot;</span></div>
<div class="ttc" id="a00141_html"><div class="ttname"><a href="a00141.html">glm</a></div><div class="ttdef"><b>Definition:</b> <a href="a00003_source.html#l00011">_noise.hpp:11</a></div></div>
<div class="ttc" id="a00210_html_gaaee4cf80d69cb86de80f12af88b3c3af"><div class="ttname"><a href="a00210.html#gaaee4cf80d69cb86de80f12af88b3c3af">glm::mixedProduct</a></div><div class="ttdeci">GLM_FUNC_DECL T mixedProduct(tvec3&lt; T, P &gt; const &amp;v1, tvec3&lt; T, P &gt; const &amp;v2, tvec3&lt; T, P &gt; const &amp;v3)</div><div class="ttdoc">Mixed product of 3 vectors (from GLM_GTX_mixed_product extension) </div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>