mewin/glm
1
0
Fork 0
Code Releases Activity

Updated API documentation

Browse Source
This commit is contained in:
Christophe Riccio
2013-12-25 23:48:55 +01:00
parent 792e5ff74f
commit fee3eddd37
459 changed files with 76100 additions and 48806 deletions
Download Patch File Download Diff File Expand all files Collapse all files

326
doc/api/a00200.html
View File

@@ -3,7 +3,8 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>GLM_GTX_rotate_vector</title>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>GLM: GLM_GTX_handed_coordinate_space</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>
@@ -15,18 +16,23 @@
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">GLM
&#160;<span id="projectnumber">0.9.5</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.2 -->
<!-- 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>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
@@ -35,125 +41,43 @@
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">GLM_GTX_rotate_vector</div> </div>
<div class="ingroups"><a class="el" href="a00139.html">GTX Extensions (Experimental)</a></div></div><!--header-->
<div class="title">GLM_GTX_handed_coordinate_space<div class="ingroups"><a class="el" href="a00165.html">GTX Extensions (Experimental)</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga4da5fddb2f1aa679fdb45abd344efffb"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga4da5fddb2f1aa679fdb45abd344efffb"><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00200.html#ga4da5fddb2f1aa679fdb45abd344efffb">orientation</a> (detail::tvec3&lt; T &gt; const &amp;Normal, detail::tvec3&lt; T &gt; const &amp;Up)</td></tr>
<tr class="separator:ga4da5fddb2f1aa679fdb45abd344efffb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab40685a29feeaa0b2ceb5b733421adcb"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:gab40685a29feeaa0b2ceb5b733421adcb"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec2&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00200.html#gab40685a29feeaa0b2ceb5b733421adcb">rotate</a> (detail::tvec2&lt; T &gt; const &amp;v, T const &amp;angle)</td></tr>
<tr class="separator:gab40685a29feeaa0b2ceb5b733421adcb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab556da0efabc9606f198f89a74cb1964"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:gab556da0efabc9606f198f89a74cb1964"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00200.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 class="separator:gab556da0efabc9606f198f89a74cb1964"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6e2b5cddfb385e640dfcf1ae7769b910"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga6e2b5cddfb385e640dfcf1ae7769b910"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec4&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00200.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 class="separator:ga6e2b5cddfb385e640dfcf1ae7769b910"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaaadca0c077515d56955f3c662a3a3c7f"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:gaaadca0c077515d56955f3c662a3a3c7f"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00200.html#gaaadca0c077515d56955f3c662a3a3c7f">rotateX</a> (detail::tvec3&lt; T &gt; const &amp;v, T const &amp;angle)</td></tr>
<tr class="separator:gaaadca0c077515d56955f3c662a3a3c7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5fb5ea6e3daf540f1445aea068f49eb1"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga5fb5ea6e3daf540f1445aea068f49eb1"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec4&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00200.html#ga5fb5ea6e3daf540f1445aea068f49eb1">rotateX</a> (detail::tvec4&lt; T &gt; const &amp;v, T const &amp;angle)</td></tr>
<tr class="separator:ga5fb5ea6e3daf540f1445aea068f49eb1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacffa0ae7f32f4e2ee7bc1dc0ed290d45"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:gacffa0ae7f32f4e2ee7bc1dc0ed290d45"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00200.html#gacffa0ae7f32f4e2ee7bc1dc0ed290d45">rotateY</a> (detail::tvec3&lt; T &gt; const &amp;v, T const &amp;angle)</td></tr>
<tr class="separator:gacffa0ae7f32f4e2ee7bc1dc0ed290d45"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga869410096bb5a69f9b9a58708eadcbad"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga869410096bb5a69f9b9a58708eadcbad"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec4&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00200.html#ga869410096bb5a69f9b9a58708eadcbad">rotateY</a> (detail::tvec4&lt; T &gt; const &amp;v, T const &amp;angle)</td></tr>
<tr class="separator:ga869410096bb5a69f9b9a58708eadcbad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga105c77751b4ab56c491334655751e0af"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga105c77751b4ab56c491334655751e0af"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00200.html#ga105c77751b4ab56c491334655751e0af">rotateZ</a> (detail::tvec3&lt; T &gt; const &amp;v, T const &amp;angle)</td></tr>
<tr class="separator:ga105c77751b4ab56c491334655751e0af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6330788b96a0ec5e76ca3dd2892cca8c"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ga6330788b96a0ec5e76ca3dd2892cca8c"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec4&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00200.html#ga6330788b96a0ec5e76ca3dd2892cca8c">rotateZ</a> (detail::tvec4&lt; T &gt; const &amp;v, T const &amp;angle)</td></tr>
<tr class="separator:ga6330788b96a0ec5e76ca3dd2892cca8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabce2601c792d8961aa495803a640e035"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:gabce2601c792d8961aa495803a640e035"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00200.html#gabce2601c792d8961aa495803a640e035">leftHanded</a> (detail::tvec3&lt; T, P &gt; const &amp;tangent, detail::tvec3&lt; T, P &gt; const &amp;binormal, detail::tvec3&lt; T, P &gt; const &amp;normal)</td></tr>
<tr class="separator:gabce2601c792d8961aa495803a640e035"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad06cdc63effdab6532f397b561f6de88"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
<tr class="memitem:gad06cdc63effdab6532f397b561f6de88"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00200.html#gad06cdc63effdab6532f397b561f6de88">rightHanded</a> (detail::tvec3&lt; T, P &gt; const &amp;tangent, detail::tvec3&lt; T, P &gt; const &amp;binormal, detail::tvec3&lt; T, P &gt; const &amp;normal)</td></tr>
<tr class="separator:gad06cdc63effdab6532f397b561f6de88"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Function to directly rotate a vector. </p>
<p>&lt;<a class="el" href="a00083.html" title="OpenGL Mathematics (glm.g-truc.net)">glm/gtx/rotate_vector.hpp</a>&gt; need to be included to use these functionalities. </p>
<p>To know if a set of three basis vectors defines a right or left-handed coordinate system. </p>
<p>&lt;glm/gtx/handed_coordinate_system.hpp&gt; need to be included to use these functionalities. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga4da5fddb2f1aa679fdb45abd344efffb"></a>
<a class="anchor" id="gabce2601c792d8961aa495803a640e035"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tmat4x4&lt;T&gt; glm::orientation </td>
<td class="memname">bool glm::leftHanded </td>
<td>(</td>
<td class="paramtype">detail::tvec3&lt; T &gt; const &amp;&#160;</td>
<td class="paramname"><em>Normal</em>, </td>
<td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>tangent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">detail::tvec3&lt; T &gt; const &amp;&#160;</td>
<td class="paramname"><em>Up</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Build a rotation matrix from a normal and a up vector. </p>
<p>From GLM_GTX_rotate_vector extension. </p>
</div>
</div>
<a class="anchor" id="gab40685a29feeaa0b2ceb5b733421adcb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tvec2&lt;T&gt; glm::rotate </td>
<td>(</td>
<td class="paramtype">detail::tvec2&lt; T &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em>, </td>
<td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>binormal</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>angle</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Rotate a two dimensional vector. </p>
<p>From GLM_GTX_rotate_vector extension. </p>
</div>
</div>
<a class="anchor" id="gab556da0efabc9606f198f89a74cb1964"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tvec3&lt;T&gt; glm::rotate </td>
<td>(</td>
<td class="paramtype">detail::tvec3&lt; T &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>angle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">detail::tvec3&lt; T &gt; const &amp;&#160;</td>
<td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>normal</em>&#160;</td>
</tr>
<tr>
@@ -164,31 +88,31 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Rotate a three dimensional vector around an axis. </p>
<p>From GLM_GTX_rotate_vector extension. </p>
<p>Return if a trihedron left handed or not. </p>
<p>From GLM_GTX_handed_coordinate_space extension. </p>
</div>
</div>
<a class="anchor" id="ga6e2b5cddfb385e640dfcf1ae7769b910"></a>
<a class="anchor" id="gad06cdc63effdab6532f397b561f6de88"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tvec4&lt;T&gt; glm::rotate </td>
<td class="memname">bool glm::rightHanded </td>
<td>(</td>
<td class="paramtype">detail::tvec4&lt; T &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em>, </td>
<td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>tangent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>angle</em>, </td>
<td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>binormal</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">detail::tvec3&lt; T &gt; const &amp;&#160;</td>
<td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
<td class="paramname"><em>normal</em>&#160;</td>
</tr>
<tr>
@@ -199,182 +123,8 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Rotate a four dimensional vector around an axis. </p>
<p>From GLM_GTX_rotate_vector extension. </p>
</div>
</div>
<a class="anchor" id="gaaadca0c077515d56955f3c662a3a3c7f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tvec3&lt;T&gt; glm::rotateX </td>
<td>(</td>
<td class="paramtype">detail::tvec3&lt; T &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>angle</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Rotate a three dimensional vector around the X axis. </p>
<p>From GLM_GTX_rotate_vector extension. </p>
</div>
</div>
<a class="anchor" id="ga5fb5ea6e3daf540f1445aea068f49eb1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tvec4&lt;T&gt; glm::rotateX </td>
<td>(</td>
<td class="paramtype">detail::tvec4&lt; T &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>angle</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Rotate a four dimentionnals vector around the X axis. </p>
<p>From GLM_GTX_rotate_vector extension. </p>
</div>
</div>
<a class="anchor" id="gacffa0ae7f32f4e2ee7bc1dc0ed290d45"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tvec3&lt;T&gt; glm::rotateY </td>
<td>(</td>
<td class="paramtype">detail::tvec3&lt; T &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>angle</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Rotate a three dimensional vector around the Y axis. </p>
<p>From GLM_GTX_rotate_vector extension. </p>
</div>
</div>
<a class="anchor" id="ga869410096bb5a69f9b9a58708eadcbad"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tvec4&lt;T&gt; glm::rotateY </td>
<td>(</td>
<td class="paramtype">detail::tvec4&lt; T &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>angle</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Rotate a four dimensional vector around the X axis. </p>
<p>From GLM_GTX_rotate_vector extension. </p>
</div>
</div>
<a class="anchor" id="ga105c77751b4ab56c491334655751e0af"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tvec3&lt;T&gt; glm::rotateZ </td>
<td>(</td>
<td class="paramtype">detail::tvec3&lt; T &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>angle</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Rotate a three dimensional vector around the Z axis. </p>
<p>From GLM_GTX_rotate_vector extension. </p>
</div>
</div>
<a class="anchor" id="ga6330788b96a0ec5e76ca3dd2892cca8c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">detail::tvec4&lt;T&gt; glm::rotateZ </td>
<td>(</td>
<td class="paramtype">detail::tvec4&lt; T &gt; const &amp;&#160;</td>
<td class="paramname"><em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T const &amp;&#160;</td>
<td class="paramname"><em>angle</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Rotate a four dimensional vector around the X axis. </p>
<p>From GLM_GTX_rotate_vector extension. </p>
<p>Return if a trihedron right handed or not. </p>
<p>From GLM_GTX_handed_coordinate_space extension. </p>
</div>
</div>
@@ -383,7 +133,7 @@ Functions</h2></td></tr>
<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.8.2
</a> 1.8.5
</small></address>
</body>
</html>