glm/doc/api/a00083_source.html

166 lines
18 KiB
HTML
Raw Normal View History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
2012-11-18 13:05:52 +00:00
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>rotate_vector.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
2012-11-18 13:05:52 +00:00
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
2012-11-18 13:05:52 +00:00
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
2012-11-18 13:05:52 +00:00
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
</tr>
</tbody>
</table>
</div>
2012-11-18 13:05:52 +00:00
<!-- end header part -->
<!-- Generated by Doxygen 1.8.2 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
</ul>
</div>
2012-11-18 13:05:52 +00:00
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_934f46a345653ef2b3014a1b37a162c1.html">G:</a></li><li class="navelem"><a class="el" href="dir_bf513233250988b6ff3b72f8482c1597.html">Repository</a></li><li class="navelem"><a class="el" href="dir_e217bba5d90990da93f61f0ea8b942dc.html">glm</a></li><li class="navelem"><a class="el" href="dir_a844bf6d5a07b8853f8463b41029861e.html">glm</a></li><li class="navelem"><a class="el" href="dir_abb3ddac8d2c26e45fecc003279ba790.html">gtx</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
2012-11-18 13:05:52 +00:00
<div class="title">rotate_vector.hpp</div> </div>
</div><!--header-->
<div class="contents">
2012-11-18 13:05:52 +00:00
<a href="a00083.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>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;</div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;</div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;</div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;</div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;</div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;</div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;</div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;</div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;</div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="preprocessor">#ifndef GLM_GTX_rotate_vector</span></div>
<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 GLM_VERSION</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="comment">// Dependency:</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="preprocessor">#include &quot;../glm.hpp&quot;</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="preprocessor">#include &quot;../gtx/transform.hpp&quot;</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div>
<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))</span></div>
<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>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="keyword">namespace </span>glm</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;{</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;</div>
<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&gt; </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; detail::tvec2&lt;T&gt; <a class="code" href="a00151.html#gaacb9cbe8f93a8fef9dc3e25559df19c0" title="Builds a rotation 4 * 4 matrix created from an axis vector and an angle.">rotate</a>(</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; detail::tvec2&lt;T&gt; <span class="keyword">const</span> &amp; v, </div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; T <span class="keyword">const</span> &amp; <a class="code" href="a00153.html#ga69041d18bd8539fe82d6170932d28362" title="Returns the quaternion rotation angle.">angle</a>);</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; </div>
<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&gt; </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; detail::tvec3&lt;T&gt; <a class="code" href="a00151.html#gaacb9cbe8f93a8fef9dc3e25559df19c0" title="Builds a rotation 4 * 4 matrix created from an axis vector and an angle.">rotate</a>(</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; detail::tvec3&lt;T&gt; <span class="keyword">const</span> &amp; v, </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; T <span class="keyword">const</span> &amp; <a class="code" href="a00153.html#ga69041d18bd8539fe82d6170932d28362" title="Returns the quaternion rotation angle.">angle</a>, </div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; detail::tvec3&lt;T&gt; <span class="keyword">const</span> &amp; normal);</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; </div>
<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&gt; </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; detail::tvec4&lt;T&gt; <a class="code" href="a00151.html#gaacb9cbe8f93a8fef9dc3e25559df19c0" title="Builds a rotation 4 * 4 matrix created from an axis vector and an angle.">rotate</a>(</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; detail::tvec4&lt;T&gt; <span class="keyword">const</span> &amp; v, </div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; T <span class="keyword">const</span> &amp; <a class="code" href="a00153.html#ga69041d18bd8539fe82d6170932d28362" title="Returns the quaternion rotation angle.">angle</a>, </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; detail::tvec3&lt;T&gt; <span class="keyword">const</span> &amp; normal);</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; </div>
<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&gt; </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; detail::tvec3&lt;T&gt; <a class="code" href="a00200.html#gaaadca0c077515d56955f3c662a3a3c7f" title="Rotate a three dimensional vector around the X axis.">rotateX</a>(</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; detail::tvec3&lt;T&gt; <span class="keyword">const</span> &amp; v, </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; T <span class="keyword">const</span> &amp; <a class="code" href="a00153.html#ga69041d18bd8539fe82d6170932d28362" title="Returns the quaternion rotation angle.">angle</a>);</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;</div>
<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&gt; </div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; detail::tvec3&lt;T&gt; <a class="code" href="a00200.html#gacffa0ae7f32f4e2ee7bc1dc0ed290d45" title="Rotate a three dimensional vector around the Y axis.">rotateY</a>(</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; detail::tvec3&lt;T&gt; <span class="keyword">const</span> &amp; v, </div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; T <span class="keyword">const</span> &amp; <a class="code" href="a00153.html#ga69041d18bd8539fe82d6170932d28362" title="Returns the quaternion rotation angle.">angle</a>);</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; </div>
<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&gt; </div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; detail::tvec3&lt;T&gt; <a class="code" href="a00200.html#ga105c77751b4ab56c491334655751e0af" title="Rotate a three dimensional vector around the Z axis.">rotateZ</a>(</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; detail::tvec3&lt;T&gt; <span class="keyword">const</span> &amp; v, </div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; T <span class="keyword">const</span> &amp; <a class="code" href="a00153.html#ga69041d18bd8539fe82d6170932d28362" title="Returns the quaternion rotation angle.">angle</a>);</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; </div>
<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&gt; </div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; detail::tvec4&lt;T&gt; <a class="code" href="a00200.html#gaaadca0c077515d56955f3c662a3a3c7f" title="Rotate a three dimensional vector around the X axis.">rotateX</a>(</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; detail::tvec4&lt;T&gt; <span class="keyword">const</span> &amp; v, </div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; T <span class="keyword">const</span> &amp; <a class="code" href="a00153.html#ga69041d18bd8539fe82d6170932d28362" title="Returns the quaternion rotation angle.">angle</a>);</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; </div>
<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&gt; </div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; detail::tvec4&lt;T&gt; <a class="code" href="a00200.html#gacffa0ae7f32f4e2ee7bc1dc0ed290d45" title="Rotate a three dimensional vector around the Y axis.">rotateY</a>(</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; detail::tvec4&lt;T&gt; <span class="keyword">const</span> &amp; v, </div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; T <span class="keyword">const</span> &amp; <a class="code" href="a00153.html#ga69041d18bd8539fe82d6170932d28362" title="Returns the quaternion rotation angle.">angle</a>);</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; </div>
<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&gt; </div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; detail::tvec4&lt;T&gt; <a class="code" href="a00200.html#ga105c77751b4ab56c491334655751e0af" title="Rotate a three dimensional vector around the Z axis.">rotateZ</a>(</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; detail::tvec4&lt;T&gt; <span class="keyword">const</span> &amp; v, </div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; T <span class="keyword">const</span> &amp; <a class="code" href="a00153.html#ga69041d18bd8539fe82d6170932d28362" title="Returns the quaternion rotation angle.">angle</a>);</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; </div>
<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&gt; </div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; detail::tmat4x4&lt;T&gt; <a class="code" href="a00200.html#ga4da5fddb2f1aa679fdb45abd344efffb" title="Build a rotation matrix from a normal and a up vector.">orientation</a>(</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; detail::tvec3&lt;T&gt; <span class="keyword">const</span> &amp; Normal, </div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; detail::tvec3&lt;T&gt; <span class="keyword">const</span> &amp; Up);</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;}<span class="comment">//namespace glm</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;<span class="preprocessor">#include &quot;rotate_vector.inl&quot;</span></div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160;<span class="preprocessor">#endif//GLM_GTX_rotate_vector</span></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
2012-11-18 13:05:52 +00:00
</a> 1.8.2
</small></address>
</body>
</html>