a00224.html 7.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167
  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.5"/>
  7. <title>GLM: 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 style="padding-left: 0.5em;">
  20. <div id="projectname">GLM
  21. &#160;<span id="projectnumber">0.9.5</span>
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.5 -->
  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="pages.html"><span>Related&#160;Pages</span></a></li>
  34. <li><a href="modules.html"><span>Modules</span></a></li>
  35. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  36. <li><a href="files.html"><span>Files</span></a></li>
  37. </ul>
  38. </div>
  39. </div><!-- top -->
  40. <div class="header">
  41. <div class="summary">
  42. <a href="#func-members">Functions</a> </div>
  43. <div class="headertitle">
  44. <div class="title">GLM_GTX_rotate_normalized_axis<div class="ingroups"><a class="el" href="a00164.html">GTC Extensions (Stable)</a></div></div> </div>
  45. </div><!--header-->
  46. <div class="contents">
  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:ga05f9b087d45a649cc221926415b0b2f9"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
  51. <tr class="memitem:ga05f9b087d45a649cc221926415b0b2f9"><td class="memTemplItemLeft" align="right" valign="top">detail::tmat4x4&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00224.html#ga05f9b087d45a649cc221926415b0b2f9">rotateNormalizedAxis</a> (detail::tmat4x4&lt; T, P &gt; const &amp;m, T const &amp;angle, detail::tvec3&lt; T, P &gt; const &amp;axis)</td></tr>
  52. <tr class="separator:ga05f9b087d45a649cc221926415b0b2f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  53. <tr class="memitem:ga886abfa3ad43c29cca5fb01046243745"><td class="memTemplParams" colspan="2">template&lt;typename T , precision P&gt; </td></tr>
  54. <tr class="memitem:ga886abfa3ad43c29cca5fb01046243745"><td class="memTemplItemLeft" align="right" valign="top">detail::tquat&lt; T, P &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00224.html#ga886abfa3ad43c29cca5fb01046243745">rotateNormalizedAxis</a> (detail::tquat&lt; T, P &gt; const &amp;q, T const &amp;angle, detail::tvec3&lt; T, P &gt; const &amp;axis)</td></tr>
  55. <tr class="separator:ga886abfa3ad43c29cca5fb01046243745"><td class="memSeparator" colspan="2">&#160;</td></tr>
  56. </table>
  57. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  58. <p>Quaternions and matrices rotations around normalized axis. </p>
  59. <p>&lt;<a class="el" href="a00105.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtx/rotate_normalized_axis.hpp</a>&gt; need to be included to use these functionalities. </p>
  60. <h2 class="groupheader">Function Documentation</h2>
  61. <a class="anchor" id="ga05f9b087d45a649cc221926415b0b2f9"></a>
  62. <div class="memitem">
  63. <div class="memproto">
  64. <table class="memname">
  65. <tr>
  66. <td class="memname">detail::tmat4x4&lt;T, P&gt; glm::rotateNormalizedAxis </td>
  67. <td>(</td>
  68. <td class="paramtype">detail::tmat4x4&lt; T, P &gt; const &amp;&#160;</td>
  69. <td class="paramname"><em>m</em>, </td>
  70. </tr>
  71. <tr>
  72. <td class="paramkey"></td>
  73. <td></td>
  74. <td class="paramtype">T const &amp;&#160;</td>
  75. <td class="paramname"><em>angle</em>, </td>
  76. </tr>
  77. <tr>
  78. <td class="paramkey"></td>
  79. <td></td>
  80. <td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
  81. <td class="paramname"><em>axis</em>&#160;</td>
  82. </tr>
  83. <tr>
  84. <td></td>
  85. <td>)</td>
  86. <td></td><td></td>
  87. </tr>
  88. </table>
  89. </div><div class="memdoc">
  90. <p>Builds a rotation 4 * 4 matrix created from a normalized axis and an angle. </p>
  91. <dl class="params"><dt>Parameters</dt><dd>
  92. <table class="params">
  93. <tr><td class="paramname">m</td><td>Input matrix multiplied by this rotation matrix. </td></tr>
  94. <tr><td class="paramname">angle</td><td>Rotation angle expressed in radians if GLM_FORCE_RADIANS is define or degrees otherwise. </td></tr>
  95. <tr><td class="paramname">axis</td><td>Rotation axis, must be normalized. </td></tr>
  96. </table>
  97. </dd>
  98. </dl>
  99. <dl class="tparams"><dt>Template Parameters</dt><dd>
  100. <table class="tparams">
  101. <tr><td class="paramname">T</td><td>Value type used to build the matrix. Currently supported: half (not recommanded), float or double.</td></tr>
  102. </table>
  103. </dd>
  104. </dl>
  105. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00224.html" title="Quaternions and matrices rotations around normalized axis. ">GLM_GTX_rotate_normalized_axis</a> </dd>
  106. <dd>
  107. - rotate(T angle, T x, T y, T z) </dd>
  108. <dd>
  109. - rotate(detail::tmat4x4&lt;T, P&gt; const &amp; m, T angle, T x, T y, T z) </dd>
  110. <dd>
  111. - <a class="el" href="a00231.html#ga115fb8c9ef8a665bed518d979211e863" title="Builds a rotation 4 * 4 matrix created from an axis of 3 scalars and an angle expressed in degrees...">rotate(T angle, detail::tvec3&lt;T, P&gt; const &amp; v)</a> </dd></dl>
  112. </div>
  113. </div>
  114. <a class="anchor" id="ga886abfa3ad43c29cca5fb01046243745"></a>
  115. <div class="memitem">
  116. <div class="memproto">
  117. <table class="memname">
  118. <tr>
  119. <td class="memname">detail::tquat&lt;T, P&gt; glm::rotateNormalizedAxis </td>
  120. <td>(</td>
  121. <td class="paramtype">detail::tquat&lt; T, P &gt; const &amp;&#160;</td>
  122. <td class="paramname"><em>q</em>, </td>
  123. </tr>
  124. <tr>
  125. <td class="paramkey"></td>
  126. <td></td>
  127. <td class="paramtype">T const &amp;&#160;</td>
  128. <td class="paramname"><em>angle</em>, </td>
  129. </tr>
  130. <tr>
  131. <td class="paramkey"></td>
  132. <td></td>
  133. <td class="paramtype">detail::tvec3&lt; T, P &gt; const &amp;&#160;</td>
  134. <td class="paramname"><em>axis</em>&#160;</td>
  135. </tr>
  136. <tr>
  137. <td></td>
  138. <td>)</td>
  139. <td></td><td></td>
  140. </tr>
  141. </table>
  142. </div><div class="memdoc">
  143. <p>Rotates a quaternion from a vector of 3 components normalized axis and an angle. </p>
  144. <dl class="params"><dt>Parameters</dt><dd>
  145. <table class="params">
  146. <tr><td class="paramname">q</td><td>Source orientation </td></tr>
  147. <tr><td class="paramname">angle</td><td>Angle expressed in radians if GLM_FORCE_RADIANS is define or degrees otherwise. </td></tr>
  148. <tr><td class="paramname">axis</td><td>Normalized axis of the rotation, must be normalized.</td></tr>
  149. </table>
  150. </dd>
  151. </dl>
  152. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="a00224.html" title="Quaternions and matrices rotations around normalized axis. ">GLM_GTX_rotate_normalized_axis</a> </dd></dl>
  153. </div>
  154. </div>
  155. </div><!-- contents -->
  156. <!-- start footer part -->
  157. <hr class="footer"/><address class="footer"><small>
  158. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  159. <img class="footer" src="doxygen.png" alt="doxygen"/>
  160. </a> 1.8.5
  161. </small></address>
  162. </body>
  163. </html>