a00979.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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. <meta name="generator" content="Doxygen 1.8.18"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>1.0.0 API documentation: GLM_GTX_vector_query</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
  24. <td id="projectalign" style="padding-left: 0.5em;">
  25. <div id="projectname">1.0.0 API documentation
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.18 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */</script>
  48. <div id="main-nav"></div>
  49. </div><!-- top -->
  50. <!-- window showing the filter options -->
  51. <div id="MSearchSelectWindow"
  52. onmouseover="return searchBox.OnSearchSelectShow()"
  53. onmouseout="return searchBox.OnSearchSelectHide()"
  54. onkeydown="return searchBox.OnSearchSelectKey(event)">
  55. </div>
  56. <!-- iframe showing the search results (closed by default) -->
  57. <div id="MSearchResultsWindow">
  58. <iframe src="javascript:void(0)" frameborder="0"
  59. name="MSearchResults" id="MSearchResults">
  60. </iframe>
  61. </div>
  62. <div class="header">
  63. <div class="summary">
  64. <a href="#func-members">Functions</a> </div>
  65. <div class="headertitle">
  66. <div class="title">GLM_GTX_vector_query<div class="ingroups"><a class="el" href="a00896.html">Experimental extensions</a></div></div> </div>
  67. </div><!--header-->
  68. <div class="contents">
  69. <table class="memberdecls">
  70. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  71. Functions</h2></td></tr>
  72. <tr class="memitem:ga13da4a787a2ff70e95d561fb19ff91b4"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  73. <tr class="memitem:ga13da4a787a2ff70e95d561fb19ff91b4"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00979.html#ga13da4a787a2ff70e95d561fb19ff91b4">areCollinear</a> (vec&lt; L, T, Q &gt; const &amp;v0, vec&lt; L, T, Q &gt; const &amp;v1, T const &amp;epsilon)</td></tr>
  74. <tr class="memdesc:ga13da4a787a2ff70e95d561fb19ff91b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether two vectors are collinears. <a href="a00979.html#ga13da4a787a2ff70e95d561fb19ff91b4">More...</a><br /></td></tr>
  75. <tr class="separator:ga13da4a787a2ff70e95d561fb19ff91b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:gac7b95b3f798e3c293262b2bdaad47c57"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  77. <tr class="memitem:gac7b95b3f798e3c293262b2bdaad47c57"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00979.html#gac7b95b3f798e3c293262b2bdaad47c57">areOrthogonal</a> (vec&lt; L, T, Q &gt; const &amp;v0, vec&lt; L, T, Q &gt; const &amp;v1, T const &amp;epsilon)</td></tr>
  78. <tr class="memdesc:gac7b95b3f798e3c293262b2bdaad47c57"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether two vectors are orthogonals. <a href="a00979.html#gac7b95b3f798e3c293262b2bdaad47c57">More...</a><br /></td></tr>
  79. <tr class="separator:gac7b95b3f798e3c293262b2bdaad47c57"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:ga1b091c3d7f9ee3b0708311c001c293e3"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  81. <tr class="memitem:ga1b091c3d7f9ee3b0708311c001c293e3"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00979.html#ga1b091c3d7f9ee3b0708311c001c293e3">areOrthonormal</a> (vec&lt; L, T, Q &gt; const &amp;v0, vec&lt; L, T, Q &gt; const &amp;v1, T const &amp;epsilon)</td></tr>
  82. <tr class="memdesc:ga1b091c3d7f9ee3b0708311c001c293e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether two vectors are orthonormal. <a href="a00979.html#ga1b091c3d7f9ee3b0708311c001c293e3">More...</a><br /></td></tr>
  83. <tr class="separator:ga1b091c3d7f9ee3b0708311c001c293e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:gaf6ec1688eab7442fe96fe4941d5d4e76"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  85. <tr class="memitem:gaf6ec1688eab7442fe96fe4941d5d4e76"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL vec&lt; L, bool, Q &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00979.html#gaf6ec1688eab7442fe96fe4941d5d4e76">isCompNull</a> (vec&lt; L, T, Q &gt; const &amp;v, T const &amp;epsilon)</td></tr>
  86. <tr class="memdesc:gaf6ec1688eab7442fe96fe4941d5d4e76"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether a each component of a vector is null. <a href="a00979.html#gaf6ec1688eab7442fe96fe4941d5d4e76">More...</a><br /></td></tr>
  87. <tr class="separator:gaf6ec1688eab7442fe96fe4941d5d4e76"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:gac3c974f459fd75453134fad7ae89a39e"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  89. <tr class="memitem:gac3c974f459fd75453134fad7ae89a39e"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00979.html#gac3c974f459fd75453134fad7ae89a39e">isNormalized</a> (vec&lt; L, T, Q &gt; const &amp;v, T const &amp;epsilon)</td></tr>
  90. <tr class="memdesc:gac3c974f459fd75453134fad7ae89a39e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether a vector is normalized. <a href="a00979.html#gac3c974f459fd75453134fad7ae89a39e">More...</a><br /></td></tr>
  91. <tr class="separator:gac3c974f459fd75453134fad7ae89a39e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:gab4a3637dbcb4bb42dc55caea7a1e0495"><td class="memTemplParams" colspan="2">template&lt;length_t L, typename T , qualifier Q&gt; </td></tr>
  93. <tr class="memitem:gab4a3637dbcb4bb42dc55caea7a1e0495"><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_DECL bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00979.html#gab4a3637dbcb4bb42dc55caea7a1e0495">isNull</a> (vec&lt; L, T, Q &gt; const &amp;v, T const &amp;epsilon)</td></tr>
  94. <tr class="memdesc:gab4a3637dbcb4bb42dc55caea7a1e0495"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether a vector is null. <a href="a00979.html#gab4a3637dbcb4bb42dc55caea7a1e0495">More...</a><br /></td></tr>
  95. <tr class="separator:gab4a3637dbcb4bb42dc55caea7a1e0495"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. </table>
  97. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  98. <p>Include &lt;<a class="el" href="a00752.html" title="GLM_GTX_vector_query">glm/gtx/vector_query.hpp</a>&gt; to use the features of this extension.</p>
  99. <p>Query information of vector types </p>
  100. <h2 class="groupheader">Function Documentation</h2>
  101. <a id="ga13da4a787a2ff70e95d561fb19ff91b4"></a>
  102. <h2 class="memtitle"><span class="permalink"><a href="#ga13da4a787a2ff70e95d561fb19ff91b4">&#9670;&nbsp;</a></span>areCollinear()</h2>
  103. <div class="memitem">
  104. <div class="memproto">
  105. <table class="memname">
  106. <tr>
  107. <td class="memname">GLM_FUNC_DECL bool glm::areCollinear </td>
  108. <td>(</td>
  109. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  110. <td class="paramname"><em>v0</em>, </td>
  111. </tr>
  112. <tr>
  113. <td class="paramkey"></td>
  114. <td></td>
  115. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  116. <td class="paramname"><em>v1</em>, </td>
  117. </tr>
  118. <tr>
  119. <td class="paramkey"></td>
  120. <td></td>
  121. <td class="paramtype">T const &amp;&#160;</td>
  122. <td class="paramname"><em>epsilon</em>&#160;</td>
  123. </tr>
  124. <tr>
  125. <td></td>
  126. <td>)</td>
  127. <td></td><td></td>
  128. </tr>
  129. </table>
  130. </div><div class="memdoc">
  131. <p>Check whether two vectors are collinears. </p>
  132. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00979.html">GLM_GTX_vector_query</a> extensions. </dd></dl>
  133. </div>
  134. </div>
  135. <a id="gac7b95b3f798e3c293262b2bdaad47c57"></a>
  136. <h2 class="memtitle"><span class="permalink"><a href="#gac7b95b3f798e3c293262b2bdaad47c57">&#9670;&nbsp;</a></span>areOrthogonal()</h2>
  137. <div class="memitem">
  138. <div class="memproto">
  139. <table class="memname">
  140. <tr>
  141. <td class="memname">GLM_FUNC_DECL bool glm::areOrthogonal </td>
  142. <td>(</td>
  143. <td class="paramtype">vec&lt; L, T, Q &gt; 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">vec&lt; L, T, Q &gt; 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">T 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 orthogonals. </p>
  166. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00979.html">GLM_GTX_vector_query</a> extensions. </dd></dl>
  167. </div>
  168. </div>
  169. <a id="ga1b091c3d7f9ee3b0708311c001c293e3"></a>
  170. <h2 class="memtitle"><span class="permalink"><a href="#ga1b091c3d7f9ee3b0708311c001c293e3">&#9670;&nbsp;</a></span>areOrthonormal()</h2>
  171. <div class="memitem">
  172. <div class="memproto">
  173. <table class="memname">
  174. <tr>
  175. <td class="memname">GLM_FUNC_DECL bool glm::areOrthonormal </td>
  176. <td>(</td>
  177. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  178. <td class="paramname"><em>v0</em>, </td>
  179. </tr>
  180. <tr>
  181. <td class="paramkey"></td>
  182. <td></td>
  183. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  184. <td class="paramname"><em>v1</em>, </td>
  185. </tr>
  186. <tr>
  187. <td class="paramkey"></td>
  188. <td></td>
  189. <td class="paramtype">T const &amp;&#160;</td>
  190. <td class="paramname"><em>epsilon</em>&#160;</td>
  191. </tr>
  192. <tr>
  193. <td></td>
  194. <td>)</td>
  195. <td></td><td></td>
  196. </tr>
  197. </table>
  198. </div><div class="memdoc">
  199. <p>Check whether two vectors are orthonormal. </p>
  200. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00979.html">GLM_GTX_vector_query</a> extensions. </dd></dl>
  201. </div>
  202. </div>
  203. <a id="gaf6ec1688eab7442fe96fe4941d5d4e76"></a>
  204. <h2 class="memtitle"><span class="permalink"><a href="#gaf6ec1688eab7442fe96fe4941d5d4e76">&#9670;&nbsp;</a></span>isCompNull()</h2>
  205. <div class="memitem">
  206. <div class="memproto">
  207. <table class="memname">
  208. <tr>
  209. <td class="memname">GLM_FUNC_DECL vec&lt;L, bool, Q&gt; glm::isCompNull </td>
  210. <td>(</td>
  211. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  212. <td class="paramname"><em>v</em>, </td>
  213. </tr>
  214. <tr>
  215. <td class="paramkey"></td>
  216. <td></td>
  217. <td class="paramtype">T const &amp;&#160;</td>
  218. <td class="paramname"><em>epsilon</em>&#160;</td>
  219. </tr>
  220. <tr>
  221. <td></td>
  222. <td>)</td>
  223. <td></td><td></td>
  224. </tr>
  225. </table>
  226. </div><div class="memdoc">
  227. <p>Check whether a each component of a vector is null. </p>
  228. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00979.html">GLM_GTX_vector_query</a> extensions. </dd></dl>
  229. </div>
  230. </div>
  231. <a id="gac3c974f459fd75453134fad7ae89a39e"></a>
  232. <h2 class="memtitle"><span class="permalink"><a href="#gac3c974f459fd75453134fad7ae89a39e">&#9670;&nbsp;</a></span>isNormalized()</h2>
  233. <div class="memitem">
  234. <div class="memproto">
  235. <table class="memname">
  236. <tr>
  237. <td class="memname">GLM_FUNC_DECL bool glm::isNormalized </td>
  238. <td>(</td>
  239. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  240. <td class="paramname"><em>v</em>, </td>
  241. </tr>
  242. <tr>
  243. <td class="paramkey"></td>
  244. <td></td>
  245. <td class="paramtype">T const &amp;&#160;</td>
  246. <td class="paramname"><em>epsilon</em>&#160;</td>
  247. </tr>
  248. <tr>
  249. <td></td>
  250. <td>)</td>
  251. <td></td><td></td>
  252. </tr>
  253. </table>
  254. </div><div class="memdoc">
  255. <p>Check whether a vector is normalized. </p>
  256. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00979.html">GLM_GTX_vector_query</a> extensions. </dd></dl>
  257. </div>
  258. </div>
  259. <a id="gab4a3637dbcb4bb42dc55caea7a1e0495"></a>
  260. <h2 class="memtitle"><span class="permalink"><a href="#gab4a3637dbcb4bb42dc55caea7a1e0495">&#9670;&nbsp;</a></span>isNull()</h2>
  261. <div class="memitem">
  262. <div class="memproto">
  263. <table class="memname">
  264. <tr>
  265. <td class="memname">GLM_FUNC_DECL bool glm::isNull </td>
  266. <td>(</td>
  267. <td class="paramtype">vec&lt; L, T, Q &gt; const &amp;&#160;</td>
  268. <td class="paramname"><em>v</em>, </td>
  269. </tr>
  270. <tr>
  271. <td class="paramkey"></td>
  272. <td></td>
  273. <td class="paramtype">T const &amp;&#160;</td>
  274. <td class="paramname"><em>epsilon</em>&#160;</td>
  275. </tr>
  276. <tr>
  277. <td></td>
  278. <td>)</td>
  279. <td></td><td></td>
  280. </tr>
  281. </table>
  282. </div><div class="memdoc">
  283. <p>Check whether a vector is null. </p>
  284. <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00979.html">GLM_GTX_vector_query</a> extensions. </dd></dl>
  285. </div>
  286. </div>
  287. </div><!-- contents -->
  288. <!-- start footer part -->
  289. <hr class="footer"/><address class="footer"><small>
  290. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  291. <img class="footer" src="doxygen.png" alt="doxygen"/>
  292. </a> 1.8.18
  293. </small></address>
  294. </body>
  295. </html>