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

a00030_source.html 14 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121 
  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. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    6. 

  6. <meta name="generator" content="Doxygen 1.8.8"/>
    7. 

  7. <title>0.9.6: func_geometric.hpp Source File</title>
    8. 

  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    9. 

  9. <script type="text/javascript" src="jquery.js"></script>
    10. 

  10. <script type="text/javascript" src="dynsections.js"></script>
    11. 

  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
    12. 

  12. </head>
    13. 

  13. <body>
    14. 

  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    15. 

  15. <div id="titlearea">
    16. 

  16. <table cellspacing="0" cellpadding="0">
    17. 

  17.  <tbody>
    18. 

  18.  <tr style="height: 56px;">
    19. 

  19.   <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
    20. 

  20.   <td style="padding-left: 0.5em;">
    21. 

  21.    <div id="projectname">0.9.6
    22. 

  22.    </div>
    23. 

  23.   </td>
    24. 

  24.  </tr>
    25. 

  25.  </tbody>
    26. 

  26. </table>
    27. 

  27. </div>
    28. 

  28. <!-- end header part -->
    29. 

  29. <!-- Generated by Doxygen 1.8.8 -->
    30. 

  30.   <div id="navrow1" class="tabs">
    31. 

  31.     <ul class="tablist">
    32. 

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

  33.       <li><a href="modules.html"><span>Modules</span></a></li>
    34. 

  34.       <li class="current"><a href="files.html"><span>Files</span></a></li>
    35. 

  35.     </ul>
    36. 

  36.   </div>
    37. 

  37.   <div id="navrow2" class="tabs2">
    38. 

  38.     <ul class="tablist">
    39. 

  39.       <li><a href="files.html"><span>File&#160;List</span></a></li>
    40. 

  40.     </ul>
    41. 

  41.   </div>
    42. 

  42. <div id="nav-path" class="navpath">
    43. 

  43.   <ul>
    44. 

  44. <li class="navelem"><a class="el" href="dir_885cc87fac2d91e269af0a5a959fa5f6.html">E:</a></li><li class="navelem"><a class="el" href="dir_153b03dd71a7bff437c38ec53cb2e014.html">Source</a></li><li class="navelem"><a class="el" href="dir_0c6652232a835be54bedd6cfd7502504.html">G-Truc</a></li><li class="navelem"><a class="el" href="dir_e2c7faa62a52820b5be8795affd6e495.html">glm</a></li><li class="navelem"><a class="el" href="dir_5cf96241cdcf6779b80e104875f9716f.html">glm</a></li><li class="navelem"><a class="el" href="dir_9b22c367036d391e575f56d067c9855b.html">detail</a></li>  </ul>
    45. 

  45. </div>
    46. 

  46. </div><!-- top -->
    47. 

  47. <div class="header">
    48. 

  48.   <div class="headertitle">
    49. 

  49. <div class="title">func_geometric.hpp</div>  </div>
    50. 

  50. </div><!--header-->
    51. 

  51. <div class="contents">
    52. 

  52. <a href="a00030.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;</div>
    53. 

  53. <div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="preprocessor">#pragma once</span></div>
    54. 

  54. <div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;</div>
    55. 

  55. <div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00135.html">type_vec3.hpp</a>&quot;</span></div>
    56. 

  56. <div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;</div>
    57. 

  57. <div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="keyword">namespace </span><a class="code" href="a00146.html">glm</a></div>
    58. 

  58. <div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;{</div>
    59. 

  59. <div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;</div>
    60. 

  60. <div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;        <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
    61. 

  61. <div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;        GLM_FUNC_DECL T <a class="code" href="a00152.html#ga18d45e3d4c7705e67ccfabd99e521604">length</a>(</div>
    62. 

  62. <div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;                vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; x);</div>
    63. 

  63. <div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;</div>
    64. 

  64. <div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;        <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
    65. 

  65. <div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;        GLM_FUNC_DECL T <a class="code" href="a00152.html#ga7ca317dde0d7e94d920153554d4a02a8">distance</a>(</div>
    66. 

  66. <div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;                vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; p0,</div>
    67. 

  67. <div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;                vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; p1);</div>
    68. 

  68. <div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;</div>
    69. 

  69. <div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;        <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
    70. 

  70. <div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;        GLM_FUNC_DECL T <a class="code" href="a00152.html#ga7dada304da2ba7dd3376ab4f178c3f6b">dot</a>(</div>
    71. 

  71. <div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;                vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; x,</div>
    72. 

  72. <div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;                vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; y);</div>
    73. 

  73. <div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;</div>
    74. 

  74. <div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;        <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P&gt;</div>
    75. 

  75. <div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;        GLM_FUNC_DECL tvec3&lt;T, P&gt; <a class="code" href="a00152.html#gafe2cae8cb26fd44be62aee97369d0af8">cross</a>(</div>
    76. 

  76. <div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;                tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; x,</div>
    77. 

  77. <div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;                tvec3&lt;T, P&gt; <span class="keyword">const</span> &amp; y);</div>
    78. 

  78. <div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;</div>
    79. 

  79. <div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;        <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
    80. 

  80. <div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;        GLM_FUNC_DECL vecType&lt;T, P&gt; <a class="code" href="a00152.html#gada9451ec170a36fe53552812b9c03a68">normalize</a>(</div>
    81. 

  81. <div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;                vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; x);</div>
    82. 

  82. <div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;</div>
    83. 

  83. <div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;        <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;</div>
    84. 

  84. <div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;        GLM_FUNC_DECL genType <a class="code" href="a00152.html#ga4bbb036ef9527ee9f67384233029ed9b">faceforward</a>(</div>
    85. 

  85. <div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;                genType <span class="keyword">const</span> &amp; N,</div>
    86. 

  86. <div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;                genType <span class="keyword">const</span> &amp; I,</div>
    87. 

  87. <div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;                genType <span class="keyword">const</span> &amp; Nref);</div>
    88. 

  88. <div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;</div>
    89. 

  89. <div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;        <span class="keyword">template</span> &lt;<span class="keyword">typename</span> genType&gt;</div>
    90. 

  90. <div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;        GLM_FUNC_DECL genType <a class="code" href="a00152.html#gab63646fc36b81cf69d3ce123a72f76f2">reflect</a>(</div>
    91. 

  91. <div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;                genType <span class="keyword">const</span> &amp; I,</div>
    92. 

  92. <div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;                genType <span class="keyword">const</span> &amp; N);</div>
    93. 

  93. <div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;</div>
    94. 

  94. <div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;        <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, precision P, <span class="keyword">template</span> &lt;<span class="keyword">typename</span>, precision&gt; <span class="keyword">class </span>vecType&gt;</div>
    95. 

  95. <div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;        GLM_FUNC_DECL vecType&lt;T, P&gt; <a class="code" href="a00152.html#gab7e7cdf4403931a5f7b74560ad64159b">refract</a>(</div>
    96. 

  96. <div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;                vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; I,</div>
    97. 

  97. <div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;                vecType&lt;T, P&gt; <span class="keyword">const</span> &amp; N,</div>
    98. 

  98. <div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;                T eta);</div>
    99. 

  99. <div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;</div>
    100. 

  100. <div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;}<span class="comment">//namespace glm</span></div>
    101. 

  101. <div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;</div>
    102. 

  102. <div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;<span class="preprocessor">#include &quot;func_geometric.inl&quot;</span></div>
    103. 

  103. <div class="ttc" id="a00152_html_ga18d45e3d4c7705e67ccfabd99e521604"><div class="ttname"><a href="a00152.html#ga18d45e3d4c7705e67ccfabd99e521604">glm::length</a></div><div class="ttdeci">GLM_FUNC_DECL T length(vecType&lt; T, P &gt; const &amp;x)</div><div class="ttdoc">Returns the length of x, i.e., sqrt(x * x). </div></div>
    104. 

  104. <div class="ttc" id="a00152_html_gada9451ec170a36fe53552812b9c03a68"><div class="ttname"><a href="a00152.html#gada9451ec170a36fe53552812b9c03a68">glm::normalize</a></div><div class="ttdeci">GLM_FUNC_DECL vecType&lt; T, P &gt; normalize(vecType&lt; T, P &gt; const &amp;x)</div><div class="ttdoc">Returns a vector in the same direction as x but with length of 1. </div></div>
    105. 

  105. <div class="ttc" id="a00135_html"><div class="ttname"><a href="a00135.html">type_vec3.hpp</a></div><div class="ttdoc">OpenGL Mathematics (glm.g-truc.net) </div></div>
    106. 

  106. <div class="ttc" id="a00152_html_gab7e7cdf4403931a5f7b74560ad64159b"><div class="ttname"><a href="a00152.html#gab7e7cdf4403931a5f7b74560ad64159b">glm::refract</a></div><div class="ttdeci">GLM_FUNC_DECL vecType&lt; T, P &gt; refract(vecType&lt; T, P &gt; const &amp;I, vecType&lt; T, P &gt; const &amp;N, T eta)</div><div class="ttdoc">For the incident vector I and surface normal N, and the ratio of indices of refraction eta...</div></div>
    107. 

  107. <div class="ttc" id="a00146_html"><div class="ttname"><a href="a00146.html">glm</a></div><div class="ttdef"><b>Definition:</b> <a href="a00003_source.html#l00031">_noise.hpp:31</a></div></div>
    108. 

  108. <div class="ttc" id="a00152_html_gab63646fc36b81cf69d3ce123a72f76f2"><div class="ttname"><a href="a00152.html#gab63646fc36b81cf69d3ce123a72f76f2">glm::reflect</a></div><div class="ttdeci">GLM_FUNC_DECL genType reflect(genType const &amp;I, genType const &amp;N)</div><div class="ttdoc">For the incident vector I and surface orientation N, returns the reflection direction : result = I - ...</div></div>
    109. 

  109. <div class="ttc" id="a00152_html_ga7ca317dde0d7e94d920153554d4a02a8"><div class="ttname"><a href="a00152.html#ga7ca317dde0d7e94d920153554d4a02a8">glm::distance</a></div><div class="ttdeci">GLM_FUNC_DECL T distance(vecType&lt; T, P &gt; const &amp;p0, vecType&lt; T, P &gt; const &amp;p1)</div><div class="ttdoc">Returns the distance betwwen p0 and p1, i.e., length(p0 - p1). </div></div>
    110. 

  110. <div class="ttc" id="a00152_html_ga4bbb036ef9527ee9f67384233029ed9b"><div class="ttname"><a href="a00152.html#ga4bbb036ef9527ee9f67384233029ed9b">glm::faceforward</a></div><div class="ttdeci">GLM_FUNC_DECL genType faceforward(genType const &amp;N, genType const &amp;I, genType const &amp;Nref)</div><div class="ttdoc">If dot(Nref, I) < 0.0, return N, otherwise, return -N. </div></div>
    111. 

  111. <div class="ttc" id="a00152_html_ga7dada304da2ba7dd3376ab4f178c3f6b"><div class="ttname"><a href="a00152.html#ga7dada304da2ba7dd3376ab4f178c3f6b">glm::dot</a></div><div class="ttdeci">GLM_FUNC_DECL T dot(vecType&lt; T, P &gt; const &amp;x, vecType&lt; T, P &gt; const &amp;y)</div><div class="ttdoc">Returns the dot product of x and y, i.e., result = x * y. </div></div>
    112. 

  112. <div class="ttc" id="a00152_html_gafe2cae8cb26fd44be62aee97369d0af8"><div class="ttname"><a href="a00152.html#gafe2cae8cb26fd44be62aee97369d0af8">glm::cross</a></div><div class="ttdeci">GLM_FUNC_DECL tvec3&lt; T, P &gt; cross(tvec3&lt; T, P &gt; const &amp;x, tvec3&lt; T, P &gt; const &amp;y)</div><div class="ttdoc">Returns the cross product of x and y. </div></div>
    113. 

  113. </div><!-- fragment --></div><!-- contents -->
    114. 

  114. <!-- start footer part -->
    115. 

  115. <hr class="footer"/><address class="footer"><small>
    116. 

  116. Generated by &#160;<a href="http://www.doxygen.org/index.html">
    117. 

  117. <img class="footer" src="doxygen.png" alt="doxygen"/>
    118. 

  118. </a> 1.8.8
    119. 

  119. </small></address>
    120. 

  120. </body>
    121. 

  121. </html>
    122.