a00355.html 9.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209
  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_GTX_rotate_normalized_axis</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_GTX_rotate_normalized_axis<div class="ingroups"><a class="el" href="a00287.html">Experimental extensions</a></div></div> </div>
  80. </div><!--header-->
  81. <div class="contents">
  82. <p>Include &lt;<a class="el" href="a00141.html" title="GLM_GTX_rotate_normalized_axis ">glm/gtx/rotate_normalized_axis.hpp</a>&gt; to use the features of this extension.
  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:ga50efd7ebca0f7a603bb3cc11e34c708d"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  88. <tr class="memitem:ga50efd7ebca0f7a603bb3cc11e34c708d"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL mat&lt; 4, 4, T, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00355.html#ga50efd7ebca0f7a603bb3cc11e34c708d">rotateNormalizedAxis</a> (mat&lt; 4, 4, T, Q &gt; const &amp;m, T const &amp;angle, vec&lt; 3, T, Q &gt; const &amp;axis)</td></tr>
  89. <tr class="memdesc:ga50efd7ebca0f7a603bb3cc11e34c708d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builds a rotation 4 * 4 matrix created from a normalized axis and an angle. <a href="a00355.html#ga50efd7ebca0f7a603bb3cc11e34c708d">More...</a><br /></td></tr>
  90. <tr class="separator:ga50efd7ebca0f7a603bb3cc11e34c708d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:ga08f9c5411437d528019a25bfc01473d1"><td class="memTemplParams" colspan="2">template&lt;typename T , qualifier Q&gt; </td></tr>
  92. <tr class="memitem:ga08f9c5411437d528019a25bfc01473d1"><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="a00355.html#ga08f9c5411437d528019a25bfc01473d1">rotateNormalizedAxis</a> (qua&lt; T, Q &gt; const &amp;q, T const &amp;angle, vec&lt; 3, T, Q &gt; const &amp;axis)</td></tr>
  93. <tr class="memdesc:ga08f9c5411437d528019a25bfc01473d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rotates a quaternion from a vector of 3 components normalized axis and an angle. <a href="a00355.html#ga08f9c5411437d528019a25bfc01473d1">More...</a><br /></td></tr>
  94. <tr class="separator:ga08f9c5411437d528019a25bfc01473d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. </table>
  96. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  97. <p>Include &lt;<a class="el" href="a00141.html" title="GLM_GTX_rotate_normalized_axis ">glm/gtx/rotate_normalized_axis.hpp</a>&gt; to use the features of this extension. </p>
  98. <p>Quaternions and matrices rotations around normalized axis. </p>
  99. <h2 class="groupheader">Function Documentation</h2>
  100. <a class="anchor" id="ga50efd7ebca0f7a603bb3cc11e34c708d"></a>
  101. <div class="memitem">
  102. <div class="memproto">
  103. <table class="memname">
  104. <tr>
  105. <td class="memname">GLM_FUNC_DECL mat&lt;4, 4, T, Q&gt; glm::rotateNormalizedAxis </td>
  106. <td>(</td>
  107. <td class="paramtype">mat&lt; 4, 4, T, Q &gt; const &amp;&#160;</td>
  108. <td class="paramname"><em>m</em>, </td>
  109. </tr>
  110. <tr>
  111. <td class="paramkey"></td>
  112. <td></td>
  113. <td class="paramtype">T const &amp;&#160;</td>
  114. <td class="paramname"><em>angle</em>, </td>
  115. </tr>
  116. <tr>
  117. <td class="paramkey"></td>
  118. <td></td>
  119. <td class="paramtype">vec&lt; 3, T, Q &gt; const &amp;&#160;</td>
  120. <td class="paramname"><em>axis</em>&#160;</td>
  121. </tr>
  122. <tr>
  123. <td></td>
  124. <td>)</td>
  125. <td></td><td></td>
  126. </tr>
  127. </table>
  128. </div><div class="memdoc">
  129. <p>Builds a rotation 4 * 4 matrix created from a normalized axis and an angle. </p>
  130. <dl class="params"><dt>Parameters</dt><dd>
  131. <table class="params">
  132. <tr><td class="paramname">m</td><td>Input matrix multiplied by this rotation matrix. </td></tr>
  133. <tr><td class="paramname">angle</td><td>Rotation angle expressed in radians. </td></tr>
  134. <tr><td class="paramname">axis</td><td>Rotation axis, must be normalized. </td></tr>
  135. </table>
  136. </dd>
  137. </dl>
  138. <dl class="tparams"><dt>Template Parameters</dt><dd>
  139. <table class="tparams">
  140. <tr><td class="paramname">T</td><td>Value type used to build the matrix. Currently supported: half (not recommended), float or double.</td></tr>
  141. </table>
  142. </dd>
  143. </dl>
  144. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00355.html" title="Include <glm/gtx/rotate_normalized_axis.hpp> to use the features of this extension. ">GLM_GTX_rotate_normalized_axis</a> </dd>
  145. <dd>
  146. - rotate(T angle, T x, T y, T z) </dd>
  147. <dd>
  148. - rotate(mat&lt;4, 4, T, Q&gt; const&amp; m, T angle, T x, T y, T z) </dd>
  149. <dd>
  150. - rotate(T angle, vec&lt;3, T, Q&gt; const&amp; v) </dd></dl>
  151. </div>
  152. </div>
  153. <a class="anchor" id="ga08f9c5411437d528019a25bfc01473d1"></a>
  154. <div class="memitem">
  155. <div class="memproto">
  156. <table class="memname">
  157. <tr>
  158. <td class="memname">GLM_FUNC_DECL qua&lt;T, Q&gt; glm::rotateNormalizedAxis </td>
  159. <td>(</td>
  160. <td class="paramtype">qua&lt; T, Q &gt; const &amp;&#160;</td>
  161. <td class="paramname"><em>q</em>, </td>
  162. </tr>
  163. <tr>
  164. <td class="paramkey"></td>
  165. <td></td>
  166. <td class="paramtype">T const &amp;&#160;</td>
  167. <td class="paramname"><em>angle</em>, </td>
  168. </tr>
  169. <tr>
  170. <td class="paramkey"></td>
  171. <td></td>
  172. <td class="paramtype">vec&lt; 3, T, Q &gt; const &amp;&#160;</td>
  173. <td class="paramname"><em>axis</em>&#160;</td>
  174. </tr>
  175. <tr>
  176. <td></td>
  177. <td>)</td>
  178. <td></td><td></td>
  179. </tr>
  180. </table>
  181. </div><div class="memdoc">
  182. <p>Rotates a quaternion from a vector of 3 components normalized axis and an angle. </p>
  183. <dl class="params"><dt>Parameters</dt><dd>
  184. <table class="params">
  185. <tr><td class="paramname">q</td><td>Source orientation </td></tr>
  186. <tr><td class="paramname">angle</td><td>Angle expressed in radians. </td></tr>
  187. <tr><td class="paramname">axis</td><td>Normalized axis of the rotation, must be normalized.</td></tr>
  188. </table>
  189. </dd>
  190. </dl>
  191. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00355.html" title="Include <glm/gtx/rotate_normalized_axis.hpp> to use the features of this extension. ">GLM_GTX_rotate_normalized_axis</a> </dd></dl>
  192. </div>
  193. </div>
  194. </div><!-- contents -->
  195. <!-- start footer part -->
  196. <hr class="footer"/><address class="footer"><small>
  197. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  198. <img class="footer" src="doxygen.png" alt="doxygen"/>
  199. </a> 1.8.10
  200. </small></address>
  201. </body>
  202. </html>