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>GLM_GTX_rotate_vector: Rotate vector</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>
@@ -32,41 +46,38 @@
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>GLM_GTX_rotate_vector: Rotate vector</h1> </div>
<div class="title">GLM_GTX_rotate_vector: Rotate vector</div> </div>
<div class="ingroups"><a class="el" href="a00152.html">GTX Extensions (Experimental)</a></div></div>
<div class="contents">
<p>Function to directly rotate a vector.
<a href="#_details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00214.html#gaa6c581760c3dd639c3dc12a06b5bacb8">orientation</a> (detail::tvec3&lt; T &gt; const &amp;Normal, detail::tvec3&lt; T &gt; const &amp;Up)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00214.html#ga4da5fddb2f1aa679fdb45abd344efffb">orientation</a> (detail::tvec3&lt; T &gt; const &amp;Normal, detail::tvec3&lt; T &gt; const &amp;Up)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec2&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00214.html#gabb907cf5a35208d39af91cd9f585c7d0">rotate</a> (detail::tvec2&lt; T &gt; const &amp;v, T const &amp;angle)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec2&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00214.html#gab40685a29feeaa0b2ceb5b733421adcb">rotate</a> (detail::tvec2&lt; T &gt; const &amp;v, T const &amp;angle)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00214.html#ga6c7b783238c75ced6c821c56ace7c93c">rotate</a> (detail::tvec3&lt; T &gt; const &amp;v, T const &amp;angle, detail::tvec3&lt; T &gt; const &amp;normal)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00214.html#gab556da0efabc9606f198f89a74cb1964">rotate</a> (detail::tvec3&lt; T &gt; const &amp;v, T const &amp;angle, detail::tvec3&lt; T &gt; const &amp;normal)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec4&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00214.html#ga0d75679a3e22646e367ac03d0aae6117">rotate</a> (detail::tvec4&lt; T &gt; const &amp;v, T const &amp;angle, detail::tvec3&lt; T &gt; const &amp;normal)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec4&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00214.html#ga6e2b5cddfb385e640dfcf1ae7769b910">rotate</a> (detail::tvec4&lt; T &gt; const &amp;v, T const &amp;angle, detail::tvec3&lt; T &gt; const &amp;normal)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00214.html#ga603375207c0acd76599464864e3ad905">rotateX</a> (detail::tvec3&lt; T &gt; const &amp;v, T const &amp;angle)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00214.html#gaaadca0c077515d56955f3c662a3a3c7f">rotateX</a> (detail::tvec3&lt; T &gt; const &amp;v, T const &amp;angle)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec4&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00214.html#ga971935f6aa8a3607e75da5709f72d7ab">rotateX</a> (detail::tvec4&lt; T &gt; const &amp;v, T const &amp;angle)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec4&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00214.html#ga5fb5ea6e3daf540f1445aea068f49eb1">rotateX</a> (detail::tvec4&lt; T &gt; const &amp;v, T const &amp;angle)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00214.html#gae67c9eb092464d784bcabb0f529686ce">rotateY</a> (detail::tvec3&lt; T &gt; const &amp;v, T const &amp;angle)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00214.html#gacffa0ae7f32f4e2ee7bc1dc0ed290d45">rotateY</a> (detail::tvec3&lt; T &gt; const &amp;v, T const &amp;angle)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec4&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00214.html#ga49f1ef74e6eb3659e12638513c2fb2e8">rotateY</a> (detail::tvec4&lt; T &gt; const &amp;v, T const &amp;angle)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec4&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00214.html#ga869410096bb5a69f9b9a58708eadcbad">rotateY</a> (detail::tvec4&lt; T &gt; const &amp;v, T const &amp;angle)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00214.html#gaf71baa2432e486d9f93511d649903a97">rotateZ</a> (detail::tvec3&lt; T &gt; const &amp;v, T const &amp;angle)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00214.html#ga105c77751b4ab56c491334655751e0af">rotateZ</a> (detail::tvec3&lt; T &gt; const &amp;v, T const &amp;angle)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec4&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00214.html#gabac6527a1ae9082b5f989194a5101af7">rotateZ</a> (detail::tvec4&lt; T &gt; const &amp;v, T const &amp;angle)</td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec4&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00214.html#ga6330788b96a0ec5e76ca3dd2892cca8c">rotateZ</a> (detail::tvec4&lt; T &gt; const &amp;v, T const &amp;angle)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>Function to directly rotate a vector. </p>
<p>&lt;<a class="el" href="a00097.html" title="OpenGL Mathematics (glm.g-truc.net)">glm/gtx/rotate_vector.hpp</a>&gt; need to be included to use these functionalities. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="gaa6c581760c3dd639c3dc12a06b5bacb8"></a><!-- doxytag: member="glm::orientation" ref="gaa6c581760c3dd639c3dc12a06b5bacb8" args="(detail::tvec3&lt; T &gt; const &amp;Normal, detail::tvec3&lt; T &gt; const &amp;Up)" -->
<a class="anchor" id="ga4da5fddb2f1aa679fdb45abd344efffb"></a><!-- doxytag: member="glm::orientation" ref="ga4da5fddb2f1aa679fdb45abd344efffb" args="(detail::tvec3&lt; T &gt; const &amp;Normal, detail::tvec3&lt; T &gt; const &amp;Up)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -96,7 +107,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="gabb907cf5a35208d39af91cd9f585c7d0"></a><!-- doxytag: member="glm::rotate" ref="gabb907cf5a35208d39af91cd9f585c7d0" args="(detail::tvec2&lt; T &gt; const &amp;v, T const &amp;angle)" -->
<a class="anchor" id="gab40685a29feeaa0b2ceb5b733421adcb"></a><!-- doxytag: member="glm::rotate" ref="gab40685a29feeaa0b2ceb5b733421adcb" args="(detail::tvec2&lt; T &gt; const &amp;v, T const &amp;angle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -126,7 +137,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="ga6c7b783238c75ced6c821c56ace7c93c"></a><!-- doxytag: member="glm::rotate" ref="ga6c7b783238c75ced6c821c56ace7c93c" args="(detail::tvec3&lt; T &gt; const &amp;v, T const &amp;angle, detail::tvec3&lt; T &gt; const &amp;normal)" -->
<a class="anchor" id="gab556da0efabc9606f198f89a74cb1964"></a><!-- doxytag: member="glm::rotate" ref="gab556da0efabc9606f198f89a74cb1964" args="(detail::tvec3&lt; T &gt; const &amp;v, T const &amp;angle, detail::tvec3&lt; T &gt; const &amp;normal)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -162,7 +173,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="ga0d75679a3e22646e367ac03d0aae6117"></a><!-- doxytag: member="glm::rotate" ref="ga0d75679a3e22646e367ac03d0aae6117" args="(detail::tvec4&lt; T &gt; const &amp;v, T const &amp;angle, detail::tvec3&lt; T &gt; const &amp;normal)" -->
<a class="anchor" id="ga6e2b5cddfb385e640dfcf1ae7769b910"></a><!-- doxytag: member="glm::rotate" ref="ga6e2b5cddfb385e640dfcf1ae7769b910" args="(detail::tvec4&lt; T &gt; const &amp;v, T const &amp;angle, detail::tvec3&lt; T &gt; const &amp;normal)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -198,7 +209,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="ga603375207c0acd76599464864e3ad905"></a><!-- doxytag: member="glm::rotateX" ref="ga603375207c0acd76599464864e3ad905" args="(detail::tvec3&lt; T &gt; const &amp;v, T const &amp;angle)" -->
<a class="anchor" id="gaaadca0c077515d56955f3c662a3a3c7f"></a><!-- doxytag: member="glm::rotateX" ref="gaaadca0c077515d56955f3c662a3a3c7f" args="(detail::tvec3&lt; T &gt; const &amp;v, T const &amp;angle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -228,7 +239,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="ga971935f6aa8a3607e75da5709f72d7ab"></a><!-- doxytag: member="glm::rotateX" ref="ga971935f6aa8a3607e75da5709f72d7ab" args="(detail::tvec4&lt; T &gt; const &amp;v, T const &amp;angle)" -->
<a class="anchor" id="ga5fb5ea6e3daf540f1445aea068f49eb1"></a><!-- doxytag: member="glm::rotateX" ref="ga5fb5ea6e3daf540f1445aea068f49eb1" args="(detail::tvec4&lt; T &gt; const &amp;v, T const &amp;angle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -258,7 +269,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="gae67c9eb092464d784bcabb0f529686ce"></a><!-- doxytag: member="glm::rotateY" ref="gae67c9eb092464d784bcabb0f529686ce" args="(detail::tvec3&lt; T &gt; const &amp;v, T const &amp;angle)" -->
<a class="anchor" id="gacffa0ae7f32f4e2ee7bc1dc0ed290d45"></a><!-- doxytag: member="glm::rotateY" ref="gacffa0ae7f32f4e2ee7bc1dc0ed290d45" args="(detail::tvec3&lt; T &gt; const &amp;v, T const &amp;angle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -288,7 +299,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="ga49f1ef74e6eb3659e12638513c2fb2e8"></a><!-- doxytag: member="glm::rotateY" ref="ga49f1ef74e6eb3659e12638513c2fb2e8" args="(detail::tvec4&lt; T &gt; const &amp;v, T const &amp;angle)" -->
<a class="anchor" id="ga869410096bb5a69f9b9a58708eadcbad"></a><!-- doxytag: member="glm::rotateY" ref="ga869410096bb5a69f9b9a58708eadcbad" args="(detail::tvec4&lt; T &gt; const &amp;v, T const &amp;angle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -318,7 +329,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="gaf71baa2432e486d9f93511d649903a97"></a><!-- doxytag: member="glm::rotateZ" ref="gaf71baa2432e486d9f93511d649903a97" args="(detail::tvec3&lt; T &gt; const &amp;v, T const &amp;angle)" -->
<a class="anchor" id="ga105c77751b4ab56c491334655751e0af"></a><!-- doxytag: member="glm::rotateZ" ref="ga105c77751b4ab56c491334655751e0af" args="(detail::tvec3&lt; T &gt; const &amp;v, T const &amp;angle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -348,7 +359,7 @@ Functions</h2></td></tr>
</div>
</div>
<a class="anchor" id="gabac6527a1ae9082b5f989194a5101af7"></a><!-- doxytag: member="glm::rotateZ" ref="gabac6527a1ae9082b5f989194a5101af7" args="(detail::tvec4&lt; T &gt; const &amp;v, T const &amp;angle)" -->
<a class="anchor" id="ga6330788b96a0ec5e76ca3dd2892cca8c"></a><!-- doxytag: member="glm::rotateZ" ref="ga6330788b96a0ec5e76ca3dd2892cca8c" args="(detail::tvec4&lt; T &gt; const &amp;v, T const &amp;angle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
@@ -379,8 +390,13 @@ Functions</h2></td></tr>
</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>