a00856.html 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464
  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_common</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_common<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:ga5b646f1cd4422eb76ab90496bcd0b60a"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  73. <tr class="memitem:ga5b646f1cd4422eb76ab90496bcd0b60a"><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="a00856.html#ga5b646f1cd4422eb76ab90496bcd0b60a">conjugate</a> (qua&lt; T, Q &gt; const &amp;q)</td></tr>
  74. <tr class="memdesc:ga5b646f1cd4422eb76ab90496bcd0b60a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the q conjugate. <a href="a00856.html#ga5b646f1cd4422eb76ab90496bcd0b60a">More...</a><br /></td></tr>
  75. <tr class="separator:ga5b646f1cd4422eb76ab90496bcd0b60a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:ga50db49335150de11562052667537e517"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  77. <tr class="memitem:ga50db49335150de11562052667537e517"><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="a00856.html#ga50db49335150de11562052667537e517">inverse</a> (qua&lt; T, Q &gt; const &amp;q)</td></tr>
  78. <tr class="memdesc:ga50db49335150de11562052667537e517"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the q inverse. <a href="a00856.html#ga50db49335150de11562052667537e517">More...</a><br /></td></tr>
  79. <tr class="separator:ga50db49335150de11562052667537e517"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:ga45722741ea266b4e861938b365c5f362"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  81. <tr class="memitem:ga45722741ea266b4e861938b365c5f362"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; 4, bool, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00856.html#ga45722741ea266b4e861938b365c5f362">isinf</a> (qua&lt; T, Q &gt; const &amp;x)</td></tr>
  82. <tr class="memdesc:ga45722741ea266b4e861938b365c5f362"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if x holds a positive infinity or negative infinity representation in the underlying implementation's set of floating point representations. <a href="a00856.html#ga45722741ea266b4e861938b365c5f362">More...</a><br /></td></tr>
  83. <tr class="separator:ga45722741ea266b4e861938b365c5f362"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:ga1bb55f8963616502e96dc564384d8a03"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  85. <tr class="memitem:ga1bb55f8963616502e96dc564384d8a03"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; 4, bool, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00856.html#ga1bb55f8963616502e96dc564384d8a03">isnan</a> (qua&lt; T, Q &gt; const &amp;x)</td></tr>
  86. <tr class="memdesc:ga1bb55f8963616502e96dc564384d8a03"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if x holds a NaN (not a number) representation in the underlying implementation's set of floating point representations. <a href="a00856.html#ga1bb55f8963616502e96dc564384d8a03">More...</a><br /></td></tr>
  87. <tr class="separator:ga1bb55f8963616502e96dc564384d8a03"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:gaacd3d0591852faa4bc291b61da88ad44"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  89. <tr class="memitem:gaacd3d0591852faa4bc291b61da88ad44"><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="a00856.html#gaacd3d0591852faa4bc291b61da88ad44">lerp</a> (qua&lt; T, Q &gt; const &amp;x, qua&lt; T, Q &gt; const &amp;y, T a)</td></tr>
  90. <tr class="memdesc:gaacd3d0591852faa4bc291b61da88ad44"><td class="mdescLeft">&#160;</td><td class="mdescRight">Linear interpolation of two quaternions. <a href="a00856.html#gaacd3d0591852faa4bc291b61da88ad44">More...</a><br /></td></tr>
  91. <tr class="separator:gaacd3d0591852faa4bc291b61da88ad44"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:gafbfe587b8da11fb89a30c3d67dd5ccc2"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  93. <tr class="memitem:gafbfe587b8da11fb89a30c3d67dd5ccc2"><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="a00856.html#gafbfe587b8da11fb89a30c3d67dd5ccc2">mix</a> (qua&lt; T, Q &gt; const &amp;x, qua&lt; T, Q &gt; const &amp;y, T a)</td></tr>
  94. <tr class="memdesc:gafbfe587b8da11fb89a30c3d67dd5ccc2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Spherical linear interpolation of two quaternions. <a href="a00856.html#gafbfe587b8da11fb89a30c3d67dd5ccc2">More...</a><br /></td></tr>
  95. <tr class="separator:gafbfe587b8da11fb89a30c3d67dd5ccc2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:gae7fc3c945be366b9942b842f55da428a"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  97. <tr class="memitem:gae7fc3c945be366b9942b842f55da428a"><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="a00856.html#gae7fc3c945be366b9942b842f55da428a">slerp</a> (qua&lt; T, Q &gt; const &amp;x, qua&lt; T, Q &gt; const &amp;y, T a)</td></tr>
  98. <tr class="memdesc:gae7fc3c945be366b9942b842f55da428a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Spherical linear interpolation of two quaternions. <a href="a00856.html#gae7fc3c945be366b9942b842f55da428a">More...</a><br /></td></tr>
  99. <tr class="separator:gae7fc3c945be366b9942b842f55da428a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:ga8514da9c52cfee86f716cc0933ce118a"><td class="memTemplParams" colspan="2">template&lt;typename T , typename S , qualifier Q&gt; </td></tr>
  101. <tr class="memitem:ga8514da9c52cfee86f716cc0933ce118a"><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="a00856.html#ga8514da9c52cfee86f716cc0933ce118a">slerp</a> (qua&lt; T, Q &gt; const &amp;x, qua&lt; T, Q &gt; const &amp;y, T a, S k)</td></tr>
  102. <tr class="memdesc:ga8514da9c52cfee86f716cc0933ce118a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Spherical linear interpolation of two quaternions with multiple spins over rotation axis. <a href="a00856.html#ga8514da9c52cfee86f716cc0933ce118a">More...</a><br /></td></tr>
  103. <tr class="separator:ga8514da9c52cfee86f716cc0933ce118a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. </table>
  105. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  106. <p>Provides common functions for quaternion types</p>
  107. <p>Include &lt;<a class="el" href="a00326.html" title="GLM_EXT_quaternion_common">glm/ext/quaternion_common.hpp</a>&gt; to use the features of this extension.</p>
  108. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00866.html">GLM_EXT_scalar_common</a> </dd>
  109. <dd>
  110. <a class="el" href="a00877.html">GLM_EXT_vector_common</a> </dd>
  111. <dd>
  112. <a class="el" href="a00860.html">GLM_EXT_quaternion_float</a> </dd>
  113. <dd>
  114. <a class="el" href="a00857.html">GLM_EXT_quaternion_double</a> </dd>
  115. <dd>
  116. <a class="el" href="a00859.html">GLM_EXT_quaternion_exponential</a> </dd>
  117. <dd>
  118. <a class="el" href="a00862.html">GLM_EXT_quaternion_geometric</a> </dd>
  119. <dd>
  120. <a class="el" href="a00863.html">GLM_EXT_quaternion_relational</a> </dd>
  121. <dd>
  122. <a class="el" href="a00865.html">GLM_EXT_quaternion_trigonometric</a> </dd>
  123. <dd>
  124. <a class="el" href="a00864.html">GLM_EXT_quaternion_transform</a> </dd></dl>
  125. <h2 class="groupheader">Function Documentation</h2>
  126. <a id="ga5b646f1cd4422eb76ab90496bcd0b60a"></a>
  127. <h2 class="memtitle"><span class="permalink"><a href="#ga5b646f1cd4422eb76ab90496bcd0b60a">&#9670;&nbsp;</a></span>conjugate()</h2>
  128. <div class="memitem">
  129. <div class="memproto">
  130. <table class="memname">
  131. <tr>
  132. <td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR qua&lt;T, Q&gt; glm::conjugate </td>
  133. <td>(</td>
  134. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  135. <td class="paramname"><em>q</em></td><td>)</td>
  136. <td></td>
  137. </tr>
  138. </table>
  139. </div><div class="memdoc">
  140. <p>Returns the q conjugate. </p>
  141. <dl class="tparams"><dt>Template Parameters</dt><dd>
  142. <table class="tparams">
  143. <tr><td class="paramname">T</td><td>A floating-point scalar type </td></tr>
  144. <tr><td class="paramname">Q</td><td>A value from qualifier enum </td></tr>
  145. </table>
  146. </dd>
  147. </dl>
  148. </div>
  149. </div>
  150. <a id="ga50db49335150de11562052667537e517"></a>
  151. <h2 class="memtitle"><span class="permalink"><a href="#ga50db49335150de11562052667537e517">&#9670;&nbsp;</a></span>inverse()</h2>
  152. <div class="memitem">
  153. <div class="memproto">
  154. <table class="memname">
  155. <tr>
  156. <td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR qua&lt;T, Q&gt; glm::inverse </td>
  157. <td>(</td>
  158. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  159. <td class="paramname"><em>q</em></td><td>)</td>
  160. <td></td>
  161. </tr>
  162. </table>
  163. </div><div class="memdoc">
  164. <p>Returns the q inverse. </p>
  165. <dl class="tparams"><dt>Template Parameters</dt><dd>
  166. <table class="tparams">
  167. <tr><td class="paramname">T</td><td>A floating-point scalar type </td></tr>
  168. <tr><td class="paramname">Q</td><td>A value from qualifier enum </td></tr>
  169. </table>
  170. </dd>
  171. </dl>
  172. </div>
  173. </div>
  174. <a id="ga45722741ea266b4e861938b365c5f362"></a>
  175. <h2 class="memtitle"><span class="permalink"><a href="#ga45722741ea266b4e861938b365c5f362">&#9670;&nbsp;</a></span>isinf()</h2>
  176. <div class="memitem">
  177. <div class="memproto">
  178. <table class="memname">
  179. <tr>
  180. <td class="memname">GLM_FUNC_DECL vec&lt;4, bool, Q&gt; glm::isinf </td>
  181. <td>(</td>
  182. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  183. <td class="paramname"><em>x</em></td><td>)</td>
  184. <td></td>
  185. </tr>
  186. </table>
  187. </div><div class="memdoc">
  188. <p>Returns true if x holds a positive infinity or negative infinity representation in the underlying implementation's set of floating point representations. </p>
  189. <p>Returns false otherwise, including for implementations with no infinity representations.</p>
  190. <dl class="tparams"><dt>Template Parameters</dt><dd>
  191. <table class="tparams">
  192. <tr><td class="paramname">T</td><td>A floating-point scalar type </td></tr>
  193. <tr><td class="paramname">Q</td><td>A value from qualifier enum </td></tr>
  194. </table>
  195. </dd>
  196. </dl>
  197. </div>
  198. </div>
  199. <a id="ga1bb55f8963616502e96dc564384d8a03"></a>
  200. <h2 class="memtitle"><span class="permalink"><a href="#ga1bb55f8963616502e96dc564384d8a03">&#9670;&nbsp;</a></span>isnan()</h2>
  201. <div class="memitem">
  202. <div class="memproto">
  203. <table class="memname">
  204. <tr>
  205. <td class="memname">GLM_FUNC_DECL vec&lt;4, bool, Q&gt; glm::isnan </td>
  206. <td>(</td>
  207. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  208. <td class="paramname"><em>x</em></td><td>)</td>
  209. <td></td>
  210. </tr>
  211. </table>
  212. </div><div class="memdoc">
  213. <p>Returns true if x holds a NaN (not a number) representation in the underlying implementation's set of floating point representations. </p>
  214. <p>Returns false otherwise, including for implementations with no NaN representations.</p>
  215. <p>/!\ When using compiler fast math, this function may fail.</p>
  216. <dl class="tparams"><dt>Template Parameters</dt><dd>
  217. <table class="tparams">
  218. <tr><td class="paramname">T</td><td>A floating-point scalar type </td></tr>
  219. <tr><td class="paramname">Q</td><td>A value from qualifier enum </td></tr>
  220. </table>
  221. </dd>
  222. </dl>
  223. </div>
  224. </div>
  225. <a id="gaacd3d0591852faa4bc291b61da88ad44"></a>
  226. <h2 class="memtitle"><span class="permalink"><a href="#gaacd3d0591852faa4bc291b61da88ad44">&#9670;&nbsp;</a></span>lerp()</h2>
  227. <div class="memitem">
  228. <div class="memproto">
  229. <table class="memname">
  230. <tr>
  231. <td class="memname">GLM_FUNC_DECL GLM_CONSTEXPR qua&lt;T, Q&gt; glm::lerp </td>
  232. <td>(</td>
  233. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  234. <td class="paramname"><em>x</em>, </td>
  235. </tr>
  236. <tr>
  237. <td class="paramkey"></td>
  238. <td></td>
  239. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  240. <td class="paramname"><em>y</em>, </td>
  241. </tr>
  242. <tr>
  243. <td class="paramkey"></td>
  244. <td></td>
  245. <td class="paramtype">T&#160;</td>
  246. <td class="paramname"><em>a</em>&#160;</td>
  247. </tr>
  248. <tr>
  249. <td></td>
  250. <td>)</td>
  251. <td></td><td></td>
  252. </tr>
  253. </table>
  254. </div><div class="memdoc">
  255. <p>Linear interpolation of two quaternions. </p>
  256. <p>The interpolation is oriented.</p>
  257. <dl class="params"><dt>Parameters</dt><dd>
  258. <table class="params">
  259. <tr><td class="paramname">x</td><td>A quaternion </td></tr>
  260. <tr><td class="paramname">y</td><td>A quaternion </td></tr>
  261. <tr><td class="paramname">a</td><td>Interpolation factor. The interpolation is defined in the range [0, 1].</td></tr>
  262. </table>
  263. </dd>
  264. </dl>
  265. <dl class="tparams"><dt>Template Parameters</dt><dd>
  266. <table class="tparams">
  267. <tr><td class="paramname">T</td><td>A floating-point scalar type </td></tr>
  268. <tr><td class="paramname">Q</td><td>A value from qualifier enum </td></tr>
  269. </table>
  270. </dd>
  271. </dl>
  272. </div>
  273. </div>
  274. <a id="gafbfe587b8da11fb89a30c3d67dd5ccc2"></a>
  275. <h2 class="memtitle"><span class="permalink"><a href="#gafbfe587b8da11fb89a30c3d67dd5ccc2">&#9670;&nbsp;</a></span>mix()</h2>
  276. <div class="memitem">
  277. <div class="memproto">
  278. <table class="memname">
  279. <tr>
  280. <td class="memname">GLM_FUNC_DECL qua&lt;T, Q&gt; glm::mix </td>
  281. <td>(</td>
  282. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  283. <td class="paramname"><em>x</em>, </td>
  284. </tr>
  285. <tr>
  286. <td class="paramkey"></td>
  287. <td></td>
  288. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  289. <td class="paramname"><em>y</em>, </td>
  290. </tr>
  291. <tr>
  292. <td class="paramkey"></td>
  293. <td></td>
  294. <td class="paramtype">T&#160;</td>
  295. <td class="paramname"><em>a</em>&#160;</td>
  296. </tr>
  297. <tr>
  298. <td></td>
  299. <td>)</td>
  300. <td></td><td></td>
  301. </tr>
  302. </table>
  303. </div><div class="memdoc">
  304. <p>Spherical linear interpolation of two quaternions. </p>
  305. <p>The interpolation is oriented and the rotation is performed at constant speed. For short path spherical linear interpolation, use the slerp function.</p>
  306. <dl class="params"><dt>Parameters</dt><dd>
  307. <table class="params">
  308. <tr><td class="paramname">x</td><td>A quaternion </td></tr>
  309. <tr><td class="paramname">y</td><td>A quaternion </td></tr>
  310. <tr><td class="paramname">a</td><td>Interpolation factor. The interpolation is defined beyond the range [0, 1].</td></tr>
  311. </table>
  312. </dd>
  313. </dl>
  314. <dl class="tparams"><dt>Template Parameters</dt><dd>
  315. <table class="tparams">
  316. <tr><td class="paramname">T</td><td>A floating-point scalar type </td></tr>
  317. <tr><td class="paramname">Q</td><td>A value from qualifier enum</td></tr>
  318. </table>
  319. </dd>
  320. </dl>
  321. <dl class="section see"><dt>See also</dt><dd>- slerp(qua&lt;T, Q&gt; const&amp; x, qua&lt;T, Q&gt; const&amp; y, T const&amp; a) </dd></dl>
  322. </div>
  323. </div>
  324. <a id="gae7fc3c945be366b9942b842f55da428a"></a>
  325. <h2 class="memtitle"><span class="permalink"><a href="#gae7fc3c945be366b9942b842f55da428a">&#9670;&nbsp;</a></span>slerp() <span class="overload">[1/2]</span></h2>
  326. <div class="memitem">
  327. <div class="memproto">
  328. <table class="memname">
  329. <tr>
  330. <td class="memname">GLM_FUNC_DECL qua&lt;T, Q&gt; glm::slerp </td>
  331. <td>(</td>
  332. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  333. <td class="paramname"><em>x</em>, </td>
  334. </tr>
  335. <tr>
  336. <td class="paramkey"></td>
  337. <td></td>
  338. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  339. <td class="paramname"><em>y</em>, </td>
  340. </tr>
  341. <tr>
  342. <td class="paramkey"></td>
  343. <td></td>
  344. <td class="paramtype">T&#160;</td>
  345. <td class="paramname"><em>a</em>&#160;</td>
  346. </tr>
  347. <tr>
  348. <td></td>
  349. <td>)</td>
  350. <td></td><td></td>
  351. </tr>
  352. </table>
  353. </div><div class="memdoc">
  354. <p>Spherical linear interpolation of two quaternions. </p>
  355. <p>The interpolation always take the short path and the rotation is performed at constant speed.</p>
  356. <dl class="params"><dt>Parameters</dt><dd>
  357. <table class="params">
  358. <tr><td class="paramname">x</td><td>A quaternion </td></tr>
  359. <tr><td class="paramname">y</td><td>A quaternion </td></tr>
  360. <tr><td class="paramname">a</td><td>Interpolation factor. The interpolation is defined beyond the range [0, 1].</td></tr>
  361. </table>
  362. </dd>
  363. </dl>
  364. <dl class="tparams"><dt>Template Parameters</dt><dd>
  365. <table class="tparams">
  366. <tr><td class="paramname">T</td><td>A floating-point scalar type </td></tr>
  367. <tr><td class="paramname">Q</td><td>A value from qualifier enum </td></tr>
  368. </table>
  369. </dd>
  370. </dl>
  371. </div>
  372. </div>
  373. <a id="ga8514da9c52cfee86f716cc0933ce118a"></a>
  374. <h2 class="memtitle"><span class="permalink"><a href="#ga8514da9c52cfee86f716cc0933ce118a">&#9670;&nbsp;</a></span>slerp() <span class="overload">[2/2]</span></h2>
  375. <div class="memitem">
  376. <div class="memproto">
  377. <table class="memname">
  378. <tr>
  379. <td class="memname">GLM_FUNC_DECL qua&lt;T, Q&gt; glm::slerp </td>
  380. <td>(</td>
  381. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  382. <td class="paramname"><em>x</em>, </td>
  383. </tr>
  384. <tr>
  385. <td class="paramkey"></td>
  386. <td></td>
  387. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  388. <td class="paramname"><em>y</em>, </td>
  389. </tr>
  390. <tr>
  391. <td class="paramkey"></td>
  392. <td></td>
  393. <td class="paramtype">T&#160;</td>
  394. <td class="paramname"><em>a</em>, </td>
  395. </tr>
  396. <tr>
  397. <td class="paramkey"></td>
  398. <td></td>
  399. <td class="paramtype">S&#160;</td>
  400. <td class="paramname"><em>k</em>&#160;</td>
  401. </tr>
  402. <tr>
  403. <td></td>
  404. <td>)</td>
  405. <td></td><td></td>
  406. </tr>
  407. </table>
  408. </div><div class="memdoc">
  409. <p>Spherical linear interpolation of two quaternions with multiple spins over rotation axis. </p>
  410. <p>The interpolation always take the short path when the spin count is positive and long path when count is negative. Rotation is performed at constant speed.</p>
  411. <dl class="params"><dt>Parameters</dt><dd>
  412. <table class="params">
  413. <tr><td class="paramname">x</td><td>A quaternion </td></tr>
  414. <tr><td class="paramname">y</td><td>A quaternion </td></tr>
  415. <tr><td class="paramname">a</td><td>Interpolation factor. The interpolation is defined beyond the range [0, 1]. </td></tr>
  416. <tr><td class="paramname">k</td><td>Additional spin count. If Value is negative interpolation will be on "long" path.</td></tr>
  417. </table>
  418. </dd>
  419. </dl>
  420. <dl class="tparams"><dt>Template Parameters</dt><dd>
  421. <table class="tparams">
  422. <tr><td class="paramname">T</td><td>A floating-point scalar type </td></tr>
  423. <tr><td class="paramname">S</td><td>An integer scalar type </td></tr>
  424. <tr><td class="paramname">Q</td><td>A value from qualifier enum </td></tr>
  425. </table>
  426. </dd>
  427. </dl>
  428. </div>
  429. </div>
  430. </div><!-- contents -->
  431. <!-- start footer part -->
  432. <hr class="footer"/><address class="footer"><small>
  433. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  434. <img class="footer" src="doxygen.png" alt="doxygen"/>
  435. </a> 1.8.18
  436. </small></address>
  437. </body>
  438. </html>