a00368.html 16 KB

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