a00076_source.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243
  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. <title>quaternion.hpp Source File</title>
  7. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  8. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  9. </head>
  10. <body>
  11. <div id="top"><!-- do not remove this div! -->
  12. <div id="titlearea">
  13. <table cellspacing="0" cellpadding="0">
  14. <tbody>
  15. <tr style="height: 56px;">
  16. <td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
  17. </tr>
  18. </tbody>
  19. </table>
  20. </div>
  21. <!-- Generated by Doxygen 1.7.6.1 -->
  22. <div id="navrow1" class="tabs">
  23. <ul class="tablist">
  24. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  25. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  26. <li><a href="modules.html"><span>Modules</span></a></li>
  27. <li><a href="annotated.html"><span>Classes</span></a></li>
  28. <li class="current"><a href="files.html"><span>Files</span></a></li>
  29. </ul>
  30. </div>
  31. <div id="navrow2" class="tabs2">
  32. <ul class="tablist">
  33. <li><a href="files.html"><span>File&#160;List</span></a></li>
  34. </ul>
  35. </div>
  36. </div>
  37. <div class="header">
  38. <div class="headertitle">
  39. <div class="title">quaternion.hpp</div> </div>
  40. </div><!--header-->
  41. <div class="contents">
  42. <a href="a00076.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001
  43. <a name="l00002"></a>00002
  44. <a name="l00003"></a>00003
  45. <a name="l00004"></a>00004
  46. <a name="l00005"></a>00005
  47. <a name="l00006"></a>00006
  48. <a name="l00007"></a>00007
  49. <a name="l00008"></a>00008
  50. <a name="l00009"></a>00009
  51. <a name="l00010"></a>00010
  52. <a name="l00011"></a>00011
  53. <a name="l00012"></a>00012
  54. <a name="l00013"></a>00013
  55. <a name="l00014"></a>00014
  56. <a name="l00015"></a>00015
  57. <a name="l00016"></a>00016
  58. <a name="l00017"></a>00017
  59. <a name="l00018"></a>00018
  60. <a name="l00019"></a>00019
  61. <a name="l00020"></a>00020
  62. <a name="l00021"></a>00021
  63. <a name="l00022"></a>00022
  64. <a name="l00023"></a>00023
  65. <a name="l00024"></a>00024
  66. <a name="l00025"></a>00025
  67. <a name="l00026"></a>00026
  68. <a name="l00027"></a>00027
  69. <a name="l00028"></a>00028
  70. <a name="l00029"></a>00029
  71. <a name="l00030"></a>00030
  72. <a name="l00031"></a>00031
  73. <a name="l00032"></a>00032
  74. <a name="l00033"></a>00033
  75. <a name="l00034"></a>00034
  76. <a name="l00035"></a>00035
  77. <a name="l00036"></a>00036
  78. <a name="l00037"></a>00037
  79. <a name="l00038"></a>00038
  80. <a name="l00039"></a>00039 <span class="preprocessor">#ifndef GLM_GTX_quaternion</span>
  81. <a name="l00040"></a>00040 <span class="preprocessor"></span><span class="preprocessor">#define GLM_GTX_quaternion GLM_VERSION</span>
  82. <a name="l00041"></a>00041 <span class="preprocessor"></span>
  83. <a name="l00042"></a>00042 <span class="comment">// Dependency:</span>
  84. <a name="l00043"></a>00043 <span class="preprocessor">#include &quot;../glm.hpp&quot;</span>
  85. <a name="l00044"></a>00044 <span class="preprocessor">#include &quot;../gtc/quaternion.hpp&quot;</span>
  86. <a name="l00045"></a>00045
  87. <a name="l00046"></a>00046 <span class="preprocessor">#if(defined(GLM_MESSAGES) &amp;&amp; !defined(glm_ext))</span>
  88. <a name="l00047"></a>00047 <span class="preprocessor"></span><span class="preprocessor"># pragma message(&quot;GLM: GLM_GTX_quaternion extension included&quot;)</span>
  89. <a name="l00048"></a>00048 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
  90. <a name="l00049"></a>00049 <span class="preprocessor"></span>
  91. <a name="l00050"></a>00050 <span class="keyword">namespace </span>glm
  92. <a name="l00051"></a>00051 {
  93. <a name="l00054"></a>00054
  94. <a name="l00057"></a>00057 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> valType&gt;
  95. <a name="l00058"></a>00058 detail::tvec3&lt;valType&gt; <a class="code" href="a00127.html#gaa127ddc9d38f715125f91742d399eb6f" title="Returns the cross product of x and y.">cross</a>(
  96. <a name="l00059"></a>00059 detail::tquat&lt;valType&gt; <span class="keyword">const</span> &amp; q,
  97. <a name="l00060"></a>00060 detail::tvec3&lt;valType&gt; <span class="keyword">const</span> &amp; v);
  98. <a name="l00061"></a>00061
  99. <a name="l00064"></a>00064 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> valType&gt;
  100. <a name="l00065"></a>00065 detail::tvec3&lt;valType&gt; <a class="code" href="a00127.html#gaa127ddc9d38f715125f91742d399eb6f" title="Returns the cross product of x and y.">cross</a>(
  101. <a name="l00066"></a>00066 detail::tvec3&lt;valType&gt; <span class="keyword">const</span> &amp; v,
  102. <a name="l00067"></a>00067 detail::tquat&lt;valType&gt; <span class="keyword">const</span> &amp; q);
  103. <a name="l00068"></a>00068
  104. <a name="l00072"></a>00072 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> valType&gt;
  105. <a name="l00073"></a>00073 detail::tquat&lt;valType&gt; squad(
  106. <a name="l00074"></a>00074 detail::tquat&lt;valType&gt; <span class="keyword">const</span> &amp; q1,
  107. <a name="l00075"></a>00075 detail::tquat&lt;valType&gt; <span class="keyword">const</span> &amp; q2,
  108. <a name="l00076"></a>00076 detail::tquat&lt;valType&gt; <span class="keyword">const</span> &amp; s1,
  109. <a name="l00077"></a>00077 detail::tquat&lt;valType&gt; <span class="keyword">const</span> &amp; s2,
  110. <a name="l00078"></a>00078 valType <span class="keyword">const</span> &amp; h);
  111. <a name="l00079"></a>00079
  112. <a name="l00082"></a>00082 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> valType&gt;
  113. <a name="l00083"></a>00083 detail::tquat&lt;valType&gt; intermediate(
  114. <a name="l00084"></a>00084 detail::tquat&lt;valType&gt; <span class="keyword">const</span> &amp; prev,
  115. <a name="l00085"></a>00085 detail::tquat&lt;valType&gt; <span class="keyword">const</span> &amp; curr,
  116. <a name="l00086"></a>00086 detail::tquat&lt;valType&gt; <span class="keyword">const</span> &amp; next);
  117. <a name="l00087"></a>00087
  118. <a name="l00090"></a>00090 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> valType&gt;
  119. <a name="l00091"></a>00091 detail::tquat&lt;valType&gt; <a class="code" href="a00126.html#ga03903bb9395a13d554a5fbecdf67792b" title="Returns the natural exponentiation of x, i.e., e^x.">exp</a>(
  120. <a name="l00092"></a>00092 detail::tquat&lt;valType&gt; <span class="keyword">const</span> &amp; q,
  121. <a name="l00093"></a>00093 valType <span class="keyword">const</span> &amp; exponent);
  122. <a name="l00094"></a>00094
  123. <a name="l00097"></a>00097 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> valType&gt;
  124. <a name="l00098"></a>00098 detail::tquat&lt;valType&gt; <a class="code" href="a00126.html#ga46a307f466090551e328eec42abf61bc" title="Returns the natural logarithm of x, i.e., returns the value y which satisfies the equation x = e^y...">log</a>(
  125. <a name="l00099"></a>00099 detail::tquat&lt;valType&gt; <span class="keyword">const</span> &amp; q);
  126. <a name="l00100"></a>00100
  127. <a name="l00103"></a>00103 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> valType&gt;
  128. <a name="l00104"></a>00104 detail::tquat&lt;valType&gt; <a class="code" href="a00126.html#gac93ea301c287d87a63fa14a4c44b719b" title="Returns x raised to the y power.">pow</a>(
  129. <a name="l00105"></a>00105 detail::tquat&lt;valType&gt; <span class="keyword">const</span> &amp; x,
  130. <a name="l00106"></a>00106 valType <span class="keyword">const</span> &amp; y);
  131. <a name="l00107"></a>00107
  132. <a name="l00110"></a>00110 <span class="comment">//template &lt;typename valType&gt; </span>
  133. <a name="l00111"></a>00111 <span class="comment">//detail::tquat&lt;valType&gt; sqrt(</span>
  134. <a name="l00112"></a>00112 <span class="comment">// detail::tquat&lt;valType&gt; const &amp; q);</span>
  135. <a name="l00113"></a>00113
  136. <a name="l00116"></a>00116 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> valType&gt;
  137. <a name="l00117"></a>00117 detail::tvec3&lt;valType&gt; rotate(
  138. <a name="l00118"></a>00118 detail::tquat&lt;valType&gt; <span class="keyword">const</span> &amp; q,
  139. <a name="l00119"></a>00119 detail::tvec3&lt;valType&gt; <span class="keyword">const</span> &amp; v);
  140. <a name="l00120"></a>00120
  141. <a name="l00123"></a>00123 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> valType&gt;
  142. <a name="l00124"></a>00124 detail::tvec4&lt;valType&gt; rotate(
  143. <a name="l00125"></a>00125 detail::tquat&lt;valType&gt; <span class="keyword">const</span> &amp; q,
  144. <a name="l00126"></a>00126 detail::tvec4&lt;valType&gt; <span class="keyword">const</span> &amp; v);
  145. <a name="l00127"></a>00127
  146. <a name="l00130"></a>00130 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> valType&gt;
  147. <a name="l00131"></a>00131 valType angle(
  148. <a name="l00132"></a>00132 detail::tquat&lt;valType&gt; <span class="keyword">const</span> &amp; x);
  149. <a name="l00133"></a>00133
  150. <a name="l00136"></a>00136 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> valType&gt;
  151. <a name="l00137"></a>00137 detail::tvec3&lt;valType&gt; axis(
  152. <a name="l00138"></a>00138 detail::tquat&lt;valType&gt; <span class="keyword">const</span> &amp; x);
  153. <a name="l00139"></a>00139
  154. <a name="l00142"></a>00142 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> valType&gt;
  155. <a name="l00143"></a>00143 detail::tquat&lt;valType&gt; angleAxis(
  156. <a name="l00144"></a>00144 valType <span class="keyword">const</span> &amp; angle,
  157. <a name="l00145"></a>00145 valType <span class="keyword">const</span> &amp; x,
  158. <a name="l00146"></a>00146 valType <span class="keyword">const</span> &amp; y,
  159. <a name="l00147"></a>00147 valType <span class="keyword">const</span> &amp; z);
  160. <a name="l00148"></a>00148
  161. <a name="l00151"></a>00151 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> valType&gt;
  162. <a name="l00152"></a>00152 detail::tquat&lt;valType&gt; angleAxis(
  163. <a name="l00153"></a>00153 valType <span class="keyword">const</span> &amp; angle,
  164. <a name="l00154"></a>00154 detail::tvec3&lt;valType&gt; <span class="keyword">const</span> &amp; axis);
  165. <a name="l00155"></a>00155
  166. <a name="l00158"></a>00158 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> valType&gt;
  167. <a name="l00159"></a>00159 valType extractRealComponent(
  168. <a name="l00160"></a>00160 detail::tquat&lt;valType&gt; <span class="keyword">const</span> &amp; q);
  169. <a name="l00161"></a>00161
  170. <a name="l00164"></a>00164 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> valType&gt;
  171. <a name="l00165"></a>00165 valType roll(
  172. <a name="l00166"></a>00166 detail::tquat&lt;valType&gt; <span class="keyword">const</span> &amp; x);
  173. <a name="l00167"></a>00167
  174. <a name="l00170"></a>00170 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> valType&gt;
  175. <a name="l00171"></a>00171 valType pitch(
  176. <a name="l00172"></a>00172 detail::tquat&lt;valType&gt; <span class="keyword">const</span> &amp; x);
  177. <a name="l00173"></a>00173
  178. <a name="l00176"></a>00176 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> valType&gt;
  179. <a name="l00177"></a>00177 valType yaw(
  180. <a name="l00178"></a>00178 detail::tquat&lt;valType&gt; <span class="keyword">const</span> &amp; x);
  181. <a name="l00179"></a>00179
  182. <a name="l00182"></a>00182 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> valType&gt;
  183. <a name="l00183"></a>00183 detail::tvec3&lt;valType&gt; eulerAngles(
  184. <a name="l00184"></a>00184 detail::tquat&lt;valType&gt; <span class="keyword">const</span> &amp; x);
  185. <a name="l00185"></a>00185
  186. <a name="l00188"></a>00188 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> valType&gt;
  187. <a name="l00189"></a>00189 detail::tmat3x3&lt;valType&gt; toMat3(
  188. <a name="l00190"></a>00190 detail::tquat&lt;valType&gt; <span class="keyword">const</span> &amp; x){<span class="keywordflow">return</span> mat3_cast(x);}
  189. <a name="l00191"></a>00191
  190. <a name="l00194"></a>00194 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> valType&gt;
  191. <a name="l00195"></a>00195 detail::tmat4x4&lt;valType&gt; toMat4(
  192. <a name="l00196"></a>00196 detail::tquat&lt;valType&gt; <span class="keyword">const</span> &amp; x){<span class="keywordflow">return</span> mat4_cast(x);}
  193. <a name="l00197"></a>00197
  194. <a name="l00200"></a>00200 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> valType&gt;
  195. <a name="l00201"></a>00201 detail::tquat&lt;valType&gt; toQuat(
  196. <a name="l00202"></a>00202 detail::tmat3x3&lt;valType&gt; <span class="keyword">const</span> &amp; x){<span class="keywordflow">return</span> quat_cast(x);}
  197. <a name="l00203"></a>00203
  198. <a name="l00206"></a>00206 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> valType&gt;
  199. <a name="l00207"></a>00207 detail::tquat&lt;valType&gt; toQuat(
  200. <a name="l00208"></a>00208 detail::tmat4x4&lt;valType&gt; <span class="keyword">const</span> &amp; x){<span class="keywordflow">return</span> quat_cast(x);}
  201. <a name="l00209"></a>00209
  202. <a name="l00212"></a>00212 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
  203. <a name="l00213"></a>00213 detail::tquat&lt;T&gt; shortMix(
  204. <a name="l00214"></a>00214 detail::tquat&lt;T&gt; <span class="keyword">const</span> &amp; x,
  205. <a name="l00215"></a>00215 detail::tquat&lt;T&gt; <span class="keyword">const</span> &amp; y,
  206. <a name="l00216"></a>00216 T <span class="keyword">const</span> &amp; a);
  207. <a name="l00217"></a>00217
  208. <a name="l00220"></a>00220 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
  209. <a name="l00221"></a>00221 detail::tquat&lt;T&gt; fastMix(
  210. <a name="l00222"></a>00222 detail::tquat&lt;T&gt; <span class="keyword">const</span> &amp; x,
  211. <a name="l00223"></a>00223 detail::tquat&lt;T&gt; <span class="keyword">const</span> &amp; y,
  212. <a name="l00224"></a>00224 T <span class="keyword">const</span> &amp; a);
  213. <a name="l00225"></a>00225
  214. <a name="l00227"></a>00227 }<span class="comment">//namespace glm</span>
  215. <a name="l00228"></a>00228
  216. <a name="l00229"></a>00229 <span class="preprocessor">#include &quot;quaternion.inl&quot;</span>
  217. <a name="l00230"></a>00230
  218. <a name="l00231"></a>00231 <span class="preprocessor">#endif//GLM_GTX_quaternion</span>
  219. </pre></div></div><!-- contents -->
  220. <hr class="footer"/><address class="footer"><small>
  221. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  222. <img class="footer" src="doxygen.png" alt="doxygen"/>
  223. </a> 1.7.6.1
  224. </small></address>
  225. </body>
  226. </html>