Home Explore Help
Sign In
cpp
/
glm
mirror of https://github.com/g-truc/glm.git
2
0
Fork 0
Files Issues 0 Wiki
Branch: 0.9.2
Branches Tags
glm
/
doc
/
api-0.9.2
/
a00300.html

a00300.html 14 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <title>GLM_GTX_vector_query: Vector query</title>
    6. 

  6. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    7. 

  7. <link href="doxygen.css" rel="stylesheet" type="text/css"/>
    8. 

  8. </head>
    9. 

  9. <body>
    10. 

  10. <!-- Generated by Doxygen 1.7.4 -->
    11. 

  11. <div id="top">
    12. 

  12. <div id="titlearea">
    13. 

  13. <table cellspacing="0" cellpadding="0">
    14. 

  14.  <tbody>
    15. 

  15.  <tr style="height: 56px;">
    16. 

  16.   <td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
    17. 

  17.  </tr>
    18. 

  18.  </tbody>
    19. 

  19. </table>
    20. 

  20. </div>
    21. 

  21.   <div id="navrow1" class="tabs">
    22. 

  22.     <ul class="tablist">
    23. 

  23.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
    24. 

  24.       <li><a href="modules.html"><span>Modules</span></a></li>
    25. 

  25.       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    26. 

  26.       <li><a href="annotated.html"><span>Classes</span></a></li>
    27. 

  27.       <li><a href="files.html"><span>Files</span></a></li>
    28. 

  28.     </ul>
    29. 

  29.   </div>
    30. 

  30. </div>
    31. 

  31. <div class="header">
    32. 

  32.   <div class="summary">
    33. 

  33. <a href="#func-members">Functions</a>  </div>
    34. 

  34.   <div class="headertitle">
    35. 

  35. <div class="title">GLM_GTX_vector_query: Vector query</div>  </div>
    36. 

  36. <div class="ingroups"><a class="el" href="a00248.html">GTX Extensions (Experimental)</a></div></div>
    37. 

  37. <div class="contents">
    38. 

  38. 

  39. <p>Query informations of vector types.  
    40. 

  40. <a href="#details">More...</a></p>
    41. 

  41. <table class="memberdecls">
    42. 

  42. <tr><td colspan="2"><h2><a name="func-members"></a>
    43. 

  43. Functions</h2></td></tr>
    44. 

  44. <tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    45. 

  45. <tr><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00300.html#gadf4603b05ea58193d1f63f128160757e">areCollinear</a> (genType const &amp;v0, genType const &amp;v1, typename genType::value_type const &amp;epsilon=std::numeric_limits&lt; typename genType::value_type &gt;::epsilon())</td></tr>
    46. 

  46. <tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    47. 

  47. <tr><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00300.html#gacac4975ef9ab28dafe0b07f543fd1d35">areOpposite</a> (genType const &amp;v0, genType const &amp;v1, typename genType::value_type const &amp;epsilon=std::numeric_limits&lt; typename genType::value_type &gt;::epsilon())</td></tr>
    48. 

  48. <tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    49. 

  49. <tr><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00300.html#ga6d56f0cfc253d49844bac10cefb1ec92">areOrthogonal</a> (genType const &amp;v0, genType const &amp;v1, typename genType::value_type const &amp;epsilon=std::numeric_limits&lt; typename genType::value_type &gt;::epsilon())</td></tr>
    50. 

  50. <tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    51. 

  51. <tr><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00300.html#ga300e715a70b718689fd405e65b09f26a">areOrthonormal</a> (genType const &amp;v0, genType const &amp;v1, typename genType::value_type const &amp;epsilon=std::numeric_limits&lt; typename genType::value_type &gt;::epsilon())</td></tr>
    52. 

  52. <tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    53. 

  53. <tr><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00300.html#gac91707dd854ae62484e9670311105545">areSimilar</a> (genType const &amp;v0, genType const &amp;v1, typename genType::value_type const &amp;epsilon=std::numeric_limits&lt; typename genType::value_type &gt;::epsilon())</td></tr>
    54. 

  54. <tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    55. 

  55. <tr><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00300.html#ga727dbe962529a68632f779ccc79e2cef">isNormalized</a> (genType const &amp;v, typename genType::value_type const &amp;epsilon=std::numeric_limits&lt; typename genType::value_type &gt;::epsilon())</td></tr>
    56. 

  56. <tr><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
    57. 

  57. <tr><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00300.html#gab8f7a48850ba11f19dbbfcc0429b116c">isNull</a> (genType const &amp;v, typename genType::value_type const &amp;epsilon=std::numeric_limits&lt; typename genType::value_type &gt;::epsilon())</td></tr>
    58. 

  58. </table>
    59. 

  59. <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
    60. 

  60. <p>Query informations of vector types. </p>
    61. 

  61. <p>&lt;<a class="el" href="a00138_source.html">glm/gtx/vector_query.hpp</a>&gt; need to be included to use these functionalities. </p>
    62. 

  62. <hr/><h2>Function Documentation</h2>
    63. 

  63. <a class="anchor" id="gadf4603b05ea58193d1f63f128160757e"></a><!-- doxytag: member="glm::gtx::vector_query::areCollinear" ref="gadf4603b05ea58193d1f63f128160757e" args="(genType const &amp;v0, genType const &amp;v1, typename genType::value_type const &amp;epsilon=std::numeric_limits&lt; typename genType::value_type &gt;::epsilon())" -->
    64. 

  64. <div class="memitem">
    65. 

  65. <div class="memproto">
    66. 

  66.       <table class="memname">
    67. 

  67.         <tr>
    68. 

  68.           <td class="memname">bool glm::gtx::vector_query::areCollinear </td>
    69. 

  69.           <td>(</td>
    70. 

  70.           <td class="paramtype">genType const &amp;&#160;</td>
    71. 

  71.           <td class="paramname"><em>v0</em>, </td>
    72. 

  72.         </tr>
    73. 

  73.         <tr>
    74. 

  74.           <td class="paramkey"></td>
    75. 

  75.           <td></td>
    76. 

  76.           <td class="paramtype">genType const &amp;&#160;</td>
    77. 

  77.           <td class="paramname"><em>v1</em>, </td>
    78. 

  78.         </tr>
    79. 

  79.         <tr>
    80. 

  80.           <td class="paramkey"></td>
    81. 

  81.           <td></td>
    82. 

  82.           <td class="paramtype">typename genType::value_type const &amp;&#160;</td>
    83. 

  83.           <td class="paramname"><em>epsilon</em> = <code>std::numeric_limits&lt;&#160;typename&#160;genType::value_type&#160;&gt;::epsilon()</code>&#160;</td>
    84. 

  84.         </tr>
    85. 

  85.         <tr>
    86. 

  86.           <td></td>
    87. 

  87.           <td>)</td>
    88. 

  88.           <td></td><td></td>
    89. 

  89.         </tr>
    90. 

  90.       </table>
    91. 

  91. </div>
    92. 

  92. <div class="memdoc">
    93. 

  93. 

  94. <p>Check if two vectors are collinears. </p>
    95. 

  95. <p>From GLM_GTX_vector_query extensions. </p>
    96. 

  96. 

  97. </div>
    98. 

  98. </div>
    99. 

  99. <a class="anchor" id="gacac4975ef9ab28dafe0b07f543fd1d35"></a><!-- doxytag: member="glm::gtx::vector_query::areOpposite" ref="gacac4975ef9ab28dafe0b07f543fd1d35" args="(genType const &amp;v0, genType const &amp;v1, typename genType::value_type const &amp;epsilon=std::numeric_limits&lt; typename genType::value_type &gt;::epsilon())" -->
    100. 

  100. <div class="memitem">
    101. 

  101. <div class="memproto">
    102. 

  102.       <table class="memname">
    103. 

  103.         <tr>
    104. 

  104.           <td class="memname">bool glm::gtx::vector_query::areOpposite </td>
    105. 

  105.           <td>(</td>
    106. 

  106.           <td class="paramtype">genType const &amp;&#160;</td>
    107. 

  107.           <td class="paramname"><em>v0</em>, </td>
    108. 

  108.         </tr>
    109. 

  109.         <tr>
    110. 

  110.           <td class="paramkey"></td>
    111. 

  111.           <td></td>
    112. 

  112.           <td class="paramtype">genType const &amp;&#160;</td>
    113. 

  113.           <td class="paramname"><em>v1</em>, </td>
    114. 

  114.         </tr>
    115. 

  115.         <tr>
    116. 

  116.           <td class="paramkey"></td>
    117. 

  117.           <td></td>
    118. 

  118.           <td class="paramtype">typename genType::value_type const &amp;&#160;</td>
    119. 

  119.           <td class="paramname"><em>epsilon</em> = <code>std::numeric_limits&lt;&#160;typename&#160;genType::value_type&#160;&gt;::epsilon()</code>&#160;</td>
    120. 

  120.         </tr>
    121. 

  121.         <tr>
    122. 

  122.           <td></td>
    123. 

  123.           <td>)</td>
    124. 

  124.           <td></td><td></td>
    125. 

  125.         </tr>
    126. 

  126.       </table>
    127. 

  127. </div>
    128. 

  128. <div class="memdoc">
    129. 

  129. 

  130. <p>Check if two vectors are opposites. </p>
    131. 

  131. <p>From GLM_GTX_vector_query extensions. </p>
    132. 

  132. 

  133. </div>
    134. 

  134. </div>
    135. 

  135. <a class="anchor" id="ga6d56f0cfc253d49844bac10cefb1ec92"></a><!-- doxytag: member="glm::gtx::vector_query::areOrthogonal" ref="ga6d56f0cfc253d49844bac10cefb1ec92" args="(genType const &amp;v0, genType const &amp;v1, typename genType::value_type const &amp;epsilon=std::numeric_limits&lt; typename genType::value_type &gt;::epsilon())" -->
    136. 

  136. <div class="memitem">
    137. 

  137. <div class="memproto">
    138. 

  138.       <table class="memname">
    139. 

  139.         <tr>
    140. 

  140.           <td class="memname">bool glm::gtx::vector_query::areOrthogonal </td>
    141. 

  141.           <td>(</td>
    142. 

  142.           <td class="paramtype">genType const &amp;&#160;</td>
    143. 

  143.           <td class="paramname"><em>v0</em>, </td>
    144. 

  144.         </tr>
    145. 

  145.         <tr>
    146. 

  146.           <td class="paramkey"></td>
    147. 

  147.           <td></td>
    148. 

  148.           <td class="paramtype">genType const &amp;&#160;</td>
    149. 

  149.           <td class="paramname"><em>v1</em>, </td>
    150. 

  150.         </tr>
    151. 

  151.         <tr>
    152. 

  152.           <td class="paramkey"></td>
    153. 

  153.           <td></td>
    154. 

  154.           <td class="paramtype">typename genType::value_type const &amp;&#160;</td>
    155. 

  155.           <td class="paramname"><em>epsilon</em> = <code>std::numeric_limits&lt;&#160;typename&#160;genType::value_type&#160;&gt;::epsilon()</code>&#160;</td>
    156. 

  156.         </tr>
    157. 

  157.         <tr>
    158. 

  158.           <td></td>
    159. 

  159.           <td>)</td>
    160. 

  160.           <td></td><td></td>
    161. 

  161.         </tr>
    162. 

  162.       </table>
    163. 

  163. </div>
    164. 

  164. <div class="memdoc">
    165. 

  165. 

  166. <p>Check if two vectors are orthogonals. </p>
    167. 

  167. <p>From GLM_GTX_vector_query extensions. </p>
    168. 

  168. 

  169. </div>
    170. 

  170. </div>
    171. 

  171. <a class="anchor" id="ga300e715a70b718689fd405e65b09f26a"></a><!-- doxytag: member="glm::gtx::vector_query::areOrthonormal" ref="ga300e715a70b718689fd405e65b09f26a" args="(genType const &amp;v0, genType const &amp;v1, typename genType::value_type const &amp;epsilon=std::numeric_limits&lt; typename genType::value_type &gt;::epsilon())" -->
    172. 

  172. <div class="memitem">
    173. 

  173. <div class="memproto">
    174. 

  174.       <table class="memname">
    175. 

  175.         <tr>
    176. 

  176.           <td class="memname">bool glm::gtx::vector_query::areOrthonormal </td>
    177. 

  177.           <td>(</td>
    178. 

  178.           <td class="paramtype">genType const &amp;&#160;</td>
    179. 

  179.           <td class="paramname"><em>v0</em>, </td>
    180. 

  180.         </tr>
    181. 

  181.         <tr>
    182. 

  182.           <td class="paramkey"></td>
    183. 

  183.           <td></td>
    184. 

  184.           <td class="paramtype">genType const &amp;&#160;</td>
    185. 

  185.           <td class="paramname"><em>v1</em>, </td>
    186. 

  186.         </tr>
    187. 

  187.         <tr>
    188. 

  188.           <td class="paramkey"></td>
    189. 

  189.           <td></td>
    190. 

  190.           <td class="paramtype">typename genType::value_type const &amp;&#160;</td>
    191. 

  191.           <td class="paramname"><em>epsilon</em> = <code>std::numeric_limits&lt;&#160;typename&#160;genType::value_type&#160;&gt;::epsilon()</code>&#160;</td>
    192. 

  192.         </tr>
    193. 

  193.         <tr>
    194. 

  194.           <td></td>
    195. 

  195.           <td>)</td>
    196. 

  196.           <td></td><td></td>
    197. 

  197.         </tr>
    198. 

  198.       </table>
    199. 

  199. </div>
    200. 

  200. <div class="memdoc">
    201. 

  201. 

  202. <p>Check if two vectors are orthonormal. </p>
    203. 

  203. <p>From GLM_GTX_vector_query extensions. </p>
    204. 

  204. 

  205. </div>
    206. 

  206. </div>
    207. 

  207. <a class="anchor" id="gac91707dd854ae62484e9670311105545"></a><!-- doxytag: member="glm::gtx::vector_query::areSimilar" ref="gac91707dd854ae62484e9670311105545" args="(genType const &amp;v0, genType const &amp;v1, typename genType::value_type const &amp;epsilon=std::numeric_limits&lt; typename genType::value_type &gt;::epsilon())" -->
    208. 

  208. <div class="memitem">
    209. 

  209. <div class="memproto">
    210. 

  210.       <table class="memname">
    211. 

  211.         <tr>
    212. 

  212.           <td class="memname">bool glm::gtx::vector_query::areSimilar </td>
    213. 

  213.           <td>(</td>
    214. 

  214.           <td class="paramtype">genType const &amp;&#160;</td>
    215. 

  215.           <td class="paramname"><em>v0</em>, </td>
    216. 

  216.         </tr>
    217. 

  217.         <tr>
    218. 

  218.           <td class="paramkey"></td>
    219. 

  219.           <td></td>
    220. 

  220.           <td class="paramtype">genType const &amp;&#160;</td>
    221. 

  221.           <td class="paramname"><em>v1</em>, </td>
    222. 

  222.         </tr>
    223. 

  223.         <tr>
    224. 

  224.           <td class="paramkey"></td>
    225. 

  225.           <td></td>
    226. 

  226.           <td class="paramtype">typename genType::value_type const &amp;&#160;</td>
    227. 

  227.           <td class="paramname"><em>epsilon</em> = <code>std::numeric_limits&lt;&#160;typename&#160;genType::value_type&#160;&gt;::epsilon()</code>&#160;</td>
    228. 

  228.         </tr>
    229. 

  229.         <tr>
    230. 

  230.           <td></td>
    231. 

  231.           <td>)</td>
    232. 

  232.           <td></td><td></td>
    233. 

  233.         </tr>
    234. 

  234.       </table>
    235. 

  235. </div>
    236. 

  236. <div class="memdoc">
    237. 

  237. 

  238. <p>Check if two vectors are similar. </p>
    239. 

  239. <p>From GLM_GTX_vector_query extensions. </p>
    240. 

  240. 

  241. </div>
    242. 

  242. </div>
    243. 

  243. <a class="anchor" id="ga727dbe962529a68632f779ccc79e2cef"></a><!-- doxytag: member="glm::gtx::vector_query::isNormalized" ref="ga727dbe962529a68632f779ccc79e2cef" args="(genType const &amp;v, typename genType::value_type const &amp;epsilon=std::numeric_limits&lt; typename genType::value_type &gt;::epsilon())" -->
    244. 

  244. <div class="memitem">
    245. 

  245. <div class="memproto">
    246. 

  246.       <table class="memname">
    247. 

  247.         <tr>
    248. 

  248.           <td class="memname">bool glm::gtx::vector_query::isNormalized </td>
    249. 

  249.           <td>(</td>
    250. 

  250.           <td class="paramtype">genType const &amp;&#160;</td>
    251. 

  251.           <td class="paramname"><em>v</em>, </td>
    252. 

  252.         </tr>
    253. 

  253.         <tr>
    254. 

  254.           <td class="paramkey"></td>
    255. 

  255.           <td></td>
    256. 

  256.           <td class="paramtype">typename genType::value_type const &amp;&#160;</td>
    257. 

  257.           <td class="paramname"><em>epsilon</em> = <code>std::numeric_limits&lt;&#160;typename&#160;genType::value_type&#160;&gt;::epsilon()</code>&#160;</td>
    258. 

  258.         </tr>
    259. 

  259.         <tr>
    260. 

  260.           <td></td>
    261. 

  261.           <td>)</td>
    262. 

  262.           <td></td><td></td>
    263. 

  263.         </tr>
    264. 

  264.       </table>
    265. 

  265. </div>
    266. 

  266. <div class="memdoc">
    267. 

  267. 

  268. <p>Check if a vector is normalized. </p>
    269. 

  269. <p>From GLM_GTX_vector_query extensions. </p>
    270. 

  270. 

  271. </div>
    272. 

  272. </div>
    273. 

  273. <a class="anchor" id="gab8f7a48850ba11f19dbbfcc0429b116c"></a><!-- doxytag: member="glm::gtx::vector_query::isNull" ref="gab8f7a48850ba11f19dbbfcc0429b116c" args="(genType const &amp;v, typename genType::value_type const &amp;epsilon=std::numeric_limits&lt; typename genType::value_type &gt;::epsilon())" -->
    274. 

  274. <div class="memitem">
    275. 

  275. <div class="memproto">
    276. 

  276.       <table class="memname">
    277. 

  277.         <tr>
    278. 

  278.           <td class="memname">bool glm::gtx::vector_query::isNull </td>
    279. 

  279.           <td>(</td>
    280. 

  280.           <td class="paramtype">genType const &amp;&#160;</td>
    281. 

  281.           <td class="paramname"><em>v</em>, </td>
    282. 

  282.         </tr>
    283. 

  283.         <tr>
    284. 

  284.           <td class="paramkey"></td>
    285. 

  285.           <td></td>
    286. 

  286.           <td class="paramtype">typename genType::value_type const &amp;&#160;</td>
    287. 

  287.           <td class="paramname"><em>epsilon</em> = <code>std::numeric_limits&lt;&#160;typename&#160;genType::value_type&#160;&gt;::epsilon()</code>&#160;</td>
    288. 

  288.         </tr>
    289. 

  289.         <tr>
    290. 

  290.           <td></td>
    291. 

  291.           <td>)</td>
    292. 

  292.           <td></td><td></td>
    293. 

  293.         </tr>
    294. 

  294.       </table>
    295. 

  295. </div>
    296. 

  296. <div class="memdoc">
    297. 

  297. 

  298. <p>Check if a vector is null. </p>
    299. 

  299. <p>From GLM_GTX_vector_query extensions. </p>
    300. 

  300. 

  301. </div>
    302. 

  302. </div>
    303. 

  303. </div>
    304. 

  304. <hr class="footer"/><address class="footer"><small>Generated by&#160;
    305. 

  305. <a href="http://www.doxygen.org/index.html">
    306. 

  306. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
    307. 

  307. </body>
    308. 

  308. </html>
    309.