a00100_source.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143
  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.8"/>
  7. <title>0.9.6: rotate_vector.hpp Source File</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 style="padding-left: 0.5em;">
  21. <div id="projectname">0.9.6
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.8 -->
  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 class="current"><a href="files.html"><span>Files</span></a></li>
  35. </ul>
  36. </div>
  37. <div id="navrow2" class="tabs2">
  38. <ul class="tablist">
  39. <li><a href="files.html"><span>File&#160;List</span></a></li>
  40. </ul>
  41. </div>
  42. <div id="nav-path" class="navpath">
  43. <ul>
  44. <li class="navelem"><a class="el" href="dir_885cc87fac2d91e269af0a5a959fa5f6.html">E:</a></li><li class="navelem"><a class="el" href="dir_153b03dd71a7bff437c38ec53cb2e014.html">Source</a></li><li class="navelem"><a class="el" href="dir_0c6652232a835be54bedd6cfd7502504.html">G-Truc</a></li><li class="navelem"><a class="el" href="dir_e2c7faa62a52820b5be8795affd6e495.html">glm</a></li><li class="navelem"><a class="el" href="dir_5cf96241cdcf6779b80e104875f9716f.html">glm</a></li><li class="navelem"><a class="el" href="dir_5d3642ea3c7f2dae4a957f2cf472c9ae.html">gtx</a></li> </ul>
  45. </div>
  46. </div><!-- top -->
  47. <div class="header">
  48. <div class="headertitle">
  49. <div class="title">rotate_vector.hpp</div> </div>
  50. </div><!--header-->
  51. <div class="contents">
  52. <a href="a00100.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>
  53. <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="preprocessor">#pragma once</span></div>
  54. <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div>
  55. <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="comment">// Dependency:</span></div>
  56. <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="preprocessor">#include &quot;../glm.hpp&quot;</span></div>
  57. <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="preprocessor">#include &quot;../gtx/transform.hpp&quot;</span></div>
  58. <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div>
  59. <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="preprocessor">#if(defined(GLM_MESSAGES) &amp;&amp; !defined(GLM_EXT_INCLUDED))</span></div>
  60. <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="preprocessor"># pragma message(&quot;GLM: GLM_GTX_rotate_vector extension included&quot;)</span></div>
  61. <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="preprocessor">#endif</span></div>
  62. <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div>
  63. <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="keyword">namespace </span><a class="code" href="a00145.html">glm</a></div>
  64. <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;{</div>
  65. <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;</div>
  66. <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
  67. <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; GLM_FUNC_DECL tvec3&lt;T, P&gt; <a class="code" href="a00225.html#gafc9ab3101c3f3799f3d5d6d9d3baac09">slerp</a>(</div>
  68. <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; x,</div>
  69. <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; y,</div>
  70. <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; T <span class="keyword">const</span> &amp; a);</div>
  71. <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;</div>
  72. <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
  73. <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; GLM_FUNC_DECL tvec2&lt;T, P&gt; <a class="code" href="a00225.html#gaf4d59dd2f668f9ffb38048055d1316bd">rotate</a>(</div>
  74. <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; tvec2&lt;T, P&gt; <span class="keyword">const</span> &amp; v,</div>
  75. <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; T <span class="keyword">const</span> &amp; <a class="code" href="a00174.html#gad4a4448baedb198b2b1e7880d2544dc9">angle</a>);</div>
  76. <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; </div>
  77. <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
  78. <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; GLM_FUNC_DECL tvec3&lt;T, P&gt; <a class="code" href="a00225.html#gaf4d59dd2f668f9ffb38048055d1316bd">rotate</a>(</div>
  79. <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; v,</div>
  80. <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; T <span class="keyword">const</span> &amp; <a class="code" href="a00174.html#gad4a4448baedb198b2b1e7880d2544dc9">angle</a>,</div>
  81. <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; normal);</div>
  82. <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; </div>
  83. <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
  84. <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; GLM_FUNC_DECL tvec4&lt;T, P&gt; <a class="code" href="a00225.html#gaf4d59dd2f668f9ffb38048055d1316bd">rotate</a>(</div>
  85. <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; tvec4&lt;T, P&gt; <span class="keyword">const</span> &amp; v,</div>
  86. <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; T <span class="keyword">const</span> &amp; <a class="code" href="a00174.html#gad4a4448baedb198b2b1e7880d2544dc9">angle</a>,</div>
  87. <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; normal);</div>
  88. <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; </div>
  89. <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
  90. <div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; GLM_FUNC_DECL tvec3&lt;T, P&gt; <a class="code" href="a00225.html#gadab312d430a564741ae02215255027a0">rotateX</a>(</div>
  91. <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; v,</div>
  92. <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; T <span class="keyword">const</span> &amp; <a class="code" href="a00174.html#gad4a4448baedb198b2b1e7880d2544dc9">angle</a>);</div>
  93. <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;</div>
  94. <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
  95. <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; GLM_FUNC_DECL tvec3&lt;T, P&gt; <a class="code" href="a00225.html#gae2507577c4bffa3548b32852791dd90c">rotateY</a>(</div>
  96. <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; v,</div>
  97. <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; T <span class="keyword">const</span> &amp; <a class="code" href="a00174.html#gad4a4448baedb198b2b1e7880d2544dc9">angle</a>);</div>
  98. <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; </div>
  99. <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
  100. <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; GLM_FUNC_DECL tvec3&lt;T, P&gt; <a class="code" href="a00225.html#ga034e5d197ab4bd8685624bc2cf16e586">rotateZ</a>(</div>
  101. <div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; v,</div>
  102. <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; T <span class="keyword">const</span> &amp; <a class="code" href="a00174.html#gad4a4448baedb198b2b1e7880d2544dc9">angle</a>);</div>
  103. <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; </div>
  104. <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
  105. <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; GLM_FUNC_DECL tvec4&lt;T, P&gt; <a class="code" href="a00225.html#gadab312d430a564741ae02215255027a0">rotateX</a>(</div>
  106. <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; tvec4&lt;T, P&gt; <span class="keyword">const</span> &amp; v,</div>
  107. <div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; T <span class="keyword">const</span> &amp; <a class="code" href="a00174.html#gad4a4448baedb198b2b1e7880d2544dc9">angle</a>);</div>
  108. <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; </div>
  109. <div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
  110. <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; GLM_FUNC_DECL tvec4&lt;T, P&gt; <a class="code" href="a00225.html#gae2507577c4bffa3548b32852791dd90c">rotateY</a>(</div>
  111. <div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; tvec4&lt;T, P&gt; <span class="keyword">const</span> &amp; v,</div>
  112. <div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; T <span class="keyword">const</span> &amp; <a class="code" href="a00174.html#gad4a4448baedb198b2b1e7880d2544dc9">angle</a>);</div>
  113. <div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; </div>
  114. <div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
  115. <div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; GLM_FUNC_DECL tvec4&lt;T, P&gt; <a class="code" href="a00225.html#ga034e5d197ab4bd8685624bc2cf16e586">rotateZ</a>(</div>
  116. <div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160; tvec4&lt;T, P&gt; <span class="keyword">const</span> &amp; v,</div>
  117. <div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; T <span class="keyword">const</span> &amp; <a class="code" href="a00174.html#gad4a4448baedb198b2b1e7880d2544dc9">angle</a>);</div>
  118. <div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; </div>
  119. <div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
  120. <div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; GLM_FUNC_DECL tmat4x4&lt;T, P&gt; <a class="code" href="a00225.html#ga49b4d082305cdfcfe0a5c184f684a902">orientation</a>(</div>
  121. <div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; Normal,</div>
  122. <div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; Up);</div>
  123. <div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160;</div>
  124. <div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160;}<span class="comment">//namespace glm</span></div>
  125. <div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160;</div>
  126. <div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160;<span class="preprocessor">#include &quot;rotate_vector.inl&quot;</span></div>
  127. <div class="ttc" id="a00225_html_gadab312d430a564741ae02215255027a0"><div class="ttname"><a href="a00225.html#gadab312d430a564741ae02215255027a0">glm::rotateX</a></div><div class="ttdeci">GLM_FUNC_DECL tvec4&lt; T, P &gt; rotateX(tvec4&lt; T, P &gt; const &amp;v, T const &amp;angle)</div><div class="ttdoc">Rotate a four dimentionnals vector around the X axis. </div></div>
  128. <div class="ttc" id="a00225_html_gae2507577c4bffa3548b32852791dd90c"><div class="ttname"><a href="a00225.html#gae2507577c4bffa3548b32852791dd90c">glm::rotateY</a></div><div class="ttdeci">GLM_FUNC_DECL tvec4&lt; T, P &gt; rotateY(tvec4&lt; T, P &gt; const &amp;v, T const &amp;angle)</div><div class="ttdoc">Rotate a four dimensional vector around the X axis. </div></div>
  129. <div class="ttc" id="a00225_html_gafc9ab3101c3f3799f3d5d6d9d3baac09"><div class="ttname"><a href="a00225.html#gafc9ab3101c3f3799f3d5d6d9d3baac09">glm::slerp</a></div><div class="ttdeci">GLM_FUNC_DECL tvec3&lt; T, P &gt; slerp(tvec3&lt; T, P &gt; const &amp;x, tvec3&lt; T, P &gt; const &amp;y, T const &amp;a)</div><div class="ttdoc">Returns Spherical interpolation between two vectors. </div></div>
  130. <div class="ttc" id="a00174_html_gad4a4448baedb198b2b1e7880d2544dc9"><div class="ttname"><a href="a00174.html#gad4a4448baedb198b2b1e7880d2544dc9">glm::angle</a></div><div class="ttdeci">GLM_FUNC_DECL T angle(tquat&lt; T, P &gt; const &amp;x)</div><div class="ttdoc">Returns the quaternion rotation angle. </div></div>
  131. <div class="ttc" id="a00225_html_ga034e5d197ab4bd8685624bc2cf16e586"><div class="ttname"><a href="a00225.html#ga034e5d197ab4bd8685624bc2cf16e586">glm::rotateZ</a></div><div class="ttdeci">GLM_FUNC_DECL tvec4&lt; T, P &gt; rotateZ(tvec4&lt; T, P &gt; const &amp;v, T const &amp;angle)</div><div class="ttdoc">Rotate a four dimensional vector around the X axis. </div></div>
  132. <div class="ttc" id="a00145_html"><div class="ttname"><a href="a00145.html">glm</a></div><div class="ttdef"><b>Definition:</b> <a href="a00003_source.html#l00039">_noise.hpp:39</a></div></div>
  133. <div class="ttc" id="a00225_html_ga49b4d082305cdfcfe0a5c184f684a902"><div class="ttname"><a href="a00225.html#ga49b4d082305cdfcfe0a5c184f684a902">glm::orientation</a></div><div class="ttdeci">GLM_FUNC_DECL tmat4x4&lt; T, P &gt; orientation(tvec3&lt; T, P &gt; const &amp;Normal, tvec3&lt; T, P &gt; const &amp;Up)</div><div class="ttdoc">Build a rotation matrix from a normal and a up vector. </div></div>
  134. <div class="ttc" id="a00225_html_gaf4d59dd2f668f9ffb38048055d1316bd"><div class="ttname"><a href="a00225.html#gaf4d59dd2f668f9ffb38048055d1316bd">glm::rotate</a></div><div class="ttdeci">GLM_FUNC_DECL tvec4&lt; T, P &gt; rotate(tvec4&lt; T, P &gt; const &amp;v, T const &amp;angle, tvec3&lt; T, P &gt; const &amp;normal)</div><div class="ttdoc">Rotate a four dimensional vector around an axis. </div></div>
  135. </div><!-- fragment --></div><!-- contents -->
  136. <!-- start footer part -->
  137. <hr class="footer"/><address class="footer"><small>
  138. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  139. <img class="footer" src="doxygen.png" alt="doxygen"/>
  140. </a> 1.8.8
  141. </small></address>
  142. </body>
  143. </html>