glm/doc/api-0.9.3/a00214.html

387 lines
16 KiB
HTML
Raw Normal View History

2011-10-24 14:24:48 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<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"/>
</head>
<body>
2011-11-12 23:26:02 +00:00
<!-- Generated by Doxygen 1.7.3 -->
2011-10-24 14:24:48 +00:00
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
2011-11-12 23:26:02 +00:00
<td id="projectlogo"><img alt="Logo" src="logo-mini.png"></td>
2011-10-24 14:24:48 +00:00
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
2011-11-12 23:26:02 +00:00
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
2011-10-24 14:24:48 +00:00
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
2011-11-12 23:26:02 +00:00
<h1>GLM_GTX_rotate_vector: Rotate vector</h1> </div>
<div class="ingroups"><a class="el" href="a00152.html">GTX Extensions (Experimental)</a></div></div>
2011-10-24 14:24:48 +00:00
<div class="contents">
<p>Function to directly rotate a vector.
2011-11-12 23:26:02 +00:00
<a href="#_details">More...</a></p>
2011-10-24 14:24:48 +00:00
<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>
2011-11-12 23:26:02 +00:00
<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>
2011-10-24 14:24:48 +00:00
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
2011-11-12 23:26:02 +00:00
<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>
2011-10-24 14:24:48 +00:00
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
2011-11-12 23:26:02 +00:00
<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>
2011-10-24 14:24:48 +00:00
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
2011-11-12 23:26:02 +00:00
<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>
2011-10-24 14:24:48 +00:00
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
2011-11-12 23:26:02 +00:00
<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>
2011-10-24 14:24:48 +00:00
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
2011-11-12 23:26:02 +00:00
<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>
2011-10-24 14:24:48 +00:00
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
2011-11-12 23:26:02 +00:00
<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>
2011-10-24 14:24:48 +00:00
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
2011-11-12 23:26:02 +00:00
<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>
2011-10-24 14:24:48 +00:00
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
2011-11-12 23:26:02 +00:00
<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>
2011-10-24 14:24:48 +00:00
<tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
2011-11-12 23:26:02 +00:00
<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>
2011-10-24 14:24:48 +00:00
</table>
2011-11-12 23:26:02 +00:00
<hr/><a name="_details"></a><h2>Detailed Description</h2>
2011-10-24 14:24:48 +00:00
<p>Function to directly rotate a vector. </p>
2011-11-12 23:26:02 +00:00
<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>
2011-10-24 14:24:48 +00:00
<hr/><h2>Function Documentation</h2>
2011-11-12 23:26:02 +00:00
<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)" -->
2011-10-24 14:24:48 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2011-11-12 23:26:02 +00:00
<td class="memname">detail::tmat4x4&lt;T&gt; glm::orientation </td>
2011-10-24 14:24:48 +00:00
<td>(</td>
<td class="paramtype">detail::tvec3&lt; T &gt; const &amp;&#160;</td>
<td class="paramname"><em>Normal</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>
2011-11-12 23:26:02 +00:00
<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)" -->
2011-10-24 14:24:48 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2011-11-12 23:26:02 +00:00
<td class="memname">detail::tvec2&lt;T&gt; glm::rotate </td>
2011-10-24 14:24:48 +00:00
<td>(</td>
<td class="paramtype">detail::tvec2&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 two dimensional vector. </p>
<p>From GLM_GTX_rotate_vector extension. </p>
</div>
</div>
2011-11-12 23:26:02 +00:00
<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)" -->
2011-10-24 14:24:48 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2011-11-12 23:26:02 +00:00
<td class="memname">detail::tvec3&lt;T&gt; glm::rotate </td>
2011-10-24 14:24:48 +00:00
<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="paramname"><em>normal</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 an axis. </p>
<p>From GLM_GTX_rotate_vector extension. </p>
</div>
</div>
2011-11-12 23:26:02 +00:00
<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)" -->
2011-10-24 14:24:48 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2011-11-12 23:26:02 +00:00
<td class="memname">detail::tvec4&lt;T&gt; glm::rotate </td>
2011-10-24 14:24:48 +00:00
<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>, </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>normal</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 an axis. </p>
<p>From GLM_GTX_rotate_vector extension. </p>
</div>
</div>
2011-11-12 23:26:02 +00:00
<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)" -->
2011-10-24 14:24:48 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2011-11-12 23:26:02 +00:00
<td class="memname">detail::tvec3&lt;T&gt; glm::rotateX </td>
2011-10-24 14:24:48 +00:00
<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>
2011-11-12 23:26:02 +00:00
<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)" -->
2011-10-24 14:24:48 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2011-11-12 23:26:02 +00:00
<td class="memname">detail::tvec4&lt;T&gt; glm::rotateX </td>
2011-10-24 14:24:48 +00:00
<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>
2011-11-12 23:26:02 +00:00
<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)" -->
2011-10-24 14:24:48 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2011-11-12 23:26:02 +00:00
<td class="memname">detail::tvec3&lt;T&gt; glm::rotateY </td>
2011-10-24 14:24:48 +00:00
<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>
2011-11-12 23:26:02 +00:00
<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)" -->
2011-10-24 14:24:48 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2011-11-12 23:26:02 +00:00
<td class="memname">detail::tvec4&lt;T&gt; glm::rotateY </td>
2011-10-24 14:24:48 +00:00
<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>
2011-11-12 23:26:02 +00:00
<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)" -->
2011-10-24 14:24:48 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2011-11-12 23:26:02 +00:00
<td class="memname">detail::tvec3&lt;T&gt; glm::rotateZ </td>
2011-10-24 14:24:48 +00:00
<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>
2011-11-12 23:26:02 +00:00
<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)" -->
2011-10-24 14:24:48 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2011-11-12 23:26:02 +00:00
<td class="memname">detail::tvec4&lt;T&gt; glm::rotateZ </td>
2011-10-24 14:24:48 +00:00
<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>
</div>
<hr class="footer"/><address class="footer"><small>Generated by&#160;
<a href="http://www.doxygen.org/index.html">
2011-11-12 23:26:02 +00:00
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
2011-10-24 14:24:48 +00:00
</body>
</html>