Skip to content

Commit

Permalink
more documentation
Browse files Browse the repository at this point in the history
More documentation, including a simple example usage of ConvexVoxelizer.

Signed-off-by: ghurstunither <[email protected]>
  • Loading branch information
ghurstunither committed Oct 11, 2024
1 parent 8d027e5 commit 862333d
Show file tree
Hide file tree
Showing 35 changed files with 4,240 additions and 7 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>My Project: Member List</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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">My Project
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceopenvdb.html">openvdb</a></li><li class="navelem"><b>OPENVDB_VERSION_NAME</b></li><li class="navelem"><b>tools</b></li><li class="navelem"><b>lvlset</b></li><li class="navelem"><a class="el" href="classopenvdb_1_1_o_p_e_n_v_d_b___v_e_r_s_i_o_n___n_a_m_e_1_1tools_1_1lvlset_1_1_capsule_voxelizer.html">CapsuleVoxelizer</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="headertitle"><div class="title">openvdb::OPENVDB_VERSION_NAME::tools::lvlset::CapsuleVoxelizer&lt; GridType, InterruptT &gt; Member List</div></div>
</div><!--header-->
<div class="contents">

<p>This is the complete list of members for <a class="el" href="classopenvdb_1_1_o_p_e_n_v_d_b___v_e_r_s_i_o_n___n_a_m_e_1_1tools_1_1lvlset_1_1_capsule_voxelizer.html">openvdb::OPENVDB_VERSION_NAME::tools::lvlset::CapsuleVoxelizer&lt; GridType, InterruptT &gt;</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="classopenvdb_1_1_o_p_e_n_v_d_b___v_e_r_s_i_o_n___n_a_m_e_1_1tools_1_1_convex_voxelizer.html#a1158ea8a1d417de37cca1e796bd70068">bottomTop</a></td><td class="entry"><a class="el" href="classopenvdb_1_1_o_p_e_n_v_d_b___v_e_r_s_i_o_n___n_a_m_e_1_1tools_1_1_convex_voxelizer.html">openvdb::OPENVDB_VERSION_NAME::tools::ConvexVoxelizer&lt; GridType, CapsuleVoxelizer&lt; GridType, util::NullInterrupter &gt;, util::NullInterrupter &gt;</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classopenvdb_1_1_o_p_e_n_v_d_b___v_e_r_s_i_o_n___n_a_m_e_1_1tools_1_1lvlset_1_1_capsule_voxelizer.html#ad85a7558fee992c66aeae670a158c586">CapsuleVoxelizer</a>(GridPtr &amp;grid, const bool &amp;threaded=true, InterruptT *interrupter=nullptr)</td><td class="entry"><a class="el" href="classopenvdb_1_1_o_p_e_n_v_d_b___v_e_r_s_i_o_n___n_a_m_e_1_1tools_1_1lvlset_1_1_capsule_voxelizer.html">openvdb::OPENVDB_VERSION_NAME::tools::lvlset::CapsuleVoxelizer&lt; GridType, InterruptT &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classopenvdb_1_1_o_p_e_n_v_d_b___v_e_r_s_i_o_n___n_a_m_e_1_1tools_1_1_convex_voxelizer.html#a24ff4c04abf7ec74e93b08d8c0aff2db">circleBottom</a>(const float &amp;x0, const float &amp;y0, const float &amp;r, const float &amp;x)</td><td class="entry"><a class="el" href="classopenvdb_1_1_o_p_e_n_v_d_b___v_e_r_s_i_o_n___n_a_m_e_1_1tools_1_1_convex_voxelizer.html">openvdb::OPENVDB_VERSION_NAME::tools::ConvexVoxelizer&lt; GridType, CapsuleVoxelizer&lt; GridType, util::NullInterrupter &gt;, util::NullInterrupter &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">static</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classopenvdb_1_1_o_p_e_n_v_d_b___v_e_r_s_i_o_n___n_a_m_e_1_1tools_1_1_convex_voxelizer.html#af544b11befe3e71f5cffee848de6b70e">circleTop</a>(const float &amp;x0, const float &amp;y0, const float &amp;r, const float &amp;x)</td><td class="entry"><a class="el" href="classopenvdb_1_1_o_p_e_n_v_d_b___v_e_r_s_i_o_n___n_a_m_e_1_1tools_1_1_convex_voxelizer.html">openvdb::OPENVDB_VERSION_NAME::tools::ConvexVoxelizer&lt; GridType, CapsuleVoxelizer&lt; GridType, util::NullInterrupter &gt;, util::NullInterrupter &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classopenvdb_1_1_o_p_e_n_v_d_b___v_e_r_s_i_o_n___n_a_m_e_1_1tools_1_1_convex_voxelizer.html#a460ecf21afdcca49185937f8e53385fe">ConvexVoxelizer</a>(GridPtr &amp;grid, const bool &amp;threaded=false, util::NullInterrupter *interrupter=nullptr)</td><td class="entry"><a class="el" href="classopenvdb_1_1_o_p_e_n_v_d_b___v_e_r_s_i_o_n___n_a_m_e_1_1tools_1_1_convex_voxelizer.html">openvdb::OPENVDB_VERSION_NAME::tools::ConvexVoxelizer&lt; GridType, CapsuleVoxelizer&lt; GridType, util::NullInterrupter &gt;, util::NullInterrupter &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>ConvexVoxelizer&lt; GridType, CapsuleVoxelizer&lt; GridType, InterruptT &gt;, InterruptT &gt;</b> (defined in <a class="el" href="classopenvdb_1_1_o_p_e_n_v_d_b___v_e_r_s_i_o_n___n_a_m_e_1_1tools_1_1lvlset_1_1_capsule_voxelizer.html">openvdb::OPENVDB_VERSION_NAME::tools::lvlset::CapsuleVoxelizer&lt; GridType, InterruptT &gt;</a>)</td><td class="entry"><a class="el" href="classopenvdb_1_1_o_p_e_n_v_d_b___v_e_r_s_i_o_n___n_a_m_e_1_1tools_1_1lvlset_1_1_capsule_voxelizer.html">openvdb::OPENVDB_VERSION_NAME::tools::lvlset::CapsuleVoxelizer&lt; GridType, InterruptT &gt;</a></td><td class="entry"><span class="mlabel">friend</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classopenvdb_1_1_o_p_e_n_v_d_b___v_e_r_s_i_o_n___n_a_m_e_1_1tools_1_1_convex_voxelizer.html#ae2d7a6795b817a76fe3e8b586e9eda0c">halfWidth</a>() const</td><td class="entry"><a class="el" href="classopenvdb_1_1_o_p_e_n_v_d_b___v_e_r_s_i_o_n___n_a_m_e_1_1tools_1_1_convex_voxelizer.html">openvdb::OPENVDB_VERSION_NAME::tools::ConvexVoxelizer&lt; GridType, CapsuleVoxelizer&lt; GridType, util::NullInterrupter &gt;, util::NullInterrupter &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classopenvdb_1_1_o_p_e_n_v_d_b___v_e_r_s_i_o_n___n_a_m_e_1_1tools_1_1_convex_voxelizer.html#aa9f792aa6ea8bbfd275d2530eded1004">iterate</a>()</td><td class="entry"><a class="el" href="classopenvdb_1_1_o_p_e_n_v_d_b___v_e_r_s_i_o_n___n_a_m_e_1_1tools_1_1_convex_voxelizer.html">openvdb::OPENVDB_VERSION_NAME::tools::ConvexVoxelizer&lt; GridType, CapsuleVoxelizer&lt; GridType, util::NullInterrupter &gt;, util::NullInterrupter &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classopenvdb_1_1_o_p_e_n_v_d_b___v_e_r_s_i_o_n___n_a_m_e_1_1tools_1_1lvlset_1_1_capsule_voxelizer.html#ad1c5c8b218674b3af417da1d2afc6d73">operator()</a>(const Vec3s &amp;pt1, const Vec3s &amp;pt2, const float &amp;r)</td><td class="entry"><a class="el" href="classopenvdb_1_1_o_p_e_n_v_d_b___v_e_r_s_i_o_n___n_a_m_e_1_1tools_1_1lvlset_1_1_capsule_voxelizer.html">openvdb::OPENVDB_VERSION_NAME::tools::lvlset::CapsuleVoxelizer&lt; GridType, InterruptT &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classopenvdb_1_1_o_p_e_n_v_d_b___v_e_r_s_i_o_n___n_a_m_e_1_1tools_1_1_convex_voxelizer.html#ad78acb10393d4c098bb488e526cb214e">sphereBottom</a>(const float &amp;x0, const float &amp;y0, const float &amp;z0, const float &amp;r, const float &amp;x, const float &amp;y)</td><td class="entry"><a class="el" href="classopenvdb_1_1_o_p_e_n_v_d_b___v_e_r_s_i_o_n___n_a_m_e_1_1tools_1_1_convex_voxelizer.html">openvdb::OPENVDB_VERSION_NAME::tools::ConvexVoxelizer&lt; GridType, CapsuleVoxelizer&lt; GridType, util::NullInterrupter &gt;, util::NullInterrupter &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classopenvdb_1_1_o_p_e_n_v_d_b___v_e_r_s_i_o_n___n_a_m_e_1_1tools_1_1_convex_voxelizer.html#ae2e20fc933cb63336b759a2e9c7520a0">sphereTop</a>(const float &amp;x0, const float &amp;y0, const float &amp;z0, const float &amp;r, const float &amp;x, const float &amp;y)</td><td class="entry"><a class="el" href="classopenvdb_1_1_o_p_e_n_v_d_b___v_e_r_s_i_o_n___n_a_m_e_1_1tools_1_1_convex_voxelizer.html">openvdb::OPENVDB_VERSION_NAME::tools::ConvexVoxelizer&lt; GridType, CapsuleVoxelizer&lt; GridType, util::NullInterrupter &gt;, util::NullInterrupter &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">static</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classopenvdb_1_1_o_p_e_n_v_d_b___v_e_r_s_i_o_n___n_a_m_e_1_1tools_1_1_convex_voxelizer.html#ad7d718ec0ae7406d36fdd5d3bcf69a3c">tileFloor</a>(const float &amp;x, const Index &amp;step)</td><td class="entry"><a class="el" href="classopenvdb_1_1_o_p_e_n_v_d_b___v_e_r_s_i_o_n___n_a_m_e_1_1tools_1_1_convex_voxelizer.html">openvdb::OPENVDB_VERSION_NAME::tools::ConvexVoxelizer&lt; GridType, CapsuleVoxelizer&lt; GridType, util::NullInterrupter &gt;, util::NullInterrupter &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classopenvdb_1_1_o_p_e_n_v_d_b___v_e_r_s_i_o_n___n_a_m_e_1_1tools_1_1_convex_voxelizer.html#abc09963c3decbceec1877fd697947bc6">tilePointSignedDistance</a>(const Vec3s &amp;p) const</td><td class="entry"><a class="el" href="classopenvdb_1_1_o_p_e_n_v_d_b___v_e_r_s_i_o_n___n_a_m_e_1_1tools_1_1_convex_voxelizer.html">openvdb::OPENVDB_VERSION_NAME::tools::ConvexVoxelizer&lt; GridType, CapsuleVoxelizer&lt; GridType, util::NullInterrupter &gt;, util::NullInterrupter &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classopenvdb_1_1_o_p_e_n_v_d_b___v_e_r_s_i_o_n___n_a_m_e_1_1tools_1_1_convex_voxelizer.html#a9e0cf6676c4c8960d2b182e006b68643">voxelSize</a>() const</td><td class="entry"><a class="el" href="classopenvdb_1_1_o_p_e_n_v_d_b___v_e_r_s_i_o_n___n_a_m_e_1_1tools_1_1_convex_voxelizer.html">openvdb::OPENVDB_VERSION_NAME::tools::ConvexVoxelizer&lt; GridType, CapsuleVoxelizer&lt; GridType, util::NullInterrupter &gt;, util::NullInterrupter &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0
</small></address>
</div><!-- doc-content -->
</body>
</html>
Loading

0 comments on commit 862333d

Please sign in to comment.