a00719_source.html 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.18"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>1.0.0 API documentation: rotate_vector.hpp Source File</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
  24. <td id="projectalign" style="padding-left: 0.5em;">
  25. <div id="projectname">1.0.0 API documentation
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.18 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */</script>
  48. <div id="main-nav"></div>
  49. <!-- window showing the filter options -->
  50. <div id="MSearchSelectWindow"
  51. onmouseover="return searchBox.OnSearchSelectShow()"
  52. onmouseout="return searchBox.OnSearchSelectHide()"
  53. onkeydown="return searchBox.OnSearchSelectKey(event)">
  54. </div>
  55. <!-- iframe showing the search results (closed by default) -->
  56. <div id="MSearchResultsWindow">
  57. <iframe src="javascript:void(0)" frameborder="0"
  58. name="MSearchResults" id="MSearchResults">
  59. </iframe>
  60. </div>
  61. <div id="nav-path" class="navpath">
  62. <ul>
  63. <li class="navelem"><a class="el" href="dir_885cc87fac2d91e269af0a5a959fa5f6.html">E:</a></li><li class="navelem"><a class="el" href="dir_63ed049134a778d525e06b63afc2c979.html">Github</a></li><li class="navelem"><a class="el" href="dir_c98a9ac98258ab9f831b188d66361a70.html">g-truc</a></li><li class="navelem"><a class="el" href="dir_50f12b6ceb23d7f6adfb377a1ae8b006.html">glm</a></li><li class="navelem"><a class="el" href="dir_fca33f1b5115d46f42c670590789c0d2.html">glm</a></li><li class="navelem"><a class="el" href="dir_628fd60eb37daf5aa9a81e3983c640b7.html">gtx</a></li> </ul>
  64. </div>
  65. </div><!-- top -->
  66. <div class="header">
  67. <div class="headertitle">
  68. <div class="title">rotate_vector.hpp</div> </div>
  69. </div><!--header-->
  70. <div class="contents">
  71. <a href="a00719.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160; </div>
  72. <div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#pragma once</span></div>
  73. <div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; </div>
  74. <div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment">// Dependency:</span></div>
  75. <div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &quot;../gtx/transform.hpp&quot;</span></div>
  76. <div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#include &quot;../gtc/epsilon.hpp&quot;</span></div>
  77. <div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#include &quot;../ext/vector_relational.hpp&quot;</span></div>
  78. <div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &quot;../glm.hpp&quot;</span></div>
  79. <div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
  80. <div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#ifndef GLM_ENABLE_EXPERIMENTAL</span></div>
  81. <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor"># error &quot;GLM: GLM_GTX_rotate_vector is an experimental extension and may change in the future. Use #define GLM_ENABLE_EXPERIMENTAL before including it, if you really want to use it.&quot;</span></div>
  82. <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#elif GLM_MESSAGES == GLM_ENABLE &amp;&amp; !defined(GLM_EXT_INCLUDED)</span></div>
  83. <div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor"># pragma message(&quot;GLM: GLM_GTX_rotate_vector extension included&quot;)</span></div>
  84. <div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#endif</span></div>
  85. <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; </div>
  86. <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="keyword">namespace </span>glm</div>
  87. <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;{</div>
  88. <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
  89. <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, qualifier Q&gt;</div>
  90. <div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="a00966.html#ga8b11b18ce824174ea1a5a69ea14e2cee"> 41</a></span>&#160; GLM_FUNC_DECL vec&lt;3, T, Q&gt; <a class="code" href="a00966.html#ga8b11b18ce824174ea1a5a69ea14e2cee">slerp</a>(</div>
  91. <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; vec&lt;3, T, Q&gt; <span class="keyword">const</span>&amp; x,</div>
  92. <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; vec&lt;3, T, Q&gt; <span class="keyword">const</span>&amp; y,</div>
  93. <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; T <span class="keyword">const</span>&amp; a);</div>
  94. <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; </div>
  95. <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, qualifier Q&gt;</div>
  96. <div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="a00966.html#gab64a67b52ff4f86c3ba16595a5a25af6"> 49</a></span>&#160; GLM_FUNC_DECL vec&lt;2, T, Q&gt; <a class="code" href="a00966.html#ga1005f1267ed9c57faa3f24cf6873b961">rotate</a>(</div>
  97. <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; vec&lt;2, T, Q&gt; <span class="keyword">const</span>&amp; v,</div>
  98. <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; T <span class="keyword">const</span>&amp; <a class="code" href="a00856.html#ga8aa248b31d5ade470c87304df5eb7bd8">angle</a>);</div>
  99. <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; </div>
  100. <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, qualifier Q&gt;</div>
  101. <div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="a00966.html#ga1ba501ef83d1a009a17ac774cc560f21"> 56</a></span>&#160; GLM_FUNC_DECL vec&lt;3, T, Q&gt; <a class="code" href="a00966.html#ga1005f1267ed9c57faa3f24cf6873b961">rotate</a>(</div>
  102. <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; vec&lt;3, T, Q&gt; <span class="keyword">const</span>&amp; v,</div>
  103. <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; T <span class="keyword">const</span>&amp; <a class="code" href="a00856.html#ga8aa248b31d5ade470c87304df5eb7bd8">angle</a>,</div>
  104. <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; vec&lt;3, T, Q&gt; <span class="keyword">const</span>&amp; normal);</div>
  105. <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; </div>
  106. <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, qualifier Q&gt;</div>
  107. <div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="a00966.html#ga1005f1267ed9c57faa3f24cf6873b961"> 64</a></span>&#160; GLM_FUNC_DECL vec&lt;4, T, Q&gt; <a class="code" href="a00966.html#ga1005f1267ed9c57faa3f24cf6873b961">rotate</a>(</div>
  108. <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; vec&lt;4, T, Q&gt; <span class="keyword">const</span>&amp; v,</div>
  109. <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; T <span class="keyword">const</span>&amp; <a class="code" href="a00856.html#ga8aa248b31d5ade470c87304df5eb7bd8">angle</a>,</div>
  110. <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; vec&lt;3, T, Q&gt; <span class="keyword">const</span>&amp; normal);</div>
  111. <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; </div>
  112. <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, qualifier Q&gt;</div>
  113. <div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="a00966.html#ga059fdbdba4cca35cdff172a9d0d0afc9"> 72</a></span>&#160; GLM_FUNC_DECL vec&lt;3, T, Q&gt; <a class="code" href="a00966.html#ga4333b1ea8ebf1bd52bc3801a7617398a">rotateX</a>(</div>
  114. <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; vec&lt;3, T, Q&gt; <span class="keyword">const</span>&amp; v,</div>
  115. <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; T <span class="keyword">const</span>&amp; <a class="code" href="a00856.html#ga8aa248b31d5ade470c87304df5eb7bd8">angle</a>);</div>
  116. <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; </div>
  117. <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, qualifier Q&gt;</div>
  118. <div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="a00966.html#gaebdc8b054ace27d9f62e054531c6f44d"> 79</a></span>&#160; GLM_FUNC_DECL vec&lt;3, T, Q&gt; <a class="code" href="a00966.html#ga3ce3db0867b7f8efd878ee34f95a623b">rotateY</a>(</div>
  119. <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; vec&lt;3, T, Q&gt; <span class="keyword">const</span>&amp; v,</div>
  120. <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; T <span class="keyword">const</span>&amp; <a class="code" href="a00856.html#ga8aa248b31d5ade470c87304df5eb7bd8">angle</a>);</div>
  121. <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; </div>
  122. <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, qualifier Q&gt;</div>
  123. <div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="a00966.html#ga5a048838a03f6249acbacb4dbacf79c4"> 86</a></span>&#160; GLM_FUNC_DECL vec&lt;3, T, Q&gt; <a class="code" href="a00966.html#ga923b75c6448161053768822d880702e6">rotateZ</a>(</div>
  124. <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; vec&lt;3, T, Q&gt; <span class="keyword">const</span>&amp; v,</div>
  125. <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; T <span class="keyword">const</span>&amp; <a class="code" href="a00856.html#ga8aa248b31d5ade470c87304df5eb7bd8">angle</a>);</div>
  126. <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; </div>
  127. <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, qualifier Q&gt;</div>
  128. <div class="line"><a name="l00093"></a><span class="lineno"><a class="line" href="a00966.html#ga4333b1ea8ebf1bd52bc3801a7617398a"> 93</a></span>&#160; GLM_FUNC_DECL vec&lt;4, T, Q&gt; <a class="code" href="a00966.html#ga4333b1ea8ebf1bd52bc3801a7617398a">rotateX</a>(</div>
  129. <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; vec&lt;4, T, Q&gt; <span class="keyword">const</span>&amp; v,</div>
  130. <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; T <span class="keyword">const</span>&amp; <a class="code" href="a00856.html#ga8aa248b31d5ade470c87304df5eb7bd8">angle</a>);</div>
  131. <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; </div>
  132. <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, qualifier Q&gt;</div>
  133. <div class="line"><a name="l00100"></a><span class="lineno"><a class="line" href="a00966.html#ga3ce3db0867b7f8efd878ee34f95a623b"> 100</a></span>&#160; GLM_FUNC_DECL vec&lt;4, T, Q&gt; <a class="code" href="a00966.html#ga3ce3db0867b7f8efd878ee34f95a623b">rotateY</a>(</div>
  134. <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; vec&lt;4, T, Q&gt; <span class="keyword">const</span>&amp; v,</div>
  135. <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; T <span class="keyword">const</span>&amp; <a class="code" href="a00856.html#ga8aa248b31d5ade470c87304df5eb7bd8">angle</a>);</div>
  136. <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; </div>
  137. <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, qualifier Q&gt;</div>
  138. <div class="line"><a name="l00107"></a><span class="lineno"><a class="line" href="a00966.html#ga923b75c6448161053768822d880702e6"> 107</a></span>&#160; GLM_FUNC_DECL vec&lt;4, T, Q&gt; <a class="code" href="a00966.html#ga923b75c6448161053768822d880702e6">rotateZ</a>(</div>
  139. <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; vec&lt;4, T, Q&gt; <span class="keyword">const</span>&amp; v,</div>
  140. <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; T <span class="keyword">const</span>&amp; <a class="code" href="a00856.html#ga8aa248b31d5ade470c87304df5eb7bd8">angle</a>);</div>
  141. <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; </div>
  142. <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, qualifier Q&gt;</div>
  143. <div class="line"><a name="l00114"></a><span class="lineno"><a class="line" href="a00966.html#ga1a32fceb71962e6160e8af295c91930a"> 114</a></span>&#160; GLM_FUNC_DECL mat&lt;4, 4, T, Q&gt; <a class="code" href="a00966.html#ga1a32fceb71962e6160e8af295c91930a">orientation</a>(</div>
  144. <div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; vec&lt;3, T, Q&gt; <span class="keyword">const</span>&amp; Normal,</div>
  145. <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; vec&lt;3, T, Q&gt; <span class="keyword">const</span>&amp; Up);</div>
  146. <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; </div>
  147. <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160;}<span class="comment">//namespace glm</span></div>
  148. <div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; </div>
  149. <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160;<span class="preprocessor">#include &quot;rotate_vector.inl&quot;</span></div>
  150. </div><!-- fragment --></div><!-- contents -->
  151. <div class="ttc" id="aa00856_html_ga8aa248b31d5ade470c87304df5eb7bd8"><div class="ttname"><a href="a00856.html#ga8aa248b31d5ade470c87304df5eb7bd8">glm::angle</a></div><div class="ttdeci">GLM_FUNC_DECL T angle(qua&lt; T, Q &gt; const &amp;x)</div><div class="ttdoc">Returns the quaternion rotation angle.</div></div>
  152. <div class="ttc" id="aa00966_html_ga923b75c6448161053768822d880702e6"><div class="ttname"><a href="a00966.html#ga923b75c6448161053768822d880702e6">glm::rotateZ</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; 4, T, Q &gt; rotateZ(vec&lt; 4, T, Q &gt; const &amp;v, T const &amp;angle)</div><div class="ttdoc">Rotate a four dimensional vector around the Z axis.</div></div>
  153. <div class="ttc" id="aa00966_html_ga1a32fceb71962e6160e8af295c91930a"><div class="ttname"><a href="a00966.html#ga1a32fceb71962e6160e8af295c91930a">glm::orientation</a></div><div class="ttdeci">GLM_FUNC_DECL mat&lt; 4, 4, T, Q &gt; orientation(vec&lt; 3, T, Q &gt; const &amp;Normal, vec&lt; 3, T, Q &gt; const &amp;Up)</div><div class="ttdoc">Build a rotation matrix from a normal and a up vector.</div></div>
  154. <div class="ttc" id="aa00966_html_ga8b11b18ce824174ea1a5a69ea14e2cee"><div class="ttname"><a href="a00966.html#ga8b11b18ce824174ea1a5a69ea14e2cee">glm::slerp</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; 3, T, Q &gt; slerp(vec&lt; 3, T, Q &gt; const &amp;x, vec&lt; 3, T, Q &gt; const &amp;y, T const &amp;a)</div><div class="ttdoc">Returns Spherical interpolation between two vectors.</div></div>
  155. <div class="ttc" id="aa00966_html_ga3ce3db0867b7f8efd878ee34f95a623b"><div class="ttname"><a href="a00966.html#ga3ce3db0867b7f8efd878ee34f95a623b">glm::rotateY</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; 4, T, Q &gt; rotateY(vec&lt; 4, T, Q &gt; const &amp;v, T const &amp;angle)</div><div class="ttdoc">Rotate a four dimensional vector around the Y axis.</div></div>
  156. <div class="ttc" id="aa00966_html_ga1005f1267ed9c57faa3f24cf6873b961"><div class="ttname"><a href="a00966.html#ga1005f1267ed9c57faa3f24cf6873b961">glm::rotate</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; 4, T, Q &gt; rotate(vec&lt; 4, T, Q &gt; const &amp;v, T const &amp;angle, vec&lt; 3, T, Q &gt; const &amp;normal)</div><div class="ttdoc">Rotate a four dimensional vector around an axis.</div></div>
  157. <div class="ttc" id="aa00966_html_ga4333b1ea8ebf1bd52bc3801a7617398a"><div class="ttname"><a href="a00966.html#ga4333b1ea8ebf1bd52bc3801a7617398a">glm::rotateX</a></div><div class="ttdeci">GLM_FUNC_DECL vec&lt; 4, T, Q &gt; rotateX(vec&lt; 4, T, Q &gt; const &amp;v, T const &amp;angle)</div><div class="ttdoc">Rotate a four dimensional vector around the X axis.</div></div>
  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.18
  163. </small></address>
  164. </body>
  165. </html>