a00211.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299
  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>GLM_GTX_vector_query</title>
  7. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  8. <script type="text/javascript" src="jquery.js"></script>
  9. <script type="text/javascript" src="dynsections.js"></script>
  10. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  11. </head>
  12. <body>
  13. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  14. <div id="titlearea">
  15. <table cellspacing="0" cellpadding="0">
  16. <tbody>
  17. <tr style="height: 56px;">
  18. <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  19. </tr>
  20. </tbody>
  21. </table>
  22. </div>
  23. <!-- end header part -->
  24. <!-- Generated by Doxygen 1.8.2 -->
  25. <div id="navrow1" class="tabs">
  26. <ul class="tablist">
  27. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  28. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  29. <li><a href="modules.html"><span>Modules</span></a></li>
  30. <li><a href="files.html"><span>Files</span></a></li>
  31. </ul>
  32. </div>
  33. </div><!-- top -->
  34. <div class="header">
  35. <div class="summary">
  36. <a href="#func-members">Functions</a> </div>
  37. <div class="headertitle">
  38. <div class="title">GLM_GTX_vector_query</div> </div>
  39. <div class="ingroups"><a class="el" href="a00139.html">GTX Extensions (Experimental)</a></div></div><!--header-->
  40. <div class="contents">
  41. <table class="memberdecls">
  42. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  43. Functions</h2></td></tr>
  44. <tr class="memitem:ga516c25a0d2c46c64fb5afca5eb24daab"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  45. <tr class="memitem:ga516c25a0d2c46c64fb5afca5eb24daab"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00211.html#ga516c25a0d2c46c64fb5afca5eb24daab">areCollinear</a> (genType const &amp;v0, genType const &amp;v1, typename genType::value_type const &amp;epsilon)</td></tr>
  46. <tr class="separator:ga516c25a0d2c46c64fb5afca5eb24daab"><td class="memSeparator" colspan="2">&#160;</td></tr>
  47. <tr class="memitem:ga0cba4a48074a8b8b8474538385a709e7"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  48. <tr class="memitem:ga0cba4a48074a8b8b8474538385a709e7"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00211.html#ga0cba4a48074a8b8b8474538385a709e7">areOrthogonal</a> (genType const &amp;v0, genType const &amp;v1, typename genType::value_type const &amp;epsilon)</td></tr>
  49. <tr class="separator:ga0cba4a48074a8b8b8474538385a709e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  50. <tr class="memitem:gab6b9a4e79fb7b34e8817ae9c870eb06e"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
  51. <tr class="memitem:gab6b9a4e79fb7b34e8817ae9c870eb06e"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00211.html#gab6b9a4e79fb7b34e8817ae9c870eb06e">areOrthonormal</a> (genType const &amp;v0, genType const &amp;v1, typename genType::value_type const &amp;epsilon)</td></tr>
  52. <tr class="separator:gab6b9a4e79fb7b34e8817ae9c870eb06e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  53. <tr class="memitem:ga462311ef54b0201f227b927bdcbf2c6e"><td class="memTemplParams" colspan="2">template&lt;typename genType , template&lt; typename &gt; class vecType&gt; </td></tr>
  54. <tr class="memitem:ga462311ef54b0201f227b927bdcbf2c6e"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00211.html#ga462311ef54b0201f227b927bdcbf2c6e">isNormalized</a> (vecType&lt; genType &gt; const &amp;v, genType const &amp;epsilon)</td></tr>
  55. <tr class="separator:ga462311ef54b0201f227b927bdcbf2c6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  56. <tr class="memitem:ga891a13a3a161b48496d478cadc53c5cf"><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  57. <tr class="memitem:ga891a13a3a161b48496d478cadc53c5cf"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00211.html#ga891a13a3a161b48496d478cadc53c5cf">isNull</a> (detail::tvec2&lt; valType &gt; const &amp;v, valType const &amp;epsilon)</td></tr>
  58. <tr class="separator:ga891a13a3a161b48496d478cadc53c5cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  59. <tr class="memitem:ga4be073840d3219da9caa30bbfca34140"><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  60. <tr class="memitem:ga4be073840d3219da9caa30bbfca34140"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00211.html#ga4be073840d3219da9caa30bbfca34140">isNull</a> (detail::tvec3&lt; valType &gt; const &amp;v, valType const &amp;epsilon)</td></tr>
  61. <tr class="separator:ga4be073840d3219da9caa30bbfca34140"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62. <tr class="memitem:gaeaf0cba105a973ea70c74c308ae7954f"><td class="memTemplParams" colspan="2">template&lt;typename valType &gt; </td></tr>
  63. <tr class="memitem:gaeaf0cba105a973ea70c74c308ae7954f"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00211.html#gaeaf0cba105a973ea70c74c308ae7954f">isNull</a> (detail::tvec4&lt; valType &gt; const &amp;v, valType const &amp;epsilon)</td></tr>
  64. <tr class="separator:gaeaf0cba105a973ea70c74c308ae7954f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. </table>
  66. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  67. <p>Query informations of vector types. </p>
  68. <p>&lt;<a class="el" href="a00122.html" title="OpenGL Mathematics (glm.g-truc.net)">glm/gtx/vector_query.hpp</a>&gt; need to be included to use these functionalities. </p>
  69. <h2 class="groupheader">Function Documentation</h2>
  70. <a class="anchor" id="ga516c25a0d2c46c64fb5afca5eb24daab"></a>
  71. <div class="memitem">
  72. <div class="memproto">
  73. <table class="memname">
  74. <tr>
  75. <td class="memname">bool glm::areCollinear </td>
  76. <td>(</td>
  77. <td class="paramtype">genType const &amp;&#160;</td>
  78. <td class="paramname"><em>v0</em>, </td>
  79. </tr>
  80. <tr>
  81. <td class="paramkey"></td>
  82. <td></td>
  83. <td class="paramtype">genType const &amp;&#160;</td>
  84. <td class="paramname"><em>v1</em>, </td>
  85. </tr>
  86. <tr>
  87. <td class="paramkey"></td>
  88. <td></td>
  89. <td class="paramtype">typename genType::value_type const &amp;&#160;</td>
  90. <td class="paramname"><em>epsilon</em>&#160;</td>
  91. </tr>
  92. <tr>
  93. <td></td>
  94. <td>)</td>
  95. <td></td><td></td>
  96. </tr>
  97. </table>
  98. </div><div class="memdoc">
  99. <p>Check whether two vectors are collinears. </p>
  100. <p>From GLM_GTX_vector_query extensions. </p>
  101. </div>
  102. </div>
  103. <a class="anchor" id="ga0cba4a48074a8b8b8474538385a709e7"></a>
  104. <div class="memitem">
  105. <div class="memproto">
  106. <table class="memname">
  107. <tr>
  108. <td class="memname">bool glm::areOrthogonal </td>
  109. <td>(</td>
  110. <td class="paramtype">genType const &amp;&#160;</td>
  111. <td class="paramname"><em>v0</em>, </td>
  112. </tr>
  113. <tr>
  114. <td class="paramkey"></td>
  115. <td></td>
  116. <td class="paramtype">genType const &amp;&#160;</td>
  117. <td class="paramname"><em>v1</em>, </td>
  118. </tr>
  119. <tr>
  120. <td class="paramkey"></td>
  121. <td></td>
  122. <td class="paramtype">typename genType::value_type const &amp;&#160;</td>
  123. <td class="paramname"><em>epsilon</em>&#160;</td>
  124. </tr>
  125. <tr>
  126. <td></td>
  127. <td>)</td>
  128. <td></td><td></td>
  129. </tr>
  130. </table>
  131. </div><div class="memdoc">
  132. <p>Check whether two vectors are orthogonals. </p>
  133. <p>From GLM_GTX_vector_query extensions. </p>
  134. </div>
  135. </div>
  136. <a class="anchor" id="gab6b9a4e79fb7b34e8817ae9c870eb06e"></a>
  137. <div class="memitem">
  138. <div class="memproto">
  139. <table class="memname">
  140. <tr>
  141. <td class="memname">bool glm::areOrthonormal </td>
  142. <td>(</td>
  143. <td class="paramtype">genType const &amp;&#160;</td>
  144. <td class="paramname"><em>v0</em>, </td>
  145. </tr>
  146. <tr>
  147. <td class="paramkey"></td>
  148. <td></td>
  149. <td class="paramtype">genType const &amp;&#160;</td>
  150. <td class="paramname"><em>v1</em>, </td>
  151. </tr>
  152. <tr>
  153. <td class="paramkey"></td>
  154. <td></td>
  155. <td class="paramtype">typename genType::value_type const &amp;&#160;</td>
  156. <td class="paramname"><em>epsilon</em>&#160;</td>
  157. </tr>
  158. <tr>
  159. <td></td>
  160. <td>)</td>
  161. <td></td><td></td>
  162. </tr>
  163. </table>
  164. </div><div class="memdoc">
  165. <p>Check whether two vectors are orthonormal. </p>
  166. <p>From GLM_GTX_vector_query extensions. </p>
  167. </div>
  168. </div>
  169. <a class="anchor" id="ga462311ef54b0201f227b927bdcbf2c6e"></a>
  170. <div class="memitem">
  171. <div class="memproto">
  172. <table class="memname">
  173. <tr>
  174. <td class="memname">bool glm::isNormalized </td>
  175. <td>(</td>
  176. <td class="paramtype">vecType&lt; genType &gt; const &amp;&#160;</td>
  177. <td class="paramname"><em>v</em>, </td>
  178. </tr>
  179. <tr>
  180. <td class="paramkey"></td>
  181. <td></td>
  182. <td class="paramtype">genType const &amp;&#160;</td>
  183. <td class="paramname"><em>epsilon</em>&#160;</td>
  184. </tr>
  185. <tr>
  186. <td></td>
  187. <td>)</td>
  188. <td></td><td></td>
  189. </tr>
  190. </table>
  191. </div><div class="memdoc">
  192. <p>Check whether a vector is normalized. </p>
  193. <p>From GLM_GTX_vector_query extensions. </p>
  194. </div>
  195. </div>
  196. <a class="anchor" id="ga891a13a3a161b48496d478cadc53c5cf"></a>
  197. <div class="memitem">
  198. <div class="memproto">
  199. <table class="memname">
  200. <tr>
  201. <td class="memname">bool glm::isNull </td>
  202. <td>(</td>
  203. <td class="paramtype">detail::tvec2&lt; valType &gt; const &amp;&#160;</td>
  204. <td class="paramname"><em>v</em>, </td>
  205. </tr>
  206. <tr>
  207. <td class="paramkey"></td>
  208. <td></td>
  209. <td class="paramtype">valType const &amp;&#160;</td>
  210. <td class="paramname"><em>epsilon</em>&#160;</td>
  211. </tr>
  212. <tr>
  213. <td></td>
  214. <td>)</td>
  215. <td></td><td></td>
  216. </tr>
  217. </table>
  218. </div><div class="memdoc">
  219. <p>Check whether a vector is null. </p>
  220. <p>From GLM_GTX_vector_query extensions. </p>
  221. </div>
  222. </div>
  223. <a class="anchor" id="ga4be073840d3219da9caa30bbfca34140"></a>
  224. <div class="memitem">
  225. <div class="memproto">
  226. <table class="memname">
  227. <tr>
  228. <td class="memname">bool glm::isNull </td>
  229. <td>(</td>
  230. <td class="paramtype">detail::tvec3&lt; valType &gt; const &amp;&#160;</td>
  231. <td class="paramname"><em>v</em>, </td>
  232. </tr>
  233. <tr>
  234. <td class="paramkey"></td>
  235. <td></td>
  236. <td class="paramtype">valType const &amp;&#160;</td>
  237. <td class="paramname"><em>epsilon</em>&#160;</td>
  238. </tr>
  239. <tr>
  240. <td></td>
  241. <td>)</td>
  242. <td></td><td></td>
  243. </tr>
  244. </table>
  245. </div><div class="memdoc">
  246. <p>Check whether a vector is null. </p>
  247. <p>From GLM_GTX_vector_query extensions. </p>
  248. </div>
  249. </div>
  250. <a class="anchor" id="gaeaf0cba105a973ea70c74c308ae7954f"></a>
  251. <div class="memitem">
  252. <div class="memproto">
  253. <table class="memname">
  254. <tr>
  255. <td class="memname">bool glm::isNull </td>
  256. <td>(</td>
  257. <td class="paramtype">detail::tvec4&lt; valType &gt; const &amp;&#160;</td>
  258. <td class="paramname"><em>v</em>, </td>
  259. </tr>
  260. <tr>
  261. <td class="paramkey"></td>
  262. <td></td>
  263. <td class="paramtype">valType const &amp;&#160;</td>
  264. <td class="paramname"><em>epsilon</em>&#160;</td>
  265. </tr>
  266. <tr>
  267. <td></td>
  268. <td>)</td>
  269. <td></td><td></td>
  270. </tr>
  271. </table>
  272. </div><div class="memdoc">
  273. <p>Check whether a vector is null. </p>
  274. <p>From GLM_GTX_vector_query extensions. </p>
  275. </div>
  276. </div>
  277. </div><!-- contents -->
  278. <!-- start footer part -->
  279. <hr class="footer"/><address class="footer"><small>
  280. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  281. <img class="footer" src="doxygen.png" alt="doxygen"/>
  282. </a> 1.8.2
  283. </small></address>
  284. </body>
  285. </html>