a00153.html 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654
  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_GTC_quaternion</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="#typedef-members">Typedefs</a> &#124;
  37. <a href="#func-members">Functions</a> </div>
  38. <div class="headertitle">
  39. <div class="title">GLM_GTC_quaternion</div> </div>
  40. <div class="ingroups"><a class="el" href="a00138.html">GTC Extensions (Stable)</a></div></div><!--header-->
  41. <div class="contents">
  42. <table class="memberdecls">
  43. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  44. Typedefs</h2></td></tr>
  45. <tr class="memitem:ga5428321324094c7170d6133c8139d255"><td class="memItemLeft" align="right" valign="top">typedef detail::tquat&lt; double &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#ga5428321324094c7170d6133c8139d255">dquat</a></td></tr>
  46. <tr class="separator:ga5428321324094c7170d6133c8139d255"><td class="memSeparator" colspan="2">&#160;</td></tr>
  47. <tr class="memitem:gaae07c293efbe1c530ff18044a15fe662"><td class="memItemLeft" align="right" valign="top">typedef detail::tquat&lt; float &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#gaae07c293efbe1c530ff18044a15fe662">fquat</a></td></tr>
  48. <tr class="separator:gaae07c293efbe1c530ff18044a15fe662"><td class="memSeparator" colspan="2">&#160;</td></tr>
  49. <tr class="memitem:ga8a7c2c751ad30db9ec4268a6b7d99f6c"><td class="memItemLeft" align="right" valign="top">typedef detail::tquat<br class="typebreak"/>
  50. &lt; highp_float &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#ga8a7c2c751ad30db9ec4268a6b7d99f6c">highp_quat</a></td></tr>
  51. <tr class="separator:ga8a7c2c751ad30db9ec4268a6b7d99f6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  52. <tr class="memitem:gaba1bbdeae84c942ce0dc83af40e1d7d3"><td class="memItemLeft" align="right" valign="top">typedef detail::tquat<br class="typebreak"/>
  53. &lt; detail::half &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#gaba1bbdeae84c942ce0dc83af40e1d7d3">hquat</a></td></tr>
  54. <tr class="separator:gaba1bbdeae84c942ce0dc83af40e1d7d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  55. <tr class="memitem:ga5acd0f3e9f9e3c0e6577440443ec4594"><td class="memItemLeft" align="right" valign="top">typedef detail::tquat&lt; lowp_float &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#ga5acd0f3e9f9e3c0e6577440443ec4594">lowp_quat</a></td></tr>
  56. <tr class="separator:ga5acd0f3e9f9e3c0e6577440443ec4594"><td class="memSeparator" colspan="2">&#160;</td></tr>
  57. <tr class="memitem:gae93fe73ea5fe5e2150c2eb0641394dc8"><td class="memItemLeft" align="right" valign="top">typedef detail::tquat<br class="typebreak"/>
  58. &lt; mediump_float &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#gae93fe73ea5fe5e2150c2eb0641394dc8">mediump_quat</a></td></tr>
  59. <tr class="separator:gae93fe73ea5fe5e2150c2eb0641394dc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  60. <tr class="memitem:ga60408579db470456070a3336295625a7"><td class="memItemLeft" align="right" valign="top">typedef detail::tquat&lt; float &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#ga60408579db470456070a3336295625a7">quat</a></td></tr>
  61. <tr class="separator:ga60408579db470456070a3336295625a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62. </table><table class="memberdecls">
  63. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  64. Functions</h2></td></tr>
  65. <tr class="memitem:ga69041d18bd8539fe82d6170932d28362"><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  66. <tr class="memitem:ga69041d18bd8539fe82d6170932d28362"><td class="memTemplItemLeft" align="right" valign="top">valType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00153.html#ga69041d18bd8539fe82d6170932d28362">angle</a> (detail::tquat&lt; valType &gt; const &amp;x)</td></tr>
  67. <tr class="separator:ga69041d18bd8539fe82d6170932d28362"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="memitem:gaafc03953867e42a39dc08575ad4532ad"><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  69. <tr class="memitem:gaafc03953867e42a39dc08575ad4532ad"><td class="memTemplItemLeft" align="right" valign="top">detail::tquat&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00153.html#gaafc03953867e42a39dc08575ad4532ad">angleAxis</a> (valType const &amp;angle, valType const &amp;x, valType const &amp;y, valType const &amp;z)</td></tr>
  70. <tr class="separator:gaafc03953867e42a39dc08575ad4532ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71. <tr class="memitem:ga30071b5b9773087b7212a5ce67d0d90a"><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  72. <tr class="memitem:ga30071b5b9773087b7212a5ce67d0d90a"><td class="memTemplItemLeft" align="right" valign="top">detail::tquat&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00153.html#ga30071b5b9773087b7212a5ce67d0d90a">angleAxis</a> (valType const &amp;angle, detail::tvec3&lt; valType &gt; const &amp;axis)</td></tr>
  73. <tr class="separator:ga30071b5b9773087b7212a5ce67d0d90a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:ga72457604550d0414e522dbec0d98f276"><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  75. <tr class="memitem:ga72457604550d0414e522dbec0d98f276"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; valType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00153.html#ga72457604550d0414e522dbec0d98f276">axis</a> (detail::tquat&lt; valType &gt; const &amp;x)</td></tr>
  76. <tr class="separator:ga72457604550d0414e522dbec0d98f276"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:ga8b6594dffb8bf455d848ffa2169ba41d"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  78. <tr class="memitem:ga8b6594dffb8bf455d848ffa2169ba41d"><td class="memTemplItemLeft" align="right" valign="top">detail::tquat&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00153.html#ga8b6594dffb8bf455d848ffa2169ba41d">conjugate</a> (detail::tquat&lt; T &gt; const &amp;q)</td></tr>
  79. <tr class="separator:ga8b6594dffb8bf455d848ffa2169ba41d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:gab9101d7f5b27ca682fc84e32b8fd70ad"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  81. <tr class="memitem:gab9101d7f5b27ca682fc84e32b8fd70ad"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00153.html#gab9101d7f5b27ca682fc84e32b8fd70ad">dot</a> (detail::tquat&lt; T &gt; const &amp;q1, detail::tquat&lt; T &gt; const &amp;q2)</td></tr>
  82. <tr class="separator:gab9101d7f5b27ca682fc84e32b8fd70ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:gaa53e0e8933e176c6207720433fb8dd2b"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  84. <tr class="memitem:gaa53e0e8933e176c6207720433fb8dd2b"><td class="memTemplItemLeft" align="right" valign="top">detail::tvec3&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00153.html#gaa53e0e8933e176c6207720433fb8dd2b">eulerAngles</a> (detail::tquat&lt; T &gt; const &amp;x)</td></tr>
  85. <tr class="separator:gaa53e0e8933e176c6207720433fb8dd2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:ga78b87a5e7152108e0dff0855d81b3bc1"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  87. <tr class="memitem:ga78b87a5e7152108e0dff0855d81b3bc1"><td class="memTemplItemLeft" align="right" valign="top">detail::tquat&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00153.html#ga78b87a5e7152108e0dff0855d81b3bc1">inverse</a> (detail::tquat&lt; T &gt; const &amp;q)</td></tr>
  88. <tr class="separator:ga78b87a5e7152108e0dff0855d81b3bc1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:ga60d5647f87c2c423497d0f3bf8c407b8"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  90. <tr class="memitem:ga60d5647f87c2c423497d0f3bf8c407b8"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00153.html#ga60d5647f87c2c423497d0f3bf8c407b8">length</a> (detail::tquat&lt; T &gt; const &amp;q)</td></tr>
  91. <tr class="separator:ga60d5647f87c2c423497d0f3bf8c407b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:gae04ce320008c9bec0037b4ba21853cb5"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  93. <tr class="memitem:gae04ce320008c9bec0037b4ba21853cb5"><td class="memTemplItemLeft" align="right" valign="top">detail::tmat3x3&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00153.html#gae04ce320008c9bec0037b4ba21853cb5">mat3_cast</a> (detail::tquat&lt; T &gt; const &amp;x)</td></tr>
  94. <tr class="separator:gae04ce320008c9bec0037b4ba21853cb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:ga8c376eb15971eb52d85df5ee26825627"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  96. <tr class="memitem:ga8c376eb15971eb52d85df5ee26825627"><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00153.html#ga8c376eb15971eb52d85df5ee26825627">mat4_cast</a> (detail::tquat&lt; T &gt; const &amp;x)</td></tr>
  97. <tr class="separator:ga8c376eb15971eb52d85df5ee26825627"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:gaaea9592fd53952b636d680321edcdb31"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  99. <tr class="memitem:gaaea9592fd53952b636d680321edcdb31"><td class="memTemplItemLeft" align="right" valign="top">detail::tquat&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00153.html#gaaea9592fd53952b636d680321edcdb31">mix</a> (detail::tquat&lt; T &gt; const &amp;x, detail::tquat&lt; T &gt; const &amp;y, T const &amp;a)</td></tr>
  100. <tr class="separator:gaaea9592fd53952b636d680321edcdb31"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:gabd269bb967469a6f1df5963455fee6be"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  102. <tr class="memitem:gabd269bb967469a6f1df5963455fee6be"><td class="memTemplItemLeft" align="right" valign="top">detail::tquat&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00153.html#gabd269bb967469a6f1df5963455fee6be">normalize</a> (detail::tquat&lt; T &gt; const &amp;q)</td></tr>
  103. <tr class="separator:gabd269bb967469a6f1df5963455fee6be"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:ga4d37447d81ceade1d10d68c995a4d881"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  105. <tr class="memitem:ga4d37447d81ceade1d10d68c995a4d881"><td class="memTemplItemLeft" align="right" valign="top">detail::tquat&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00153.html#ga4d37447d81ceade1d10d68c995a4d881">quat_cast</a> (detail::tmat3x3&lt; T &gt; const &amp;x)</td></tr>
  106. <tr class="separator:ga4d37447d81ceade1d10d68c995a4d881"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:ga24adafe33b0bcad906c8724a762e5299"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  108. <tr class="memitem:ga24adafe33b0bcad906c8724a762e5299"><td class="memTemplItemLeft" align="right" valign="top">detail::tquat&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00153.html#ga24adafe33b0bcad906c8724a762e5299">quat_cast</a> (detail::tmat4x4&lt; T &gt; const &amp;x)</td></tr>
  109. <tr class="separator:ga24adafe33b0bcad906c8724a762e5299"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:ga297d6a9635153c76d7c011efa716b5da"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  111. <tr class="memitem:ga297d6a9635153c76d7c011efa716b5da"><td class="memTemplItemLeft" align="right" valign="top">detail::tquat&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00153.html#ga297d6a9635153c76d7c011efa716b5da">rotate</a> (detail::tquat&lt; T &gt; const &amp;q, typename detail::tquat&lt; T &gt;::value_type const &amp;angle, detail::tvec3&lt; T &gt; const &amp;axis)</td></tr>
  112. <tr class="separator:ga297d6a9635153c76d7c011efa716b5da"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. </table>
  114. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  115. <p>Defines a templated quaternion type and several quaternion operations. </p>
  116. <p>&lt;<a class="el" href="a00076.html" title="OpenGL Mathematics (glm.g-truc.net)">glm/gtc/quaternion.hpp</a>&gt; need to be included to use these functionalities. </p>
  117. <h2 class="groupheader">Typedef Documentation</h2>
  118. <a class="anchor" id="ga5428321324094c7170d6133c8139d255"></a>
  119. <div class="memitem">
  120. <div class="memproto">
  121. <table class="memname">
  122. <tr>
  123. <td class="memname">typedef detail::tquat&lt;double&gt; dquat</td>
  124. </tr>
  125. </table>
  126. </div><div class="memdoc">
  127. <p>Quaternion of double-precision floating-point numbers. </p>
  128. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00153.html" title="Defines a templated quaternion type and several quaternion operations.">GLM_GTC_quaternion</a> </dd></dl>
  129. <p>Definition at line <a class="el" href="a00076_source.html#l00301">301</a> of file <a class="el" href="a00076_source.html">gtc/quaternion.hpp</a>.</p>
  130. </div>
  131. </div>
  132. <a class="anchor" id="gaae07c293efbe1c530ff18044a15fe662"></a>
  133. <div class="memitem">
  134. <div class="memproto">
  135. <table class="memname">
  136. <tr>
  137. <td class="memname">typedef detail::tquat&lt;float&gt; fquat</td>
  138. </tr>
  139. </table>
  140. </div><div class="memdoc">
  141. <p>Quaternion of single-precision floating-point numbers. </p>
  142. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00153.html" title="Defines a templated quaternion type and several quaternion operations.">GLM_GTC_quaternion</a> </dd></dl>
  143. <p>Definition at line <a class="el" href="a00076_source.html#l00296">296</a> of file <a class="el" href="a00076_source.html">gtc/quaternion.hpp</a>.</p>
  144. </div>
  145. </div>
  146. <a class="anchor" id="ga8a7c2c751ad30db9ec4268a6b7d99f6c"></a>
  147. <div class="memitem">
  148. <div class="memproto">
  149. <table class="memname">
  150. <tr>
  151. <td class="memname">typedef detail::tquat&lt;highp_float&gt; highp_quat</td>
  152. </tr>
  153. </table>
  154. </div><div class="memdoc">
  155. <p>Quaternion of high precision floating-point numbers. </p>
  156. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00153.html" title="Defines a templated quaternion type and several quaternion operations.">GLM_GTC_quaternion</a> </dd></dl>
  157. <p>Definition at line <a class="el" href="a00076_source.html#l00316">316</a> of file <a class="el" href="a00076_source.html">gtc/quaternion.hpp</a>.</p>
  158. </div>
  159. </div>
  160. <a class="anchor" id="gaba1bbdeae84c942ce0dc83af40e1d7d3"></a>
  161. <div class="memitem">
  162. <div class="memproto">
  163. <table class="memname">
  164. <tr>
  165. <td class="memname">typedef detail::tquat&lt;detail::half&gt; hquat</td>
  166. </tr>
  167. </table>
  168. </div><div class="memdoc">
  169. <p>Quaternion of half-precision floating-point numbers. </p>
  170. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00153.html" title="Defines a templated quaternion type and several quaternion operations.">GLM_GTC_quaternion</a> </dd></dl>
  171. <p>Definition at line <a class="el" href="a00076_source.html#l00291">291</a> of file <a class="el" href="a00076_source.html">gtc/quaternion.hpp</a>.</p>
  172. </div>
  173. </div>
  174. <a class="anchor" id="ga5acd0f3e9f9e3c0e6577440443ec4594"></a>
  175. <div class="memitem">
  176. <div class="memproto">
  177. <table class="memname">
  178. <tr>
  179. <td class="memname">typedef detail::tquat&lt;lowp_float&gt; lowp_quat</td>
  180. </tr>
  181. </table>
  182. </div><div class="memdoc">
  183. <p>Quaternion of low precision floating-point numbers. </p>
  184. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00153.html" title="Defines a templated quaternion type and several quaternion operations.">GLM_GTC_quaternion</a> </dd></dl>
  185. <p>Definition at line <a class="el" href="a00076_source.html#l00306">306</a> of file <a class="el" href="a00076_source.html">gtc/quaternion.hpp</a>.</p>
  186. </div>
  187. </div>
  188. <a class="anchor" id="gae93fe73ea5fe5e2150c2eb0641394dc8"></a>
  189. <div class="memitem">
  190. <div class="memproto">
  191. <table class="memname">
  192. <tr>
  193. <td class="memname">typedef detail::tquat&lt;mediump_float&gt; mediump_quat</td>
  194. </tr>
  195. </table>
  196. </div><div class="memdoc">
  197. <p>Quaternion of medium precision floating-point numbers. </p>
  198. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00153.html" title="Defines a templated quaternion type and several quaternion operations.">GLM_GTC_quaternion</a> </dd></dl>
  199. <p>Definition at line <a class="el" href="a00076_source.html#l00311">311</a> of file <a class="el" href="a00076_source.html">gtc/quaternion.hpp</a>.</p>
  200. </div>
  201. </div>
  202. <a class="anchor" id="ga60408579db470456070a3336295625a7"></a>
  203. <div class="memitem">
  204. <div class="memproto">
  205. <table class="memname">
  206. <tr>
  207. <td class="memname">typedef detail::tquat&lt;float&gt; quat</td>
  208. </tr>
  209. </table>
  210. </div><div class="memdoc">
  211. <p>Quaternion of floating-point numbers. </p>
  212. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00153.html" title="Defines a templated quaternion type and several quaternion operations.">GLM_GTC_quaternion</a> </dd></dl>
  213. <p>Definition at line <a class="el" href="a00076_source.html#l00286">286</a> of file <a class="el" href="a00076_source.html">gtc/quaternion.hpp</a>.</p>
  214. </div>
  215. </div>
  216. <h2 class="groupheader">Function Documentation</h2>
  217. <a class="anchor" id="ga69041d18bd8539fe82d6170932d28362"></a>
  218. <div class="memitem">
  219. <div class="memproto">
  220. <table class="memname">
  221. <tr>
  222. <td class="memname">valType glm::angle </td>
  223. <td>(</td>
  224. <td class="paramtype">detail::tquat&lt; valType &gt; const &amp;&#160;</td>
  225. <td class="paramname"><em>x</em></td><td>)</td>
  226. <td></td>
  227. </tr>
  228. </table>
  229. </div><div class="memdoc">
  230. <p>Returns the quaternion rotation angle. </p>
  231. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00153.html" title="Defines a templated quaternion type and several quaternion operations.">GLM_GTC_quaternion</a> </dd></dl>
  232. </div>
  233. </div>
  234. <a class="anchor" id="gaafc03953867e42a39dc08575ad4532ad"></a>
  235. <div class="memitem">
  236. <div class="memproto">
  237. <table class="memname">
  238. <tr>
  239. <td class="memname">detail::tquat&lt;valType&gt; glm::angleAxis </td>
  240. <td>(</td>
  241. <td class="paramtype">valType const &amp;&#160;</td>
  242. <td class="paramname"><em>angle</em>, </td>
  243. </tr>
  244. <tr>
  245. <td class="paramkey"></td>
  246. <td></td>
  247. <td class="paramtype">valType const &amp;&#160;</td>
  248. <td class="paramname"><em>x</em>, </td>
  249. </tr>
  250. <tr>
  251. <td class="paramkey"></td>
  252. <td></td>
  253. <td class="paramtype">valType const &amp;&#160;</td>
  254. <td class="paramname"><em>y</em>, </td>
  255. </tr>
  256. <tr>
  257. <td class="paramkey"></td>
  258. <td></td>
  259. <td class="paramtype">valType const &amp;&#160;</td>
  260. <td class="paramname"><em>z</em>&#160;</td>
  261. </tr>
  262. <tr>
  263. <td></td>
  264. <td>)</td>
  265. <td></td><td></td>
  266. </tr>
  267. </table>
  268. </div><div class="memdoc">
  269. <p>Build a quaternion from an angle and a normalized axis. </p>
  270. <dl class="params"><dt>Parameters</dt><dd>
  271. <table class="params">
  272. <tr><td class="paramname">angle</td><td>Angle expressed in radians if GLM_FORCE_RADIANS is define or degrees otherwise. </td></tr>
  273. <tr><td class="paramname">x</td><td>x component of the x-axis, x, y, z must be a normalized axis </td></tr>
  274. <tr><td class="paramname">y</td><td>y component of the y-axis, x, y, z must be a normalized axis </td></tr>
  275. <tr><td class="paramname">z</td><td>z component of the z-axis, x, y, z must be a normalized axis</td></tr>
  276. </table>
  277. </dd>
  278. </dl>
  279. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00153.html" title="Defines a templated quaternion type and several quaternion operations.">GLM_GTC_quaternion</a> </dd></dl>
  280. </div>
  281. </div>
  282. <a class="anchor" id="ga30071b5b9773087b7212a5ce67d0d90a"></a>
  283. <div class="memitem">
  284. <div class="memproto">
  285. <table class="memname">
  286. <tr>
  287. <td class="memname">detail::tquat&lt;valType&gt; glm::angleAxis </td>
  288. <td>(</td>
  289. <td class="paramtype">valType const &amp;&#160;</td>
  290. <td class="paramname"><em>angle</em>, </td>
  291. </tr>
  292. <tr>
  293. <td class="paramkey"></td>
  294. <td></td>
  295. <td class="paramtype">detail::tvec3&lt; valType &gt; const &amp;&#160;</td>
  296. <td class="paramname"><em>axis</em>&#160;</td>
  297. </tr>
  298. <tr>
  299. <td></td>
  300. <td>)</td>
  301. <td></td><td></td>
  302. </tr>
  303. </table>
  304. </div><div class="memdoc">
  305. <p>Build a quaternion from an angle and a normalized axis. </p>
  306. <dl class="params"><dt>Parameters</dt><dd>
  307. <table class="params">
  308. <tr><td class="paramname">angle</td><td>Angle expressed in radians if GLM_FORCE_RADIANS is define or degrees otherwise. </td></tr>
  309. <tr><td class="paramname">axis</td><td>Axis of the quaternion, must be normalized.</td></tr>
  310. </table>
  311. </dd>
  312. </dl>
  313. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00153.html" title="Defines a templated quaternion type and several quaternion operations.">GLM_GTC_quaternion</a> </dd></dl>
  314. </div>
  315. </div>
  316. <a class="anchor" id="ga72457604550d0414e522dbec0d98f276"></a>
  317. <div class="memitem">
  318. <div class="memproto">
  319. <table class="memname">
  320. <tr>
  321. <td class="memname">detail::tvec3&lt;valType&gt; glm::axis </td>
  322. <td>(</td>
  323. <td class="paramtype">detail::tquat&lt; valType &gt; const &amp;&#160;</td>
  324. <td class="paramname"><em>x</em></td><td>)</td>
  325. <td></td>
  326. </tr>
  327. </table>
  328. </div><div class="memdoc">
  329. <p>Returns the q rotation axis. </p>
  330. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00153.html" title="Defines a templated quaternion type and several quaternion operations.">GLM_GTC_quaternion</a> </dd></dl>
  331. </div>
  332. </div>
  333. <a class="anchor" id="ga8b6594dffb8bf455d848ffa2169ba41d"></a>
  334. <div class="memitem">
  335. <div class="memproto">
  336. <table class="memname">
  337. <tr>
  338. <td class="memname">detail::tquat&lt;T&gt; glm::conjugate </td>
  339. <td>(</td>
  340. <td class="paramtype">detail::tquat&lt; T &gt; const &amp;&#160;</td>
  341. <td class="paramname"><em>q</em></td><td>)</td>
  342. <td></td>
  343. </tr>
  344. </table>
  345. </div><div class="memdoc">
  346. <p>Returns the q conjugate. </p>
  347. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00153.html" title="Defines a templated quaternion type and several quaternion operations.">GLM_GTC_quaternion</a> </dd></dl>
  348. </div>
  349. </div>
  350. <a class="anchor" id="gab9101d7f5b27ca682fc84e32b8fd70ad"></a>
  351. <div class="memitem">
  352. <div class="memproto">
  353. <table class="memname">
  354. <tr>
  355. <td class="memname">T glm::dot </td>
  356. <td>(</td>
  357. <td class="paramtype">detail::tquat&lt; T &gt; const &amp;&#160;</td>
  358. <td class="paramname"><em>q1</em>, </td>
  359. </tr>
  360. <tr>
  361. <td class="paramkey"></td>
  362. <td></td>
  363. <td class="paramtype">detail::tquat&lt; T &gt; const &amp;&#160;</td>
  364. <td class="paramname"><em>q2</em>&#160;</td>
  365. </tr>
  366. <tr>
  367. <td></td>
  368. <td>)</td>
  369. <td></td><td></td>
  370. </tr>
  371. </table>
  372. </div><div class="memdoc">
  373. <p>Returns dot product of q1 and q2, i.e., q1[0] * q2[0] + q1[1] * q2[1] + ... </p>
  374. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00153.html" title="Defines a templated quaternion type and several quaternion operations.">GLM_GTC_quaternion</a> </dd></dl>
  375. </div>
  376. </div>
  377. <a class="anchor" id="gaa53e0e8933e176c6207720433fb8dd2b"></a>
  378. <div class="memitem">
  379. <div class="memproto">
  380. <table class="memname">
  381. <tr>
  382. <td class="memname">detail::tvec3&lt;T&gt; glm::eulerAngles </td>
  383. <td>(</td>
  384. <td class="paramtype">detail::tquat&lt; T &gt; const &amp;&#160;</td>
  385. <td class="paramname"><em>x</em></td><td>)</td>
  386. <td></td>
  387. </tr>
  388. </table>
  389. </div><div class="memdoc">
  390. <p>Returns euler angles, yitch as x, yaw as y, roll as z. </p>
  391. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00153.html" title="Defines a templated quaternion type and several quaternion operations.">GLM_GTC_quaternion</a> </dd></dl>
  392. </div>
  393. </div>
  394. <a class="anchor" id="ga78b87a5e7152108e0dff0855d81b3bc1"></a>
  395. <div class="memitem">
  396. <div class="memproto">
  397. <table class="memname">
  398. <tr>
  399. <td class="memname">detail::tquat&lt;T&gt; glm::inverse </td>
  400. <td>(</td>
  401. <td class="paramtype">detail::tquat&lt; T &gt; const &amp;&#160;</td>
  402. <td class="paramname"><em>q</em></td><td>)</td>
  403. <td></td>
  404. </tr>
  405. </table>
  406. </div><div class="memdoc">
  407. <p>Returns the q inverse. </p>
  408. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00153.html" title="Defines a templated quaternion type and several quaternion operations.">GLM_GTC_quaternion</a> </dd></dl>
  409. </div>
  410. </div>
  411. <a class="anchor" id="ga60d5647f87c2c423497d0f3bf8c407b8"></a>
  412. <div class="memitem">
  413. <div class="memproto">
  414. <table class="memname">
  415. <tr>
  416. <td class="memname">T glm::length </td>
  417. <td>(</td>
  418. <td class="paramtype">detail::tquat&lt; T &gt; const &amp;&#160;</td>
  419. <td class="paramname"><em>q</em></td><td>)</td>
  420. <td></td>
  421. </tr>
  422. </table>
  423. </div><div class="memdoc">
  424. <p>Returns the length of the quaternion. </p>
  425. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00153.html" title="Defines a templated quaternion type and several quaternion operations.">GLM_GTC_quaternion</a> </dd></dl>
  426. </div>
  427. </div>
  428. <a class="anchor" id="gae04ce320008c9bec0037b4ba21853cb5"></a>
  429. <div class="memitem">
  430. <div class="memproto">
  431. <table class="memname">
  432. <tr>
  433. <td class="memname">detail::tmat3x3&lt;T&gt; glm::mat3_cast </td>
  434. <td>(</td>
  435. <td class="paramtype">detail::tquat&lt; T &gt; const &amp;&#160;</td>
  436. <td class="paramname"><em>x</em></td><td>)</td>
  437. <td></td>
  438. </tr>
  439. </table>
  440. </div><div class="memdoc">
  441. <p>Converts a quaternion to a 3 * 3 matrix. </p>
  442. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00153.html" title="Defines a templated quaternion type and several quaternion operations.">GLM_GTC_quaternion</a> </dd></dl>
  443. <p>Referenced by <a class="el" href="a00077_source.html#l00177">glm::toMat3()</a>.</p>
  444. </div>
  445. </div>
  446. <a class="anchor" id="ga8c376eb15971eb52d85df5ee26825627"></a>
  447. <div class="memitem">
  448. <div class="memproto">
  449. <table class="memname">
  450. <tr>
  451. <td class="memname">detail::tmat4x4&lt;T&gt; glm::mat4_cast </td>
  452. <td>(</td>
  453. <td class="paramtype">detail::tquat&lt; T &gt; const &amp;&#160;</td>
  454. <td class="paramname"><em>x</em></td><td>)</td>
  455. <td></td>
  456. </tr>
  457. </table>
  458. </div><div class="memdoc">
  459. <p>Converts a quaternion to a 4 * 4 matrix. </p>
  460. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00153.html" title="Defines a templated quaternion type and several quaternion operations.">GLM_GTC_quaternion</a> </dd></dl>
  461. <p>Referenced by <a class="el" href="a00077_source.html#l00184">glm::toMat4()</a>.</p>
  462. </div>
  463. </div>
  464. <a class="anchor" id="gaaea9592fd53952b636d680321edcdb31"></a>
  465. <div class="memitem">
  466. <div class="memproto">
  467. <table class="memname">
  468. <tr>
  469. <td class="memname">detail::tquat&lt;T&gt; glm::mix </td>
  470. <td>(</td>
  471. <td class="paramtype">detail::tquat&lt; T &gt; const &amp;&#160;</td>
  472. <td class="paramname"><em>x</em>, </td>
  473. </tr>
  474. <tr>
  475. <td class="paramkey"></td>
  476. <td></td>
  477. <td class="paramtype">detail::tquat&lt; T &gt; const &amp;&#160;</td>
  478. <td class="paramname"><em>y</em>, </td>
  479. </tr>
  480. <tr>
  481. <td class="paramkey"></td>
  482. <td></td>
  483. <td class="paramtype">T const &amp;&#160;</td>
  484. <td class="paramname"><em>a</em>&#160;</td>
  485. </tr>
  486. <tr>
  487. <td></td>
  488. <td>)</td>
  489. <td></td><td></td>
  490. </tr>
  491. </table>
  492. </div><div class="memdoc">
  493. <p>Returns a SLERP interpolated quaternion of x and y according a. </p>
  494. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00153.html" title="Defines a templated quaternion type and several quaternion operations.">GLM_GTC_quaternion</a> </dd></dl>
  495. </div>
  496. </div>
  497. <a class="anchor" id="gabd269bb967469a6f1df5963455fee6be"></a>
  498. <div class="memitem">
  499. <div class="memproto">
  500. <table class="memname">
  501. <tr>
  502. <td class="memname">detail::tquat&lt;T&gt; glm::normalize </td>
  503. <td>(</td>
  504. <td class="paramtype">detail::tquat&lt; T &gt; const &amp;&#160;</td>
  505. <td class="paramname"><em>q</em></td><td>)</td>
  506. <td></td>
  507. </tr>
  508. </table>
  509. </div><div class="memdoc">
  510. <p>Returns the normalized quaternion. </p>
  511. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00153.html" title="Defines a templated quaternion type and several quaternion operations.">GLM_GTC_quaternion</a> </dd></dl>
  512. </div>
  513. </div>
  514. <a class="anchor" id="ga4d37447d81ceade1d10d68c995a4d881"></a>
  515. <div class="memitem">
  516. <div class="memproto">
  517. <table class="memname">
  518. <tr>
  519. <td class="memname">detail::tquat&lt;T&gt; glm::quat_cast </td>
  520. <td>(</td>
  521. <td class="paramtype">detail::tmat3x3&lt; T &gt; const &amp;&#160;</td>
  522. <td class="paramname"><em>x</em></td><td>)</td>
  523. <td></td>
  524. </tr>
  525. </table>
  526. </div><div class="memdoc">
  527. <p>Converts a 3 * 3 matrix to a quaternion. </p>
  528. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00153.html" title="Defines a templated quaternion type and several quaternion operations.">GLM_GTC_quaternion</a> </dd></dl>
  529. <p>Referenced by <a class="el" href="a00077_source.html#l00191">glm::toQuat()</a>.</p>
  530. </div>
  531. </div>
  532. <a class="anchor" id="ga24adafe33b0bcad906c8724a762e5299"></a>
  533. <div class="memitem">
  534. <div class="memproto">
  535. <table class="memname">
  536. <tr>
  537. <td class="memname">detail::tquat&lt;T&gt; glm::quat_cast </td>
  538. <td>(</td>
  539. <td class="paramtype">detail::tmat4x4&lt; T &gt; const &amp;&#160;</td>
  540. <td class="paramname"><em>x</em></td><td>)</td>
  541. <td></td>
  542. </tr>
  543. </table>
  544. </div><div class="memdoc">
  545. <p>Converts a 4 * 4 matrix to a quaternion. </p>
  546. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00153.html" title="Defines a templated quaternion type and several quaternion operations.">GLM_GTC_quaternion</a> </dd></dl>
  547. </div>
  548. </div>
  549. <a class="anchor" id="ga297d6a9635153c76d7c011efa716b5da"></a>
  550. <div class="memitem">
  551. <div class="memproto">
  552. <table class="memname">
  553. <tr>
  554. <td class="memname">detail::tquat&lt;T&gt; glm::rotate </td>
  555. <td>(</td>
  556. <td class="paramtype">detail::tquat&lt; T &gt; const &amp;&#160;</td>
  557. <td class="paramname"><em>q</em>, </td>
  558. </tr>
  559. <tr>
  560. <td class="paramkey"></td>
  561. <td></td>
  562. <td class="paramtype">typename detail::tquat&lt; T &gt;::value_type const &amp;&#160;</td>
  563. <td class="paramname"><em>angle</em>, </td>
  564. </tr>
  565. <tr>
  566. <td class="paramkey"></td>
  567. <td></td>
  568. <td class="paramtype">detail::tvec3&lt; T &gt; const &amp;&#160;</td>
  569. <td class="paramname"><em>axis</em>&#160;</td>
  570. </tr>
  571. <tr>
  572. <td></td>
  573. <td>)</td>
  574. <td></td><td></td>
  575. </tr>
  576. </table>
  577. </div><div class="memdoc">
  578. <p>Rotates a quaternion from an vector of 3 components axis and an angle. </p>
  579. <dl class="params"><dt>Parameters</dt><dd>
  580. <table class="params">
  581. <tr><td class="paramname">q</td><td>Source orientation </td></tr>
  582. <tr><td class="paramname">angle</td><td>Angle expressed in radians if GLM_FORCE_RADIANS is define or degrees otherwise. </td></tr>
  583. <tr><td class="paramname">axis</td><td>Axis of the rotation, must be normalized.</td></tr>
  584. </table>
  585. </dd>
  586. </dl>
  587. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00153.html" title="Defines a templated quaternion type and several quaternion operations.">GLM_GTC_quaternion</a> </dd></dl>
  588. </div>
  589. </div>
  590. </div><!-- contents -->
  591. <!-- start footer part -->
  592. <hr class="footer"/><address class="footer"><small>
  593. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  594. <img class="footer" src="doxygen.png" alt="doxygen"/>
  595. </a> 1.8.2
  596. </small></address>
  597. </body>
  598. </html>