a00120_source.html 41 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. <title>GLM: vecx.hpp Source File</title>
  6. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  7. <link href="doxygen.css" rel="stylesheet" type="text/css"/>
  8. </head>
  9. <body>
  10. <!-- Generated by Doxygen 1.6.1 -->
  11. <div class="navigation" id="top">
  12. <div class="tabs">
  13. <ul>
  14. <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  15. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  16. <li class="current"><a href="files.html"><span>Files</span></a></li>
  17. </ul>
  18. </div>
  19. <div class="tabs">
  20. <ul>
  21. <li><a href="files.html"><span>File&nbsp;List</span></a></li>
  22. </ul>
  23. </div>
  24. <h1>vecx.hpp</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001
  25. <a name="l00002"></a>00002 <span class="comment">// OpenGL Mathematics Copyright (c) 2005 - 2009 G-Truc Creation (www.g-truc.net)</span>
  26. <a name="l00004"></a>00004 <span class="comment"></span><span class="comment">// Created : 2007-02-21</span>
  27. <a name="l00005"></a>00005 <span class="comment">// Updated : 2007-02-21</span>
  28. <a name="l00006"></a>00006 <span class="comment">// Licence : This source is under MIT License</span>
  29. <a name="l00007"></a>00007 <span class="comment">// File : glm/gtx/vecx.h</span>
  30. <a name="l00009"></a>00009 <span class="comment"></span><span class="comment">// Dependency:</span>
  31. <a name="l00010"></a>00010 <span class="comment">// - GLM core</span>
  32. <a name="l00012"></a>00012 <span class="comment"></span>
  33. <a name="l00013"></a>00013 <span class="preprocessor">#ifndef glm_gtx_vecx</span>
  34. <a name="l00014"></a>00014 <span class="preprocessor"></span><span class="preprocessor">#define glm_gtx_vecx</span>
  35. <a name="l00015"></a>00015 <span class="preprocessor"></span>
  36. <a name="l00016"></a>00016 <span class="keyword">namespace </span>glm{
  37. <a name="l00017"></a>00017 <span class="keyword">namespace </span>detail{
  38. <a name="l00018"></a>00018
  39. <a name="l00019"></a>00019 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N&gt;
  40. <a name="l00020"></a>00020 <span class="keyword">class </span>_bvecxGTX
  41. <a name="l00021"></a>00021 {
  42. <a name="l00022"></a>00022 <span class="keyword">private</span>:
  43. <a name="l00023"></a>00023 <span class="keywordtype">bool</span> data[N];
  44. <a name="l00024"></a>00024
  45. <a name="l00025"></a>00025 <span class="keyword">public</span>:
  46. <a name="l00026"></a>00026 <span class="keyword">typedef</span> <span class="keywordtype">bool</span> value_type;
  47. <a name="l00027"></a>00027 <span class="keyword">typedef</span> <span class="keywordtype">int</span> size_type;
  48. <a name="l00028"></a>00028 <span class="keyword">static</span> <span class="keyword">const</span> size_type value_size;
  49. <a name="l00029"></a>00029 <span class="keyword">static</span> <span class="keyword">const</span> size_type col_size;
  50. <a name="l00030"></a>00030 <span class="keyword">static</span> <span class="keyword">const</span> size_type row_size;
  51. <a name="l00031"></a>00031
  52. <a name="l00032"></a>00032 <span class="comment">// Common constructors</span>
  53. <a name="l00033"></a>00033 _bvecxGTX();
  54. <a name="l00034"></a>00034 _bvecxGTX(<span class="keyword">const</span> _bvecxGTX&amp; v);
  55. <a name="l00035"></a>00035
  56. <a name="l00036"></a>00036 <span class="comment">// Accesses</span>
  57. <a name="l00037"></a>00037 <span class="keywordtype">bool</span>&amp; operator[](<span class="keywordtype">int</span> i);
  58. <a name="l00038"></a>00038 <span class="keywordtype">bool</span> operator[](<span class="keywordtype">int</span> i) <span class="keyword">const</span>;
  59. <a name="l00039"></a>00039 operator bool*();
  60. <a name="l00040"></a>00040 operator const bool*() <span class="keyword">const</span>;
  61. <a name="l00041"></a>00041
  62. <a name="l00042"></a>00042 <span class="comment">// Bool constructors</span>
  63. <a name="l00043"></a>00043 <span class="keyword">explicit</span> _bvecxGTX(<span class="keyword">const</span> <span class="keywordtype">bool</span> a);
  64. <a name="l00044"></a>00044
  65. <a name="l00045"></a>00045 <span class="comment">// Operators</span>
  66. <a name="l00046"></a>00046 _bvecxGTX&lt;N&gt;&amp; operator=(<span class="keyword">const</span> _bvecxGTX&lt;N&gt;&amp; v);
  67. <a name="l00047"></a>00047 _bvecxGTX&lt;N&gt; operator! () <span class="keyword">const</span>;
  68. <a name="l00048"></a>00048 };
  69. <a name="l00049"></a>00049
  70. <a name="l00050"></a>00050 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T = <span class="keywordtype">float</span>&gt;
  71. <a name="l00051"></a>00051 <span class="keyword">class </span>_xvecxGTX
  72. <a name="l00052"></a>00052 {
  73. <a name="l00053"></a>00053 <span class="keyword">private</span>:
  74. <a name="l00054"></a>00054 T data[N];
  75. <a name="l00055"></a>00055
  76. <a name="l00056"></a>00056 <span class="keyword">public</span>:
  77. <a name="l00057"></a>00057 <span class="keyword">typedef</span> T value_type;
  78. <a name="l00058"></a>00058 <span class="keyword">typedef</span> <span class="keywordtype">int</span> size_type;
  79. <a name="l00059"></a>00059 <span class="keyword">static</span> <span class="keyword">const</span> size_type value_size;
  80. <a name="l00060"></a>00060
  81. <a name="l00061"></a>00061 <span class="comment">// Common constructors</span>
  82. <a name="l00062"></a>00062 _xvecxGTX();
  83. <a name="l00063"></a>00063 _xvecxGTX(<span class="keyword">const</span> _xvecxGTX&lt;N, T&gt;&amp; v);
  84. <a name="l00064"></a>00064
  85. <a name="l00065"></a>00065 <span class="comment">// Accesses</span>
  86. <a name="l00066"></a>00066 T&amp; operator[](<span class="keywordtype">int</span> i);
  87. <a name="l00067"></a>00067 T operator[](<span class="keywordtype">int</span> i) <span class="keyword">const</span>;
  88. <a name="l00068"></a>00068 operator T*();
  89. <a name="l00069"></a>00069 operator const T*() <span class="keyword">const</span>;
  90. <a name="l00070"></a>00070
  91. <a name="l00071"></a>00071 <span class="comment">// T constructors</span>
  92. <a name="l00072"></a>00072 <span class="keyword">explicit</span> _xvecxGTX(<span class="keyword">const</span> T x);
  93. <a name="l00073"></a>00073
  94. <a name="l00074"></a>00074 <span class="comment">// Unary updatable operators</span>
  95. <a name="l00075"></a>00075 _xvecxGTX&lt;N, T&gt;&amp; operator= (<span class="keyword">const</span> _xvecxGTX&lt;N, T&gt;&amp; v);
  96. <a name="l00076"></a>00076 _xvecxGTX&lt;N, T&gt;&amp; operator+=(<span class="keyword">const</span> T s);
  97. <a name="l00077"></a>00077 _xvecxGTX&lt;N, T&gt;&amp; operator+=(<span class="keyword">const</span> _xvecxGTX&lt;N, T&gt;&amp; v);
  98. <a name="l00078"></a>00078 _xvecxGTX&lt;N, T&gt;&amp; operator-=(<span class="keyword">const</span> T s);
  99. <a name="l00079"></a>00079 _xvecxGTX&lt;N, T&gt;&amp; operator-=(<span class="keyword">const</span> _xvecxGTX&lt;N, T&gt;&amp; v);
  100. <a name="l00080"></a>00080 _xvecxGTX&lt;N, T&gt;&amp; operator*=(<span class="keyword">const</span> T s);
  101. <a name="l00081"></a>00081 _xvecxGTX&lt;N, T&gt;&amp; operator*=(<span class="keyword">const</span> _xvecxGTX&lt;N, T&gt;&amp; v);
  102. <a name="l00082"></a>00082 _xvecxGTX&lt;N, T&gt;&amp; operator/=(<span class="keyword">const</span> T s);
  103. <a name="l00083"></a>00083 _xvecxGTX&lt;N, T&gt;&amp; operator/=(<span class="keyword">const</span> _xvecxGTX&lt;N, T&gt;&amp; v);
  104. <a name="l00084"></a>00084 _xvecxGTX&lt;N, T&gt;&amp; operator++();
  105. <a name="l00085"></a>00085 _xvecxGTX&lt;N, T&gt;&amp; operator--();
  106. <a name="l00086"></a>00086 };
  107. <a name="l00087"></a>00087
  108. <a name="l00088"></a>00088 <span class="comment">// Binary operators</span>
  109. <a name="l00089"></a>00089 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt;
  110. <a name="l00090"></a>00090 detail::_xvecxGTX&lt;N, T&gt; operator+ (<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; v, <span class="keyword">const</span> T s);
  111. <a name="l00091"></a>00091
  112. <a name="l00092"></a>00092 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt;
  113. <a name="l00093"></a>00093 detail::_xvecxGTX&lt;N, T&gt; operator+ (<span class="keyword">const</span> T s, <span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; v);
  114. <a name="l00094"></a>00094
  115. <a name="l00095"></a>00095 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt;
  116. <a name="l00096"></a>00096 detail::_xvecxGTX&lt;N, T&gt; operator+ (<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; v1, <span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; v2);
  117. <a name="l00097"></a>00097
  118. <a name="l00098"></a>00098 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt;
  119. <a name="l00099"></a>00099 detail::_xvecxGTX&lt;N, T&gt; operator- (<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; v, <span class="keyword">const</span> T s);
  120. <a name="l00100"></a>00100
  121. <a name="l00101"></a>00101 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt;
  122. <a name="l00102"></a>00102 detail::_xvecxGTX&lt;N, T&gt; operator- (<span class="keyword">const</span> T s, <span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; v);
  123. <a name="l00103"></a>00103
  124. <a name="l00104"></a>00104 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt;
  125. <a name="l00105"></a>00105 detail::_xvecxGTX&lt;N, T&gt; operator- (<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; v1, <span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; v2);
  126. <a name="l00106"></a>00106
  127. <a name="l00107"></a>00107 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt;
  128. <a name="l00108"></a>00108 detail::_xvecxGTX&lt;N, T&gt; operator* (<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; v, <span class="keyword">const</span> T s);
  129. <a name="l00109"></a>00109
  130. <a name="l00110"></a>00110 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt;
  131. <a name="l00111"></a>00111 detail::_xvecxGTX&lt;N, T&gt; operator* (<span class="keyword">const</span> T s, <span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; v);
  132. <a name="l00112"></a>00112
  133. <a name="l00113"></a>00113 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt;
  134. <a name="l00114"></a>00114 detail::_xvecxGTX&lt;N, T&gt; operator* (<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; v1, <span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; v2);
  135. <a name="l00115"></a>00115
  136. <a name="l00116"></a>00116 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt;
  137. <a name="l00117"></a>00117 detail::_xvecxGTX&lt;N, T&gt; operator/ (<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; v, <span class="keyword">const</span> T s);
  138. <a name="l00118"></a>00118
  139. <a name="l00119"></a>00119 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt;
  140. <a name="l00120"></a>00120 detail::_xvecxGTX&lt;N, T&gt; operator/ (<span class="keyword">const</span> T s, <span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; v);
  141. <a name="l00121"></a>00121
  142. <a name="l00122"></a>00122 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt;
  143. <a name="l00123"></a>00123 detail::_xvecxGTX&lt;N, T&gt; operator/ (<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; v1, <span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; v2);
  144. <a name="l00124"></a>00124
  145. <a name="l00125"></a>00125 <span class="comment">// Unary constant operators</span>
  146. <a name="l00126"></a>00126 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt;
  147. <a name="l00127"></a>00127 <span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt; operator- (<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; v);
  148. <a name="l00128"></a>00128
  149. <a name="l00129"></a>00129 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt;
  150. <a name="l00130"></a>00130 <span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt; operator-- (<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; v, <span class="keywordtype">int</span>);
  151. <a name="l00131"></a>00131
  152. <a name="l00132"></a>00132 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt;
  153. <a name="l00133"></a>00133 <span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt; operator++ (<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; v, <span class="keywordtype">int</span>);
  154. <a name="l00134"></a>00134
  155. <a name="l00135"></a>00135 }<span class="comment">//namespace detail</span>
  156. <a name="l00136"></a>00136
  157. <a name="l00137"></a>00137 <span class="keyword">namespace </span>gtx
  158. <a name="l00138"></a>00138 {
  159. <a name="l00140"></a><a class="code" href="a00215.html">00140</a> <span class="keyword">namespace </span>vecx
  160. <a name="l00141"></a>00141 {
  161. <a name="l00142"></a>00142 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T, <span class="keywordtype">int</span> N&gt;
  162. <a name="l00143"></a>00143 <span class="keyword">struct </span>vec
  163. <a name="l00144"></a>00144 {
  164. <a name="l00145"></a>00145 <span class="keyword">typedef</span> detail::_xvecxGTX&lt;N, T&gt; type;
  165. <a name="l00146"></a>00146 };
  166. <a name="l00147"></a>00147
  167. <a name="l00148"></a>00148 <span class="comment">// Trigonometric Functions</span>
  168. <a name="l00149"></a>00149 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_xvecxGTX&lt;N, T&gt; radiansGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; <a class="code" href="a00132.html#a2dc092f93e998e01c1cfdaef817ca926" title="Converts radians to degrees and returns the result.">degrees</a>); <span class="comment">//&lt; \brief Converts degrees to radians and returns the result. (From GLM_GTX_vecx extension)</span>
  169. <a name="l00150"></a>00150 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_xvecxGTX&lt;N, T&gt; degreesGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; <a class="code" href="a00132.html#a40251a4a07049e7fdcbf155c3cc6d32a" title="Converts degrees to radians and returns the result.">radians</a>); <span class="comment">//&lt; \brief Converts radians to degrees and returns the result. (From GLM_GTX_vecx extension)</span>
  170. <a name="l00151"></a>00151 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_xvecxGTX&lt;N, T&gt; sinGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; angle); <span class="comment">//&lt; \brief The standard trigonometric sine function. The values returned by this function will range from [-1, 1]. (From GLM_GTX_vecx extension)</span>
  171. <a name="l00152"></a>00152 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_xvecxGTX&lt;N, T&gt; cosGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; angle); <span class="comment">//&lt; \brief The standard trigonometric cosine function. The values returned by this function will range from [-1, 1]. (From GLM_GTX_vecx extension)</span>
  172. <a name="l00153"></a>00153 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_xvecxGTX&lt;N, T&gt; tanGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; angle); <span class="comment">//&lt; \brief The standard trigonometric tangent function. (From GLM_GTX_vecx extension)</span>
  173. <a name="l00154"></a>00154 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_xvecxGTX&lt;N, T&gt; asinGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; x); <span class="comment">//&lt; \brief Arc sine. Returns an angle whose sine is x. The range of values returned by this function is [-PI/2, PI/2]. Results are undefined if |x| &gt; 1. (From GLM_GTX_vecx extension)</span>
  174. <a name="l00155"></a>00155 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_xvecxGTX&lt;N, T&gt; acosGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; x); <span class="comment">//&lt; \brief Arc cosine. Returns an angle whose sine is x. The range of values returned by this function is [0, PI]. Results are undefined if |x| &gt; 1. (From GLM_GTX_vecx extension)</span>
  175. <a name="l00156"></a>00156 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_xvecxGTX&lt;N, T&gt; atanGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; y, <span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; x); <span class="comment">//&lt; \brief Arc tangent. Returns an angle whose tangent is y/x. The signs of x and y are used to determine what quadrant the angle is in. The range of values returned by this function is [-PI, PI]. Results are undefined if x and y are both 0. (From GLM_GTX_vecx extension)</span>
  176. <a name="l00157"></a>00157 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_xvecxGTX&lt;N, T&gt; atanGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; y_over_x); <span class="comment">//&lt; \brief Arc tangent. Returns an angle whose tangent is y_over_x. The range of values returned by this function is [-PI/2, PI/2]. (From GLM_GTX_vecx extension)</span>
  177. <a name="l00158"></a>00158
  178. <a name="l00159"></a>00159 <span class="comment">// Exponential Functions</span>
  179. <a name="l00160"></a>00160 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_xvecxGTX&lt;N, T&gt; powGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; x, <span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; y); <span class="comment">//&lt; \brief Returns x raised to the y power. (From GLM_GTX_vecx extension)</span>
  180. <a name="l00161"></a>00161 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_xvecxGTX&lt;N, T&gt; expGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; x); <span class="comment">//&lt; \brief Returns the natural exponentiation of x, i.e., e^x. (From GLM_GTX_vecx extension)</span>
  181. <a name="l00162"></a>00162 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_xvecxGTX&lt;N, T&gt; logGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; x); <span class="comment">//&lt; \brief Returns the natural logarithm of x, i.e., returns the value y which satisfies the equation x = e^y. Results are undefined if x &lt;= 0. (From GLM_GTX_vecx extension)</span>
  182. <a name="l00163"></a>00163 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_xvecxGTX&lt;N, T&gt; exp2GTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; x); <span class="comment">//&lt; \brief Returns 2 raised to the x power. (From GLM_GTX_vecx extension)</span>
  183. <a name="l00164"></a>00164 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_xvecxGTX&lt;N, T&gt; log2GTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; x); <span class="comment">//&lt; \brief Returns the base 2 log of x, i.e., returns the value y, which satisfies the equation x = 2 ^ y. (From GLM_GTX_vecx extension)</span>
  184. <a name="l00165"></a>00165 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_xvecxGTX&lt;N, T&gt; sqrtGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; x); <span class="comment">//&lt; \brief Returns the positive square root of x. (From GLM_GTX_vecx extension)</span>
  185. <a name="l00166"></a>00166 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_xvecxGTX&lt;N, T&gt; inversesqrtGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; x); <span class="comment">//&lt; \brief Returns the reciprocal of the positive square root of x. (From GLM_GTX_vecx extension)</span>
  186. <a name="l00167"></a>00167
  187. <a name="l00168"></a>00168 <span class="comment">// Common Functions</span>
  188. <a name="l00169"></a>00169 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_xvecxGTX&lt;N, T&gt; absGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; x); <span class="comment">//&lt; \brief Returns x if x &gt;= 0; otherwise, it returns -x. (From GLM_GTX_vecx extension)</span>
  189. <a name="l00170"></a>00170 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_xvecxGTX&lt;N, T&gt; floorGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; x); <span class="comment">//&lt; \brief Returns a value equal to the nearest integer that is less then or equal to x. (From GLM_GTX_vecx extension)</span>
  190. <a name="l00171"></a>00171 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_xvecxGTX&lt;N, T&gt; ceilGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; x); <span class="comment">//&lt; \brief Returns a value equal to the nearest integer that is greater than or equal to x. (From GLM_GTX_vecx extension)</span>
  191. <a name="l00172"></a>00172 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_xvecxGTX&lt;N, T&gt; fractGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; x); <span class="comment">//&lt; \brief Return x - floor(x). (From GLM_GTX_vecx extension)</span>
  192. <a name="l00173"></a>00173 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_xvecxGTX&lt;N, T&gt; modGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; x, T y); <span class="comment">//&lt; \brief Modulus. Returns x - y * floor(x / y) for each component in x using the floating point value y. (From GLM_GTX_vecx extension)</span>
  193. <a name="l00174"></a>00174 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_xvecxGTX&lt;N, T&gt; modGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; x, <span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; y); <span class="comment">//&lt; \brief Modulus. Returns x - y * floor(x / y) for each component in x using the corresponding component of y. (From GLM_GTX_vecx extension)</span>
  194. <a name="l00175"></a>00175 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_xvecxGTX&lt;N, T&gt; minGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; x, T y); <span class="comment">//&lt; \brief Returns y if y &lt; x; otherwise, it returns x. (From GLM_GTX_vecx extension)</span>
  195. <a name="l00176"></a>00176 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_xvecxGTX&lt;N, T&gt; minGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; x, <span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; y); <span class="comment">//&lt; \brief Returns minimum of each component of x compared with the floating-point value y. (From GLM_GTX_vecx extension)</span>
  196. <a name="l00177"></a>00177 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_xvecxGTX&lt;N, T&gt; maxGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; x, T y); <span class="comment">//&lt; \brief Returns y if x &lt; y; otherwise, it returns x. (From GLM_GTX_vecx extension)</span>
  197. <a name="l00178"></a>00178 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_xvecxGTX&lt;N, T&gt; maxGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; x, <span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; y); <span class="comment">//&lt; \brief Returns maximum of each component of x compared with the floating-point value y. (From GLM_GTX_vecx extension)</span>
  198. <a name="l00179"></a>00179 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_xvecxGTX&lt;N, T&gt; clampGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; x, T minVal, T maxVal); <span class="comment">//&lt; \brief Returns min(max(x, minVal), maxVal) for each component in x using the floating-point values minVal and maxVal. (From GLM_GTX_vecx extension)</span>
  199. <a name="l00180"></a>00180 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_xvecxGTX&lt;N, T&gt; clampGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; x, <span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; minVal, <span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; maxVal); <span class="comment">//&lt; \brief Returns the component-wise result of min(max(x, minVal), maxVal). (From GLM_GTX_vecx extension)</span>
  200. <a name="l00181"></a>00181 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_xvecxGTX&lt;N, T&gt; stepGTX(T edge, <span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; x); <span class="comment">//&lt; \brief Returns 0.0 if x &lt;= edge; otherwise, it returns 1.0. (From GLM_GTX_vecx extension)</span>
  201. <a name="l00182"></a>00182 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_xvecxGTX&lt;N, T&gt; stepGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; edge, <span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; x); <span class="comment">//&lt; \brief Returns 0.0 if x &lt;= edge; otherwise, it returns 1.0. (From GLM_GTX_vecx extension)</span>
  202. <a name="l00183"></a>00183 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_xvecxGTX&lt;N, T&gt; smoothstepGTX(T edge0, T edge1, <span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; x); <span class="comment">//&lt; \brief Returns 0.0 if x &lt;= edge0 and 1.0 if x &gt;= edge1 and performs smooth Hermite interpolation between 0 and 1 when edge0 &lt; x, edge1. (From GLM_GTX_vecx extension)</span>
  203. <a name="l00184"></a>00184 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_xvecxGTX&lt;N, T&gt; smoothstepGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; edge0, <span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; edge1, <span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; x);<span class="comment">//&lt; \brief Returns 0.0 if x &lt;= edge0 and 1.0 if x &gt;= edge1 and performs smooth Hermite interpolation between 0 and 1 when edge0 &lt; x, edge1. (From GLM_GTX_vecx extension)</span>
  204. <a name="l00185"></a>00185
  205. <a name="l00186"></a>00186 <span class="comment">// Geometric Functions</span>
  206. <a name="l00187"></a>00187 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; T lengthGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; x); <span class="comment">//&lt; \brief Returns the length of x, i.e., sqrt(x * x). (From GLM_GTX_vecx extension)</span>
  207. <a name="l00188"></a>00188 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; T distanceGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; p0, <span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; p1); <span class="comment">//&lt; \brief Returns the distance betwwen p0 and p1, i.e., length(p0 - p1). (From GLM_GTX_vecx extension)</span>
  208. <a name="l00189"></a>00189 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; T dotGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; x, <span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; y); <span class="comment">//&lt; \brief Returns the dot product of x and y, i.e., result = x[0] * y[0] + x[1] * y[1]. (From GLM_GTX_vecx extension)</span>
  209. <a name="l00190"></a>00190 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_xvecxGTX&lt;N, T&gt; normalizeGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; x); <span class="comment">//&lt; \brief Returns a vector in the same direction as x but with length of 1. (From GLM_GTX_vecx extension)</span>
  210. <a name="l00191"></a>00191 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_xvecxGTX&lt;N, T&gt; faceforwardGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; Norm, <span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; I, <span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; Nref); <span class="comment">//&lt; \brief If dot(Nref, I) &lt; 0.0, return N, otherwise, return -N. (From GLM_GTX_vecx extension)</span>
  211. <a name="l00192"></a>00192 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_xvecxGTX&lt;N, T&gt; reflectGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; I, <span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; N); <span class="comment">//&lt; \brief For the incident vector I and surface orientation N, returns the reflection direction : result = I - 2.0 * dot(N, I) * N. (From GLM_GTX_vecx extension)</span>
  212. <a name="l00193"></a>00193 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_xvecxGTX&lt;N, T&gt; refractGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; I, <span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; N, T eta); <span class="comment">//&lt; \brief For the incident vector I and surface normal N, and the ratio of indices of refraction eta, return the refraction vector. (From GLM_GTX_vecx extension)</span>
  213. <a name="l00194"></a>00194
  214. <a name="l00195"></a>00195 <span class="comment">// Vector Relational Functions</span>
  215. <a name="l00196"></a>00196 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_bvecxGTX&lt;N&gt; lessThanGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; x, <span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; y); <span class="comment">//&lt; \brief Returns the component-wise compare of x &lt; y. (From GLM_GTX_vecx extension) </span>
  216. <a name="l00197"></a>00197 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_bvecxGTX&lt;N&gt; lessThanEqualGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; x, <span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; y); <span class="comment">//&lt; \brief Returns the component-wise compare of x &lt;= y. (From GLM_GTX_vecx extension) </span>
  217. <a name="l00198"></a>00198 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_bvecxGTX&lt;N&gt; greaterThanGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; x, <span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; y); <span class="comment">//&lt; \brief Returns the component-wise compare of x &gt; y. (From GLM_GTX_vecx extension) </span>
  218. <a name="l00199"></a>00199 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_bvecxGTX&lt;N&gt; greaterThanEqualGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; x, <span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; y); <span class="comment">//&lt; \brief Returns the component-wise compare of x &gt;= y. (From GLM_GTX_vecx extension)</span>
  219. <a name="l00200"></a>00200 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N&gt; detail::_bvecxGTX&lt;N&gt; equalGTX(<span class="keyword">const</span> detail::_bvecxGTX&lt;N&gt;&amp; x, <span class="keyword">const</span> detail::_bvecxGTX&lt;N&gt;&amp; y); <span class="comment">//&lt; \brief Returns the component-wise compare of x == y. (From GLM_GTX_vecx extension)</span>
  220. <a name="l00201"></a>00201 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_bvecxGTX&lt;N&gt; equalGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; x, <span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; y); <span class="comment">//&lt; \brief Returns the component-wise compare of x == y. (From GLM_GTX_vecx extension)</span>
  221. <a name="l00202"></a>00202 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N&gt; detail::_bvecxGTX&lt;N&gt; notEqualGTX(<span class="keyword">const</span> detail::_bvecxGTX&lt;N&gt;&amp; x, <span class="keyword">const</span> detail::_bvecxGTX&lt;N&gt;&amp; y); <span class="comment">//&lt; \brief Returns the component-wise compare of x != y. (From GLM_GTX_vecx extension)</span>
  222. <a name="l00203"></a>00203 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N, <span class="keyword">typename</span> T&gt; detail::_bvecxGTX&lt;N&gt; notEqualGTX(<span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; x, <span class="keyword">const</span> detail::_xvecxGTX&lt;N, T&gt;&amp; y); <span class="comment">//&lt; \brief Returns the component-wise compare of x != y. (From GLM_GTX_vecx extension)</span>
  223. <a name="l00204"></a>00204 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N&gt; <span class="keywordtype">bool</span> anyGTX(<span class="keyword">const</span> detail::_bvecxGTX&lt;N&gt;&amp; x); <span class="comment">//&lt; \brief Returns true if any component of x is true. (From GLM_GTX_vecx extension)</span>
  224. <a name="l00205"></a>00205 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N&gt; <span class="keywordtype">bool</span> allGTX(<span class="keyword">const</span> detail::_bvecxGTX&lt;N&gt;&amp; x); <span class="comment">//&lt; \brief Returns true if all component of x is true. (From GLM_GTX_vecx extension)</span>
  225. <a name="l00206"></a>00206 <span class="keyword">template</span> &lt;<span class="keywordtype">int</span> N&gt; detail::_bvecxGTX&lt;N&gt; notGTX(<span class="keyword">const</span> detail::_bvecxGTX&lt;N&gt;&amp; v); <span class="comment">//&lt; \brief Returns the component-wise logical complement of x. (From GLM_GTX_vecx extension)</span>
  226. <a name="l00207"></a>00207 }
  227. <a name="l00208"></a>00208 }
  228. <a name="l00209"></a>00209 }
  229. <a name="l00210"></a>00210
  230. <a name="l00211"></a>00211 <span class="preprocessor">#define GLM_GTX_vecx namespace gtx::vecx</span>
  231. <a name="l00212"></a>00212 <span class="preprocessor"></span><span class="preprocessor">#ifndef GLM_GTX_GLOBAL</span>
  232. <a name="l00213"></a>00213 <span class="preprocessor"></span><span class="keyword">namespace </span>glm {<span class="keyword">using</span> GLM_GTX_vecx;}
  233. <a name="l00214"></a>00214 <span class="preprocessor">#endif//GLM_GTX_GLOBAL</span>
  234. <a name="l00215"></a>00215 <span class="preprocessor"></span>
  235. <a name="l00216"></a>00216 <span class="preprocessor">#include &quot;vecx.inl&quot;</span>
  236. <a name="l00217"></a>00217
  237. <a name="l00218"></a>00218 <span class="preprocessor">#endif//glm_gtx_vecx</span>
  238. </pre></div></div>
  239. <hr size="1"/><address style="text-align: right;"><small>Generated on Mon Nov 16 11:23:23 2009 for GLM by&nbsp;
  240. <a href="http://www.doxygen.org/index.html">
  241. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
  242. </body>
  243. </html>