a00256.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.10"/>
  7. <title>0.9.9 API documentation: GLM_EXT_quaternion_transform</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/searchdata.js"></script>
  13. <script type="text/javascript" src="search/search.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(function() { init_search(); });
  16. </script>
  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  18. </head>
  19. <body>
  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  21. <div id="titlearea">
  22. <table cellspacing="0" cellpadding="0">
  23. <tbody>
  24. <tr style="height: 56px;">
  25. <td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
  26. <td id="projectalign" style="padding-left: 0.5em;">
  27. <div id="projectname">0.9.9 API documentation
  28. </div>
  29. </td>
  30. </tr>
  31. </tbody>
  32. </table>
  33. </div>
  34. <!-- end header part -->
  35. <!-- Generated by Doxygen 1.8.10 -->
  36. <script type="text/javascript">
  37. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  38. </script>
  39. <div id="navrow1" class="tabs">
  40. <ul class="tablist">
  41. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  42. <li><a href="modules.html"><span>Modules</span></a></li>
  43. <li><a href="files.html"><span>Files</span></a></li>
  44. <li>
  45. <div id="MSearchBox" class="MSearchBoxInactive">
  46. <span class="left">
  47. <img id="MSearchSelect" src="search/mag_sel.png"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. alt=""/>
  51. <input type="text" id="MSearchField" value="Search" accesskey="S"
  52. onfocus="searchBox.OnSearchFieldFocus(true)"
  53. onblur="searchBox.OnSearchFieldFocus(false)"
  54. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  55. </span><span class="right">
  56. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  57. </span>
  58. </div>
  59. </li>
  60. </ul>
  61. </div>
  62. </div><!-- top -->
  63. <!-- window showing the filter options -->
  64. <div id="MSearchSelectWindow"
  65. onmouseover="return searchBox.OnSearchSelectShow()"
  66. onmouseout="return searchBox.OnSearchSelectHide()"
  67. onkeydown="return searchBox.OnSearchSelectKey(event)">
  68. </div>
  69. <!-- iframe showing the search results (closed by default) -->
  70. <div id="MSearchResultsWindow">
  71. <iframe src="javascript:void(0)" frameborder="0"
  72. name="MSearchResults" id="MSearchResults">
  73. </iframe>
  74. </div>
  75. <div class="header">
  76. <div class="summary">
  77. <a href="#func-members">Functions</a> </div>
  78. <div class="headertitle">
  79. <div class="title">GLM_EXT_quaternion_transform<div class="ingroups"><a class="el" href="a00285.html">Stable extensions</a></div></div> </div>
  80. </div><!--header-->
  81. <div class="contents">
  82. <p>Provides transformation functions for quaternion types.
  83. <a href="#details">More...</a></p>
  84. <table class="memberdecls">
  85. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  86. Functions</h2></td></tr>
  87. <tr class="memitem:gaab2d37ef7265819f1d2939b9dc2c52ac"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  88. <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="a00256.html#gaab2d37ef7265819f1d2939b9dc2c52ac">exp</a> (qua&lt; T, Q &gt; const &amp;q)</td></tr>
  89. <tr class="memdesc:gaab2d37ef7265819f1d2939b9dc2c52ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a exponential of a quaternion. <a href="a00256.html#gaab2d37ef7265819f1d2939b9dc2c52ac">More...</a><br /></td></tr>
  90. <tr class="separator:gaab2d37ef7265819f1d2939b9dc2c52ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:gaa5f7b20e296671b16ce25a2ab7ad5473"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  92. <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="a00256.html#gaa5f7b20e296671b16ce25a2ab7ad5473">log</a> (qua&lt; T, Q &gt; const &amp;q)</td></tr>
  93. <tr class="memdesc:gaa5f7b20e296671b16ce25a2ab7ad5473"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a logarithm of a quaternion. <a href="a00256.html#gaa5f7b20e296671b16ce25a2ab7ad5473">More...</a><br /></td></tr>
  94. <tr class="separator:gaa5f7b20e296671b16ce25a2ab7ad5473"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:ga4975ffcacd312a8c0bbd046a76c5607e"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  96. <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="a00256.html#ga4975ffcacd312a8c0bbd046a76c5607e">pow</a> (qua&lt; T, Q &gt; const &amp;q, T y)</td></tr>
  97. <tr class="memdesc:ga4975ffcacd312a8c0bbd046a76c5607e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a quaternion raised to a power. <a href="a00256.html#ga4975ffcacd312a8c0bbd046a76c5607e">More...</a><br /></td></tr>
  98. <tr class="separator:ga4975ffcacd312a8c0bbd046a76c5607e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:gabfc57de6d4d2e11970f54119c5ccf0f5"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  100. <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="a00256.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>
  101. <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="a00256.html#gabfc57de6d4d2e11970f54119c5ccf0f5">More...</a><br /></td></tr>
  102. <tr class="separator:gabfc57de6d4d2e11970f54119c5ccf0f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:ga64b7b255ed7bcba616fe6b44470b022e"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  104. <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="a00256.html#ga64b7b255ed7bcba616fe6b44470b022e">sqrt</a> (qua&lt; T, Q &gt; const &amp;q)</td></tr>
  105. <tr class="memdesc:ga64b7b255ed7bcba616fe6b44470b022e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the square root of a quaternion. <a href="a00256.html#ga64b7b255ed7bcba616fe6b44470b022e">More...</a><br /></td></tr>
  106. <tr class="separator:ga64b7b255ed7bcba616fe6b44470b022e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. </table>
  108. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  109. <p>Provides transformation functions for quaternion types. </p>
  110. <p>Include &lt;<a class="el" href="a00135.html" title="GLM_EXT_quaternion_transform ">glm/ext/quaternion_transform.hpp</a>&gt; to use the features of this extension.</p>
  111. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00252.html" title="Exposes single-precision floating point quaternion type. ">GLM_EXT_quaternion_float</a> </dd>
  112. <dd>
  113. <a class="el" href="a00249.html" title="Exposes double-precision floating point quaternion type. ">GLM_EXT_quaternion_double</a> </dd>
  114. <dd>
  115. <a class="el" href="a00251.html" title="Provides exponential functions for quaternion types. ">GLM_EXT_quaternion_exponential</a> </dd>
  116. <dd>
  117. <a class="el" href="a00254.html" title="Provides geometric functions for quaternion types. ">GLM_EXT_quaternion_geometric</a> </dd>
  118. <dd>
  119. <a class="el" href="a00255.html" title="Exposes comparison functions for quaternion types that take a user defined epsilon values...">GLM_EXT_quaternion_relational</a> </dd>
  120. <dd>
  121. <a class="el" href="a00257.html" title="Provides trigonometric functions for quaternion types. ">GLM_EXT_quaternion_trigonometric</a> </dd></dl>
  122. <h2 class="groupheader">Function Documentation</h2>
  123. <a class="anchor" id="gaab2d37ef7265819f1d2939b9dc2c52ac"></a>
  124. <div class="memitem">
  125. <div class="memproto">
  126. <table class="memname">
  127. <tr>
  128. <td class="memname">GLM_FUNC_DECL qua&lt;T, Q&gt; glm::exp </td>
  129. <td>(</td>
  130. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  131. <td class="paramname"><em>q</em></td><td>)</td>
  132. <td></td>
  133. </tr>
  134. </table>
  135. </div><div class="memdoc">
  136. <p>Returns a exponential of a quaternion. </p>
  137. <dl class="tparams"><dt>Template Parameters</dt><dd>
  138. <table class="tparams">
  139. <tr><td class="paramname">T</td><td>A floating-point scalar type </td></tr>
  140. <tr><td class="paramname">Q</td><td>A value from qualifier enum </td></tr>
  141. </table>
  142. </dd>
  143. </dl>
  144. </div>
  145. </div>
  146. <a class="anchor" id="gaa5f7b20e296671b16ce25a2ab7ad5473"></a>
  147. <div class="memitem">
  148. <div class="memproto">
  149. <table class="memname">
  150. <tr>
  151. <td class="memname">GLM_FUNC_DECL qua&lt;T, Q&gt; glm::log </td>
  152. <td>(</td>
  153. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  154. <td class="paramname"><em>q</em></td><td>)</td>
  155. <td></td>
  156. </tr>
  157. </table>
  158. </div><div class="memdoc">
  159. <p>Returns a logarithm of a quaternion. </p>
  160. <dl class="tparams"><dt>Template Parameters</dt><dd>
  161. <table class="tparams">
  162. <tr><td class="paramname">T</td><td>A floating-point scalar type </td></tr>
  163. <tr><td class="paramname">Q</td><td>A value from qualifier enum </td></tr>
  164. </table>
  165. </dd>
  166. </dl>
  167. </div>
  168. </div>
  169. <a class="anchor" id="ga4975ffcacd312a8c0bbd046a76c5607e"></a>
  170. <div class="memitem">
  171. <div class="memproto">
  172. <table class="memname">
  173. <tr>
  174. <td class="memname">GLM_FUNC_DECL qua&lt;T, Q&gt; glm::pow </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>
  178. </tr>
  179. <tr>
  180. <td class="paramkey"></td>
  181. <td></td>
  182. <td class="paramtype">T&#160;</td>
  183. <td class="paramname"><em>y</em>&#160;</td>
  184. </tr>
  185. <tr>
  186. <td></td>
  187. <td>)</td>
  188. <td></td><td></td>
  189. </tr>
  190. </table>
  191. </div><div class="memdoc">
  192. <p>Returns a quaternion raised to a power. </p>
  193. <dl class="tparams"><dt>Template Parameters</dt><dd>
  194. <table class="tparams">
  195. <tr><td class="paramname">T</td><td>A floating-point scalar type </td></tr>
  196. <tr><td class="paramname">Q</td><td>A value from qualifier enum </td></tr>
  197. </table>
  198. </dd>
  199. </dl>
  200. </div>
  201. </div>
  202. <a class="anchor" id="gabfc57de6d4d2e11970f54119c5ccf0f5"></a>
  203. <div class="memitem">
  204. <div class="memproto">
  205. <table class="memname">
  206. <tr>
  207. <td class="memname">GLM_FUNC_DECL qua&lt;T, Q&gt; glm::rotate </td>
  208. <td>(</td>
  209. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  210. <td class="paramname"><em>q</em>, </td>
  211. </tr>
  212. <tr>
  213. <td class="paramkey"></td>
  214. <td></td>
  215. <td class="paramtype">T const &amp;&#160;</td>
  216. <td class="paramname"><em>angle</em>, </td>
  217. </tr>
  218. <tr>
  219. <td class="paramkey"></td>
  220. <td></td>
  221. <td class="paramtype">vec&lt; 3, T, Q &gt; const &amp;&#160;</td>
  222. <td class="paramname"><em>axis</em>&#160;</td>
  223. </tr>
  224. <tr>
  225. <td></td>
  226. <td>)</td>
  227. <td></td><td></td>
  228. </tr>
  229. </table>
  230. </div><div class="memdoc">
  231. <p>Rotates a quaternion from a vector of 3 components axis and an angle. </p>
  232. <dl class="params"><dt>Parameters</dt><dd>
  233. <table class="params">
  234. <tr><td class="paramname">q</td><td>Source orientation </td></tr>
  235. <tr><td class="paramname">angle</td><td>Angle expressed in radians. </td></tr>
  236. <tr><td class="paramname">axis</td><td>Axis of the rotation</td></tr>
  237. </table>
  238. </dd>
  239. </dl>
  240. <dl class="tparams"><dt>Template Parameters</dt><dd>
  241. <table class="tparams">
  242. <tr><td class="paramname">T</td><td>Floating-point scalar types </td></tr>
  243. <tr><td class="paramname">Q</td><td>Value from qualifier enum </td></tr>
  244. </table>
  245. </dd>
  246. </dl>
  247. </div>
  248. </div>
  249. <a class="anchor" id="ga64b7b255ed7bcba616fe6b44470b022e"></a>
  250. <div class="memitem">
  251. <div class="memproto">
  252. <table class="memname">
  253. <tr>
  254. <td class="memname">GLM_FUNC_DECL qua&lt;T, Q&gt; glm::sqrt </td>
  255. <td>(</td>
  256. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  257. <td class="paramname"><em>q</em></td><td>)</td>
  258. <td></td>
  259. </tr>
  260. </table>
  261. </div><div class="memdoc">
  262. <p>Returns the square root of a quaternion. </p>
  263. <dl class="tparams"><dt>Template Parameters</dt><dd>
  264. <table class="tparams">
  265. <tr><td class="paramname">T</td><td>A floating-point scalar type </td></tr>
  266. <tr><td class="paramname">Q</td><td>A value from qualifier enum </td></tr>
  267. </table>
  268. </dd>
  269. </dl>
  270. </div>
  271. </div>
  272. </div><!-- contents -->
  273. <!-- start footer part -->
  274. <hr class="footer"/><address class="footer"><small>
  275. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  276. <img class="footer" src="doxygen.png" alt="doxygen"/>
  277. </a> 1.8.10
  278. </small></address>
  279. </body>
  280. </html>