<!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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Box2D: b2DynamicTree Class 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="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 style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="icon.gif"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Box2D
 <span id="projectnumber">2.3.0</span>
</div>
<div id="projectbrief">A 2D Physics Engine for Games</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classb2_dynamic_tree-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">b2DynamicTree Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="b2_dynamic_tree_8h_source.html">b2DynamicTree.h</a>></code></p>
<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:a8af64cf6a1566fa4c5b5c9683bd937d9"><td class="memItemLeft" align="right" valign="top"><a id="a8af64cf6a1566fa4c5b5c9683bd937d9"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classb2_dynamic_tree.html#a8af64cf6a1566fa4c5b5c9683bd937d9">b2DynamicTree</a> ()</td></tr>
<tr class="memdesc:a8af64cf6a1566fa4c5b5c9683bd937d9"><td class="mdescLeft"> </td><td class="mdescRight">Constructing the tree initializes the node pool. <br /></td></tr>
<tr class="separator:a8af64cf6a1566fa4c5b5c9683bd937d9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9060565fc63b4dd87d9560775c076786"><td class="memItemLeft" align="right" valign="top"><a id="a9060565fc63b4dd87d9560775c076786"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classb2_dynamic_tree.html#a9060565fc63b4dd87d9560775c076786">~b2DynamicTree</a> ()</td></tr>
<tr class="memdesc:a9060565fc63b4dd87d9560775c076786"><td class="mdescLeft"> </td><td class="mdescRight">Destroy the tree, freeing the node pool. <br /></td></tr>
<tr class="separator:a9060565fc63b4dd87d9560775c076786"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae44676f12977dada46037da47fc7ffbf"><td class="memItemLeft" align="right" valign="top"><a id="ae44676f12977dada46037da47fc7ffbf"></a>
int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classb2_dynamic_tree.html#ae44676f12977dada46037da47fc7ffbf">CreateProxy</a> (const <a class="el" href="structb2_a_a_b_b.html">b2AABB</a> &aabb, void *userData)</td></tr>
<tr class="memdesc:ae44676f12977dada46037da47fc7ffbf"><td class="mdescLeft"> </td><td class="mdescRight">Create a proxy. Provide a tight fitting AABB and a userData pointer. <br /></td></tr>
<tr class="separator:ae44676f12977dada46037da47fc7ffbf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a62aa451e7d7fe029818dd05f76ea9cdc"><td class="memItemLeft" align="right" valign="top"><a id="a62aa451e7d7fe029818dd05f76ea9cdc"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classb2_dynamic_tree.html#a62aa451e7d7fe029818dd05f76ea9cdc">DestroyProxy</a> (int32 proxyId)</td></tr>
<tr class="memdesc:a62aa451e7d7fe029818dd05f76ea9cdc"><td class="mdescLeft"> </td><td class="mdescRight">Destroy a proxy. This asserts if the id is invalid. <br /></td></tr>
<tr class="separator:a62aa451e7d7fe029818dd05f76ea9cdc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7748252811f3c575015931399cbe4daa"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classb2_dynamic_tree.html#a7748252811f3c575015931399cbe4daa">MoveProxy</a> (int32 proxyId, const <a class="el" href="structb2_a_a_b_b.html">b2AABB</a> &aabb1, const <a class="el" href="structb2_vec2.html">b2Vec2</a> &displacement)</td></tr>
<tr class="separator:a7748252811f3c575015931399cbe4daa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa8399f9440707780f267696098e8b920"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classb2_dynamic_tree.html#aa8399f9440707780f267696098e8b920">GetUserData</a> (int32 proxyId) const</td></tr>
<tr class="separator:aa8399f9440707780f267696098e8b920"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a655b9ddff43e4e0a34a372eddc03ecb9"><td class="memItemLeft" align="right" valign="top"><a id="a655b9ddff43e4e0a34a372eddc03ecb9"></a>
const <a class="el" href="structb2_a_a_b_b.html">b2AABB</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classb2_dynamic_tree.html#a655b9ddff43e4e0a34a372eddc03ecb9">GetFatAABB</a> (int32 proxyId) const</td></tr>
<tr class="memdesc:a655b9ddff43e4e0a34a372eddc03ecb9"><td class="mdescLeft"> </td><td class="mdescRight">Get the fat AABB for a proxy. <br /></td></tr>
<tr class="separator:a655b9ddff43e4e0a34a372eddc03ecb9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a324df3eb65dfc22d3dcdca387737b193"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
<tr class="memitem:a324df3eb65dfc22d3dcdca387737b193"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classb2_dynamic_tree.html#a324df3eb65dfc22d3dcdca387737b193">Query</a> (T *callback, const <a class="el" href="structb2_a_a_b_b.html">b2AABB</a> &aabb) const</td></tr>
<tr class="separator:a324df3eb65dfc22d3dcdca387737b193"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aebd2dc6ee462e0cd0763a5f472243a13"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
<tr class="memitem:aebd2dc6ee462e0cd0763a5f472243a13"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classb2_dynamic_tree.html#aebd2dc6ee462e0cd0763a5f472243a13">RayCast</a> (T *callback, const <a class="el" href="structb2_ray_cast_input.html">b2RayCastInput</a> &input) const</td></tr>
<tr class="separator:aebd2dc6ee462e0cd0763a5f472243a13"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae9b989f0c04e38f9c940623d4e1728b9"><td class="memItemLeft" align="right" valign="top"><a id="ae9b989f0c04e38f9c940623d4e1728b9"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classb2_dynamic_tree.html#ae9b989f0c04e38f9c940623d4e1728b9">Validate</a> () const</td></tr>
<tr class="memdesc:ae9b989f0c04e38f9c940623d4e1728b9"><td class="mdescLeft"> </td><td class="mdescRight">Validate this tree. For testing. <br /></td></tr>
<tr class="separator:ae9b989f0c04e38f9c940623d4e1728b9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae3c7dc771d596f1f95fd3a3d7f2f3e97"><td class="memItemLeft" align="right" valign="top">int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classb2_dynamic_tree.html#ae3c7dc771d596f1f95fd3a3d7f2f3e97">GetHeight</a> () const</td></tr>
<tr class="separator:ae3c7dc771d596f1f95fd3a3d7f2f3e97"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3feab170229e0acd17f6a4ad3fca406e"><td class="memItemLeft" align="right" valign="top">int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classb2_dynamic_tree.html#a3feab170229e0acd17f6a4ad3fca406e">GetMaxBalance</a> () const</td></tr>
<tr class="separator:a3feab170229e0acd17f6a4ad3fca406e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a87da9819c4f190faec38f7fe4608caae"><td class="memItemLeft" align="right" valign="top"><a id="a87da9819c4f190faec38f7fe4608caae"></a>
float32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classb2_dynamic_tree.html#a87da9819c4f190faec38f7fe4608caae">GetAreaRatio</a> () const</td></tr>
<tr class="memdesc:a87da9819c4f190faec38f7fe4608caae"><td class="mdescLeft"> </td><td class="mdescRight">Get the ratio of the sum of the node areas to the root area. <br /></td></tr>
<tr class="separator:a87da9819c4f190faec38f7fe4608caae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abd146017cfec1cf5ea7b87331f30a3ff"><td class="memItemLeft" align="right" valign="top"><a id="abd146017cfec1cf5ea7b87331f30a3ff"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classb2_dynamic_tree.html#abd146017cfec1cf5ea7b87331f30a3ff">RebuildBottomUp</a> ()</td></tr>
<tr class="memdesc:abd146017cfec1cf5ea7b87331f30a3ff"><td class="mdescLeft"> </td><td class="mdescRight">Build an optimal tree. Very expensive. For testing. <br /></td></tr>
<tr class="separator:abd146017cfec1cf5ea7b87331f30a3ff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af37ddfed6a5da97d5a78b09918d19ceb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classb2_dynamic_tree.html#af37ddfed6a5da97d5a78b09918d19ceb">ShiftOrigin</a> (const <a class="el" href="structb2_vec2.html">b2Vec2</a> &newOrigin)</td></tr>
<tr class="separator:af37ddfed6a5da97d5a78b09918d19ceb"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A dynamic AABB tree broad-phase, inspired by Nathanael Presson's btDbvt. A dynamic tree arranges data in a binary tree to accelerate queries such as volume queries and ray casts. Leafs are proxies with an AABB. In the tree we expand the proxy AABB by b2_fatAABBFactor so that the proxy AABB is bigger than the client object. This allows the client object to move by small amounts without triggering a tree update.</p>
<p>Nodes are pooled and relocatable, so we use node indices rather than pointers. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ae3c7dc771d596f1f95fd3a3d7f2f3e97"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae3c7dc771d596f1f95fd3a3d7f2f3e97">◆ </a></span>GetHeight()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32 b2DynamicTree::GetHeight </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Compute the height of the binary tree in O(N) time. Should not be called often. </p>
</div>
</div>
<a id="a3feab170229e0acd17f6a4ad3fca406e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3feab170229e0acd17f6a4ad3fca406e">◆ </a></span>GetMaxBalance()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32 b2DynamicTree::GetMaxBalance </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the maximum balance of an node in the tree. The balance is the difference in height of the two children of a node. </p>
</div>
</div>
<a id="aa8399f9440707780f267696098e8b920"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8399f9440707780f267696098e8b920">◆ </a></span>GetUserData()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void * b2DynamicTree::GetUserData </td>
<td>(</td>
<td class="paramtype">int32 </td>
<td class="paramname"><em>proxyId</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">
<p>Get proxy user data. </p><dl class="section return"><dt>Returns</dt><dd>the proxy user data or 0 if the id is invalid. </dd></dl>
</div>
</div>
<a id="a7748252811f3c575015931399cbe4daa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7748252811f3c575015931399cbe4daa">◆ </a></span>MoveProxy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool b2DynamicTree::MoveProxy </td>
<td>(</td>
<td class="paramtype">int32 </td>
<td class="paramname"><em>proxyId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structb2_a_a_b_b.html">b2AABB</a> & </td>
<td class="paramname"><em>aabb1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structb2_vec2.html">b2Vec2</a> & </td>
<td class="paramname"><em>displacement</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Move a proxy with a swepted AABB. If the proxy has moved outside of its fattened AABB, then the proxy is removed from the tree and re-inserted. Otherwise the function returns immediately. </p><dl class="section return"><dt>Returns</dt><dd>true if the proxy was re-inserted. </dd></dl>
</div>
</div>
<a id="a324df3eb65dfc22d3dcdca387737b193"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a324df3eb65dfc22d3dcdca387737b193">◆ </a></span>Query()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void b2DynamicTree::Query </td>
<td>(</td>
<td class="paramtype">T * </td>
<td class="paramname"><em>callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structb2_a_a_b_b.html">b2AABB</a> & </td>
<td class="paramname"><em>aabb</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>Query an AABB for overlapping proxies. The callback class is called for each proxy that overlaps the supplied AABB. </p>
</div>
</div>
<a id="aebd2dc6ee462e0cd0763a5f472243a13"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aebd2dc6ee462e0cd0763a5f472243a13">◆ </a></span>RayCast()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void b2DynamicTree::RayCast </td>
<td>(</td>
<td class="paramtype">T * </td>
<td class="paramname"><em>callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structb2_ray_cast_input.html">b2RayCastInput</a> & </td>
<td class="paramname"><em>input</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>Ray-cast against the proxies in the tree. This relies on the callback to perform a exact ray-cast in the case were the proxy contains a shape. The callback also performs the any collision filtering. This has performance roughly equal to k * log(n), where k is the number of collisions and n is the number of proxies in the tree. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">input</td><td>the ray-cast input data. The ray extends from p1 to p1 + maxFraction * (p2 - p1). </td></tr>
<tr><td class="paramname">callback</td><td>a callback class that is called for each proxy that is hit by the ray. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af37ddfed6a5da97d5a78b09918d19ceb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af37ddfed6a5da97d5a78b09918d19ceb">◆ </a></span>ShiftOrigin()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void b2DynamicTree::ShiftOrigin </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structb2_vec2.html">b2Vec2</a> & </td>
<td class="paramname"><em>newOrigin</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Shift the world origin. Useful for large worlds. The shift formula is: position -= newOrigin </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">newOrigin</td><td>the new origin with respect to the old origin </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="b2_dynamic_tree_8h_source.html">b2DynamicTree.h</a></li>
<li>b2DynamicTree.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Sep 21 2018 22:35:07 for Box2D by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
deebb45492ddfb87b1d0b33e0be8a2b3
>
files
>
158
