Updated documentation
This commit is contained in:
Christophe Riccio
@@ -2,107 +2,76 @@
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
|
||||
<title>GLM_GTX_intersect: Intersection tests</title>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<title>GLM_GTX_handed_coordinate_space</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>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div! -->
|
||||
|
||||
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
<div id="titlearea">
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
|
||||
<td id="projectlogo"><img alt="Logo" src="logo-mini.png"/></td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<!-- Generated by Doxygen 1.7.5.1 -->
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.2 -->
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="modules.html"><span>Modules</span></a></li>
|
||||
<li><a href="annotated.html"><span>Classes</span></a></li>
|
||||
<li><a href="files.html"><span>Files</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div class="header">
|
||||
<div class="summary">
|
||||
<a href="#func-members">Functions</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">GLM_GTX_intersect: Intersection tests</div> </div>
|
||||
<div class="ingroups"><a class="el" href="a00137.html">GTX Extensions (Experimental)</a></div></div>
|
||||
<div class="title">GLM_GTX_handed_coordinate_space</div> </div>
|
||||
<div class="ingroups"><a class="el" href="a00139.html">GTX Extensions (Experimental)</a></div></div><!--header-->
|
||||
<div class="contents">
|
||||
<table class="memberdecls">
|
||||
<tr><td colspan="2"><h2><a name="func-members"></a>
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
||||
Functions</h2></td></tr>
|
||||
<tr><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
||||
<tr><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00175.html#gaa8552e6a12621c629786f6d25ab1fc8e">intersectLineSphere</a> (genType const &point0, genType const &point1, genType const &center, typename genType::value_type radius, genType &position, genType &normal)</td></tr>
|
||||
<tr><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
||||
<tr><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00175.html#ga54942f4d0fc37afdd866e79a4b8b997f">intersectLineTriangle</a> (genType const &orig, genType const &dir, genType const &vert0, genType const &vert1, genType const &vert2, genType &position)</td></tr>
|
||||
<tr><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
||||
<tr><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00175.html#gac2114cdc93a129257300a86489c797f2">intersectRaySphere</a> (genType const &orig, genType const &dir, genType const &center, typename genType::value_type radius, genType &position, genType &normal)</td></tr>
|
||||
<tr><td class="memTemplParams" colspan="2">template<typename genType > </td></tr>
|
||||
<tr><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00175.html#gac8bcfc662702cc5ae4463a7f95c35ed4">intersectRayTriangle</a> (genType const &orig, genType const &dir, genType const &vert0, genType const &vert1, genType const &vert2, genType &baryPosition)</td></tr>
|
||||
<tr class="memitem:ga574a69fa0e592151454d3d2dd03275d9"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
||||
<tr class="memitem:ga574a69fa0e592151454d3d2dd03275d9"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00175.html#ga574a69fa0e592151454d3d2dd03275d9">leftHanded</a> (detail::tvec3< T > const &tangent, detail::tvec3< T > const &binormal, detail::tvec3< T > const &normal)</td></tr>
|
||||
<tr class="separator:ga574a69fa0e592151454d3d2dd03275d9"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:gabf06566f29bba31600e114ecbeef379a"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
||||
<tr class="memitem:gabf06566f29bba31600e114ecbeef379a"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00175.html#gabf06566f29bba31600e114ecbeef379a">rightHanded</a> (detail::tvec3< T > const &tangent, detail::tvec3< T > const &binormal, detail::tvec3< T > const &normal)</td></tr>
|
||||
<tr class="separator:gabf06566f29bba31600e114ecbeef379a"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
|
||||
<p>Add intersection functions. </p>
|
||||
<p><<a class="el" href="a00043.html" title="OpenGL Mathematics (glm.g-truc.net)">glm/gtx/intersect.hpp</a>> need to be included to use these functionalities. </p>
|
||||
<hr/><h2>Function Documentation</h2>
|
||||
<a class="anchor" id="gaa8552e6a12621c629786f6d25ab1fc8e"></a><!-- doxytag: member="glm::intersectLineSphere" ref="gaa8552e6a12621c629786f6d25ab1fc8e" args="(genType const &point0, genType const &point1, genType const &center, typename genType::value_type radius, genType &position, genType &normal)" -->
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<p>To know if a set of three basis vectors defines a right or left-handed coordinate system. </p>
|
||||
<p><glm/gtx/handed_coordinate_system.hpp> need to be included to use these functionalities. </p>
|
||||
<h2 class="groupheader">Function Documentation</h2>
|
||||
<a class="anchor" id="ga574a69fa0e592151454d3d2dd03275d9"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">bool glm::intersectLineSphere </td>
|
||||
<td class="memname">bool glm::leftHanded </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>point0</em>, </td>
|
||||
<td class="paramtype">detail::tvec3< T > const & </td>
|
||||
<td class="paramname"><em>tangent</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>point1</em>, </td>
|
||||
<td class="paramtype">detail::tvec3< T > const & </td>
|
||||
<td class="paramname"><em>binormal</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>center</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">typename genType::value_type </td>
|
||||
<td class="paramname"><em>radius</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">genType & </td>
|
||||
<td class="paramname"><em>position</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">genType & </td>
|
||||
<td class="paramtype">detail::tvec3< T > const & </td>
|
||||
<td class="paramname"><em>normal</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -111,106 +80,33 @@ Functions</h2></td></tr>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Compute the intersection of a line and a sphere. </p>
|
||||
<p>From GLM_GTX_intersect extension </p>
|
||||
<p>Return if a trihedron left handed or not. </p>
|
||||
<p>From GLM_GTX_handed_coordinate_space extension. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="ga54942f4d0fc37afdd866e79a4b8b997f"></a><!-- doxytag: member="glm::intersectLineTriangle" ref="ga54942f4d0fc37afdd866e79a4b8b997f" args="(genType const &orig, genType const &dir, genType const &vert0, genType const &vert1, genType const &vert2, genType &position)" -->
|
||||
<a class="anchor" id="gabf06566f29bba31600e114ecbeef379a"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">bool glm::intersectLineTriangle </td>
|
||||
<td class="memname">bool glm::rightHanded </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>orig</em>, </td>
|
||||
<td class="paramtype">detail::tvec3< T > const & </td>
|
||||
<td class="paramname"><em>tangent</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>dir</em>, </td>
|
||||
<td class="paramtype">detail::tvec3< T > const & </td>
|
||||
<td class="paramname"><em>binormal</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>vert0</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>vert1</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>vert2</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">genType & </td>
|
||||
<td class="paramname"><em>position</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Compute the intersection of a line and a triangle. </p>
|
||||
<p>From GLM_GTX_intersect extension. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="gac2114cdc93a129257300a86489c797f2"></a><!-- doxytag: member="glm::intersectRaySphere" ref="gac2114cdc93a129257300a86489c797f2" args="(genType const &orig, genType const &dir, genType const &center, typename genType::value_type radius, genType &position, genType &normal)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">bool glm::intersectRaySphere </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>orig</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>dir</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>center</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">typename genType::value_type </td>
|
||||
<td class="paramname"><em>radius</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">genType & </td>
|
||||
<td class="paramname"><em>position</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">genType & </td>
|
||||
<td class="paramtype">detail::tvec3< T > const & </td>
|
||||
<td class="paramname"><em>normal</em> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -219,76 +115,19 @@ Functions</h2></td></tr>
|
||||
<td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Compute the intersection of a ray and a sphere. </p>
|
||||
<p>From GLM_GTX_intersect extension. </p>
|
||||
<p>Return if a trihedron right handed or not. </p>
|
||||
<p>From GLM_GTX_handed_coordinate_space extension. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="gac8bcfc662702cc5ae4463a7f95c35ed4"></a><!-- doxytag: member="glm::intersectRayTriangle" ref="gac8bcfc662702cc5ae4463a7f95c35ed4" args="(genType const &orig, genType const &dir, genType const &vert0, genType const &vert1, genType const &vert2, genType &baryPosition)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">bool glm::intersectRayTriangle </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>orig</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>dir</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>vert0</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>vert1</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">genType const & </td>
|
||||
<td class="paramname"><em>vert2</em>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">genType & </td>
|
||||
<td class="paramname"><em>baryPosition</em> </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>
|
||||
</div>
|
||||
|
||||
|
||||
</div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.7.5.1
|
||||
</a> 1.8.2
|
||||
</small></address>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
||||
Reference in New Issue
Block a user