2
0

a00862.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240
  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_EXT_quaternion_geometric</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_EXT_quaternion_geometric<div class="ingroups"><a class="el" href="a00903.html">Stable 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:ga9a47ad9ca44bc04eeaac260d42105134"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  73. <tr class="memitem:ga9a47ad9ca44bc04eeaac260d42105134"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_QUALIFIER GLM_CONSTEXPR qua&lt; T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00862.html#ga9a47ad9ca44bc04eeaac260d42105134">cross</a> (qua&lt; T, Q &gt; const &amp;q1, qua&lt; T, Q &gt; const &amp;q2)</td></tr>
  74. <tr class="memdesc:ga9a47ad9ca44bc04eeaac260d42105134"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute a cross product. <a href="a00862.html#ga9a47ad9ca44bc04eeaac260d42105134">More...</a><br /></td></tr>
  75. <tr class="separator:ga9a47ad9ca44bc04eeaac260d42105134"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:gadaab7b4495755b4102838d7834cd9544"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  77. <tr class="memitem:gadaab7b4495755b4102838d7834cd9544"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL GLM_CONSTEXPR T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00862.html#gadaab7b4495755b4102838d7834cd9544">dot</a> (qua&lt; T, Q &gt; const &amp;x, qua&lt; T, Q &gt; const &amp;y)</td></tr>
  78. <tr class="memdesc:gadaab7b4495755b4102838d7834cd9544"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns dot product of q1 and q2, i.e., q1[0] * q2[0] + q1[1] * q2[1] + ... <a href="a00862.html#gadaab7b4495755b4102838d7834cd9544">More...</a><br /></td></tr>
  79. <tr class="separator:gadaab7b4495755b4102838d7834cd9544"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:gab703732449be6c7199369b3f9a91ed38"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  81. <tr class="memitem:gab703732449be6c7199369b3f9a91ed38"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00862.html#gab703732449be6c7199369b3f9a91ed38">length</a> (qua&lt; T, Q &gt; const &amp;q)</td></tr>
  82. <tr class="memdesc:gab703732449be6c7199369b3f9a91ed38"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the norm of a quaternions. <a href="a00862.html#gab703732449be6c7199369b3f9a91ed38">More...</a><br /></td></tr>
  83. <tr class="separator:gab703732449be6c7199369b3f9a91ed38"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:gad815f4de07f2fe6502cdd2cd86c3dabd"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  85. <tr class="memitem:gad815f4de07f2fe6502cdd2cd86c3dabd"><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="a00862.html#gad815f4de07f2fe6502cdd2cd86c3dabd">normalize</a> (qua&lt; T, Q &gt; const &amp;q)</td></tr>
  86. <tr class="memdesc:gad815f4de07f2fe6502cdd2cd86c3dabd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the normalized quaternion. <a href="a00862.html#gad815f4de07f2fe6502cdd2cd86c3dabd">More...</a><br /></td></tr>
  87. <tr class="separator:gad815f4de07f2fe6502cdd2cd86c3dabd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. </table>
  89. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  90. <p>Provides geometric functions for quaternion types</p>
  91. <p>Include &lt;<a class="el" href="a00344.html" title="GLM_EXT_quaternion_geometric">glm/ext/quaternion_geometric.hpp</a>&gt; to use the features of this extension.</p>
  92. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00897.html">Geometric functions</a> </dd>
  93. <dd>
  94. <a class="el" href="a00860.html">GLM_EXT_quaternion_float</a> </dd>
  95. <dd>
  96. <a class="el" href="a00857.html">GLM_EXT_quaternion_double</a> </dd></dl>
  97. <h2 class="groupheader">Function Documentation</h2>
  98. <a id="ga9a47ad9ca44bc04eeaac260d42105134"></a>
  99. <h2 class="memtitle"><span class="permalink"><a href="#ga9a47ad9ca44bc04eeaac260d42105134">&#9670;&nbsp;</a></span>cross()</h2>
  100. <div class="memitem">
  101. <div class="memproto">
  102. <table class="memname">
  103. <tr>
  104. <td class="memname">GLM_FUNC_QUALIFIER GLM_CONSTEXPR qua&lt;T, Q&gt; glm::cross </td>
  105. <td>(</td>
  106. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  107. <td class="paramname"><em>q1</em>, </td>
  108. </tr>
  109. <tr>
  110. <td class="paramkey"></td>
  111. <td></td>
  112. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  113. <td class="paramname"><em>q2</em>&#160;</td>
  114. </tr>
  115. <tr>
  116. <td></td>
  117. <td>)</td>
  118. <td></td><td></td>
  119. </tr>
  120. </table>
  121. </div><div class="memdoc">
  122. <p>Compute a cross product. </p>
  123. <dl class="tparams"><dt>Template Parameters</dt><dd>
  124. <table class="tparams">
  125. <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
  126. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  127. </table>
  128. </dd>
  129. </dl>
  130. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00862.html">GLM_EXT_quaternion_geometric</a> </dd></dl>
  131. </div>
  132. </div>
  133. <a id="gadaab7b4495755b4102838d7834cd9544"></a>
  134. <h2 class="memtitle"><span class="permalink"><a href="#gadaab7b4495755b4102838d7834cd9544">&#9670;&nbsp;</a></span>dot()</h2>
  135. <div class="memitem">
  136. <div class="memproto">
  137. <table class="memname">
  138. <tr>
  139. <td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR T glm::dot </td>
  140. <td>(</td>
  141. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  142. <td class="paramname"><em>x</em>, </td>
  143. </tr>
  144. <tr>
  145. <td class="paramkey"></td>
  146. <td></td>
  147. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  148. <td class="paramname"><em>y</em>&#160;</td>
  149. </tr>
  150. <tr>
  151. <td></td>
  152. <td>)</td>
  153. <td></td><td></td>
  154. </tr>
  155. </table>
  156. </div><div class="memdoc">
  157. <p>Returns dot product of q1 and q2, i.e., q1[0] * q2[0] + q1[1] * q2[1] + ... </p>
  158. <dl class="tparams"><dt>Template Parameters</dt><dd>
  159. <table class="tparams">
  160. <tr><td class="paramname">T</td><td>Floating-point scalar types. </td></tr>
  161. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  162. </table>
  163. </dd>
  164. </dl>
  165. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00862.html">GLM_EXT_quaternion_geometric</a> </dd></dl>
  166. </div>
  167. </div>
  168. <a id="gab703732449be6c7199369b3f9a91ed38"></a>
  169. <h2 class="memtitle"><span class="permalink"><a href="#gab703732449be6c7199369b3f9a91ed38">&#9670;&nbsp;</a></span>length()</h2>
  170. <div class="memitem">
  171. <div class="memproto">
  172. <table class="memname">
  173. <tr>
  174. <td class="memname">GLM_FUNC_DECL T glm::length </td>
  175. <td>(</td>
  176. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  177. <td class="paramname"><em>q</em></td><td>)</td>
  178. <td></td>
  179. </tr>
  180. </table>
  181. </div><div class="memdoc">
  182. <p>Returns the norm of a quaternions. </p>
  183. <dl class="tparams"><dt>Template Parameters</dt><dd>
  184. <table class="tparams">
  185. <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
  186. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  187. </table>
  188. </dd>
  189. </dl>
  190. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00862.html">GLM_EXT_quaternion_geometric</a> </dd></dl>
  191. </div>
  192. </div>
  193. <a id="gad815f4de07f2fe6502cdd2cd86c3dabd"></a>
  194. <h2 class="memtitle"><span class="permalink"><a href="#gad815f4de07f2fe6502cdd2cd86c3dabd">&#9670;&nbsp;</a></span>normalize()</h2>
  195. <div class="memitem">
  196. <div class="memproto">
  197. <table class="memname">
  198. <tr>
  199. <td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR qua&lt;T, Q&gt; glm::normalize </td>
  200. <td>(</td>
  201. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  202. <td class="paramname"><em>q</em></td><td>)</td>
  203. <td></td>
  204. </tr>
  205. </table>
  206. </div><div class="memdoc">
  207. <p>Returns the normalized quaternion. </p>
  208. <dl class="tparams"><dt>Template Parameters</dt><dd>
  209. <table class="tparams">
  210. <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
  211. <tr><td class="paramname">Q</td><td>Value from qualifier enum</td></tr>
  212. </table>
  213. </dd>
  214. </dl>
  215. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00862.html">GLM_EXT_quaternion_geometric</a> </dd></dl>
  216. </div>
  217. </div>
  218. </div><!-- contents -->
  219. <!-- start footer part -->
  220. <hr class="footer"/><address class="footer"><small>
  221. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  222. <img class="footer" src="doxygen.png" alt="doxygen"/>
  223. </a> 1.8.18
  224. </small></address>
  225. </body>
  226. </html>