a00972.html 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.18"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>1.0.2 API documentation: GLM_GTX_quaternion</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
  24. <td id="projectalign" style="padding-left: 0.5em;">
  25. <div id="projectname">1.0.2 API documentation
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.18 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */</script>
  48. <div id="main-nav"></div>
  49. </div><!-- top -->
  50. <!-- window showing the filter options -->
  51. <div id="MSearchSelectWindow"
  52. onmouseover="return searchBox.OnSearchSelectShow()"
  53. onmouseout="return searchBox.OnSearchSelectHide()"
  54. onkeydown="return searchBox.OnSearchSelectKey(event)">
  55. </div>
  56. <!-- iframe showing the search results (closed by default) -->
  57. <div id="MSearchResultsWindow">
  58. <iframe src="javascript:void(0)" frameborder="0"
  59. name="MSearchResults" id="MSearchResults">
  60. </iframe>
  61. </div>
  62. <div class="header">
  63. <div class="summary">
  64. <a href="#func-members">Functions</a> </div>
  65. <div class="headertitle">
  66. <div class="title">GLM_GTX_quaternion<div class="ingroups"><a class="el" href="a00905.html">Experimental extensions</a></div></div> </div>
  67. </div><!--header-->
  68. <div class="contents">
  69. <table class="memberdecls">
  70. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  71. Functions</h2></td></tr>
  72. <tr class="memitem:gacbbbf93d24828d6bd9ba48d43abc985e"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  73. <tr class="memitem:gacbbbf93d24828d6bd9ba48d43abc985e"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL GLM_CONSTEXPR vec&lt; 3, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00972.html#gacbbbf93d24828d6bd9ba48d43abc985e">cross</a> (qua&lt; T, Q &gt; const &amp;q, vec&lt; 3, T, Q &gt; const &amp;v)</td></tr>
  74. <tr class="memdesc:gacbbbf93d24828d6bd9ba48d43abc985e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute a cross product between a quaternion and a vector. <a href="a00972.html#gacbbbf93d24828d6bd9ba48d43abc985e">More...</a><br /></td></tr>
  75. <tr class="separator:gacbbbf93d24828d6bd9ba48d43abc985e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:ga7877a1ec00e43bbfccf6dd11894c0536"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  77. <tr class="memitem:ga7877a1ec00e43bbfccf6dd11894c0536"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL GLM_CONSTEXPR vec&lt; 3, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00972.html#ga7877a1ec00e43bbfccf6dd11894c0536">cross</a> (vec&lt; 3, T, Q &gt; const &amp;v, qua&lt; T, Q &gt; const &amp;q)</td></tr>
  78. <tr class="memdesc:ga7877a1ec00e43bbfccf6dd11894c0536"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute a cross product between a vector and a quaternion. <a href="a00972.html#ga7877a1ec00e43bbfccf6dd11894c0536">More...</a><br /></td></tr>
  79. <tr class="separator:ga7877a1ec00e43bbfccf6dd11894c0536"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:ga321953c1b2e7befe6f5dcfddbfc6b76b"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  81. <tr class="memitem:ga321953c1b2e7befe6f5dcfddbfc6b76b"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00972.html#ga321953c1b2e7befe6f5dcfddbfc6b76b">extractRealComponent</a> (qua&lt; T, Q &gt; const &amp;q)</td></tr>
  82. <tr class="memdesc:ga321953c1b2e7befe6f5dcfddbfc6b76b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Extract the real component of a quaternion. <a href="a00972.html#ga321953c1b2e7befe6f5dcfddbfc6b76b">More...</a><br /></td></tr>
  83. <tr class="separator:ga321953c1b2e7befe6f5dcfddbfc6b76b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:ga264e10708d58dd0ff53b7902a2bd2561"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  85. <tr class="memitem:ga264e10708d58dd0ff53b7902a2bd2561"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL qua&lt; T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00972.html#ga264e10708d58dd0ff53b7902a2bd2561">fastMix</a> (qua&lt; T, Q &gt; const &amp;x, qua&lt; T, Q &gt; const &amp;y, T const &amp;a)</td></tr>
  86. <tr class="memdesc:ga264e10708d58dd0ff53b7902a2bd2561"><td class="mdescLeft">&#160;</td><td class="mdescRight">Quaternion normalized linear interpolation. <a href="a00972.html#ga264e10708d58dd0ff53b7902a2bd2561">More...</a><br /></td></tr>
  87. <tr class="separator:ga264e10708d58dd0ff53b7902a2bd2561"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:gacc5cd5f3e78de61d141c2355417424de"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  89. <tr class="memitem:gacc5cd5f3e78de61d141c2355417424de"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL qua&lt; T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00972.html#gacc5cd5f3e78de61d141c2355417424de">intermediate</a> (qua&lt; T, Q &gt; const &amp;prev, qua&lt; T, Q &gt; const &amp;curr, qua&lt; T, Q &gt; const &amp;next)</td></tr>
  90. <tr class="memdesc:gacc5cd5f3e78de61d141c2355417424de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns an intermediate control point for squad interpolation. <a href="a00972.html#gacc5cd5f3e78de61d141c2355417424de">More...</a><br /></td></tr>
  91. <tr class="separator:gacc5cd5f3e78de61d141c2355417424de"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:ga08eb643306c5ba9211a81b322bc89543"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  93. <tr class="memitem:ga08eb643306c5ba9211a81b322bc89543"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL GLM_CONSTEXPR T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00972.html#ga08eb643306c5ba9211a81b322bc89543">length2</a> (qua&lt; T, Q &gt; const &amp;q)</td></tr>
  94. <tr class="memdesc:ga08eb643306c5ba9211a81b322bc89543"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the squared length of x. <a href="a00972.html#ga08eb643306c5ba9211a81b322bc89543">More...</a><br /></td></tr>
  95. <tr class="separator:ga08eb643306c5ba9211a81b322bc89543"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:ga77d9e2c313b98a1002a1b12408bf5b45"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  97. <tr class="memitem:ga77d9e2c313b98a1002a1b12408bf5b45"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL GLM_CONSTEXPR qua&lt; T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00972.html#ga77d9e2c313b98a1002a1b12408bf5b45">quat_identity</a> ()</td></tr>
  98. <tr class="memdesc:ga77d9e2c313b98a1002a1b12408bf5b45"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create an identity quaternion. <a href="a00972.html#ga77d9e2c313b98a1002a1b12408bf5b45">More...</a><br /></td></tr>
  99. <tr class="separator:ga77d9e2c313b98a1002a1b12408bf5b45"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:ga07da6ef58646442efe93b0c273d73776"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  101. <tr class="memitem:ga07da6ef58646442efe93b0c273d73776"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; 3, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00972.html#ga07da6ef58646442efe93b0c273d73776">rotate</a> (qua&lt; T, Q &gt; const &amp;q, vec&lt; 3, T, Q &gt; const &amp;v)</td></tr>
  102. <tr class="memdesc:ga07da6ef58646442efe93b0c273d73776"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns quarternion square root. <a href="a00972.html#ga07da6ef58646442efe93b0c273d73776">More...</a><br /></td></tr>
  103. <tr class="separator:ga07da6ef58646442efe93b0c273d73776"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:gafcb78dfff45fbf19a7fcb2bd03fbf196"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  105. <tr class="memitem:gafcb78dfff45fbf19a7fcb2bd03fbf196"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; 4, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00972.html#gafcb78dfff45fbf19a7fcb2bd03fbf196">rotate</a> (qua&lt; T, Q &gt; const &amp;q, vec&lt; 4, T, Q &gt; const &amp;v)</td></tr>
  106. <tr class="memdesc:gafcb78dfff45fbf19a7fcb2bd03fbf196"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rotates a 4 components vector by a quaternion. <a href="a00972.html#gafcb78dfff45fbf19a7fcb2bd03fbf196">More...</a><br /></td></tr>
  107. <tr class="separator:gafcb78dfff45fbf19a7fcb2bd03fbf196"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:ga03e61282831cc3f52cc76f72f52ad2c5"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  109. <tr class="memitem:ga03e61282831cc3f52cc76f72f52ad2c5"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL qua&lt; T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00972.html#ga03e61282831cc3f52cc76f72f52ad2c5">rotation</a> (vec&lt; 3, T, Q &gt; const &amp;orig, vec&lt; 3, T, Q &gt; const &amp;dest)</td></tr>
  110. <tr class="memdesc:ga03e61282831cc3f52cc76f72f52ad2c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute the rotation between two vectors. <a href="a00972.html#ga03e61282831cc3f52cc76f72f52ad2c5">More...</a><br /></td></tr>
  111. <tr class="separator:ga03e61282831cc3f52cc76f72f52ad2c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:gadc576cc957adc2a568cdcbc3799175bc"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  113. <tr class="memitem:gadc576cc957adc2a568cdcbc3799175bc"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL qua&lt; T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00972.html#gadc576cc957adc2a568cdcbc3799175bc">shortMix</a> (qua&lt; T, Q &gt; const &amp;x, qua&lt; T, Q &gt; const &amp;y, T const &amp;a)</td></tr>
  114. <tr class="memdesc:gadc576cc957adc2a568cdcbc3799175bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Quaternion interpolation using the rotation short path. <a href="a00972.html#gadc576cc957adc2a568cdcbc3799175bc">More...</a><br /></td></tr>
  115. <tr class="separator:gadc576cc957adc2a568cdcbc3799175bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:ga0b9bf3459e132ad8a18fe970669e3e35"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  117. <tr class="memitem:ga0b9bf3459e132ad8a18fe970669e3e35"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL qua&lt; T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00972.html#ga0b9bf3459e132ad8a18fe970669e3e35">squad</a> (qua&lt; T, Q &gt; const &amp;q1, qua&lt; T, Q &gt; const &amp;q2, qua&lt; T, Q &gt; const &amp;s1, qua&lt; T, Q &gt; const &amp;s2, T const &amp;h)</td></tr>
  118. <tr class="memdesc:ga0b9bf3459e132ad8a18fe970669e3e35"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute a point on a path according squad equation. <a href="a00972.html#ga0b9bf3459e132ad8a18fe970669e3e35">More...</a><br /></td></tr>
  119. <tr class="separator:ga0b9bf3459e132ad8a18fe970669e3e35"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:gac228e3fcfa813841804362fcae02b337"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  121. <tr class="memitem:gac228e3fcfa813841804362fcae02b337"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_QUALIFIER mat&lt; 3, 3, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00972.html#gac228e3fcfa813841804362fcae02b337">toMat3</a> (qua&lt; T, Q &gt; const &amp;x)</td></tr>
  122. <tr class="memdesc:gac228e3fcfa813841804362fcae02b337"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts a quaternion to a 3 * 3 matrix. <a href="a00972.html#gac228e3fcfa813841804362fcae02b337">More...</a><br /></td></tr>
  123. <tr class="separator:gac228e3fcfa813841804362fcae02b337"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:gad0d0c14d7d3c852b41d6a6e4d1da6606"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  125. <tr class="memitem:gad0d0c14d7d3c852b41d6a6e4d1da6606"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_QUALIFIER mat&lt; 4, 4, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00972.html#gad0d0c14d7d3c852b41d6a6e4d1da6606">toMat4</a> (qua&lt; T, Q &gt; const &amp;x)</td></tr>
  126. <tr class="memdesc:gad0d0c14d7d3c852b41d6a6e4d1da6606"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts a quaternion to a 4 * 4 matrix. <a href="a00972.html#gad0d0c14d7d3c852b41d6a6e4d1da6606">More...</a><br /></td></tr>
  127. <tr class="separator:gad0d0c14d7d3c852b41d6a6e4d1da6606"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:ga7b2be33d948db631c8815e9f2953a451"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  129. <tr class="memitem:ga7b2be33d948db631c8815e9f2953a451"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_QUALIFIER qua&lt; T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00972.html#ga7b2be33d948db631c8815e9f2953a451">toQuat</a> (mat&lt; 3, 3, T, Q &gt; const &amp;x)</td></tr>
  130. <tr class="memdesc:ga7b2be33d948db631c8815e9f2953a451"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts a 3 * 3 matrix to a quaternion. <a href="a00972.html#ga7b2be33d948db631c8815e9f2953a451">More...</a><br /></td></tr>
  131. <tr class="separator:ga7b2be33d948db631c8815e9f2953a451"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:ga4cf12d456770d716b590fd498bce6136"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  133. <tr class="memitem:ga4cf12d456770d716b590fd498bce6136"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_QUALIFIER qua&lt; T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00972.html#ga4cf12d456770d716b590fd498bce6136">toQuat</a> (mat&lt; 4, 4, T, Q &gt; const &amp;x)</td></tr>
  134. <tr class="memdesc:ga4cf12d456770d716b590fd498bce6136"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts a 4 * 4 matrix to a quaternion. <a href="a00972.html#ga4cf12d456770d716b590fd498bce6136">More...</a><br /></td></tr>
  135. <tr class="separator:ga4cf12d456770d716b590fd498bce6136"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. </table>
  137. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  138. <p>Include &lt;<a class="el" href="a01714.html" title="GLM_GTX_quaternion">glm/gtx/quaternion.hpp</a>&gt; to use the features of this extension.</p>
  139. <p>Extended quaternion types and functions </p>
  140. <h2 class="groupheader">Function Documentation</h2>
  141. <a id="gacbbbf93d24828d6bd9ba48d43abc985e"></a>
  142. <h2 class="memtitle"><span class="permalink"><a href="#gacbbbf93d24828d6bd9ba48d43abc985e">&#9670;&nbsp;</a></span>cross() <span class="overload">[1/2]</span></h2>
  143. <div class="memitem">
  144. <div class="memproto">
  145. <table class="memname">
  146. <tr>
  147. <td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR vec&lt;3, T, Q&gt; glm::cross </td>
  148. <td>(</td>
  149. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  150. <td class="paramname"><em>q</em>, </td>
  151. </tr>
  152. <tr>
  153. <td class="paramkey"></td>
  154. <td></td>
  155. <td class="paramtype">vec&lt; 3, T, Q &gt; const &amp;&#160;</td>
  156. <td class="paramname"><em>v</em>&#160;</td>
  157. </tr>
  158. <tr>
  159. <td></td>
  160. <td>)</td>
  161. <td></td><td></td>
  162. </tr>
  163. </table>
  164. </div><div class="memdoc">
  165. <p>Compute a cross product between a quaternion and a vector. </p>
  166. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00972.html">GLM_GTX_quaternion</a> </dd></dl>
  167. </div>
  168. </div>
  169. <a id="ga7877a1ec00e43bbfccf6dd11894c0536"></a>
  170. <h2 class="memtitle"><span class="permalink"><a href="#ga7877a1ec00e43bbfccf6dd11894c0536">&#9670;&nbsp;</a></span>cross() <span class="overload">[2/2]</span></h2>
  171. <div class="memitem">
  172. <div class="memproto">
  173. <table class="memname">
  174. <tr>
  175. <td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR vec&lt;3, T, Q&gt; glm::cross </td>
  176. <td>(</td>
  177. <td class="paramtype">vec&lt; 3, T, Q &gt; const &amp;&#160;</td>
  178. <td class="paramname"><em>v</em>, </td>
  179. </tr>
  180. <tr>
  181. <td class="paramkey"></td>
  182. <td></td>
  183. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  184. <td class="paramname"><em>q</em>&#160;</td>
  185. </tr>
  186. <tr>
  187. <td></td>
  188. <td>)</td>
  189. <td></td><td></td>
  190. </tr>
  191. </table>
  192. </div><div class="memdoc">
  193. <p>Compute a cross product between a vector and a quaternion. </p>
  194. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00972.html">GLM_GTX_quaternion</a> </dd></dl>
  195. </div>
  196. </div>
  197. <a id="ga321953c1b2e7befe6f5dcfddbfc6b76b"></a>
  198. <h2 class="memtitle"><span class="permalink"><a href="#ga321953c1b2e7befe6f5dcfddbfc6b76b">&#9670;&nbsp;</a></span>extractRealComponent()</h2>
  199. <div class="memitem">
  200. <div class="memproto">
  201. <table class="memname">
  202. <tr>
  203. <td class="memname">GLM_FUNC_DECL T glm::extractRealComponent </td>
  204. <td>(</td>
  205. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  206. <td class="paramname"><em>q</em></td><td>)</td>
  207. <td></td>
  208. </tr>
  209. </table>
  210. </div><div class="memdoc">
  211. <p>Extract the real component of a quaternion. </p>
  212. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00972.html">GLM_GTX_quaternion</a> </dd></dl>
  213. </div>
  214. </div>
  215. <a id="ga264e10708d58dd0ff53b7902a2bd2561"></a>
  216. <h2 class="memtitle"><span class="permalink"><a href="#ga264e10708d58dd0ff53b7902a2bd2561">&#9670;&nbsp;</a></span>fastMix()</h2>
  217. <div class="memitem">
  218. <div class="memproto">
  219. <table class="memname">
  220. <tr>
  221. <td class="memname">GLM_FUNC_DECL qua&lt;T, Q&gt; glm::fastMix </td>
  222. <td>(</td>
  223. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  224. <td class="paramname"><em>x</em>, </td>
  225. </tr>
  226. <tr>
  227. <td class="paramkey"></td>
  228. <td></td>
  229. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  230. <td class="paramname"><em>y</em>, </td>
  231. </tr>
  232. <tr>
  233. <td class="paramkey"></td>
  234. <td></td>
  235. <td class="paramtype">T const &amp;&#160;</td>
  236. <td class="paramname"><em>a</em>&#160;</td>
  237. </tr>
  238. <tr>
  239. <td></td>
  240. <td>)</td>
  241. <td></td><td></td>
  242. </tr>
  243. </table>
  244. </div><div class="memdoc">
  245. <p>Quaternion normalized linear interpolation. </p>
  246. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00972.html">GLM_GTX_quaternion</a> </dd></dl>
  247. </div>
  248. </div>
  249. <a id="gacc5cd5f3e78de61d141c2355417424de"></a>
  250. <h2 class="memtitle"><span class="permalink"><a href="#gacc5cd5f3e78de61d141c2355417424de">&#9670;&nbsp;</a></span>intermediate()</h2>
  251. <div class="memitem">
  252. <div class="memproto">
  253. <table class="memname">
  254. <tr>
  255. <td class="memname">GLM_FUNC_DECL qua&lt;T, Q&gt; glm::intermediate </td>
  256. <td>(</td>
  257. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  258. <td class="paramname"><em>prev</em>, </td>
  259. </tr>
  260. <tr>
  261. <td class="paramkey"></td>
  262. <td></td>
  263. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  264. <td class="paramname"><em>curr</em>, </td>
  265. </tr>
  266. <tr>
  267. <td class="paramkey"></td>
  268. <td></td>
  269. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  270. <td class="paramname"><em>next</em>&#160;</td>
  271. </tr>
  272. <tr>
  273. <td></td>
  274. <td>)</td>
  275. <td></td><td></td>
  276. </tr>
  277. </table>
  278. </div><div class="memdoc">
  279. <p>Returns an intermediate control point for squad interpolation. </p>
  280. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00972.html">GLM_GTX_quaternion</a> </dd></dl>
  281. </div>
  282. </div>
  283. <a id="ga08eb643306c5ba9211a81b322bc89543"></a>
  284. <h2 class="memtitle"><span class="permalink"><a href="#ga08eb643306c5ba9211a81b322bc89543">&#9670;&nbsp;</a></span>length2()</h2>
  285. <div class="memitem">
  286. <div class="memproto">
  287. <table class="memname">
  288. <tr>
  289. <td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR T glm::length2 </td>
  290. <td>(</td>
  291. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  292. <td class="paramname"><em>q</em></td><td>)</td>
  293. <td></td>
  294. </tr>
  295. </table>
  296. </div><div class="memdoc">
  297. <p>Returns the squared length of x. </p>
  298. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00972.html">GLM_GTX_quaternion</a> </dd></dl>
  299. </div>
  300. </div>
  301. <a id="ga77d9e2c313b98a1002a1b12408bf5b45"></a>
  302. <h2 class="memtitle"><span class="permalink"><a href="#ga77d9e2c313b98a1002a1b12408bf5b45">&#9670;&nbsp;</a></span>quat_identity()</h2>
  303. <div class="memitem">
  304. <div class="memproto">
  305. <table class="memname">
  306. <tr>
  307. <td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR qua&lt;T, Q&gt; glm::quat_identity </td>
  308. <td>(</td>
  309. <td class="paramname"></td><td>)</td>
  310. <td></td>
  311. </tr>
  312. </table>
  313. </div><div class="memdoc">
  314. <p>Create an identity quaternion. </p>
  315. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00972.html">GLM_GTX_quaternion</a> </dd></dl>
  316. </div>
  317. </div>
  318. <a id="ga07da6ef58646442efe93b0c273d73776"></a>
  319. <h2 class="memtitle"><span class="permalink"><a href="#ga07da6ef58646442efe93b0c273d73776">&#9670;&nbsp;</a></span>rotate() <span class="overload">[1/2]</span></h2>
  320. <div class="memitem">
  321. <div class="memproto">
  322. <table class="memname">
  323. <tr>
  324. <td class="memname">GLM_FUNC_DECL vec&lt;3, T, Q&gt; glm::rotate </td>
  325. <td>(</td>
  326. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  327. <td class="paramname"><em>q</em>, </td>
  328. </tr>
  329. <tr>
  330. <td class="paramkey"></td>
  331. <td></td>
  332. <td class="paramtype">vec&lt; 3, T, Q &gt; const &amp;&#160;</td>
  333. <td class="paramname"><em>v</em>&#160;</td>
  334. </tr>
  335. <tr>
  336. <td></td>
  337. <td>)</td>
  338. <td></td><td></td>
  339. </tr>
  340. </table>
  341. </div><div class="memdoc">
  342. <p>Returns quarternion square root. </p>
  343. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00972.html">GLM_GTX_quaternion</a> Rotates a 3 components vector by a quaternion.</dd>
  344. <dd>
  345. <a class="el" href="a00972.html">GLM_GTX_quaternion</a> </dd></dl>
  346. </div>
  347. </div>
  348. <a id="gafcb78dfff45fbf19a7fcb2bd03fbf196"></a>
  349. <h2 class="memtitle"><span class="permalink"><a href="#gafcb78dfff45fbf19a7fcb2bd03fbf196">&#9670;&nbsp;</a></span>rotate() <span class="overload">[2/2]</span></h2>
  350. <div class="memitem">
  351. <div class="memproto">
  352. <table class="memname">
  353. <tr>
  354. <td class="memname">GLM_FUNC_DECL vec&lt;4, T, Q&gt; glm::rotate </td>
  355. <td>(</td>
  356. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  357. <td class="paramname"><em>q</em>, </td>
  358. </tr>
  359. <tr>
  360. <td class="paramkey"></td>
  361. <td></td>
  362. <td class="paramtype">vec&lt; 4, T, Q &gt; const &amp;&#160;</td>
  363. <td class="paramname"><em>v</em>&#160;</td>
  364. </tr>
  365. <tr>
  366. <td></td>
  367. <td>)</td>
  368. <td></td><td></td>
  369. </tr>
  370. </table>
  371. </div><div class="memdoc">
  372. <p>Rotates a 4 components vector by a quaternion. </p>
  373. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00972.html">GLM_GTX_quaternion</a> </dd></dl>
  374. </div>
  375. </div>
  376. <a id="ga03e61282831cc3f52cc76f72f52ad2c5"></a>
  377. <h2 class="memtitle"><span class="permalink"><a href="#ga03e61282831cc3f52cc76f72f52ad2c5">&#9670;&nbsp;</a></span>rotation()</h2>
  378. <div class="memitem">
  379. <div class="memproto">
  380. <table class="memname">
  381. <tr>
  382. <td class="memname">GLM_FUNC_DECL qua&lt;T, Q&gt; glm::rotation </td>
  383. <td>(</td>
  384. <td class="paramtype">vec&lt; 3, T, Q &gt; const &amp;&#160;</td>
  385. <td class="paramname"><em>orig</em>, </td>
  386. </tr>
  387. <tr>
  388. <td class="paramkey"></td>
  389. <td></td>
  390. <td class="paramtype">vec&lt; 3, T, Q &gt; const &amp;&#160;</td>
  391. <td class="paramname"><em>dest</em>&#160;</td>
  392. </tr>
  393. <tr>
  394. <td></td>
  395. <td>)</td>
  396. <td></td><td></td>
  397. </tr>
  398. </table>
  399. </div><div class="memdoc">
  400. <p>Compute the rotation between two vectors. </p>
  401. <dl class="params"><dt>Parameters</dt><dd>
  402. <table class="params">
  403. <tr><td class="paramname">orig</td><td>vector, needs to be normalized </td></tr>
  404. <tr><td class="paramname">dest</td><td>vector, needs to be normalized</td></tr>
  405. </table>
  406. </dd>
  407. </dl>
  408. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00972.html">GLM_GTX_quaternion</a> </dd></dl>
  409. </div>
  410. </div>
  411. <a id="gadc576cc957adc2a568cdcbc3799175bc"></a>
  412. <h2 class="memtitle"><span class="permalink"><a href="#gadc576cc957adc2a568cdcbc3799175bc">&#9670;&nbsp;</a></span>shortMix()</h2>
  413. <div class="memitem">
  414. <div class="memproto">
  415. <table class="memname">
  416. <tr>
  417. <td class="memname">GLM_FUNC_DECL qua&lt;T, Q&gt; glm::shortMix </td>
  418. <td>(</td>
  419. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  420. <td class="paramname"><em>x</em>, </td>
  421. </tr>
  422. <tr>
  423. <td class="paramkey"></td>
  424. <td></td>
  425. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  426. <td class="paramname"><em>y</em>, </td>
  427. </tr>
  428. <tr>
  429. <td class="paramkey"></td>
  430. <td></td>
  431. <td class="paramtype">T const &amp;&#160;</td>
  432. <td class="paramname"><em>a</em>&#160;</td>
  433. </tr>
  434. <tr>
  435. <td></td>
  436. <td>)</td>
  437. <td></td><td></td>
  438. </tr>
  439. </table>
  440. </div><div class="memdoc">
  441. <p>Quaternion interpolation using the rotation short path. </p>
  442. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00972.html">GLM_GTX_quaternion</a> </dd></dl>
  443. </div>
  444. </div>
  445. <a id="ga0b9bf3459e132ad8a18fe970669e3e35"></a>
  446. <h2 class="memtitle"><span class="permalink"><a href="#ga0b9bf3459e132ad8a18fe970669e3e35">&#9670;&nbsp;</a></span>squad()</h2>
  447. <div class="memitem">
  448. <div class="memproto">
  449. <table class="memname">
  450. <tr>
  451. <td class="memname">GLM_FUNC_DECL qua&lt;T, Q&gt; glm::squad </td>
  452. <td>(</td>
  453. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  454. <td class="paramname"><em>q1</em>, </td>
  455. </tr>
  456. <tr>
  457. <td class="paramkey"></td>
  458. <td></td>
  459. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  460. <td class="paramname"><em>q2</em>, </td>
  461. </tr>
  462. <tr>
  463. <td class="paramkey"></td>
  464. <td></td>
  465. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  466. <td class="paramname"><em>s1</em>, </td>
  467. </tr>
  468. <tr>
  469. <td class="paramkey"></td>
  470. <td></td>
  471. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  472. <td class="paramname"><em>s2</em>, </td>
  473. </tr>
  474. <tr>
  475. <td class="paramkey"></td>
  476. <td></td>
  477. <td class="paramtype">T const &amp;&#160;</td>
  478. <td class="paramname"><em>h</em>&#160;</td>
  479. </tr>
  480. <tr>
  481. <td></td>
  482. <td>)</td>
  483. <td></td><td></td>
  484. </tr>
  485. </table>
  486. </div><div class="memdoc">
  487. <p>Compute a point on a path according squad equation. </p>
  488. <p>q1 and q2 are control points; s1 and s2 are intermediate control points.</p>
  489. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00972.html">GLM_GTX_quaternion</a> </dd></dl>
  490. </div>
  491. </div>
  492. <a id="gac228e3fcfa813841804362fcae02b337"></a>
  493. <h2 class="memtitle"><span class="permalink"><a href="#gac228e3fcfa813841804362fcae02b337">&#9670;&nbsp;</a></span>toMat3()</h2>
  494. <div class="memitem">
  495. <div class="memproto">
  496. <table class="memname">
  497. <tr>
  498. <td class="memname">GLM_FUNC_QUALIFIER mat&lt;3, 3, T, Q&gt; glm::toMat3 </td>
  499. <td>(</td>
  500. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  501. <td class="paramname"><em>x</em></td><td>)</td>
  502. <td></td>
  503. </tr>
  504. </table>
  505. </div><div class="memdoc">
  506. <p>Converts a quaternion to a 3 * 3 matrix. </p>
  507. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00972.html">GLM_GTX_quaternion</a> </dd></dl>
  508. <p class="definition">Definition at line <a class="el" href="a01714_source.html#l00111">111</a> of file <a class="el" href="a01714_source.html">gtx/quaternion.hpp</a>.</p>
  509. <p class="reference">References <a class="el" href="a00917.html#ga333ab70047fbe4132406100c292dbc89">glm::mat3_cast()</a>.</p>
  510. </div>
  511. </div>
  512. <a id="gad0d0c14d7d3c852b41d6a6e4d1da6606"></a>
  513. <h2 class="memtitle"><span class="permalink"><a href="#gad0d0c14d7d3c852b41d6a6e4d1da6606">&#9670;&nbsp;</a></span>toMat4()</h2>
  514. <div class="memitem">
  515. <div class="memproto">
  516. <table class="memname">
  517. <tr>
  518. <td class="memname">GLM_FUNC_QUALIFIER mat&lt;4, 4, T, Q&gt; glm::toMat4 </td>
  519. <td>(</td>
  520. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  521. <td class="paramname"><em>x</em></td><td>)</td>
  522. <td></td>
  523. </tr>
  524. </table>
  525. </div><div class="memdoc">
  526. <p>Converts a quaternion to a 4 * 4 matrix. </p>
  527. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00972.html">GLM_GTX_quaternion</a> </dd></dl>
  528. <p class="definition">Definition at line <a class="el" href="a01714_source.html#l00118">118</a> of file <a class="el" href="a01714_source.html">gtx/quaternion.hpp</a>.</p>
  529. <p class="reference">References <a class="el" href="a00917.html#ga1113212d9bdefc2e31ad40e5bbb506f3">glm::mat4_cast()</a>.</p>
  530. </div>
  531. </div>
  532. <a id="ga7b2be33d948db631c8815e9f2953a451"></a>
  533. <h2 class="memtitle"><span class="permalink"><a href="#ga7b2be33d948db631c8815e9f2953a451">&#9670;&nbsp;</a></span>toQuat() <span class="overload">[1/2]</span></h2>
  534. <div class="memitem">
  535. <div class="memproto">
  536. <table class="memname">
  537. <tr>
  538. <td class="memname">GLM_FUNC_QUALIFIER qua&lt;T, Q&gt; glm::toQuat </td>
  539. <td>(</td>
  540. <td class="paramtype">mat&lt; 3, 3, T, Q &gt; const &amp;&#160;</td>
  541. <td class="paramname"><em>x</em></td><td>)</td>
  542. <td></td>
  543. </tr>
  544. </table>
  545. </div><div class="memdoc">
  546. <p>Converts a 3 * 3 matrix to a quaternion. </p>
  547. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00972.html">GLM_GTX_quaternion</a> </dd></dl>
  548. <p class="definition">Definition at line <a class="el" href="a01714_source.html#l00125">125</a> of file <a class="el" href="a01714_source.html">gtx/quaternion.hpp</a>.</p>
  549. <p class="reference">References <a class="el" href="a00917.html#ga1108a4ab88ca87bac321454eea7702f8">glm::quat_cast()</a>.</p>
  550. </div>
  551. </div>
  552. <a id="ga4cf12d456770d716b590fd498bce6136"></a>
  553. <h2 class="memtitle"><span class="permalink"><a href="#ga4cf12d456770d716b590fd498bce6136">&#9670;&nbsp;</a></span>toQuat() <span class="overload">[2/2]</span></h2>
  554. <div class="memitem">
  555. <div class="memproto">
  556. <table class="memname">
  557. <tr>
  558. <td class="memname">GLM_FUNC_QUALIFIER qua&lt;T, Q&gt; glm::toQuat </td>
  559. <td>(</td>
  560. <td class="paramtype">mat&lt; 4, 4, T, Q &gt; const &amp;&#160;</td>
  561. <td class="paramname"><em>x</em></td><td>)</td>
  562. <td></td>
  563. </tr>
  564. </table>
  565. </div><div class="memdoc">
  566. <p>Converts a 4 * 4 matrix to a quaternion. </p>
  567. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00972.html">GLM_GTX_quaternion</a> </dd></dl>
  568. <p class="definition">Definition at line <a class="el" href="a01714_source.html#l00132">132</a> of file <a class="el" href="a01714_source.html">gtx/quaternion.hpp</a>.</p>
  569. <p class="reference">References <a class="el" href="a00917.html#ga1108a4ab88ca87bac321454eea7702f8">glm::quat_cast()</a>.</p>
  570. </div>
  571. </div>
  572. </div><!-- contents -->
  573. <!-- start footer part -->
  574. <hr class="footer"/><address class="footer"><small>
  575. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  576. <img class="footer" src="doxygen.png" alt="doxygen"/>
  577. </a> 1.8.18
  578. </small></address>
  579. </body>
  580. </html>