Updated doxygen documentation

This commit is contained in:
Christophe Riccio
2011-12-07 14:50:15 +00:00
parent a3b5034d4e
commit f18ad6bf2e
389 changed files with 27429 additions and 14460 deletions

View File

@@ -2,22 +2,36 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>rotate_vector.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="top"><!-- do not remove this div! -->
<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-mini.png"/></td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
@@ -34,7 +48,7 @@
</div>
<div class="header">
<div class="headertitle">
<h1>rotate_vector.hpp</h1> </div>
<div class="title">rotate_vector.hpp</div> </div>
</div>
<div class="contents">
<a href="a00097.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001
@@ -79,8 +93,8 @@
<a name="l00040"></a>00040 <span class="preprocessor"></span><span class="preprocessor">#define GLM_GTX_rotate_vector GLM_VERSION</span>
<a name="l00041"></a>00041 <span class="preprocessor"></span>
<a name="l00042"></a>00042 <span class="comment">// Dependency:</span>
<a name="l00043"></a>00043 <span class="preprocessor">#include &quot;<a class="code" href="a00050.html" title="OpenGL Mathematics (glm.g-truc.net)">../glm.hpp</a>&quot;</span>
<a name="l00044"></a>00044 <span class="preprocessor">#include &quot;<a class="code" href="a00105.html" title="OpenGL Mathematics (glm.g-truc.net)">../gtx/transform.hpp</a>&quot;</span>
<a name="l00043"></a>00043 <span class="preprocessor">#include &quot;../glm.hpp&quot;</span>
<a name="l00044"></a>00044 <span class="preprocessor">#include &quot;../gtx/transform.hpp&quot;</span>
<a name="l00045"></a>00045
<a name="l00046"></a>00046 <span class="preprocessor">#if(defined(GLM_MESSAGES) &amp;&amp; !defined(glm_ext))</span>
<a name="l00047"></a>00047 <span class="preprocessor"></span><span class="preprocessor"># pragma message(&quot;GLM: GLM_GTX_rotate_vector extension included&quot;)</span>
@@ -90,54 +104,54 @@
<a name="l00051"></a>00051 {
<a name="l00054"></a>00054
<a name="l00057"></a>00057 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
<a name="l00058"></a>00058 detail::tvec2&lt;T&gt; <a class="code" href="a00162.html#ga6734e16a89f7c9ae2a5774bd86c0d79c" title="Builds a rotation 4 * 4 matrix created from an axis vector and an angle expressed in degrees...">rotate</a>(
<a name="l00058"></a>00058 detail::tvec2&lt;T&gt; <a class="code" href="a00162.html#gaacb9cbe8f93a8fef9dc3e25559df19c0" title="Builds a rotation 4 * 4 matrix created from an axis vector and an angle expressed in degrees...">rotate</a>(
<a name="l00059"></a>00059 detail::tvec2&lt;T&gt; <span class="keyword">const</span> &amp; v,
<a name="l00060"></a>00060 T <span class="keyword">const</span> &amp; <a class="code" href="a00210.html#ga9eb5d8efb18df5d24452ac826bb4af70" title="Returns the quaternion rotation angle.">angle</a>);
<a name="l00060"></a>00060 T <span class="keyword">const</span> &amp; <a class="code" href="a00210.html#ga69041d18bd8539fe82d6170932d28362" title="Returns the quaternion rotation angle.">angle</a>);
<a name="l00061"></a>00061
<a name="l00064"></a>00064 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
<a name="l00065"></a>00065 detail::tvec3&lt;T&gt; <a class="code" href="a00162.html#ga6734e16a89f7c9ae2a5774bd86c0d79c" title="Builds a rotation 4 * 4 matrix created from an axis vector and an angle expressed in degrees...">rotate</a>(
<a name="l00065"></a>00065 detail::tvec3&lt;T&gt; <a class="code" href="a00162.html#gaacb9cbe8f93a8fef9dc3e25559df19c0" title="Builds a rotation 4 * 4 matrix created from an axis vector and an angle expressed in degrees...">rotate</a>(
<a name="l00066"></a>00066 detail::tvec3&lt;T&gt; <span class="keyword">const</span> &amp; v,
<a name="l00067"></a>00067 T <span class="keyword">const</span> &amp; <a class="code" href="a00210.html#ga9eb5d8efb18df5d24452ac826bb4af70" title="Returns the quaternion rotation angle.">angle</a>,
<a name="l00067"></a>00067 T <span class="keyword">const</span> &amp; <a class="code" href="a00210.html#ga69041d18bd8539fe82d6170932d28362" title="Returns the quaternion rotation angle.">angle</a>,
<a name="l00068"></a>00068 detail::tvec3&lt;T&gt; <span class="keyword">const</span> &amp; normal);
<a name="l00069"></a>00069
<a name="l00072"></a>00072 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
<a name="l00073"></a>00073 detail::tvec4&lt;T&gt; <a class="code" href="a00162.html#ga6734e16a89f7c9ae2a5774bd86c0d79c" title="Builds a rotation 4 * 4 matrix created from an axis vector and an angle expressed in degrees...">rotate</a>(
<a name="l00073"></a>00073 detail::tvec4&lt;T&gt; <a class="code" href="a00162.html#gaacb9cbe8f93a8fef9dc3e25559df19c0" title="Builds a rotation 4 * 4 matrix created from an axis vector and an angle expressed in degrees...">rotate</a>(
<a name="l00074"></a>00074 detail::tvec4&lt;T&gt; <span class="keyword">const</span> &amp; v,
<a name="l00075"></a>00075 T <span class="keyword">const</span> &amp; <a class="code" href="a00210.html#ga9eb5d8efb18df5d24452ac826bb4af70" title="Returns the quaternion rotation angle.">angle</a>,
<a name="l00075"></a>00075 T <span class="keyword">const</span> &amp; <a class="code" href="a00210.html#ga69041d18bd8539fe82d6170932d28362" title="Returns the quaternion rotation angle.">angle</a>,
<a name="l00076"></a>00076 detail::tvec3&lt;T&gt; <span class="keyword">const</span> &amp; normal);
<a name="l00077"></a>00077
<a name="l00080"></a>00080 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
<a name="l00081"></a>00081 detail::tvec3&lt;T&gt; <a class="code" href="a00214.html#ga603375207c0acd76599464864e3ad905" title="Rotate a three dimensional vector around the X axis.">rotateX</a>(
<a name="l00081"></a>00081 detail::tvec3&lt;T&gt; <a class="code" href="a00214.html#gaaadca0c077515d56955f3c662a3a3c7f" title="Rotate a three dimensional vector around the X axis.">rotateX</a>(
<a name="l00082"></a>00082 detail::tvec3&lt;T&gt; <span class="keyword">const</span> &amp; v,
<a name="l00083"></a>00083 T <span class="keyword">const</span> &amp; <a class="code" href="a00210.html#ga9eb5d8efb18df5d24452ac826bb4af70" title="Returns the quaternion rotation angle.">angle</a>);
<a name="l00083"></a>00083 T <span class="keyword">const</span> &amp; <a class="code" href="a00210.html#ga69041d18bd8539fe82d6170932d28362" title="Returns the quaternion rotation angle.">angle</a>);
<a name="l00084"></a>00084
<a name="l00087"></a>00087 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
<a name="l00088"></a>00088 detail::tvec3&lt;T&gt; <a class="code" href="a00214.html#gae67c9eb092464d784bcabb0f529686ce" title="Rotate a three dimensional vector around the Y axis.">rotateY</a>(
<a name="l00088"></a>00088 detail::tvec3&lt;T&gt; <a class="code" href="a00214.html#gacffa0ae7f32f4e2ee7bc1dc0ed290d45" title="Rotate a three dimensional vector around the Y axis.">rotateY</a>(
<a name="l00089"></a>00089 detail::tvec3&lt;T&gt; <span class="keyword">const</span> &amp; v,
<a name="l00090"></a>00090 T <span class="keyword">const</span> &amp; <a class="code" href="a00210.html#ga9eb5d8efb18df5d24452ac826bb4af70" title="Returns the quaternion rotation angle.">angle</a>);
<a name="l00090"></a>00090 T <span class="keyword">const</span> &amp; <a class="code" href="a00210.html#ga69041d18bd8539fe82d6170932d28362" title="Returns the quaternion rotation angle.">angle</a>);
<a name="l00091"></a>00091
<a name="l00094"></a>00094 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
<a name="l00095"></a>00095 detail::tvec3&lt;T&gt; <a class="code" href="a00214.html#gaf71baa2432e486d9f93511d649903a97" title="Rotate a three dimensional vector around the Z axis.">rotateZ</a>(
<a name="l00095"></a>00095 detail::tvec3&lt;T&gt; <a class="code" href="a00214.html#ga105c77751b4ab56c491334655751e0af" title="Rotate a three dimensional vector around the Z axis.">rotateZ</a>(
<a name="l00096"></a>00096 detail::tvec3&lt;T&gt; <span class="keyword">const</span> &amp; v,
<a name="l00097"></a>00097 T <span class="keyword">const</span> &amp; <a class="code" href="a00210.html#ga9eb5d8efb18df5d24452ac826bb4af70" title="Returns the quaternion rotation angle.">angle</a>);
<a name="l00097"></a>00097 T <span class="keyword">const</span> &amp; <a class="code" href="a00210.html#ga69041d18bd8539fe82d6170932d28362" title="Returns the quaternion rotation angle.">angle</a>);
<a name="l00098"></a>00098
<a name="l00101"></a>00101 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
<a name="l00102"></a>00102 detail::tvec4&lt;T&gt; <a class="code" href="a00214.html#ga603375207c0acd76599464864e3ad905" title="Rotate a three dimensional vector around the X axis.">rotateX</a>(
<a name="l00102"></a>00102 detail::tvec4&lt;T&gt; <a class="code" href="a00214.html#gaaadca0c077515d56955f3c662a3a3c7f" title="Rotate a three dimensional vector around the X axis.">rotateX</a>(
<a name="l00103"></a>00103 detail::tvec4&lt;T&gt; <span class="keyword">const</span> &amp; v,
<a name="l00104"></a>00104 T <span class="keyword">const</span> &amp; <a class="code" href="a00210.html#ga9eb5d8efb18df5d24452ac826bb4af70" title="Returns the quaternion rotation angle.">angle</a>);
<a name="l00104"></a>00104 T <span class="keyword">const</span> &amp; <a class="code" href="a00210.html#ga69041d18bd8539fe82d6170932d28362" title="Returns the quaternion rotation angle.">angle</a>);
<a name="l00105"></a>00105
<a name="l00108"></a>00108 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
<a name="l00109"></a>00109 detail::tvec4&lt;T&gt; <a class="code" href="a00214.html#gae67c9eb092464d784bcabb0f529686ce" title="Rotate a three dimensional vector around the Y axis.">rotateY</a>(
<a name="l00109"></a>00109 detail::tvec4&lt;T&gt; <a class="code" href="a00214.html#gacffa0ae7f32f4e2ee7bc1dc0ed290d45" title="Rotate a three dimensional vector around the Y axis.">rotateY</a>(
<a name="l00110"></a>00110 detail::tvec4&lt;T&gt; <span class="keyword">const</span> &amp; v,
<a name="l00111"></a>00111 T <span class="keyword">const</span> &amp; <a class="code" href="a00210.html#ga9eb5d8efb18df5d24452ac826bb4af70" title="Returns the quaternion rotation angle.">angle</a>);
<a name="l00111"></a>00111 T <span class="keyword">const</span> &amp; <a class="code" href="a00210.html#ga69041d18bd8539fe82d6170932d28362" title="Returns the quaternion rotation angle.">angle</a>);
<a name="l00112"></a>00112
<a name="l00115"></a>00115 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
<a name="l00116"></a>00116 detail::tvec4&lt;T&gt; <a class="code" href="a00214.html#gaf71baa2432e486d9f93511d649903a97" title="Rotate a three dimensional vector around the Z axis.">rotateZ</a>(
<a name="l00116"></a>00116 detail::tvec4&lt;T&gt; <a class="code" href="a00214.html#ga105c77751b4ab56c491334655751e0af" title="Rotate a three dimensional vector around the Z axis.">rotateZ</a>(
<a name="l00117"></a>00117 detail::tvec4&lt;T&gt; <span class="keyword">const</span> &amp; v,
<a name="l00118"></a>00118 T <span class="keyword">const</span> &amp; <a class="code" href="a00210.html#ga9eb5d8efb18df5d24452ac826bb4af70" title="Returns the quaternion rotation angle.">angle</a>);
<a name="l00118"></a>00118 T <span class="keyword">const</span> &amp; <a class="code" href="a00210.html#ga69041d18bd8539fe82d6170932d28362" title="Returns the quaternion rotation angle.">angle</a>);
<a name="l00119"></a>00119
<a name="l00122"></a>00122 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
<a name="l00123"></a>00123 detail::tmat4x4&lt;T&gt; <a class="code" href="a00214.html#gaa6c581760c3dd639c3dc12a06b5bacb8" title="Build a rotation matrix from a normal and a up vector.">orientation</a>(
<a name="l00123"></a>00123 detail::tmat4x4&lt;T&gt; <a class="code" href="a00214.html#ga4da5fddb2f1aa679fdb45abd344efffb" title="Build a rotation matrix from a normal and a up vector.">orientation</a>(
<a name="l00124"></a>00124 detail::tvec3&lt;T&gt; <span class="keyword">const</span> &amp; Normal,
<a name="l00125"></a>00125 detail::tvec3&lt;T&gt; <span class="keyword">const</span> &amp; Up);
<a name="l00126"></a>00126
@@ -148,8 +162,13 @@
<a name="l00132"></a>00132 <span class="preprocessor">#endif//GLM_GTX_rotate_vector</span>
</pre></div></div>
</div>
<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.7.3 </small></address>
<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.7.5
</small></address>
</body>
</html>