a00257.html 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218
  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_trigonometric</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_trigonometric<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 trigonometric 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:ga8aa248b31d5ade470c87304df5eb7bd8"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  88. <tr class="memitem:ga8aa248b31d5ade470c87304df5eb7bd8"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00257.html#ga8aa248b31d5ade470c87304df5eb7bd8">angle</a> (qua&lt; T, Q &gt; const &amp;x)</td></tr>
  89. <tr class="memdesc:ga8aa248b31d5ade470c87304df5eb7bd8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the quaternion rotation angle. <a href="a00257.html#ga8aa248b31d5ade470c87304df5eb7bd8">More...</a><br /></td></tr>
  90. <tr class="separator:ga8aa248b31d5ade470c87304df5eb7bd8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:ga5c0095cfcb218c75a4b79d7687950036"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  92. <tr class="memitem:ga5c0095cfcb218c75a4b79d7687950036"><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="a00257.html#ga5c0095cfcb218c75a4b79d7687950036">angleAxis</a> (T const &amp;angle, vec&lt; 3, T, Q &gt; const &amp;axis)</td></tr>
  93. <tr class="memdesc:ga5c0095cfcb218c75a4b79d7687950036"><td class="mdescLeft">&#160;</td><td class="mdescRight">Build a quaternion from an angle and a normalized axis. <a href="a00257.html#ga5c0095cfcb218c75a4b79d7687950036">More...</a><br /></td></tr>
  94. <tr class="separator:ga5c0095cfcb218c75a4b79d7687950036"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:ga764254f10248b505e936e5309a88c23d"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  96. <tr class="memitem:ga764254f10248b505e936e5309a88c23d"><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="a00257.html#ga764254f10248b505e936e5309a88c23d">axis</a> (qua&lt; T, Q &gt; const &amp;x)</td></tr>
  97. <tr class="memdesc:ga764254f10248b505e936e5309a88c23d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the q rotation axis. <a href="a00257.html#ga764254f10248b505e936e5309a88c23d">More...</a><br /></td></tr>
  98. <tr class="separator:ga764254f10248b505e936e5309a88c23d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. </table>
  100. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  101. <p>Provides trigonometric functions for quaternion types. </p>
  102. <p>Include &lt;<a class="el" href="a00136.html" title="GLM_EXT_quaternion_trigonometric ">glm/ext/quaternion_trigonometric.hpp</a>&gt; to use the features of this extension.</p>
  103. <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>
  104. <dd>
  105. <a class="el" href="a00249.html" title="Exposes double-precision floating point quaternion type. ">GLM_EXT_quaternion_double</a> </dd>
  106. <dd>
  107. <a class="el" href="a00251.html" title="Provides exponential functions for quaternion types. ">GLM_EXT_quaternion_exponential</a> </dd>
  108. <dd>
  109. <a class="el" href="a00254.html" title="Provides geometric functions for quaternion types. ">GLM_EXT_quaternion_geometric</a> </dd>
  110. <dd>
  111. <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>
  112. <dd>
  113. <a class="el" href="a00256.html" title="Provides transformation functions for quaternion types. ">GLM_EXT_quaternion_transform</a> </dd></dl>
  114. <h2 class="groupheader">Function Documentation</h2>
  115. <a class="anchor" id="ga8aa248b31d5ade470c87304df5eb7bd8"></a>
  116. <div class="memitem">
  117. <div class="memproto">
  118. <table class="memname">
  119. <tr>
  120. <td class="memname">GLM_FUNC_DECL T glm::angle </td>
  121. <td>(</td>
  122. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  123. <td class="paramname"><em>x</em></td><td>)</td>
  124. <td></td>
  125. </tr>
  126. </table>
  127. </div><div class="memdoc">
  128. <p>Returns the quaternion rotation angle. </p>
  129. <dl class="tparams"><dt>Template Parameters</dt><dd>
  130. <table class="tparams">
  131. <tr><td class="paramname">T</td><td>A floating-point scalar type </td></tr>
  132. <tr><td class="paramname">Q</td><td>A value from qualifier enum </td></tr>
  133. </table>
  134. </dd>
  135. </dl>
  136. </div>
  137. </div>
  138. <a class="anchor" id="ga5c0095cfcb218c75a4b79d7687950036"></a>
  139. <div class="memitem">
  140. <div class="memproto">
  141. <table class="memname">
  142. <tr>
  143. <td class="memname">GLM_FUNC_DECL qua&lt;T, Q&gt; glm::angleAxis </td>
  144. <td>(</td>
  145. <td class="paramtype">T const &amp;&#160;</td>
  146. <td class="paramname"><em>angle</em>, </td>
  147. </tr>
  148. <tr>
  149. <td class="paramkey"></td>
  150. <td></td>
  151. <td class="paramtype">vec&lt; 3, T, Q &gt; const &amp;&#160;</td>
  152. <td class="paramname"><em>axis</em>&#160;</td>
  153. </tr>
  154. <tr>
  155. <td></td>
  156. <td>)</td>
  157. <td></td><td></td>
  158. </tr>
  159. </table>
  160. </div><div class="memdoc">
  161. <p>Build a quaternion from an angle and a normalized axis. </p>
  162. <dl class="params"><dt>Parameters</dt><dd>
  163. <table class="params">
  164. <tr><td class="paramname">angle</td><td>Angle expressed in radians. </td></tr>
  165. <tr><td class="paramname">axis</td><td>Axis of the quaternion, must be normalized.</td></tr>
  166. </table>
  167. </dd>
  168. </dl>
  169. <dl class="tparams"><dt>Template Parameters</dt><dd>
  170. <table class="tparams">
  171. <tr><td class="paramname">T</td><td>A floating-point scalar type </td></tr>
  172. <tr><td class="paramname">Q</td><td>A value from qualifier enum </td></tr>
  173. </table>
  174. </dd>
  175. </dl>
  176. </div>
  177. </div>
  178. <a class="anchor" id="ga764254f10248b505e936e5309a88c23d"></a>
  179. <div class="memitem">
  180. <div class="memproto">
  181. <table class="memname">
  182. <tr>
  183. <td class="memname">GLM_FUNC_DECL vec&lt;3, T, Q&gt; glm::axis </td>
  184. <td>(</td>
  185. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  186. <td class="paramname"><em>x</em></td><td>)</td>
  187. <td></td>
  188. </tr>
  189. </table>
  190. </div><div class="memdoc">
  191. <p>Returns the q rotation axis. </p>
  192. <dl class="tparams"><dt>Template Parameters</dt><dd>
  193. <table class="tparams">
  194. <tr><td class="paramname">T</td><td>A floating-point scalar type </td></tr>
  195. <tr><td class="paramname">Q</td><td>A value from qualifier enum </td></tr>
  196. </table>
  197. </dd>
  198. </dl>
  199. </div>
  200. </div>
  201. </div><!-- contents -->
  202. <!-- start footer part -->
  203. <hr class="footer"/><address class="footer"><small>
  204. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  205. <img class="footer" src="doxygen.png" alt="doxygen"/>
  206. </a> 1.8.10
  207. </small></address>
  208. </body>
  209. </html>