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
/
a00299.html

a00299.html 6.7 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157 
  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_angle: Vector angle</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_angle: Vector angle</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>Compute angle between vectors.  
    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 vecType &gt; </td></tr>
    45. 

  45. <tr><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_QUALIFIER <br class="typebreak"/>
    46. 

  46. vecType::value_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00299.html#ga772681c48065b380295f25ded4c9a70e">angle</a> (vecType const &amp;x, vecType const &amp;y)</td></tr>
    47. 

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

  48. <tr><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_QUALIFIER T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00299.html#ga694a29c83046cc64d917e654f044e792">orientedAngle</a> (detail::tvec3&lt; T &gt; const &amp;x, detail::tvec3&lt; T &gt; const &amp;y, detail::tvec3&lt; T &gt; const &amp;ref)</td></tr>
    49. 

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

  50. <tr><td class="memTemplItemLeft" align="right" valign="top">GLM_FUNC_QUALIFIER T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00299.html#ga4ac0ffd1ca09ae58ff79486240296663">orientedAngle</a> (detail::tvec2&lt; T &gt; const &amp;x, detail::tvec2&lt; T &gt; const &amp;y)</td></tr>
    51. 

  51. </table>
    52. 

  52. <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
    53. 

  53. <p>Compute angle between vectors. </p>
    54. 

  54. <p>&lt;<a class="el" href="a00137_source.html">glm/gtx/vector_angle.hpp</a>&gt; need to be included to use these functionalities. </p>
    55. 

  55. <hr/><h2>Function Documentation</h2>
    56. 

  56. <a class="anchor" id="ga772681c48065b380295f25ded4c9a70e"></a><!-- doxytag: member="glm::gtx::vector_angle::angle" ref="ga772681c48065b380295f25ded4c9a70e" args="(vecType const &amp;x, vecType const &amp;y)" -->
    57. 

  57. <div class="memitem">
    58. 

  58. <div class="memproto">
    59. 

  59.       <table class="memname">
    60. 

  60.         <tr>
    61. 

  61.           <td class="memname">GLM_FUNC_QUALIFIER vecType::value_type glm::gtx::vector_angle::angle </td>
    62. 

  62.           <td>(</td>
    63. 

  63.           <td class="paramtype">vecType const &amp;&#160;</td>
    64. 

  64.           <td class="paramname"><em>x</em>, </td>
    65. 

  65.         </tr>
    66. 

  66.         <tr>
    67. 

  67.           <td class="paramkey"></td>
    68. 

  68.           <td></td>
    69. 

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

  70.           <td class="paramname"><em>y</em>&#160;</td>
    71. 

  71.         </tr>
    72. 

  72.         <tr>
    73. 

  73.           <td></td>
    74. 

  74.           <td>)</td>
    75. 

  75.           <td></td><td></td>
    76. 

  76.         </tr>
    77. 

  77.       </table>
    78. 

  78. </div>
    79. 

  79. <div class="memdoc">
    80. 

  80. 

  81. <p>Returns the absolute angle between two vectors Parameters need to be normalized. </p>
    82. 

  82. <p>From GLM_GTX_vector_angle extension </p>
    83. 

  83. 

  84. </div>
    85. 

  85. </div>
    86. 

  86. <a class="anchor" id="ga694a29c83046cc64d917e654f044e792"></a><!-- doxytag: member="glm::gtx::vector_angle::orientedAngle" ref="ga694a29c83046cc64d917e654f044e792" args="(detail::tvec3&lt; T &gt; const &amp;x, detail::tvec3&lt; T &gt; const &amp;y, detail::tvec3&lt; T &gt; const &amp;ref)" -->
    87. 

  87. <div class="memitem">
    88. 

  88. <div class="memproto">
    89. 

  89.       <table class="memname">
    90. 

  90.         <tr>
    91. 

  91.           <td class="memname">GLM_FUNC_QUALIFIER T glm::gtx::vector_angle::orientedAngle </td>
    92. 

  92.           <td>(</td>
    93. 

  93.           <td class="paramtype">detail::tvec3&lt; T &gt; const &amp;&#160;</td>
    94. 

  94.           <td class="paramname"><em>x</em>, </td>
    95. 

  95.         </tr>
    96. 

  96.         <tr>
    97. 

  97.           <td class="paramkey"></td>
    98. 

  98.           <td></td>
    99. 

  99.           <td class="paramtype">detail::tvec3&lt; T &gt; const &amp;&#160;</td>
    100. 

  100.           <td class="paramname"><em>y</em>, </td>
    101. 

  101.         </tr>
    102. 

  102.         <tr>
    103. 

  103.           <td class="paramkey"></td>
    104. 

  104.           <td></td>
    105. 

  105.           <td class="paramtype">detail::tvec3&lt; T &gt; const &amp;&#160;</td>
    106. 

  106.           <td class="paramname"><em>ref</em>&#160;</td>
    107. 

  107.         </tr>
    108. 

  108.         <tr>
    109. 

  109.           <td></td>
    110. 

  110.           <td>)</td>
    111. 

  111.           <td></td><td></td>
    112. 

  112.         </tr>
    113. 

  113.       </table>
    114. 

  114. </div>
    115. 

  115. <div class="memdoc">
    116. 

  116. 

  117. <p>Returns the oriented angle between two 3d vectors based from a reference axis. </p>
    118. 

  118. <p>Parameters need to be normalized. From GLM_GTX_vector_angle extension. </p>
    119. 

  119. 

  120. </div>
    121. 

  121. </div>
    122. 

  122. <a class="anchor" id="ga4ac0ffd1ca09ae58ff79486240296663"></a><!-- doxytag: member="glm::gtx::vector_angle::orientedAngle" ref="ga4ac0ffd1ca09ae58ff79486240296663" args="(detail::tvec2&lt; T &gt; const &amp;x, detail::tvec2&lt; T &gt; const &amp;y)" -->
    123. 

  123. <div class="memitem">
    124. 

  124. <div class="memproto">
    125. 

  125.       <table class="memname">
    126. 

  126.         <tr>
    127. 

  127.           <td class="memname">GLM_FUNC_QUALIFIER T glm::gtx::vector_angle::orientedAngle </td>
    128. 

  128.           <td>(</td>
    129. 

  129.           <td class="paramtype">detail::tvec2&lt; T &gt; const &amp;&#160;</td>
    130. 

  130.           <td class="paramname"><em>x</em>, </td>
    131. 

  131.         </tr>
    132. 

  132.         <tr>
    133. 

  133.           <td class="paramkey"></td>
    134. 

  134.           <td></td>
    135. 

  135.           <td class="paramtype">detail::tvec2&lt; T &gt; const &amp;&#160;</td>
    136. 

  136.           <td class="paramname"><em>y</em>&#160;</td>
    137. 

  137.         </tr>
    138. 

  138.         <tr>
    139. 

  139.           <td></td>
    140. 

  140.           <td>)</td>
    141. 

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

  142.         </tr>
    143. 

  143.       </table>
    144. 

  144. </div>
    145. 

  145. <div class="memdoc">
    146. 

  146. 

  147. <p>Returns the oriented angle between two 2d vectors Parameters need to be normalized. </p>
    148. 

  148. <p>From GLM_GTX_vector_angle extension. </p>
    149. 

  149. 

  150. </div>
    151. 

  151. </div>
    152. 

  152. </div>
    153. 

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

  154. <a href="http://www.doxygen.org/index.html">
    155. 

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

  156. </body>
    157. 

  157. </html>
    158.