Home Explore Help
Sign In
cpp
/
glm
mirror of https://github.com/g-truc/glm.git
2
0
Fork 0
Files Issues 0 Wiki
Branch: 0.9.5
Branches Tags
glm
/
doc
/
api
/
a00106_source.html

a00106_source.html 17 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    6. 

  6. <meta name="generator" content="Doxygen 1.8.5"/>
    7. 

  7. <title>GLM: rotate_vector.hpp Source File</title>
    8. 

  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    9. 

  9. <script type="text/javascript" src="jquery.js"></script>
    10. 

  10. <script type="text/javascript" src="dynsections.js"></script>
    11. 

  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
    12. 

  12. </head>
    13. 

  13. <body>
    14. 

  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    15. 

  15. <div id="titlearea">
    16. 

  16. <table cellspacing="0" cellpadding="0">
    17. 

  17.  <tbody>
    18. 

  18.  <tr style="height: 56px;">
    19. 

  19.   <td style="padding-left: 0.5em;">
    20. 

  20.    <div id="projectname">GLM
    21. 

  21.    &#160;<span id="projectnumber">0.9.5</span>
    22. 

  22.    </div>
    23. 

  23.   </td>
    24. 

  24.  </tr>
    25. 

  25.  </tbody>
    26. 

  26. </table>
    27. 

  27. </div>
    28. 

  28. <!-- end header part -->
    29. 

  29. <!-- Generated by Doxygen 1.8.5 -->
    30. 

  30.   <div id="navrow1" class="tabs">
    31. 

  31.     <ul class="tablist">
    32. 

  32.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
    33. 

  33.       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
    34. 

  34.       <li><a href="modules.html"><span>Modules</span></a></li>
    35. 

  35.       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    36. 

  36.       <li class="current"><a href="files.html"><span>Files</span></a></li>
    37. 

  37.     </ul>
    38. 

  38.   </div>
    39. 

  39.   <div id="navrow2" class="tabs2">
    40. 

  40.     <ul class="tablist">
    41. 

  41.       <li><a href="files.html"><span>File&#160;List</span></a></li>
    42. 

  42.     </ul>
    43. 

  43.   </div>
    44. 

  44. <div id="nav-path" class="navpath">
    45. 

  45.   <ul>
    46. 

  46. <li class="navelem"><a class="el" href="dir_8ceffd4ee35c3518d4e8bdc7e638efe8.html">Users</a></li><li class="navelem"><a class="el" href="dir_968fb7988749a6351e7b3d0c1783dec4.html">Groove</a></li><li class="navelem"><a class="el" href="dir_6e418c18ca640a0404613de005739e2e.html">Documents</a></li><li class="navelem"><a class="el" href="dir_e3ecd7863bd215c92a17f47e2ae3be43.html">GitHub</a></li><li class="navelem"><a class="el" href="dir_edf753475b928be648c1cf1c6443cf63.html">glm</a></li><li class="navelem"><a class="el" href="dir_e50778361fd4ab4de52181ed9eb2b726.html">glm</a></li><li class="navelem"><a class="el" href="dir_a8d99eddac27b2368ab5252ce80ded11.html">gtx</a></li>  </ul>
    47. 

  47. </div>
    48. 

  48. </div><!-- top -->
    49. 

  49. <div class="header">
    50. 

  50.   <div class="headertitle">
    51. 

  51. <div class="title">rotate_vector.hpp</div>  </div>
    52. 

  52. </div><!--header-->
    53. 

  53. <div class="contents">
    54. 

  54. <a href="a00106.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>
    55. 

  55. <div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="preprocessor">#ifndef GLM_GTX_rotate_vector</span></div>
    56. 

  56. <div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define GLM_GTX_rotate_vector</span></div>
    57. 

  57. <div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="preprocessor"></span></div>
    58. 

  58. <div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="comment">// Dependency:</span></div>
    59. 

  59. <div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="preprocessor">#include &quot;../glm.hpp&quot;</span></div>
    60. 

  60. <div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="preprocessor">#include &quot;../gtx/transform.hpp&quot;</span></div>
    61. 

  61. <div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;</div>
    62. 

  62. <div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="preprocessor">#if(defined(GLM_MESSAGES) &amp;&amp; !defined(GLM_EXT_INCLUDED))</span></div>
    63. 

  63. <div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#       pragma message(&quot;GLM: GLM_GTX_rotate_vector extension included&quot;)</span></div>
    64. 

  64. <div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
    65. 

  65. <div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;<span class="preprocessor"></span></div>
    66. 

  66. <div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="keyword">namespace </span>glm</div>
    67. 

  67. <div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;{</div>
    68. 

  68. <div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;</div>
    69. 

  69. <div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;        <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
    70. 

  70. <div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;        detail::tvec2&lt;T, P&gt; <a class="code" href="a00176.html#ga61e65a3bb227c267d1a15113d1056fb1">rotate</a>(</div>
    71. 

  71. <div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;                detail::tvec2&lt;T, P&gt; <span class="keyword">const</span> &amp; v,</div>
    72. 

  72. <div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;                T <span class="keyword">const</span> &amp; <a class="code" href="a00179.html#ga23a3fc7ada5bbb665ff84c92c6e0542c">angle</a>);</div>
    73. 

  73. <div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;                </div>
    74. 

  74. <div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;        <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
    75. 

  75. <div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;        detail::tvec3&lt;T, P&gt; <a class="code" href="a00176.html#ga61e65a3bb227c267d1a15113d1056fb1">rotate</a>(</div>
    76. 

  76. <div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;                detail::tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; v,</div>
    77. 

  77. <div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;                T <span class="keyword">const</span> &amp; <a class="code" href="a00179.html#ga23a3fc7ada5bbb665ff84c92c6e0542c">angle</a>,</div>
    78. 

  78. <div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;                detail::tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; normal);</div>
    79. 

  79. <div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;                </div>
    80. 

  80. <div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;        <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
    81. 

  81. <div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;        detail::tvec4&lt;T, P&gt; <a class="code" href="a00176.html#ga61e65a3bb227c267d1a15113d1056fb1">rotate</a>(</div>
    82. 

  82. <div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;                detail::tvec4&lt;T, P&gt; <span class="keyword">const</span> &amp; v,</div>
    83. 

  83. <div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;                T <span class="keyword">const</span> &amp; <a class="code" href="a00179.html#ga23a3fc7ada5bbb665ff84c92c6e0542c">angle</a>,</div>
    84. 

  84. <div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;                detail::tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; normal);</div>
    85. 

  85. <div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;                </div>
    86. 

  86. <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>
    87. 

  87. <div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;        detail::tvec3&lt;T, P&gt; <a class="code" href="a00225.html#gac3c274e51d6546dcbca6759b2b78c8d7">rotateX</a>(</div>
    88. 

  88. <div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;                detail::tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; v,</div>
    89. 

  89. <div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;                T <span class="keyword">const</span> &amp; <a class="code" href="a00179.html#ga23a3fc7ada5bbb665ff84c92c6e0542c">angle</a>);</div>
    90. 

  90. <div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;</div>
    91. 

  91. <div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;        <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
    92. 

  92. <div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;        detail::tvec3&lt;T, P&gt; <a class="code" href="a00225.html#ga4cec4c2bd2d787429a32f77fe32dd31e">rotateY</a>(</div>
    93. 

  93. <div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;                detail::tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; v,</div>
    94. 

  94. <div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;                T <span class="keyword">const</span> &amp; <a class="code" href="a00179.html#ga23a3fc7ada5bbb665ff84c92c6e0542c">angle</a>);</div>
    95. 

  95. <div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;                </div>
    96. 

  96. <div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;        <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
    97. 

  97. <div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;        detail::tvec3&lt;T, P&gt; <a class="code" href="a00225.html#ga57908a3933a843921628d683049534e3">rotateZ</a>(</div>
    98. 

  98. <div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;                detail::tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; v,</div>
    99. 

  99. <div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;                T <span class="keyword">const</span> &amp; <a class="code" href="a00179.html#ga23a3fc7ada5bbb665ff84c92c6e0542c">angle</a>);</div>
    100. 

  100. <div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;                </div>
    101. 

  101. <div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;        <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
    102. 

  102. <div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;        detail::tvec4&lt;T, P&gt; <a class="code" href="a00225.html#gac3c274e51d6546dcbca6759b2b78c8d7">rotateX</a>(</div>
    103. 

  103. <div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;                detail::tvec4&lt;T, P&gt; <span class="keyword">const</span> &amp; v,</div>
    104. 

  104. <div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;                T <span class="keyword">const</span> &amp; <a class="code" href="a00179.html#ga23a3fc7ada5bbb665ff84c92c6e0542c">angle</a>);</div>
    105. 

  105. <div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;                </div>
    106. 

  106. <div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;        <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
    107. 

  107. <div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;        detail::tvec4&lt;T, P&gt; <a class="code" href="a00225.html#ga4cec4c2bd2d787429a32f77fe32dd31e">rotateY</a>(</div>
    108. 

  108. <div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;                detail::tvec4&lt;T, P&gt; <span class="keyword">const</span> &amp; v,</div>
    109. 

  109. <div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;                T <span class="keyword">const</span> &amp; <a class="code" href="a00179.html#ga23a3fc7ada5bbb665ff84c92c6e0542c">angle</a>);</div>
    110. 

  110. <div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;                </div>
    111. 

  111. <div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;        <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
    112. 

  112. <div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;        detail::tvec4&lt;T, P&gt; <a class="code" href="a00225.html#ga57908a3933a843921628d683049534e3">rotateZ</a>(</div>
    113. 

  113. <div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;                detail::tvec4&lt;T, P&gt; <span class="keyword">const</span> &amp; v,</div>
    114. 

  114. <div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;                T <span class="keyword">const</span> &amp; <a class="code" href="a00179.html#ga23a3fc7ada5bbb665ff84c92c6e0542c">angle</a>);</div>
    115. 

  115. <div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;                </div>
    116. 

  116. <div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;        <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
    117. 

  117. <div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;        detail::tmat4x4&lt;T, P&gt; <a class="code" href="a00225.html#ga69a9261c66a81fd52afe8199b30be239">orientation</a>(</div>
    118. 

  118. <div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;                detail::tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; Normal,</div>
    119. 

  119. <div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;                detail::tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; Up);</div>
    120. 

  120. <div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;</div>
    121. 

  121. <div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;}<span class="comment">//namespace glm</span></div>
    122. 

  122. <div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;</div>
    123. 

  123. <div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;<span class="preprocessor">#include &quot;rotate_vector.inl&quot;</span></div>
    124. 

  124. <div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;</div>
    125. 

  125. <div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;<span class="preprocessor">#endif//GLM_GTX_rotate_vector</span></div>
    126. 

  126. <div class="ttc" id="a00225_html_gac3c274e51d6546dcbca6759b2b78c8d7"><div class="ttname"><a href="a00225.html#gac3c274e51d6546dcbca6759b2b78c8d7">glm::rotateX</a></div><div class="ttdeci">detail::tvec3&lt; T, P &gt; rotateX(detail::tvec3&lt; T, P &gt; const &amp;v, T const &amp;angle)</div><div class="ttdoc">Rotate a three dimensional vector around the X axis. </div></div>
    127. 

  127. <div class="ttc" id="a00176_html_ga61e65a3bb227c267d1a15113d1056fb1"><div class="ttname"><a href="a00176.html#ga61e65a3bb227c267d1a15113d1056fb1">glm::rotate</a></div><div class="ttdeci">GLM_FUNC_DECL detail::tmat4x4&lt; T, P &gt; rotate(detail::tmat4x4&lt; T, P &gt; const &amp;m, T const &amp;angle, detail::tvec3&lt; T, P &gt; const &amp;axis)</div><div class="ttdoc">Builds a rotation 4 * 4 matrix created from an axis vector and an angle. </div></div>
    128. 

  128. <div class="ttc" id="a00179_html_ga23a3fc7ada5bbb665ff84c92c6e0542c"><div class="ttname"><a href="a00179.html#ga23a3fc7ada5bbb665ff84c92c6e0542c">glm::angle</a></div><div class="ttdeci">GLM_FUNC_DECL T angle(detail::tquat&lt; T, P &gt; const &amp;x)</div><div class="ttdoc">Returns the quaternion rotation angle. </div></div>
    129. 

  129. <div class="ttc" id="a00225_html_ga69a9261c66a81fd52afe8199b30be239"><div class="ttname"><a href="a00225.html#ga69a9261c66a81fd52afe8199b30be239">glm::orientation</a></div><div class="ttdeci">detail::tmat4x4&lt; T, P &gt; orientation(detail::tvec3&lt; T, P &gt; const &amp;Normal, detail::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>
    130. 

  130. <div class="ttc" id="a00225_html_ga4cec4c2bd2d787429a32f77fe32dd31e"><div class="ttname"><a href="a00225.html#ga4cec4c2bd2d787429a32f77fe32dd31e">glm::rotateY</a></div><div class="ttdeci">detail::tvec3&lt; T, P &gt; rotateY(detail::tvec3&lt; T, P &gt; const &amp;v, T const &amp;angle)</div><div class="ttdoc">Rotate a three dimensional vector around the Y axis. </div></div>
    131. 

  131. <div class="ttc" id="a00225_html_ga57908a3933a843921628d683049534e3"><div class="ttname"><a href="a00225.html#ga57908a3933a843921628d683049534e3">glm::rotateZ</a></div><div class="ttdeci">detail::tvec3&lt; T, P &gt; rotateZ(detail::tvec3&lt; T, P &gt; const &amp;v, T const &amp;angle)</div><div class="ttdoc">Rotate a three dimensional vector around the Z axis. </div></div>
    132. 

  132. </div><!-- fragment --></div><!-- contents -->
    133. 

  133. <!-- start footer part -->
    134. 

  134. <hr class="footer"/><address class="footer"><small>
    135. 

  135. Generated by &#160;<a href="http://www.doxygen.org/index.html">
    136. 

  136. <img class="footer" src="doxygen.png" alt="doxygen"/>
    137. 

  137. </a> 1.8.5
    138. 

  138. </small></address>
    139. 

  139. </body>
    140. 

  140. </html>
    141.