a00864.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287
  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_transform</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_transform<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:gaab2d37ef7265819f1d2939b9dc2c52ac"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  73. <tr class="memitem:gaab2d37ef7265819f1d2939b9dc2c52ac"><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="a00864.html#gaab2d37ef7265819f1d2939b9dc2c52ac">exp</a> (qua&lt; T, Q &gt; const &amp;q)</td></tr>
  74. <tr class="memdesc:gaab2d37ef7265819f1d2939b9dc2c52ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a exponential of a quaternion. <a href="a00864.html#gaab2d37ef7265819f1d2939b9dc2c52ac">More...</a><br /></td></tr>
  75. <tr class="separator:gaab2d37ef7265819f1d2939b9dc2c52ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:gaa5f7b20e296671b16ce25a2ab7ad5473"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  77. <tr class="memitem:gaa5f7b20e296671b16ce25a2ab7ad5473"><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="a00864.html#gaa5f7b20e296671b16ce25a2ab7ad5473">log</a> (qua&lt; T, Q &gt; const &amp;q)</td></tr>
  78. <tr class="memdesc:gaa5f7b20e296671b16ce25a2ab7ad5473"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a logarithm of a quaternion. <a href="a00864.html#gaa5f7b20e296671b16ce25a2ab7ad5473">More...</a><br /></td></tr>
  79. <tr class="separator:gaa5f7b20e296671b16ce25a2ab7ad5473"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:ga4975ffcacd312a8c0bbd046a76c5607e"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  81. <tr class="memitem:ga4975ffcacd312a8c0bbd046a76c5607e"><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="a00864.html#ga4975ffcacd312a8c0bbd046a76c5607e">pow</a> (qua&lt; T, Q &gt; const &amp;q, T y)</td></tr>
  82. <tr class="memdesc:ga4975ffcacd312a8c0bbd046a76c5607e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a quaternion raised to a power. <a href="a00864.html#ga4975ffcacd312a8c0bbd046a76c5607e">More...</a><br /></td></tr>
  83. <tr class="separator:ga4975ffcacd312a8c0bbd046a76c5607e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:gabfc57de6d4d2e11970f54119c5ccf0f5"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  85. <tr class="memitem:gabfc57de6d4d2e11970f54119c5ccf0f5"><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="a00864.html#gabfc57de6d4d2e11970f54119c5ccf0f5">rotate</a> (qua&lt; T, Q &gt; const &amp;q, T const &amp;angle, vec&lt; 3, T, Q &gt; const &amp;axis)</td></tr>
  86. <tr class="memdesc:gabfc57de6d4d2e11970f54119c5ccf0f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rotates a quaternion from a vector of 3 components axis and an angle. <a href="a00864.html#gabfc57de6d4d2e11970f54119c5ccf0f5">More...</a><br /></td></tr>
  87. <tr class="separator:gabfc57de6d4d2e11970f54119c5ccf0f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:ga64b7b255ed7bcba616fe6b44470b022e"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  89. <tr class="memitem:ga64b7b255ed7bcba616fe6b44470b022e"><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="a00864.html#ga64b7b255ed7bcba616fe6b44470b022e">sqrt</a> (qua&lt; T, Q &gt; const &amp;q)</td></tr>
  90. <tr class="memdesc:ga64b7b255ed7bcba616fe6b44470b022e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the square root of a quaternion. <a href="a00864.html#ga64b7b255ed7bcba616fe6b44470b022e">More...</a><br /></td></tr>
  91. <tr class="separator:ga64b7b255ed7bcba616fe6b44470b022e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. </table>
  93. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  94. <p>Provides transformation functions for quaternion types</p>
  95. <p>Include &lt;<a class="el" href="a00350.html" title="GLM_EXT_quaternion_transform">glm/ext/quaternion_transform.hpp</a>&gt; to use the features of this extension.</p>
  96. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00860.html">GLM_EXT_quaternion_float</a> </dd>
  97. <dd>
  98. <a class="el" href="a00857.html">GLM_EXT_quaternion_double</a> </dd>
  99. <dd>
  100. <a class="el" href="a00859.html">GLM_EXT_quaternion_exponential</a> </dd>
  101. <dd>
  102. <a class="el" href="a00862.html">GLM_EXT_quaternion_geometric</a> </dd>
  103. <dd>
  104. <a class="el" href="a00863.html">GLM_EXT_quaternion_relational</a> </dd>
  105. <dd>
  106. <a class="el" href="a00865.html">GLM_EXT_quaternion_trigonometric</a> </dd></dl>
  107. <h2 class="groupheader">Function Documentation</h2>
  108. <a id="gaab2d37ef7265819f1d2939b9dc2c52ac"></a>
  109. <h2 class="memtitle"><span class="permalink"><a href="#gaab2d37ef7265819f1d2939b9dc2c52ac">&#9670;&nbsp;</a></span>exp()</h2>
  110. <div class="memitem">
  111. <div class="memproto">
  112. <table class="memname">
  113. <tr>
  114. <td class="memname">GLM_FUNC_DECL qua&lt;T, Q&gt; glm::exp </td>
  115. <td>(</td>
  116. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  117. <td class="paramname"><em>q</em></td><td>)</td>
  118. <td></td>
  119. </tr>
  120. </table>
  121. </div><div class="memdoc">
  122. <p>Returns a exponential of a quaternion. </p>
  123. <dl class="tparams"><dt>Template Parameters</dt><dd>
  124. <table class="tparams">
  125. <tr><td class="paramname">T</td><td>A floating-point scalar type </td></tr>
  126. <tr><td class="paramname">Q</td><td>A value from qualifier enum </td></tr>
  127. </table>
  128. </dd>
  129. </dl>
  130. </div>
  131. </div>
  132. <a id="gaa5f7b20e296671b16ce25a2ab7ad5473"></a>
  133. <h2 class="memtitle"><span class="permalink"><a href="#gaa5f7b20e296671b16ce25a2ab7ad5473">&#9670;&nbsp;</a></span>log()</h2>
  134. <div class="memitem">
  135. <div class="memproto">
  136. <table class="memname">
  137. <tr>
  138. <td class="memname">GLM_FUNC_DECL qua&lt;T, Q&gt; glm::log </td>
  139. <td>(</td>
  140. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  141. <td class="paramname"><em>q</em></td><td>)</td>
  142. <td></td>
  143. </tr>
  144. </table>
  145. </div><div class="memdoc">
  146. <p>Returns a logarithm of a quaternion. </p>
  147. <dl class="tparams"><dt>Template Parameters</dt><dd>
  148. <table class="tparams">
  149. <tr><td class="paramname">T</td><td>A floating-point scalar type </td></tr>
  150. <tr><td class="paramname">Q</td><td>A value from qualifier enum </td></tr>
  151. </table>
  152. </dd>
  153. </dl>
  154. </div>
  155. </div>
  156. <a id="ga4975ffcacd312a8c0bbd046a76c5607e"></a>
  157. <h2 class="memtitle"><span class="permalink"><a href="#ga4975ffcacd312a8c0bbd046a76c5607e">&#9670;&nbsp;</a></span>pow()</h2>
  158. <div class="memitem">
  159. <div class="memproto">
  160. <table class="memname">
  161. <tr>
  162. <td class="memname">GLM_FUNC_DECL qua&lt;T, Q&gt; glm::pow </td>
  163. <td>(</td>
  164. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  165. <td class="paramname"><em>q</em>, </td>
  166. </tr>
  167. <tr>
  168. <td class="paramkey"></td>
  169. <td></td>
  170. <td class="paramtype">T&#160;</td>
  171. <td class="paramname"><em>y</em>&#160;</td>
  172. </tr>
  173. <tr>
  174. <td></td>
  175. <td>)</td>
  176. <td></td><td></td>
  177. </tr>
  178. </table>
  179. </div><div class="memdoc">
  180. <p>Returns a quaternion raised to a power. </p>
  181. <dl class="tparams"><dt>Template Parameters</dt><dd>
  182. <table class="tparams">
  183. <tr><td class="paramname">T</td><td>A floating-point scalar type </td></tr>
  184. <tr><td class="paramname">Q</td><td>A value from qualifier enum </td></tr>
  185. </table>
  186. </dd>
  187. </dl>
  188. </div>
  189. </div>
  190. <a id="gabfc57de6d4d2e11970f54119c5ccf0f5"></a>
  191. <h2 class="memtitle"><span class="permalink"><a href="#gabfc57de6d4d2e11970f54119c5ccf0f5">&#9670;&nbsp;</a></span>rotate()</h2>
  192. <div class="memitem">
  193. <div class="memproto">
  194. <table class="memname">
  195. <tr>
  196. <td class="memname">GLM_FUNC_DECL qua&lt;T, Q&gt; glm::rotate </td>
  197. <td>(</td>
  198. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  199. <td class="paramname"><em>q</em>, </td>
  200. </tr>
  201. <tr>
  202. <td class="paramkey"></td>
  203. <td></td>
  204. <td class="paramtype">T const &amp;&#160;</td>
  205. <td class="paramname"><em>angle</em>, </td>
  206. </tr>
  207. <tr>
  208. <td class="paramkey"></td>
  209. <td></td>
  210. <td class="paramtype">vec&lt; 3, T, Q &gt; const &amp;&#160;</td>
  211. <td class="paramname"><em>axis</em>&#160;</td>
  212. </tr>
  213. <tr>
  214. <td></td>
  215. <td>)</td>
  216. <td></td><td></td>
  217. </tr>
  218. </table>
  219. </div><div class="memdoc">
  220. <p>Rotates a quaternion from a vector of 3 components axis and an angle. </p>
  221. <dl class="params"><dt>Parameters</dt><dd>
  222. <table class="params">
  223. <tr><td class="paramname">q</td><td>Source orientation </td></tr>
  224. <tr><td class="paramname">angle</td><td>Angle expressed in radians. </td></tr>
  225. <tr><td class="paramname">axis</td><td>Axis of the rotation</td></tr>
  226. </table>
  227. </dd>
  228. </dl>
  229. <dl class="tparams"><dt>Template Parameters</dt><dd>
  230. <table class="tparams">
  231. <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
  232. <tr><td class="paramname">Q</td><td>Value from qualifier enum </td></tr>
  233. </table>
  234. </dd>
  235. </dl>
  236. </div>
  237. </div>
  238. <a id="ga64b7b255ed7bcba616fe6b44470b022e"></a>
  239. <h2 class="memtitle"><span class="permalink"><a href="#ga64b7b255ed7bcba616fe6b44470b022e">&#9670;&nbsp;</a></span>sqrt()</h2>
  240. <div class="memitem">
  241. <div class="memproto">
  242. <table class="memname">
  243. <tr>
  244. <td class="memname">GLM_FUNC_DECL qua&lt;T, Q&gt; glm::sqrt </td>
  245. <td>(</td>
  246. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  247. <td class="paramname"><em>q</em></td><td>)</td>
  248. <td></td>
  249. </tr>
  250. </table>
  251. </div><div class="memdoc">
  252. <p>Returns the square root of a quaternion. </p>
  253. <dl class="tparams"><dt>Template Parameters</dt><dd>
  254. <table class="tparams">
  255. <tr><td class="paramname">T</td><td>A floating-point scalar type </td></tr>
  256. <tr><td class="paramname">Q</td><td>A value from qualifier enum </td></tr>
  257. </table>
  258. </dd>
  259. </dl>
  260. </div>
  261. </div>
  262. </div><!-- contents -->
  263. <!-- start footer part -->
  264. <hr class="footer"/><address class="footer"><small>
  265. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  266. <img class="footer" src="doxygen.png" alt="doxygen"/>
  267. </a> 1.8.18
  268. </small></address>
  269. </body>
  270. </html>