a00225.html 17 KB

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