a00200.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <title>GLM_GTX_rotate_vector</title>
  7. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  8. <script type="text/javascript" src="jquery.js"></script>
  9. <script type="text/javascript" src="dynsections.js"></script>
  10. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  11. </head>
  12. <body>
  13. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  14. <div id="titlearea">
  15. <table cellspacing="0" cellpadding="0">
  16. <tbody>
  17. <tr style="height: 56px;">
  18. <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  19. </tr>
  20. </tbody>
  21. </table>
  22. </div>
  23. <!-- end header part -->
  24. <!-- Generated by Doxygen 1.8.2 -->
  25. <div id="navrow1" class="tabs">
  26. <ul class="tablist">
  27. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  28. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  29. <li><a href="modules.html"><span>Modules</span></a></li>
  30. <li><a href="files.html"><span>Files</span></a></li>
  31. </ul>
  32. </div>
  33. </div><!-- top -->
  34. <div class="header">
  35. <div class="summary">
  36. <a href="#func-members">Functions</a> </div>
  37. <div class="headertitle">
  38. <div class="title">GLM_GTX_rotate_vector</div> </div>
  39. <div class="ingroups"><a class="el" href="a00139.html">GTX Extensions (Experimental)</a></div></div><!--header-->
  40. <div class="contents">
  41. <table class="memberdecls">
  42. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  43. Functions</h2></td></tr>
  44. <tr class="memitem:ga4da5fddb2f1aa679fdb45abd344efffb"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  45. <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>
  46. <tr class="separator:ga4da5fddb2f1aa679fdb45abd344efffb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  47. <tr class="memitem:gab40685a29feeaa0b2ceb5b733421adcb"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  48. <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>
  49. <tr class="separator:gab40685a29feeaa0b2ceb5b733421adcb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  50. <tr class="memitem:gab556da0efabc9606f198f89a74cb1964"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  51. <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>
  52. <tr class="separator:gab556da0efabc9606f198f89a74cb1964"><td class="memSeparator" colspan="2">&#160;</td></tr>
  53. <tr class="memitem:ga6e2b5cddfb385e640dfcf1ae7769b910"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  54. <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>
  55. <tr class="separator:ga6e2b5cddfb385e640dfcf1ae7769b910"><td class="memSeparator" colspan="2">&#160;</td></tr>
  56. <tr class="memitem:gaaadca0c077515d56955f3c662a3a3c7f"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  57. <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>
  58. <tr class="separator:gaaadca0c077515d56955f3c662a3a3c7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  59. <tr class="memitem:ga5fb5ea6e3daf540f1445aea068f49eb1"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  60. <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>
  61. <tr class="separator:ga5fb5ea6e3daf540f1445aea068f49eb1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62. <tr class="memitem:gacffa0ae7f32f4e2ee7bc1dc0ed290d45"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  63. <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>
  64. <tr class="separator:gacffa0ae7f32f4e2ee7bc1dc0ed290d45"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. <tr class="memitem:ga869410096bb5a69f9b9a58708eadcbad"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  66. <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>
  67. <tr class="separator:ga869410096bb5a69f9b9a58708eadcbad"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="memitem:ga105c77751b4ab56c491334655751e0af"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  69. <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>
  70. <tr class="separator:ga105c77751b4ab56c491334655751e0af"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71. <tr class="memitem:ga6330788b96a0ec5e76ca3dd2892cca8c"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  72. <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>
  73. <tr class="separator:ga6330788b96a0ec5e76ca3dd2892cca8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. </table>
  75. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  76. <p>Function to directly rotate a vector. </p>
  77. <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>
  78. <h2 class="groupheader">Function Documentation</h2>
  79. <a class="anchor" id="ga4da5fddb2f1aa679fdb45abd344efffb"></a>
  80. <div class="memitem">
  81. <div class="memproto">
  82. <table class="memname">
  83. <tr>
  84. <td class="memname">detail::tmat4x4&lt;T&gt; glm::orientation </td>
  85. <td>(</td>
  86. <td class="paramtype">detail::tvec3&lt; T &gt; const &amp;&#160;</td>
  87. <td class="paramname"><em>Normal</em>, </td>
  88. </tr>
  89. <tr>
  90. <td class="paramkey"></td>
  91. <td></td>
  92. <td class="paramtype">detail::tvec3&lt; T &gt; const &amp;&#160;</td>
  93. <td class="paramname"><em>Up</em>&#160;</td>
  94. </tr>
  95. <tr>
  96. <td></td>
  97. <td>)</td>
  98. <td></td><td></td>
  99. </tr>
  100. </table>
  101. </div><div class="memdoc">
  102. <p>Build a rotation matrix from a normal and a up vector. </p>
  103. <p>From GLM_GTX_rotate_vector extension. </p>
  104. </div>
  105. </div>
  106. <a class="anchor" id="gab40685a29feeaa0b2ceb5b733421adcb"></a>
  107. <div class="memitem">
  108. <div class="memproto">
  109. <table class="memname">
  110. <tr>
  111. <td class="memname">detail::tvec2&lt;T&gt; glm::rotate </td>
  112. <td>(</td>
  113. <td class="paramtype">detail::tvec2&lt; T &gt; const &amp;&#160;</td>
  114. <td class="paramname"><em>v</em>, </td>
  115. </tr>
  116. <tr>
  117. <td class="paramkey"></td>
  118. <td></td>
  119. <td class="paramtype">T const &amp;&#160;</td>
  120. <td class="paramname"><em>angle</em>&#160;</td>
  121. </tr>
  122. <tr>
  123. <td></td>
  124. <td>)</td>
  125. <td></td><td></td>
  126. </tr>
  127. </table>
  128. </div><div class="memdoc">
  129. <p>Rotate a two dimensional vector. </p>
  130. <p>From GLM_GTX_rotate_vector extension. </p>
  131. </div>
  132. </div>
  133. <a class="anchor" id="gab556da0efabc9606f198f89a74cb1964"></a>
  134. <div class="memitem">
  135. <div class="memproto">
  136. <table class="memname">
  137. <tr>
  138. <td class="memname">detail::tvec3&lt;T&gt; glm::rotate </td>
  139. <td>(</td>
  140. <td class="paramtype">detail::tvec3&lt; T &gt; const &amp;&#160;</td>
  141. <td class="paramname"><em>v</em>, </td>
  142. </tr>
  143. <tr>
  144. <td class="paramkey"></td>
  145. <td></td>
  146. <td class="paramtype">T const &amp;&#160;</td>
  147. <td class="paramname"><em>angle</em>, </td>
  148. </tr>
  149. <tr>
  150. <td class="paramkey"></td>
  151. <td></td>
  152. <td class="paramtype">detail::tvec3&lt; T &gt; const &amp;&#160;</td>
  153. <td class="paramname"><em>normal</em>&#160;</td>
  154. </tr>
  155. <tr>
  156. <td></td>
  157. <td>)</td>
  158. <td></td><td></td>
  159. </tr>
  160. </table>
  161. </div><div class="memdoc">
  162. <p>Rotate a three dimensional vector around an axis. </p>
  163. <p>From GLM_GTX_rotate_vector extension. </p>
  164. </div>
  165. </div>
  166. <a class="anchor" id="ga6e2b5cddfb385e640dfcf1ae7769b910"></a>
  167. <div class="memitem">
  168. <div class="memproto">
  169. <table class="memname">
  170. <tr>
  171. <td class="memname">detail::tvec4&lt;T&gt; glm::rotate </td>
  172. <td>(</td>
  173. <td class="paramtype">detail::tvec4&lt; T &gt; const &amp;&#160;</td>
  174. <td class="paramname"><em>v</em>, </td>
  175. </tr>
  176. <tr>
  177. <td class="paramkey"></td>
  178. <td></td>
  179. <td class="paramtype">T const &amp;&#160;</td>
  180. <td class="paramname"><em>angle</em>, </td>
  181. </tr>
  182. <tr>
  183. <td class="paramkey"></td>
  184. <td></td>
  185. <td class="paramtype">detail::tvec3&lt; T &gt; const &amp;&#160;</td>
  186. <td class="paramname"><em>normal</em>&#160;</td>
  187. </tr>
  188. <tr>
  189. <td></td>
  190. <td>)</td>
  191. <td></td><td></td>
  192. </tr>
  193. </table>
  194. </div><div class="memdoc">
  195. <p>Rotate a four dimensional vector around an axis. </p>
  196. <p>From GLM_GTX_rotate_vector extension. </p>
  197. </div>
  198. </div>
  199. <a class="anchor" id="gaaadca0c077515d56955f3c662a3a3c7f"></a>
  200. <div class="memitem">
  201. <div class="memproto">
  202. <table class="memname">
  203. <tr>
  204. <td class="memname">detail::tvec3&lt;T&gt; glm::rotateX </td>
  205. <td>(</td>
  206. <td class="paramtype">detail::tvec3&lt; T &gt; const &amp;&#160;</td>
  207. <td class="paramname"><em>v</em>, </td>
  208. </tr>
  209. <tr>
  210. <td class="paramkey"></td>
  211. <td></td>
  212. <td class="paramtype">T const &amp;&#160;</td>
  213. <td class="paramname"><em>angle</em>&#160;</td>
  214. </tr>
  215. <tr>
  216. <td></td>
  217. <td>)</td>
  218. <td></td><td></td>
  219. </tr>
  220. </table>
  221. </div><div class="memdoc">
  222. <p>Rotate a three dimensional vector around the X axis. </p>
  223. <p>From GLM_GTX_rotate_vector extension. </p>
  224. </div>
  225. </div>
  226. <a class="anchor" id="ga5fb5ea6e3daf540f1445aea068f49eb1"></a>
  227. <div class="memitem">
  228. <div class="memproto">
  229. <table class="memname">
  230. <tr>
  231. <td class="memname">detail::tvec4&lt;T&gt; glm::rotateX </td>
  232. <td>(</td>
  233. <td class="paramtype">detail::tvec4&lt; T &gt; const &amp;&#160;</td>
  234. <td class="paramname"><em>v</em>, </td>
  235. </tr>
  236. <tr>
  237. <td class="paramkey"></td>
  238. <td></td>
  239. <td class="paramtype">T const &amp;&#160;</td>
  240. <td class="paramname"><em>angle</em>&#160;</td>
  241. </tr>
  242. <tr>
  243. <td></td>
  244. <td>)</td>
  245. <td></td><td></td>
  246. </tr>
  247. </table>
  248. </div><div class="memdoc">
  249. <p>Rotate a four dimentionnals vector around the X axis. </p>
  250. <p>From GLM_GTX_rotate_vector extension. </p>
  251. </div>
  252. </div>
  253. <a class="anchor" id="gacffa0ae7f32f4e2ee7bc1dc0ed290d45"></a>
  254. <div class="memitem">
  255. <div class="memproto">
  256. <table class="memname">
  257. <tr>
  258. <td class="memname">detail::tvec3&lt;T&gt; glm::rotateY </td>
  259. <td>(</td>
  260. <td class="paramtype">detail::tvec3&lt; T &gt; const &amp;&#160;</td>
  261. <td class="paramname"><em>v</em>, </td>
  262. </tr>
  263. <tr>
  264. <td class="paramkey"></td>
  265. <td></td>
  266. <td class="paramtype">T const &amp;&#160;</td>
  267. <td class="paramname"><em>angle</em>&#160;</td>
  268. </tr>
  269. <tr>
  270. <td></td>
  271. <td>)</td>
  272. <td></td><td></td>
  273. </tr>
  274. </table>
  275. </div><div class="memdoc">
  276. <p>Rotate a three dimensional vector around the Y axis. </p>
  277. <p>From GLM_GTX_rotate_vector extension. </p>
  278. </div>
  279. </div>
  280. <a class="anchor" id="ga869410096bb5a69f9b9a58708eadcbad"></a>
  281. <div class="memitem">
  282. <div class="memproto">
  283. <table class="memname">
  284. <tr>
  285. <td class="memname">detail::tvec4&lt;T&gt; glm::rotateY </td>
  286. <td>(</td>
  287. <td class="paramtype">detail::tvec4&lt; T &gt; const &amp;&#160;</td>
  288. <td class="paramname"><em>v</em>, </td>
  289. </tr>
  290. <tr>
  291. <td class="paramkey"></td>
  292. <td></td>
  293. <td class="paramtype">T const &amp;&#160;</td>
  294. <td class="paramname"><em>angle</em>&#160;</td>
  295. </tr>
  296. <tr>
  297. <td></td>
  298. <td>)</td>
  299. <td></td><td></td>
  300. </tr>
  301. </table>
  302. </div><div class="memdoc">
  303. <p>Rotate a four dimensional vector around the X axis. </p>
  304. <p>From GLM_GTX_rotate_vector extension. </p>
  305. </div>
  306. </div>
  307. <a class="anchor" id="ga105c77751b4ab56c491334655751e0af"></a>
  308. <div class="memitem">
  309. <div class="memproto">
  310. <table class="memname">
  311. <tr>
  312. <td class="memname">detail::tvec3&lt;T&gt; glm::rotateZ </td>
  313. <td>(</td>
  314. <td class="paramtype">detail::tvec3&lt; T &gt; const &amp;&#160;</td>
  315. <td class="paramname"><em>v</em>, </td>
  316. </tr>
  317. <tr>
  318. <td class="paramkey"></td>
  319. <td></td>
  320. <td class="paramtype">T const &amp;&#160;</td>
  321. <td class="paramname"><em>angle</em>&#160;</td>
  322. </tr>
  323. <tr>
  324. <td></td>
  325. <td>)</td>
  326. <td></td><td></td>
  327. </tr>
  328. </table>
  329. </div><div class="memdoc">
  330. <p>Rotate a three dimensional vector around the Z axis. </p>
  331. <p>From GLM_GTX_rotate_vector extension. </p>
  332. </div>
  333. </div>
  334. <a class="anchor" id="ga6330788b96a0ec5e76ca3dd2892cca8c"></a>
  335. <div class="memitem">
  336. <div class="memproto">
  337. <table class="memname">
  338. <tr>
  339. <td class="memname">detail::tvec4&lt;T&gt; glm::rotateZ </td>
  340. <td>(</td>
  341. <td class="paramtype">detail::tvec4&lt; T &gt; const &amp;&#160;</td>
  342. <td class="paramname"><em>v</em>, </td>
  343. </tr>
  344. <tr>
  345. <td class="paramkey"></td>
  346. <td></td>
  347. <td class="paramtype">T const &amp;&#160;</td>
  348. <td class="paramname"><em>angle</em>&#160;</td>
  349. </tr>
  350. <tr>
  351. <td></td>
  352. <td>)</td>
  353. <td></td><td></td>
  354. </tr>
  355. </table>
  356. </div><div class="memdoc">
  357. <p>Rotate a four dimensional vector around the X axis. </p>
  358. <p>From GLM_GTX_rotate_vector extension. </p>
  359. </div>
  360. </div>
  361. </div><!-- contents -->
  362. <!-- start footer part -->
  363. <hr class="footer"/><address class="footer"><small>
  364. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  365. <img class="footer" src="doxygen.png" alt="doxygen"/>
  366. </a> 1.8.2
  367. </small></address>
  368. </body>
  369. </html>