a00286.html 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766
  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. <title>GLM_GTX_quaternion: Extented quaternion types and functions</title>
  6. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  7. <link href="doxygen.css" rel="stylesheet" type="text/css"/>
  8. </head>
  9. <body>
  10. <!-- Generated by Doxygen 1.7.4 -->
  11. <div id="top">
  12. <div id="titlearea">
  13. <table cellspacing="0" cellpadding="0">
  14. <tbody>
  15. <tr style="height: 56px;">
  16. <td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
  17. </tr>
  18. </tbody>
  19. </table>
  20. </div>
  21. <div id="navrow1" class="tabs">
  22. <ul class="tablist">
  23. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  24. <li><a href="modules.html"><span>Modules</span></a></li>
  25. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  26. <li><a href="annotated.html"><span>Classes</span></a></li>
  27. <li><a href="files.html"><span>Files</span></a></li>
  28. </ul>
  29. </div>
  30. </div>
  31. <div class="header">
  32. <div class="summary">
  33. <a href="#func-members">Functions</a> </div>
  34. <div class="headertitle">
  35. <div class="title">GLM_GTX_quaternion: Extented quaternion types and functions</div> </div>
  36. <div class="ingroups"><a class="el" href="a00248.html">GTX Extensions (Experimental)</a></div></div>
  37. <div class="contents">
  38. <p>Extented quaternion types and functions.
  39. <a href="#details">More...</a></p>
  40. <table class="memberdecls">
  41. <tr><td colspan="2"><h2><a name="func-members"></a>
  42. Functions</h2></td></tr>
  43. <tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  44. <tr><td class="memTemplItemLeft" align="right" valign="top">valType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00286.html#ga6a3387a7d60728f60d86546b2f4d4d30">angle</a> (detail::tquat&lt; valType &gt; const &amp;x)</td></tr>
  45. <tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  46. <tr><td class="memTemplItemLeft" align="right" valign="top">detail::tquat&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00286.html#ga4412b01c376d9cfc9cc06b2d511d0f16">angleAxis</a> (valType const &amp;angle, valType const &amp;x, valType const &amp;y, valType const &amp;z)</td></tr>
  47. <tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  48. <tr><td class="memTemplItemLeft" align="right" valign="top">detail::tquat&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00286.html#gaac770715e5e3dc93f48c6634b59efd43">angleAxis</a> (valType const &amp;angle, detail::tvec3&lt; valType &gt; const &amp;axis)</td></tr>
  49. <tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  50. <tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00286.html#ga6dd1904e2a6cc8e54bd324994094a6f9">axis</a> (detail::tquat&lt; valType &gt; const &amp;x)</td></tr>
  51. <tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  52. <tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00286.html#ga2a222a07e879ab25de36d6b5a8f6610d">cross</a> (detail::tquat&lt; valType &gt; const &amp;q, detail::tvec3&lt; valType &gt; const &amp;v)</td></tr>
  53. <tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  54. <tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00286.html#ga07cefaf434b895aa6a1841837f0c106d">cross</a> (detail::tvec3&lt; valType &gt; const &amp;v, detail::tquat&lt; valType &gt; const &amp;q)</td></tr>
  55. <tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  56. <tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00286.html#ga39be27be43d9f80ce5bfc5e1adf21412">eulerAngles</a> (detail::tquat&lt; valType &gt; const &amp;x)</td></tr>
  57. <tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  58. <tr><td class="memTemplItemLeft" align="right" valign="top">detail::tquat&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00286.html#gaed2302270ec468d26de745516ccb5d4b">exp</a> (detail::tquat&lt; valType &gt; const &amp;q, valType const &amp;exponent)</td></tr>
  59. <tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  60. <tr><td class="memTemplItemLeft" align="right" valign="top">valType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00286.html#ga23eb8e1aeaf751f7cc46fbaa291e223d">extractRealComponent</a> (detail::tquat&lt; valType &gt; const &amp;q)</td></tr>
  61. <tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  62. <tr><td class="memTemplItemLeft" align="right" valign="top">detail::tquat&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00286.html#ga65d5734ce29049d334992f6a59e27e58">fastMix</a> (detail::tquat&lt; T &gt; const &amp;x, detail::tquat&lt; T &gt; const &amp;y, T const &amp;a)</td></tr>
  63. <tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  64. <tr><td class="memTemplItemLeft" align="right" valign="top">detail::tquat&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00286.html#gaa15c443e97ac7476d04627d868995891">intermediate</a> (detail::tquat&lt; valType &gt; const &amp;prev, detail::tquat&lt; valType &gt; const &amp;curr, detail::tquat&lt; valType &gt; const &amp;next)</td></tr>
  65. <tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  66. <tr><td class="memTemplItemLeft" align="right" valign="top">detail::tquat&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00286.html#ga11af1897310ec8a09210fb7b4deb0027">log</a> (detail::tquat&lt; valType &gt; const &amp;q)</td></tr>
  67. <tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  68. <tr><td class="memTemplItemLeft" align="right" valign="top">valType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00286.html#gafad23e37f1723bbbbd7f9498cd729126">pitch</a> (detail::tquat&lt; valType &gt; const &amp;x)</td></tr>
  69. <tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  70. <tr><td class="memTemplItemLeft" align="right" valign="top">detail::tquat&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00286.html#ga42873121534327c9e5238f3ca3d6cd03">pow</a> (detail::tquat&lt; valType &gt; const &amp;x, valType const &amp;y)</td></tr>
  71. <tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  72. <tr><td class="memTemplItemLeft" align="right" valign="top">valType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00286.html#ga60a4f955b2836d85f3d21ded84879926">roll</a> (detail::tquat&lt; valType &gt; const &amp;x)</td></tr>
  73. <tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  74. <tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00286.html#ga7f163c787898b76dc1d91eb48523ce87">rotate</a> (detail::tquat&lt; valType &gt; const &amp;q, detail::tvec3&lt; valType &gt; const &amp;v)</td></tr>
  75. <tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  76. <tr><td class="memTemplItemLeft" align="right" valign="top">detail::tvec4&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00286.html#ga92cb29907ffd24771d31f06c94e6d166">rotate</a> (detail::tquat&lt; valType &gt; const &amp;q, detail::tvec4&lt; valType &gt; const &amp;v)</td></tr>
  77. <tr><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  78. <tr><td class="memTemplItemLeft" align="right" valign="top">detail::tquat&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00286.html#ga22566896a998311431a0612e1c222002">shortMix</a> (detail::tquat&lt; T &gt; const &amp;x, detail::tquat&lt; T &gt; const &amp;y, T const &amp;a)</td></tr>
  79. <tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  80. <tr><td class="memTemplItemLeft" align="right" valign="top">detail::tquat&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00286.html#ga203b736245b7519eb151ac46e0bf7f21">squad</a> (detail::tquat&lt; valType &gt; const &amp;q1, detail::tquat&lt; valType &gt; const &amp;q2, detail::tquat&lt; valType &gt; const &amp;s1, detail::tquat&lt; valType &gt; const &amp;s2, valType const &amp;h)</td></tr>
  81. <tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  82. <tr><td class="memTemplItemLeft" align="right" valign="top">detail::tmat3x3&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00286.html#ga61ec971322157330116a3aefe5bae609">toMat3</a> (detail::tquat&lt; valType &gt; const &amp;x)</td></tr>
  83. <tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  84. <tr><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00286.html#ga80622343bd7ccf43c9b4cb677ba3ce38">toMat4</a> (detail::tquat&lt; valType &gt; const &amp;x)</td></tr>
  85. <tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  86. <tr><td class="memTemplItemLeft" align="right" valign="top">detail::tquat&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00286.html#ga2d9d1916258d13bd5f0373341400f18c">toQuat</a> (detail::tmat4x4&lt; valType &gt; const &amp;x)</td></tr>
  87. <tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  88. <tr><td class="memTemplItemLeft" align="right" valign="top">detail::tquat&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00286.html#ga991e534718ab690ff21e201f27bfd43b">toQuat</a> (detail::tmat3x3&lt; valType &gt; const &amp;x)</td></tr>
  89. <tr><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  90. <tr><td class="memTemplItemLeft" align="right" valign="top">valType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00286.html#ga4795f1cc522d82d672f7be9a405583c4">yaw</a> (detail::tquat&lt; valType &gt; const &amp;x)</td></tr>
  91. </table>
  92. <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
  93. <p>Extented quaternion types and functions. </p>
  94. <p>&lt;<a class="el" href="a00095_source.html">glm/gtx/quaternion.hpp</a>&gt; need to be included to use these functionalities. </p>
  95. <hr/><h2>Function Documentation</h2>
  96. <a class="anchor" id="ga6a3387a7d60728f60d86546b2f4d4d30"></a><!-- doxytag: member="glm::gtx::quaternion::angle" ref="ga6a3387a7d60728f60d86546b2f4d4d30" args="(detail::tquat&lt; valType &gt; const &amp;x)" -->
  97. <div class="memitem">
  98. <div class="memproto">
  99. <table class="memname">
  100. <tr>
  101. <td class="memname">valType glm::gtx::quaternion::angle </td>
  102. <td>(</td>
  103. <td class="paramtype">detail::tquat&lt; valType &gt; const &amp;&#160;</td>
  104. <td class="paramname"><em>x</em></td><td>)</td>
  105. <td></td>
  106. </tr>
  107. </table>
  108. </div>
  109. <div class="memdoc">
  110. <p>Returns the quaternion rotation angle. </p>
  111. <p>From GLM_GTX_quaternion extension. </p>
  112. </div>
  113. </div>
  114. <a class="anchor" id="ga4412b01c376d9cfc9cc06b2d511d0f16"></a><!-- doxytag: member="glm::gtx::quaternion::angleAxis" ref="ga4412b01c376d9cfc9cc06b2d511d0f16" args="(valType const &amp;angle, valType const &amp;x, valType const &amp;y, valType const &amp;z)" -->
  115. <div class="memitem">
  116. <div class="memproto">
  117. <table class="memname">
  118. <tr>
  119. <td class="memname">detail::tquat&lt;valType&gt; glm::gtx::quaternion::angleAxis </td>
  120. <td>(</td>
  121. <td class="paramtype">valType const &amp;&#160;</td>
  122. <td class="paramname"><em>angle</em>, </td>
  123. </tr>
  124. <tr>
  125. <td class="paramkey"></td>
  126. <td></td>
  127. <td class="paramtype">valType const &amp;&#160;</td>
  128. <td class="paramname"><em>x</em>, </td>
  129. </tr>
  130. <tr>
  131. <td class="paramkey"></td>
  132. <td></td>
  133. <td class="paramtype">valType const &amp;&#160;</td>
  134. <td class="paramname"><em>y</em>, </td>
  135. </tr>
  136. <tr>
  137. <td class="paramkey"></td>
  138. <td></td>
  139. <td class="paramtype">valType const &amp;&#160;</td>
  140. <td class="paramname"><em>z</em>&#160;</td>
  141. </tr>
  142. <tr>
  143. <td></td>
  144. <td>)</td>
  145. <td></td><td></td>
  146. </tr>
  147. </table>
  148. </div>
  149. <div class="memdoc">
  150. <p>Build a quaternion from an angle and a normalized axis. </p>
  151. <p>From GLM_GTX_quaternion extension. </p>
  152. </div>
  153. </div>
  154. <a class="anchor" id="gaac770715e5e3dc93f48c6634b59efd43"></a><!-- doxytag: member="glm::gtx::quaternion::angleAxis" ref="gaac770715e5e3dc93f48c6634b59efd43" args="(valType const &amp;angle, detail::tvec3&lt; valType &gt; const &amp;axis)" -->
  155. <div class="memitem">
  156. <div class="memproto">
  157. <table class="memname">
  158. <tr>
  159. <td class="memname">detail::tquat&lt;valType&gt; glm::gtx::quaternion::angleAxis </td>
  160. <td>(</td>
  161. <td class="paramtype">valType const &amp;&#160;</td>
  162. <td class="paramname"><em>angle</em>, </td>
  163. </tr>
  164. <tr>
  165. <td class="paramkey"></td>
  166. <td></td>
  167. <td class="paramtype">detail::tvec3&lt; valType &gt; const &amp;&#160;</td>
  168. <td class="paramname"><em>axis</em>&#160;</td>
  169. </tr>
  170. <tr>
  171. <td></td>
  172. <td>)</td>
  173. <td></td><td></td>
  174. </tr>
  175. </table>
  176. </div>
  177. <div class="memdoc">
  178. <p>Build a quaternion from an angle and a normalized axis. </p>
  179. <p>From GLM_GTX_quaternion extension. </p>
  180. </div>
  181. </div>
  182. <a class="anchor" id="ga6dd1904e2a6cc8e54bd324994094a6f9"></a><!-- doxytag: member="glm::gtx::quaternion::axis" ref="ga6dd1904e2a6cc8e54bd324994094a6f9" args="(detail::tquat&lt; valType &gt; const &amp;x)" -->
  183. <div class="memitem">
  184. <div class="memproto">
  185. <table class="memname">
  186. <tr>
  187. <td class="memname">detail::tvec3&lt;valType&gt; glm::gtx::quaternion::axis </td>
  188. <td>(</td>
  189. <td class="paramtype">detail::tquat&lt; valType &gt; const &amp;&#160;</td>
  190. <td class="paramname"><em>x</em></td><td>)</td>
  191. <td></td>
  192. </tr>
  193. </table>
  194. </div>
  195. <div class="memdoc">
  196. <p>Returns the q rotation axis. </p>
  197. <p>From GLM_GTX_quaternion extension. </p>
  198. </div>
  199. </div>
  200. <a class="anchor" id="ga2a222a07e879ab25de36d6b5a8f6610d"></a><!-- doxytag: member="glm::gtx::quaternion::cross" ref="ga2a222a07e879ab25de36d6b5a8f6610d" args="(detail::tquat&lt; valType &gt; const &amp;q, detail::tvec3&lt; valType &gt; const &amp;v)" -->
  201. <div class="memitem">
  202. <div class="memproto">
  203. <table class="memname">
  204. <tr>
  205. <td class="memname">detail::tvec3&lt;valType&gt; glm::gtx::quaternion::cross </td>
  206. <td>(</td>
  207. <td class="paramtype">detail::tquat&lt; valType &gt; const &amp;&#160;</td>
  208. <td class="paramname"><em>q</em>, </td>
  209. </tr>
  210. <tr>
  211. <td class="paramkey"></td>
  212. <td></td>
  213. <td class="paramtype">detail::tvec3&lt; valType &gt; const &amp;&#160;</td>
  214. <td class="paramname"><em>v</em>&#160;</td>
  215. </tr>
  216. <tr>
  217. <td></td>
  218. <td>)</td>
  219. <td></td><td></td>
  220. </tr>
  221. </table>
  222. </div>
  223. <div class="memdoc">
  224. <p>Compute a cross product between a quaternion and a vector. </p>
  225. <p>From GLM_GTX_quaternion extension. </p>
  226. </div>
  227. </div>
  228. <a class="anchor" id="ga07cefaf434b895aa6a1841837f0c106d"></a><!-- doxytag: member="glm::gtx::quaternion::cross" ref="ga07cefaf434b895aa6a1841837f0c106d" args="(detail::tvec3&lt; valType &gt; const &amp;v, detail::tquat&lt; valType &gt; const &amp;q)" -->
  229. <div class="memitem">
  230. <div class="memproto">
  231. <table class="memname">
  232. <tr>
  233. <td class="memname">detail::tvec3&lt;valType&gt; glm::gtx::quaternion::cross </td>
  234. <td>(</td>
  235. <td class="paramtype">detail::tvec3&lt; valType &gt; const &amp;&#160;</td>
  236. <td class="paramname"><em>v</em>, </td>
  237. </tr>
  238. <tr>
  239. <td class="paramkey"></td>
  240. <td></td>
  241. <td class="paramtype">detail::tquat&lt; valType &gt; const &amp;&#160;</td>
  242. <td class="paramname"><em>q</em>&#160;</td>
  243. </tr>
  244. <tr>
  245. <td></td>
  246. <td>)</td>
  247. <td></td><td></td>
  248. </tr>
  249. </table>
  250. </div>
  251. <div class="memdoc">
  252. <p>Compute a cross product between a vector and a quaternion. </p>
  253. <p>From GLM_GTX_quaternion extension. </p>
  254. </div>
  255. </div>
  256. <a class="anchor" id="ga39be27be43d9f80ce5bfc5e1adf21412"></a><!-- doxytag: member="glm::gtx::quaternion::eulerAngles" ref="ga39be27be43d9f80ce5bfc5e1adf21412" args="(detail::tquat&lt; valType &gt; const &amp;x)" -->
  257. <div class="memitem">
  258. <div class="memproto">
  259. <table class="memname">
  260. <tr>
  261. <td class="memname">detail::tvec3&lt;valType&gt; glm::gtx::quaternion::eulerAngles </td>
  262. <td>(</td>
  263. <td class="paramtype">detail::tquat&lt; valType &gt; const &amp;&#160;</td>
  264. <td class="paramname"><em>x</em></td><td>)</td>
  265. <td></td>
  266. </tr>
  267. </table>
  268. </div>
  269. <div class="memdoc">
  270. <p>Returns euler angles, yitch as x, yaw as y, roll as z. </p>
  271. <p>From GLM_GTX_quaternion extension. </p>
  272. </div>
  273. </div>
  274. <a class="anchor" id="gaed2302270ec468d26de745516ccb5d4b"></a><!-- doxytag: member="glm::gtx::quaternion::exp" ref="gaed2302270ec468d26de745516ccb5d4b" args="(detail::tquat&lt; valType &gt; const &amp;q, valType const &amp;exponent)" -->
  275. <div class="memitem">
  276. <div class="memproto">
  277. <table class="memname">
  278. <tr>
  279. <td class="memname">detail::tquat&lt;valType&gt; glm::gtx::quaternion::exp </td>
  280. <td>(</td>
  281. <td class="paramtype">detail::tquat&lt; valType &gt; const &amp;&#160;</td>
  282. <td class="paramname"><em>q</em>, </td>
  283. </tr>
  284. <tr>
  285. <td class="paramkey"></td>
  286. <td></td>
  287. <td class="paramtype">valType const &amp;&#160;</td>
  288. <td class="paramname"><em>exponent</em>&#160;</td>
  289. </tr>
  290. <tr>
  291. <td></td>
  292. <td>)</td>
  293. <td></td><td></td>
  294. </tr>
  295. </table>
  296. </div>
  297. <div class="memdoc">
  298. <p>Returns a exp of a quaternion. </p>
  299. <p>From GLM_GTX_quaternion extension. </p>
  300. </div>
  301. </div>
  302. <a class="anchor" id="ga23eb8e1aeaf751f7cc46fbaa291e223d"></a><!-- doxytag: member="glm::gtx::quaternion::extractRealComponent" ref="ga23eb8e1aeaf751f7cc46fbaa291e223d" args="(detail::tquat&lt; valType &gt; const &amp;q)" -->
  303. <div class="memitem">
  304. <div class="memproto">
  305. <table class="memname">
  306. <tr>
  307. <td class="memname">valType glm::gtx::quaternion::extractRealComponent </td>
  308. <td>(</td>
  309. <td class="paramtype">detail::tquat&lt; valType &gt; const &amp;&#160;</td>
  310. <td class="paramname"><em>q</em></td><td>)</td>
  311. <td></td>
  312. </tr>
  313. </table>
  314. </div>
  315. <div class="memdoc">
  316. <p>Extract the real component of a quaternion. </p>
  317. <p>From GLM_GTX_quaternion extension. </p>
  318. </div>
  319. </div>
  320. <a class="anchor" id="ga65d5734ce29049d334992f6a59e27e58"></a><!-- doxytag: member="glm::gtx::quaternion::fastMix" ref="ga65d5734ce29049d334992f6a59e27e58" args="(detail::tquat&lt; T &gt; const &amp;x, detail::tquat&lt; T &gt; const &amp;y, T const &amp;a)" -->
  321. <div class="memitem">
  322. <div class="memproto">
  323. <table class="memname">
  324. <tr>
  325. <td class="memname">detail::tquat&lt;T&gt; glm::gtx::quaternion::fastMix </td>
  326. <td>(</td>
  327. <td class="paramtype">detail::tquat&lt; T &gt; const &amp;&#160;</td>
  328. <td class="paramname"><em>x</em>, </td>
  329. </tr>
  330. <tr>
  331. <td class="paramkey"></td>
  332. <td></td>
  333. <td class="paramtype">detail::tquat&lt; T &gt; const &amp;&#160;</td>
  334. <td class="paramname"><em>y</em>, </td>
  335. </tr>
  336. <tr>
  337. <td class="paramkey"></td>
  338. <td></td>
  339. <td class="paramtype">T const &amp;&#160;</td>
  340. <td class="paramname"><em>a</em>&#160;</td>
  341. </tr>
  342. <tr>
  343. <td></td>
  344. <td>)</td>
  345. <td></td><td></td>
  346. </tr>
  347. </table>
  348. </div>
  349. <div class="memdoc">
  350. <p>Quaternion normalized linear interpolation. </p>
  351. <p>From GLM_GTX_quaternion extension. </p>
  352. </div>
  353. </div>
  354. <a class="anchor" id="gaa15c443e97ac7476d04627d868995891"></a><!-- doxytag: member="glm::gtx::quaternion::intermediate" ref="gaa15c443e97ac7476d04627d868995891" args="(detail::tquat&lt; valType &gt; const &amp;prev, detail::tquat&lt; valType &gt; const &amp;curr, detail::tquat&lt; valType &gt; const &amp;next)" -->
  355. <div class="memitem">
  356. <div class="memproto">
  357. <table class="memname">
  358. <tr>
  359. <td class="memname">detail::tquat&lt;valType&gt; glm::gtx::quaternion::intermediate </td>
  360. <td>(</td>
  361. <td class="paramtype">detail::tquat&lt; valType &gt; const &amp;&#160;</td>
  362. <td class="paramname"><em>prev</em>, </td>
  363. </tr>
  364. <tr>
  365. <td class="paramkey"></td>
  366. <td></td>
  367. <td class="paramtype">detail::tquat&lt; valType &gt; const &amp;&#160;</td>
  368. <td class="paramname"><em>curr</em>, </td>
  369. </tr>
  370. <tr>
  371. <td class="paramkey"></td>
  372. <td></td>
  373. <td class="paramtype">detail::tquat&lt; valType &gt; const &amp;&#160;</td>
  374. <td class="paramname"><em>next</em>&#160;</td>
  375. </tr>
  376. <tr>
  377. <td></td>
  378. <td>)</td>
  379. <td></td><td></td>
  380. </tr>
  381. </table>
  382. </div>
  383. <div class="memdoc">
  384. <p>Returns an intermediate control point for squad interpolation. </p>
  385. <p>From GLM_GTX_quaternion extension. </p>
  386. </div>
  387. </div>
  388. <a class="anchor" id="ga11af1897310ec8a09210fb7b4deb0027"></a><!-- doxytag: member="glm::gtx::quaternion::log" ref="ga11af1897310ec8a09210fb7b4deb0027" args="(detail::tquat&lt; valType &gt; const &amp;q)" -->
  389. <div class="memitem">
  390. <div class="memproto">
  391. <table class="memname">
  392. <tr>
  393. <td class="memname">detail::tquat&lt;valType&gt; glm::gtx::quaternion::log </td>
  394. <td>(</td>
  395. <td class="paramtype">detail::tquat&lt; valType &gt; const &amp;&#160;</td>
  396. <td class="paramname"><em>q</em></td><td>)</td>
  397. <td></td>
  398. </tr>
  399. </table>
  400. </div>
  401. <div class="memdoc">
  402. <p>Returns a log of a quaternion. </p>
  403. <p>From GLM_GTX_quaternion extension. </p>
  404. </div>
  405. </div>
  406. <a class="anchor" id="gafad23e37f1723bbbbd7f9498cd729126"></a><!-- doxytag: member="glm::gtx::quaternion::pitch" ref="gafad23e37f1723bbbbd7f9498cd729126" args="(detail::tquat&lt; valType &gt; const &amp;x)" -->
  407. <div class="memitem">
  408. <div class="memproto">
  409. <table class="memname">
  410. <tr>
  411. <td class="memname">valType glm::gtx::quaternion::pitch </td>
  412. <td>(</td>
  413. <td class="paramtype">detail::tquat&lt; valType &gt; const &amp;&#160;</td>
  414. <td class="paramname"><em>x</em></td><td>)</td>
  415. <td></td>
  416. </tr>
  417. </table>
  418. </div>
  419. <div class="memdoc">
  420. <p>Returns pitch value of euler angles in degrees. </p>
  421. <p>From GLM_GTX_quaternion extension. </p>
  422. </div>
  423. </div>
  424. <a class="anchor" id="ga42873121534327c9e5238f3ca3d6cd03"></a><!-- doxytag: member="glm::gtx::quaternion::pow" ref="ga42873121534327c9e5238f3ca3d6cd03" args="(detail::tquat&lt; valType &gt; const &amp;x, valType const &amp;y)" -->
  425. <div class="memitem">
  426. <div class="memproto">
  427. <table class="memname">
  428. <tr>
  429. <td class="memname">detail::tquat&lt;valType&gt; glm::gtx::quaternion::pow </td>
  430. <td>(</td>
  431. <td class="paramtype">detail::tquat&lt; valType &gt; const &amp;&#160;</td>
  432. <td class="paramname"><em>x</em>, </td>
  433. </tr>
  434. <tr>
  435. <td class="paramkey"></td>
  436. <td></td>
  437. <td class="paramtype">valType const &amp;&#160;</td>
  438. <td class="paramname"><em>y</em>&#160;</td>
  439. </tr>
  440. <tr>
  441. <td></td>
  442. <td>)</td>
  443. <td></td><td></td>
  444. </tr>
  445. </table>
  446. </div>
  447. <div class="memdoc">
  448. <p>Returns x raised to the y power. </p>
  449. <p>From GLM_GTX_quaternion extension. </p>
  450. </div>
  451. </div>
  452. <a class="anchor" id="ga60a4f955b2836d85f3d21ded84879926"></a><!-- doxytag: member="glm::gtx::quaternion::roll" ref="ga60a4f955b2836d85f3d21ded84879926" args="(detail::tquat&lt; valType &gt; const &amp;x)" -->
  453. <div class="memitem">
  454. <div class="memproto">
  455. <table class="memname">
  456. <tr>
  457. <td class="memname">valType glm::gtx::quaternion::roll </td>
  458. <td>(</td>
  459. <td class="paramtype">detail::tquat&lt; valType &gt; const &amp;&#160;</td>
  460. <td class="paramname"><em>x</em></td><td>)</td>
  461. <td></td>
  462. </tr>
  463. </table>
  464. </div>
  465. <div class="memdoc">
  466. <p>Returns roll value of euler angles in degrees. </p>
  467. <p>From GLM_GTX_quaternion extension. </p>
  468. </div>
  469. </div>
  470. <a class="anchor" id="ga7f163c787898b76dc1d91eb48523ce87"></a><!-- doxytag: member="glm::gtx::quaternion::rotate" ref="ga7f163c787898b76dc1d91eb48523ce87" args="(detail::tquat&lt; valType &gt; const &amp;q, detail::tvec3&lt; valType &gt; const &amp;v)" -->
  471. <div class="memitem">
  472. <div class="memproto">
  473. <table class="memname">
  474. <tr>
  475. <td class="memname">detail::tvec3&lt;valType&gt; glm::gtx::quaternion::rotate </td>
  476. <td>(</td>
  477. <td class="paramtype">detail::tquat&lt; valType &gt; const &amp;&#160;</td>
  478. <td class="paramname"><em>q</em>, </td>
  479. </tr>
  480. <tr>
  481. <td class="paramkey"></td>
  482. <td></td>
  483. <td class="paramtype">detail::tvec3&lt; valType &gt; const &amp;&#160;</td>
  484. <td class="paramname"><em>v</em>&#160;</td>
  485. </tr>
  486. <tr>
  487. <td></td>
  488. <td>)</td>
  489. <td></td><td></td>
  490. </tr>
  491. </table>
  492. </div>
  493. <div class="memdoc">
  494. <p>Returns quarternion square root. </p>
  495. <p>From GLM_GTX_quaternion extension. Rotates a 3 components vector by a quaternion. From GLM_GTX_transform extension. </p>
  496. </div>
  497. </div>
  498. <a class="anchor" id="ga92cb29907ffd24771d31f06c94e6d166"></a><!-- doxytag: member="glm::gtx::quaternion::rotate" ref="ga92cb29907ffd24771d31f06c94e6d166" args="(detail::tquat&lt; valType &gt; const &amp;q, detail::tvec4&lt; valType &gt; const &amp;v)" -->
  499. <div class="memitem">
  500. <div class="memproto">
  501. <table class="memname">
  502. <tr>
  503. <td class="memname">detail::tvec4&lt;valType&gt; glm::gtx::quaternion::rotate </td>
  504. <td>(</td>
  505. <td class="paramtype">detail::tquat&lt; valType &gt; const &amp;&#160;</td>
  506. <td class="paramname"><em>q</em>, </td>
  507. </tr>
  508. <tr>
  509. <td class="paramkey"></td>
  510. <td></td>
  511. <td class="paramtype">detail::tvec4&lt; valType &gt; const &amp;&#160;</td>
  512. <td class="paramname"><em>v</em>&#160;</td>
  513. </tr>
  514. <tr>
  515. <td></td>
  516. <td>)</td>
  517. <td></td><td></td>
  518. </tr>
  519. </table>
  520. </div>
  521. <div class="memdoc">
  522. <p>Rotates a 4 components vector by a quaternion. </p>
  523. <p>From GLM_GTX_transform extension. </p>
  524. </div>
  525. </div>
  526. <a class="anchor" id="ga22566896a998311431a0612e1c222002"></a><!-- doxytag: member="glm::gtx::quaternion::shortMix" ref="ga22566896a998311431a0612e1c222002" args="(detail::tquat&lt; T &gt; const &amp;x, detail::tquat&lt; T &gt; const &amp;y, T const &amp;a)" -->
  527. <div class="memitem">
  528. <div class="memproto">
  529. <table class="memname">
  530. <tr>
  531. <td class="memname">detail::tquat&lt;T&gt; glm::gtx::quaternion::shortMix </td>
  532. <td>(</td>
  533. <td class="paramtype">detail::tquat&lt; T &gt; const &amp;&#160;</td>
  534. <td class="paramname"><em>x</em>, </td>
  535. </tr>
  536. <tr>
  537. <td class="paramkey"></td>
  538. <td></td>
  539. <td class="paramtype">detail::tquat&lt; T &gt; const &amp;&#160;</td>
  540. <td class="paramname"><em>y</em>, </td>
  541. </tr>
  542. <tr>
  543. <td class="paramkey"></td>
  544. <td></td>
  545. <td class="paramtype">T const &amp;&#160;</td>
  546. <td class="paramname"><em>a</em>&#160;</td>
  547. </tr>
  548. <tr>
  549. <td></td>
  550. <td>)</td>
  551. <td></td><td></td>
  552. </tr>
  553. </table>
  554. </div>
  555. <div class="memdoc">
  556. <p>Quaternion interpolation using the rotation short path. </p>
  557. <p>From GLM_GTX_quaternion extension. </p>
  558. </div>
  559. </div>
  560. <a class="anchor" id="ga203b736245b7519eb151ac46e0bf7f21"></a><!-- doxytag: member="glm::gtx::quaternion::squad" ref="ga203b736245b7519eb151ac46e0bf7f21" args="(detail::tquat&lt; valType &gt; const &amp;q1, detail::tquat&lt; valType &gt; const &amp;q2, detail::tquat&lt; valType &gt; const &amp;s1, detail::tquat&lt; valType &gt; const &amp;s2, valType const &amp;h)" -->
  561. <div class="memitem">
  562. <div class="memproto">
  563. <table class="memname">
  564. <tr>
  565. <td class="memname">detail::tquat&lt;valType&gt; glm::gtx::quaternion::squad </td>
  566. <td>(</td>
  567. <td class="paramtype">detail::tquat&lt; valType &gt; const &amp;&#160;</td>
  568. <td class="paramname"><em>q1</em>, </td>
  569. </tr>
  570. <tr>
  571. <td class="paramkey"></td>
  572. <td></td>
  573. <td class="paramtype">detail::tquat&lt; valType &gt; const &amp;&#160;</td>
  574. <td class="paramname"><em>q2</em>, </td>
  575. </tr>
  576. <tr>
  577. <td class="paramkey"></td>
  578. <td></td>
  579. <td class="paramtype">detail::tquat&lt; valType &gt; const &amp;&#160;</td>
  580. <td class="paramname"><em>s1</em>, </td>
  581. </tr>
  582. <tr>
  583. <td class="paramkey"></td>
  584. <td></td>
  585. <td class="paramtype">detail::tquat&lt; valType &gt; const &amp;&#160;</td>
  586. <td class="paramname"><em>s2</em>, </td>
  587. </tr>
  588. <tr>
  589. <td class="paramkey"></td>
  590. <td></td>
  591. <td class="paramtype">valType const &amp;&#160;</td>
  592. <td class="paramname"><em>h</em>&#160;</td>
  593. </tr>
  594. <tr>
  595. <td></td>
  596. <td>)</td>
  597. <td></td><td></td>
  598. </tr>
  599. </table>
  600. </div>
  601. <div class="memdoc">
  602. <p>Compute a point on a path according squad equation. </p>
  603. <p>q1 and q2 are control points; s1 and s2 are intermediate control points. From GLM_GTX_quaternion extension. </p>
  604. </div>
  605. </div>
  606. <a class="anchor" id="ga61ec971322157330116a3aefe5bae609"></a><!-- doxytag: member="glm::gtx::quaternion::toMat3" ref="ga61ec971322157330116a3aefe5bae609" args="(detail::tquat&lt; valType &gt; const &amp;x)" -->
  607. <div class="memitem">
  608. <div class="memproto">
  609. <table class="memname">
  610. <tr>
  611. <td class="memname">detail::tmat3x3&lt;valType&gt; glm::gtx::quaternion::toMat3 </td>
  612. <td>(</td>
  613. <td class="paramtype">detail::tquat&lt; valType &gt; const &amp;&#160;</td>
  614. <td class="paramname"><em>x</em></td><td>)</td>
  615. <td></td>
  616. </tr>
  617. </table>
  618. </div>
  619. <div class="memdoc">
  620. <p>Converts a quaternion to a 3 * 3 matrix. </p>
  621. <p>From GLM_GTX_quaternion extension. </p>
  622. <p>Definition at line <a class="el" href="a00095_source.html#l00171">171</a> of file <a class="el" href="a00095_source.html">gtx/quaternion.hpp</a>.</p>
  623. <p>References <a class="el" href="a00245.html#ga38702707009c743e9f304aadc25aeeeb">glm::gtc::quaternion::mat3_cast()</a>.</p>
  624. </div>
  625. </div>
  626. <a class="anchor" id="ga80622343bd7ccf43c9b4cb677ba3ce38"></a><!-- doxytag: member="glm::gtx::quaternion::toMat4" ref="ga80622343bd7ccf43c9b4cb677ba3ce38" args="(detail::tquat&lt; valType &gt; const &amp;x)" -->
  627. <div class="memitem">
  628. <div class="memproto">
  629. <table class="memname">
  630. <tr>
  631. <td class="memname">detail::tmat4x4&lt;valType&gt; glm::gtx::quaternion::toMat4 </td>
  632. <td>(</td>
  633. <td class="paramtype">detail::tquat&lt; valType &gt; const &amp;&#160;</td>
  634. <td class="paramname"><em>x</em></td><td>)</td>
  635. <td></td>
  636. </tr>
  637. </table>
  638. </div>
  639. <div class="memdoc">
  640. <p>Converts a quaternion to a 4 * 4 matrix. </p>
  641. <p>From GLM_GTX_quaternion extension. </p>
  642. <p>Definition at line <a class="el" href="a00095_source.html#l00177">177</a> of file <a class="el" href="a00095_source.html">gtx/quaternion.hpp</a>.</p>
  643. <p>References <a class="el" href="a00245.html#gae2d14d52f9fef3da00cf867f9e2e3dfa">glm::gtc::quaternion::mat4_cast()</a>.</p>
  644. </div>
  645. </div>
  646. <a class="anchor" id="ga2d9d1916258d13bd5f0373341400f18c"></a><!-- doxytag: member="glm::gtx::quaternion::toQuat" ref="ga2d9d1916258d13bd5f0373341400f18c" args="(detail::tmat4x4&lt; valType &gt; const &amp;x)" -->
  647. <div class="memitem">
  648. <div class="memproto">
  649. <table class="memname">
  650. <tr>
  651. <td class="memname">detail::tquat&lt;valType&gt; glm::gtx::quaternion::toQuat </td>
  652. <td>(</td>
  653. <td class="paramtype">detail::tmat4x4&lt; valType &gt; const &amp;&#160;</td>
  654. <td class="paramname"><em>x</em></td><td>)</td>
  655. <td></td>
  656. </tr>
  657. </table>
  658. </div>
  659. <div class="memdoc">
  660. <p>Converts a 4 * 4 matrix to a quaternion. </p>
  661. <p>From GLM_GTX_quaternion extension. </p>
  662. <p>Definition at line <a class="el" href="a00095_source.html#l00189">189</a> of file <a class="el" href="a00095_source.html">gtx/quaternion.hpp</a>.</p>
  663. <p>References <a class="el" href="a00245.html#ga9a8fa3c0a776ce21fde307d94f5a5a52">glm::gtc::quaternion::quat_cast()</a>.</p>
  664. </div>
  665. </div>
  666. <a class="anchor" id="ga991e534718ab690ff21e201f27bfd43b"></a><!-- doxytag: member="glm::gtx::quaternion::toQuat" ref="ga991e534718ab690ff21e201f27bfd43b" args="(detail::tmat3x3&lt; valType &gt; const &amp;x)" -->
  667. <div class="memitem">
  668. <div class="memproto">
  669. <table class="memname">
  670. <tr>
  671. <td class="memname">detail::tquat&lt;valType&gt; glm::gtx::quaternion::toQuat </td>
  672. <td>(</td>
  673. <td class="paramtype">detail::tmat3x3&lt; valType &gt; const &amp;&#160;</td>
  674. <td class="paramname"><em>x</em></td><td>)</td>
  675. <td></td>
  676. </tr>
  677. </table>
  678. </div>
  679. <div class="memdoc">
  680. <p>Converts a 3 * 3 matrix to a quaternion. </p>
  681. <p>From GLM_GTX_quaternion extension. </p>
  682. <p>Definition at line <a class="el" href="a00095_source.html#l00183">183</a> of file <a class="el" href="a00095_source.html">gtx/quaternion.hpp</a>.</p>
  683. <p>References <a class="el" href="a00245.html#ga9a8fa3c0a776ce21fde307d94f5a5a52">glm::gtc::quaternion::quat_cast()</a>.</p>
  684. </div>
  685. </div>
  686. <a class="anchor" id="ga4795f1cc522d82d672f7be9a405583c4"></a><!-- doxytag: member="glm::gtx::quaternion::yaw" ref="ga4795f1cc522d82d672f7be9a405583c4" args="(detail::tquat&lt; valType &gt; const &amp;x)" -->
  687. <div class="memitem">
  688. <div class="memproto">
  689. <table class="memname">
  690. <tr>
  691. <td class="memname">valType glm::gtx::quaternion::yaw </td>
  692. <td>(</td>
  693. <td class="paramtype">detail::tquat&lt; valType &gt; const &amp;&#160;</td>
  694. <td class="paramname"><em>x</em></td><td>)</td>
  695. <td></td>
  696. </tr>
  697. </table>
  698. </div>
  699. <div class="memdoc">
  700. <p>Returns yaw value of euler angles in degrees. </p>
  701. <p>From GLM_GTX_quaternion extension. </p>
  702. </div>
  703. </div>
  704. </div>
  705. <hr class="footer"/><address class="footer"><small>Generated by&#160;
  706. <a href="http://www.doxygen.org/index.html">
  707. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
  708. </body>
  709. </html>