a00223.html 8.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170
  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.8 API documenation: 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="doxygen.css" rel="stylesheet" type="text/css" />
  12. </head>
  13. <body>
  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15. <div id="titlearea">
  16. <table cellspacing="0" cellpadding="0">
  17. <tbody>
  18. <tr style="height: 56px;">
  19. <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  20. <td id="projectalign" style="padding-left: 0.5em;">
  21. <div id="projectname">0.9.8 API documenation
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.10 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="modules.html"><span>Modules</span></a></li>
  34. <li><a href="files.html"><span>Files</span></a></li>
  35. </ul>
  36. </div>
  37. </div><!-- top -->
  38. <div class="header">
  39. <div class="summary">
  40. <a href="#func-members">Functions</a> </div>
  41. <div class="headertitle">
  42. <div class="title">GLM_GTX_rotate_normalized_axis<div class="ingroups"><a class="el" href="a00154.html">GTX Extensions (Experimental)</a></div></div> </div>
  43. </div><!--header-->
  44. <div class="contents">
  45. <p>Quaternions and matrices rotations around normalized axis.
  46. <a href="#details">More...</a></p>
  47. <table class="memberdecls">
  48. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  49. Functions</h2></td></tr>
  50. <tr class="memitem:gaada623964a895def5a8b77b5b7887dc4"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
  51. <tr class="memitem:gaada623964a895def5a8b77b5b7887dc4"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tmat4x4&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00223.html#gaada623964a895def5a8b77b5b7887dc4">rotateNormalizedAxis</a> (tmat4x4&lt; T, P &gt; const &amp;m, T const &amp;angle, tvec3&lt; T, P &gt; const &amp;axis)</td></tr>
  52. <tr class="memdesc:gaada623964a895def5a8b77b5b7887dc4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Builds a rotation 4 * 4 matrix created from a normalized axis and an angle. <a href="a00223.html#gaada623964a895def5a8b77b5b7887dc4">More...</a><br /></td></tr>
  53. <tr class="separator:gaada623964a895def5a8b77b5b7887dc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  54. <tr class="memitem:ga6c00234d844faef36a6a94669fbd1639"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
  55. <tr class="memitem:ga6c00234d844faef36a6a94669fbd1639"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL tquat&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00223.html#ga6c00234d844faef36a6a94669fbd1639">rotateNormalizedAxis</a> (tquat&lt; T, P &gt; const &amp;q, T const &amp;angle, tvec3&lt; T, P &gt; const &amp;axis)</td></tr>
  56. <tr class="memdesc:ga6c00234d844faef36a6a94669fbd1639"><td class="mdescLeft">&#160;</td><td class="mdescRight">Rotates a quaternion from a vector of 3 components normalized axis and an angle. <a href="a00223.html#ga6c00234d844faef36a6a94669fbd1639">More...</a><br /></td></tr>
  57. <tr class="separator:ga6c00234d844faef36a6a94669fbd1639"><td class="memSeparator" colspan="2">&#160;</td></tr>
  58. </table>
  59. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  60. <p>Quaternions and matrices rotations around normalized axis. </p>
  61. <p>&lt;<a class="el" href="a00094.html" title="GLM_GTX_rotate_normalized_axis ">glm/gtx/rotate_normalized_axis.hpp</a>&gt; need to be included to use these functionalities. </p>
  62. <h2 class="groupheader">Function Documentation</h2>
  63. <a class="anchor" id="gaada623964a895def5a8b77b5b7887dc4"></a>
  64. <div class="memitem">
  65. <div class="memproto">
  66. <table class="memname">
  67. <tr>
  68. <td class="memname">GLM_FUNC_DECL tmat4x4&lt;T, P&gt; glm::rotateNormalizedAxis </td>
  69. <td>(</td>
  70. <td class="paramtype">tmat4x4&lt; T, P &gt; const &amp;&#160;</td>
  71. <td class="paramname"><em>m</em>, </td>
  72. </tr>
  73. <tr>
  74. <td class="paramkey"></td>
  75. <td></td>
  76. <td class="paramtype">T const &amp;&#160;</td>
  77. <td class="paramname"><em>angle</em>, </td>
  78. </tr>
  79. <tr>
  80. <td class="paramkey"></td>
  81. <td></td>
  82. <td class="paramtype">tvec3&lt; T, P &gt; const &amp;&#160;</td>
  83. <td class="paramname"><em>axis</em>&#160;</td>
  84. </tr>
  85. <tr>
  86. <td></td>
  87. <td>)</td>
  88. <td></td><td></td>
  89. </tr>
  90. </table>
  91. </div><div class="memdoc">
  92. <p>Builds a rotation 4 * 4 matrix created from a normalized axis and an angle. </p>
  93. <dl class="params"><dt>Parameters</dt><dd>
  94. <table class="params">
  95. <tr><td class="paramname">m</td><td>Input matrix multiplied by this rotation matrix. </td></tr>
  96. <tr><td class="paramname">angle</td><td>Rotation angle expressed in radians if GLM_FORCE_RADIANS is define or degrees otherwise. </td></tr>
  97. <tr><td class="paramname">axis</td><td>Rotation axis, must be normalized. </td></tr>
  98. </table>
  99. </dd>
  100. </dl>
  101. <dl class="tparams"><dt>Template Parameters</dt><dd>
  102. <table class="tparams">
  103. <tr><td class="paramname">T</td><td>Value type used to build the matrix. Currently supported: half (not recommanded), float or double.</td></tr>
  104. </table>
  105. </dd>
  106. </dl>
  107. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00223.html" title="Quaternions and matrices rotations around normalized axis. ">GLM_GTX_rotate_normalized_axis</a> </dd>
  108. <dd>
  109. - rotate(T angle, T x, T y, T z) </dd>
  110. <dd>
  111. - rotate(tmat4x4&lt;T, P&gt; const &amp; m, T angle, T x, T y, T z) </dd>
  112. <dd>
  113. - rotate(T angle, tvec3&lt;T, P&gt; const &amp; v) </dd></dl>
  114. </div>
  115. </div>
  116. <a class="anchor" id="ga6c00234d844faef36a6a94669fbd1639"></a>
  117. <div class="memitem">
  118. <div class="memproto">
  119. <table class="memname">
  120. <tr>
  121. <td class="memname">GLM_FUNC_DECL tquat&lt;T, P&gt; glm::rotateNormalizedAxis </td>
  122. <td>(</td>
  123. <td class="paramtype">tquat&lt; T, P &gt; const &amp;&#160;</td>
  124. <td class="paramname"><em>q</em>, </td>
  125. </tr>
  126. <tr>
  127. <td class="paramkey"></td>
  128. <td></td>
  129. <td class="paramtype">T const &amp;&#160;</td>
  130. <td class="paramname"><em>angle</em>, </td>
  131. </tr>
  132. <tr>
  133. <td class="paramkey"></td>
  134. <td></td>
  135. <td class="paramtype">tvec3&lt; T, P &gt; const &amp;&#160;</td>
  136. <td class="paramname"><em>axis</em>&#160;</td>
  137. </tr>
  138. <tr>
  139. <td></td>
  140. <td>)</td>
  141. <td></td><td></td>
  142. </tr>
  143. </table>
  144. </div><div class="memdoc">
  145. <p>Rotates a quaternion from a vector of 3 components normalized axis and an angle. </p>
  146. <dl class="params"><dt>Parameters</dt><dd>
  147. <table class="params">
  148. <tr><td class="paramname">q</td><td>Source orientation </td></tr>
  149. <tr><td class="paramname">angle</td><td>Angle expressed in radians if GLM_FORCE_RADIANS is define or degrees otherwise. </td></tr>
  150. <tr><td class="paramname">axis</td><td>Normalized axis of the rotation, must be normalized.</td></tr>
  151. </table>
  152. </dd>
  153. </dl>
  154. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00223.html" title="Quaternions and matrices rotations around normalized axis. ">GLM_GTX_rotate_normalized_axis</a> </dd></dl>
  155. </div>
  156. </div>
  157. </div><!-- contents -->
  158. <!-- start footer part -->
  159. <hr class="footer"/><address class="footer"><small>
  160. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  161. <img class="footer" src="doxygen.png" alt="doxygen"/>
  162. </a> 1.8.10
  163. </small></address>
  164. </body>
  165. </html>