<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>Eigen-unsupported: KdBVH< _Scalar, _Dim, _Object > Class Template Reference</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="eigendoxy.css" rel="stylesheet" type="text/css">
<!-- -->
<script type="text/javascript" src="eigen_navtree_hacks.js"></script>
<!-- <script type="text/javascript"> -->
<!-- </script> -->
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<!-- <a name="top"></a> -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="Eigen_Silly_Professor_64x64.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname"><a href="http://eigen.tuxfamily.org">Eigen-unsupported</a>
 <span id="projectnumber">3.2.0</span>
</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classEigen_1_1KdBVH.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="classEigen_1_1KdBVH-members.html">List of all members</a> |
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">KdBVH< _Scalar, _Dim, _Object > Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template<typename _Scalar, int _Dim, typename _Object><br/>
class Eigen::KdBVH< _Scalar, _Dim, _Object ></h3>
<p>A simple bounding volume hierarchy based on AlignedBox. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">_Scalar</td><td>The underlying scalar type of the bounding boxes </td></tr>
<tr><td class="paramname">_Dim</td><td>The dimension of the space in which the hierarchy lives </td></tr>
<tr><td class="paramname">_Object</td><td>The object type that lives in the hierarchy. It must have value semantics. Either bounding_box(_Object) must be defined and return an AlignedBox<_Scalar, _Dim> or bounding boxes must be provided to the tree initializer.</td></tr>
</table>
</dd>
</dl>
<p>This class provides a simple (as opposed to optimized) implementation of a bounding volume hierarchy analogous to a Kd-tree. Given a sequence of objects, it computes their bounding boxes, constructs a Kd-tree of their centers and builds a BVH with the structure of that Kd-tree. When the elements of the tree are too expensive to be copied around, it is useful for _Object to be a pointer. </p>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a88354e0fefc749d13640a60ffe30e850"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1KdBVH.html#a88354e0fefc749d13640a60ffe30e850">getChildren</a> (Index index, VolumeIterator &outVBegin, VolumeIterator &outVEnd, ObjectIterator &outOBegin, ObjectIterator &outOEnd) const </td></tr>
<tr class="separator:a88354e0fefc749d13640a60ffe30e850"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6e92e01e1caffcf76e051860ba193d8d"><td class="memItemLeft" align="right" valign="top">Index </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1KdBVH.html#a6e92e01e1caffcf76e051860ba193d8d">getRootIndex</a> () const </td></tr>
<tr class="separator:a6e92e01e1caffcf76e051860ba193d8d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af0be37ad63c87fd0f84f032bdb80534f"><td class="memItemLeft" align="right" valign="top">const Volume & </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1KdBVH.html#af0be37ad63c87fd0f84f032bdb80534f">getVolume</a> (Index index) const </td></tr>
<tr class="separator:af0be37ad63c87fd0f84f032bdb80534f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a89e898247922e6e4e1db057a626225a0"><td class="memTemplParams" colspan="2">template<typename Iter > </td></tr>
<tr class="memitem:a89e898247922e6e4e1db057a626225a0"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classEigen_1_1KdBVH.html#a89e898247922e6e4e1db057a626225a0">init</a> (Iter begin, Iter end)</td></tr>
<tr class="separator:a89e898247922e6e4e1db057a626225a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a92efd52a33d4228274c5f1896ed94b68"><td class="memTemplParams" colspan="2">template<typename OIter , typename BIter > </td></tr>
<tr class="memitem:a92efd52a33d4228274c5f1896ed94b68"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classEigen_1_1KdBVH.html#a92efd52a33d4228274c5f1896ed94b68">init</a> (OIter begin, OIter end, BIter boxBegin, BIter boxEnd)</td></tr>
<tr class="separator:a92efd52a33d4228274c5f1896ed94b68"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4338491d2b517c9db2267dc16d18f548"><td class="memTemplParams" colspan="2">template<typename Iter > </td></tr>
<tr class="memitem:a4338491d2b517c9db2267dc16d18f548"><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classEigen_1_1KdBVH.html#a4338491d2b517c9db2267dc16d18f548">KdBVH</a> (Iter begin, Iter end)</td></tr>
<tr class="separator:a4338491d2b517c9db2267dc16d18f548"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2665b91b46996e439b716671d5d92c6f"><td class="memTemplParams" colspan="2">template<typename OIter , typename BIter > </td></tr>
<tr class="memitem:a2665b91b46996e439b716671d5d92c6f"><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classEigen_1_1KdBVH.html#a2665b91b46996e439b716671d5d92c6f">KdBVH</a> (OIter begin, OIter end, BIter boxBegin, BIter boxEnd)</td></tr>
<tr class="separator:a2665b91b46996e439b716671d5d92c6f"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a4338491d2b517c9db2267dc16d18f548"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classEigen_1_1KdBVH.html">KdBVH</a> </td>
<td>(</td>
<td class="paramtype">Iter </td>
<td class="paramname"><em>begin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Iter </td>
<td class="paramname"><em>end</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Given an iterator range over <em>Object</em> references, constructs the BVH. Requires that bounding_box(Object) return a Volume. </p>
<p>References <a class="el" href="classEigen_1_1KdBVH.html#a89e898247922e6e4e1db057a626225a0">KdBVH< _Scalar, _Dim, _Object >::init()</a>.</p>
</div>
</div>
<a class="anchor" id="a2665b91b46996e439b716671d5d92c6f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classEigen_1_1KdBVH.html">KdBVH</a> </td>
<td>(</td>
<td class="paramtype">OIter </td>
<td class="paramname"><em>begin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">OIter </td>
<td class="paramname"><em>end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">BIter </td>
<td class="paramname"><em>boxBegin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">BIter </td>
<td class="paramname"><em>boxEnd</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Given an iterator range over <em>Object</em> references and an iterator range over their bounding boxes, constructs the BVH </p>
<p>References <a class="el" href="classEigen_1_1KdBVH.html#a89e898247922e6e4e1db057a626225a0">KdBVH< _Scalar, _Dim, _Object >::init()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a88354e0fefc749d13640a60ffe30e850"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void getChildren </td>
<td>(</td>
<td class="paramtype">Index </td>
<td class="paramname"><em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">VolumeIterator & </td>
<td class="paramname"><em>outVBegin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">VolumeIterator & </td>
<td class="paramname"><em>outVEnd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ObjectIterator & </td>
<td class="paramname"><em>outOBegin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ObjectIterator & </td>
<td class="paramname"><em>outOEnd</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Given an <em>index</em> of a node, on exit, <em>outVBegin</em> and <em>outVEnd</em> range over the indices of the volume children of the node and <em>outOBegin</em> and <em>outOEnd</em> range over the object children of the node </p>
</div>
</div>
<a class="anchor" id="a6e92e01e1caffcf76e051860ba193d8d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Index getRootIndex </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the index of the root of the hierarchy </dd></dl>
</div>
</div>
<a class="anchor" id="af0be37ad63c87fd0f84f032bdb80534f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const Volume& getVolume </td>
<td>(</td>
<td class="paramtype">Index </td>
<td class="paramname"><em>index</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the bounding box of the node at <em>index</em> </dd></dl>
</div>
</div>
<a class="anchor" id="a89e898247922e6e4e1db057a626225a0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void init </td>
<td>(</td>
<td class="paramtype">Iter </td>
<td class="paramname"><em>begin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Iter </td>
<td class="paramname"><em>end</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Given an iterator range over <em>Object</em> references, constructs the BVH, overwriting whatever is in there currently. Requires that bounding_box(Object) return a Volume. </p>
<p>References <a class="el" href="classEigen_1_1KdBVH.html#a89e898247922e6e4e1db057a626225a0">KdBVH< _Scalar, _Dim, _Object >::init()</a>.</p>
<p>Referenced by <a class="el" href="classEigen_1_1KdBVH.html#a89e898247922e6e4e1db057a626225a0">KdBVH< _Scalar, _Dim, _Object >::init()</a>, and <a class="el" href="classEigen_1_1KdBVH.html#a4338491d2b517c9db2267dc16d18f548">KdBVH< _Scalar, _Dim, _Object >::KdBVH()</a>.</p>
</div>
</div>
<a class="anchor" id="a92efd52a33d4228274c5f1896ed94b68"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void init </td>
<td>(</td>
<td class="paramtype">OIter </td>
<td class="paramname"><em>begin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">OIter </td>
<td class="paramname"><em>end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">BIter </td>
<td class="paramname"><em>boxBegin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">BIter </td>
<td class="paramname"><em>boxEnd</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Given an iterator range over <em>Object</em> references and an iterator range over their bounding boxes, constructs the BVH, overwriting whatever is in there currently. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="KdBVH_8h_source.html">KdBVH.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespaceEigen.html">Eigen</a></li><li class="navelem"><a class="el" href="classEigen_1_1KdBVH.html">KdBVH</a></li>
<li class="footer">Generated on Mon Oct 28 2013 11:05:27 for Eigen-unsupported by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
</ul>
</div>
<!-- Piwik -->
<!--
<script type="text/javascript">
var pkBaseURL = (("https:" == document.location.protocol) ? "https://stats.sylphide-consulting.com/piwik/" : "http://stats.sylphide-consulting.com/piwik/");
document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));
</script><script type="text/javascript">
try {
var piwikTracker = Piwik.getTracker(pkBaseURL + "piwik.php", 20);
piwikTracker.trackPageView();
piwikTracker.enableLinkTracking();
} catch( err ) {}
</script><noscript><p><img src="http://stats.sylphide-consulting.com/piwik/piwik.php?idsite=20" style="border:0" alt="" /></p></noscript>
-->
<!-- End Piwik Tracking Code -->
</body>
</html>
