mewin/glm
1
0
Fork 0
Code Releases Activity

Updated API documentation

Browse Source
This commit is contained in:
Christophe Riccio
2013-12-25 23:48:55 +01:00
parent 792e5ff74f
commit fee3eddd37
459 changed files with 76100 additions and 48806 deletions
Download Patch File Download Diff File Expand all files Collapse all files

240
doc/api/a00203.html
View File

@@ -3,7 +3,8 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>GLM_GTX_spline</title>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>GLM: GLM_GTX_intersect</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
@@ -15,18 +16,23 @@
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">GLM
&#160;<span id="projectnumber">0.9.5</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.2 -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
@@ -35,59 +41,83 @@
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">GLM_GTX_spline</div> </div>
<div class="ingroups"><a class="el" href="a00139.html">GTX Extensions (Experimental)</a></div></div><!--header-->
<div class="title">GLM_GTX_intersect<div class="ingroups"><a class="el" href="a00165.html">GTX Extensions (Experimental)</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga392c457b16903889ff080038772f6ef2"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga392c457b16903889ff080038772f6ef2"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00203.html#ga392c457b16903889ff080038772f6ef2">catmullRom</a> (genType const &amp;v1, genType const &amp;v2, genType const &amp;v3, genType const &amp;v4, typename genType::value_type const &amp;s)</td></tr>
<tr class="separator:ga392c457b16903889ff080038772f6ef2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1ce22b5ceec4df8c6022990058bcf215"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga1ce22b5ceec4df8c6022990058bcf215"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00203.html#ga1ce22b5ceec4df8c6022990058bcf215">cubic</a> (genType const &amp;v1, genType const &amp;v2, genType const &amp;v3, genType const &amp;v4, typename genType::value_type const &amp;s)</td></tr>
<tr class="separator:ga1ce22b5ceec4df8c6022990058bcf215"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga19e4a66ad17ebedc6b8250e8751e7624"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga19e4a66ad17ebedc6b8250e8751e7624"><td class="memTemplItemLeft" align="right" valign="top">genType&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00203.html#ga19e4a66ad17ebedc6b8250e8751e7624">hermite</a> (genType const &amp;v1, genType const &amp;t1, genType const &amp;v2, genType const &amp;t2, typename genType::value_type const &amp;s)</td></tr>
<tr class="separator:ga19e4a66ad17ebedc6b8250e8751e7624"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga029b0fdc889428d905a6267aee1f0f25"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga029b0fdc889428d905a6267aee1f0f25"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00203.html#ga029b0fdc889428d905a6267aee1f0f25">intersectLineSphere</a> (genType const &amp;point0, genType const &amp;point1, genType const &amp;sphereCenter, typename genType::value_type sphereRadius, genType &amp;intersectionPosition1, genType &amp;intersectionNormal1, genType &amp;intersectionPosition2=genType(), genType &amp;intersectionNormal2=genType())</td></tr>
<tr class="separator:ga029b0fdc889428d905a6267aee1f0f25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga54942f4d0fc37afdd866e79a4b8b997f"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga54942f4d0fc37afdd866e79a4b8b997f"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00203.html#ga54942f4d0fc37afdd866e79a4b8b997f">intersectLineTriangle</a> (genType const &amp;orig, genType const &amp;dir, genType const &amp;vert0, genType const &amp;vert1, genType const &amp;vert2, genType &amp;position)</td></tr>
<tr class="separator:ga54942f4d0fc37afdd866e79a4b8b997f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga916045826fbdb82ec0ec393c66065c95"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga916045826fbdb82ec0ec393c66065c95"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00203.html#ga916045826fbdb82ec0ec393c66065c95">intersectRaySphere</a> (genType const &amp;rayStarting, genType const &amp;rayNormalizedDirection, genType const &amp;sphereCenter, const typename genType::value_type sphereRadiusSquered, typename genType::value_type &amp;intersectionDistance)</td></tr>
<tr class="separator:ga916045826fbdb82ec0ec393c66065c95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5b3915fd8ab76d3e3d9a98869d9a3c44"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:ga5b3915fd8ab76d3e3d9a98869d9a3c44"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00203.html#ga5b3915fd8ab76d3e3d9a98869d9a3c44">intersectRaySphere</a> (genType const &amp;rayStarting, genType const &amp;rayNormalizedDirection, genType const &amp;sphereCenter, const typename genType::value_type sphereRadius, genType &amp;intersectionPosition, genType &amp;intersectionNormal)</td></tr>
<tr class="separator:ga5b3915fd8ab76d3e3d9a98869d9a3c44"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac8bcfc662702cc5ae4463a7f95c35ed4"><td class="memTemplParams" colspan="2">template&lt;typename genType &gt; </td></tr>
<tr class="memitem:gac8bcfc662702cc5ae4463a7f95c35ed4"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00203.html#gac8bcfc662702cc5ae4463a7f95c35ed4">intersectRayTriangle</a> (genType const &amp;orig, genType const &amp;dir, genType const &amp;vert0, genType const &amp;vert1, genType const &amp;vert2, genType &amp;baryPosition)</td></tr>
<tr class="separator:gac8bcfc662702cc5ae4463a7f95c35ed4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Spline functions. </p>
<p>&lt;<a class="el" href="a00087.html" title="OpenGL Mathematics (glm.g-truc.net)">glm/gtx/spline.hpp</a>&gt; need to be included to use these functionalities. </p>
<p>Add intersection functions. </p>
<p>&lt;<a class="el" href="a00051.html" title="OpenGL Mathematics (glm.g-truc.net) ">glm/gtx/intersect.hpp</a>&gt; need to be included to use these functionalities. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga392c457b16903889ff080038772f6ef2"></a>
<a class="anchor" id="ga029b0fdc889428d905a6267aee1f0f25"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">genType glm::catmullRom </td>
<td class="memname">bool glm::intersectLineSphere </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v1</em>, </td>
<td class="paramname"><em>point0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v2</em>, </td>
<td class="paramname"><em>point1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v3</em>, </td>
<td class="paramname"><em>sphereCenter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v4</em>, </td>
<td class="paramtype">typename genType::value_type&#160;</td>
<td class="paramname"><em>sphereRadius</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">typename genType::value_type const &amp;&#160;</td>
<td class="paramname"><em>s</em>&#160;</td>
<td class="paramtype">genType &amp;&#160;</td>
<td class="paramname"><em>intersectionPosition1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType &amp;&#160;</td>
<td class="paramname"><em>intersectionNormal1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType &amp;&#160;</td>
<td class="paramname"><em>intersectionPosition2</em> = <code>genType()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType &amp;&#160;</td>
<td class="paramname"><em>intersectionNormal2</em> = <code>genType()</code>&#160;</td>
</tr>
<tr>
<td></td>
@@ -97,44 +127,50 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Return a point from a catmull rom curve. </p>
<p>From GLM_GTX_spline extension. </p>
<p>Compute the intersection of a line and a sphere. </p>
<p>From GLM_GTX_intersect extension </p>
</div>
</div>
<a class="anchor" id="ga1ce22b5ceec4df8c6022990058bcf215"></a>
<a class="anchor" id="ga54942f4d0fc37afdd866e79a4b8b997f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">genType glm::cubic </td>
<td class="memname">bool glm::intersectLineTriangle </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v1</em>, </td>
<td class="paramname"><em>orig</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v2</em>, </td>
<td class="paramname"><em>dir</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v3</em>, </td>
<td class="paramname"><em>vert0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v4</em>, </td>
<td class="paramname"><em>vert1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">typename genType::value_type const &amp;&#160;</td>
<td class="paramname"><em>s</em>&#160;</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>vert2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType &amp;&#160;</td>
<td class="paramname"><em>position</em>&#160;</td>
</tr>
<tr>
<td></td>
@@ -144,44 +180,44 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Return a point from a cubic curve. </p>
<p>From GLM_GTX_spline extension. </p>
<p>Compute the intersection of a line and a triangle. </p>
<p>From GLM_GTX_intersect extension. </p>
</div>
</div>
<a class="anchor" id="ga19e4a66ad17ebedc6b8250e8751e7624"></a>
<a class="anchor" id="ga916045826fbdb82ec0ec393c66065c95"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">genType glm::hermite </td>
<td class="memname">bool glm::intersectRaySphere </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v1</em>, </td>
<td class="paramname"><em>rayStarting</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>t1</em>, </td>
<td class="paramname"><em>rayNormalizedDirection</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>v2</em>, </td>
<td class="paramname"><em>sphereCenter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>t2</em>, </td>
<td class="paramtype">const typename genType::value_type&#160;</td>
<td class="paramname"><em>sphereRadiusSquered</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">typename genType::value_type const &amp;&#160;</td>
<td class="paramname"><em>s</em>&#160;</td>
<td class="paramtype">typename genType::value_type &amp;&#160;</td>
<td class="paramname"><em>intersectionDistance</em>&#160;</td>
</tr>
<tr>
<td></td>
@@ -191,8 +227,114 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Return a point from a hermite curve. </p>
<p>From GLM_GTX_spline extension. </p>
<p>Compute the intersection distance of a ray and a sphere. </p>
<p>The ray direction vector is unit length. From GLM_GTX_intersect extension. </p>
</div>
</div>
<a class="anchor" id="ga5b3915fd8ab76d3e3d9a98869d9a3c44"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool glm::intersectRaySphere </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>rayStarting</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>rayNormalizedDirection</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>sphereCenter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const typename genType::value_type&#160;</td>
<td class="paramname"><em>sphereRadius</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType &amp;&#160;</td>
<td class="paramname"><em>intersectionPosition</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType &amp;&#160;</td>
<td class="paramname"><em>intersectionNormal</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Compute the intersection of a ray and a sphere. </p>
<p>From GLM_GTX_intersect extension. </p>
</div>
</div>
<a class="anchor" id="gac8bcfc662702cc5ae4463a7f95c35ed4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool glm::intersectRayTriangle </td>
<td>(</td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>orig</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>dir</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>vert0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>vert1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType const &amp;&#160;</td>
<td class="paramname"><em>vert2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">genType &amp;&#160;</td>
<td class="paramname"><em>baryPosition</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Compute the intersection of a ray and a triangle. </p>
<p>From GLM_GTX_intersect extension. </p>
</div>
</div>
@@ -201,7 +343,7 @@ Functions</h2></td></tr>
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.2
</a> 1.8.5
</small></address>
</body>
</html>