Sophie

Sophie

distrib > Fedora > 15 > i386 > by-pkgid > efd2f02d3f11cbd298bc69a2fbc20533 > files > 751

fife-doc-0.3.2-5.r2.fc15.noarch.rpm

<!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"/>
<title>FIFE: FIFE::QuadTree&lt; DataType, MinimumSize &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">FIFE&#160;<span id="projectnumber">2008.0</span></div>
  </td>
 </tr>
 </tbody>
</table>
</div>
  <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="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
      <li id="searchli">
        <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>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('class_f_i_f_e_1_1_quad_tree.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">FIFE::QuadTree&lt; DataType, MinimumSize &gt; Class Template Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="FIFE::QuadTree" -->
<p><code>#include &lt;<a class="el" href="quadtree_8h_source.html">quadtree.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for FIFE::QuadTree&lt; DataType, MinimumSize &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="class_f_i_f_e_1_1_quad_tree__inherit__graph.png" border="0" usemap="#_f_i_f_e_1_1_quad_tree_3_01_data_type_00_01_minimum_size_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="_f_i_f_e_1_1_quad_tree_3_01_data_type_00_01_minimum_size_01_4_inherit__map" id="_f_i_f_e_1_1_quad_tree_3_01_data_type_00_01_minimum_size_01_4_inherit__map">
<area shape="rect" id="node3" href="class_f_i_f_e_1_1_quad_tree.html" title="{FIFE::QuadTree\&lt; InstanceList, kTreeDepth \&gt;\n|# m_root\l# m_cursor\l|+ QuadTree()\l+ ~QuadTree()\l+ find_container()\l+ find_container()\l+ apply_visitor()\l+ clear()\l}" alt="" coords="5,261,291,451"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for FIFE::QuadTree&lt; DataType, MinimumSize &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="class_f_i_f_e_1_1_quad_tree__coll__graph.png" border="0" usemap="#_f_i_f_e_1_1_quad_tree_3_01_data_type_00_01_minimum_size_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="_f_i_f_e_1_1_quad_tree_3_01_data_type_00_01_minimum_size_01_4_coll__map" id="_f_i_f_e_1_1_quad_tree_3_01_data_type_00_01_minimum_size_01_4_coll__map">
<area shape="rect" id="node2" href="class_f_i_f_e_1_1_quad_node.html" title="{FIFE::QuadNode\&lt; DataType, MinimumSize \&gt;\n|# m_parent\l# m_nodes\l# m_x\l# m_y\l# m_size\l# m_data\l|+ QuadNode()\l+ ~QuadNode()\l+ find_container()\l+ find_container()\l+ apply_visitor()\l+ x()\l+ y()\l+ size()\l+ data()\l+ contains()\l+ splice()\l+ parent()\l+ create_parent()\l# subnode()\l}" alt="" coords="5,5,293,403"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="class_f_i_f_e_1_1_quad_tree-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_quad_tree.html#a64401058efd63c8cacb404a1dd1042bf">QuadTree</a> (int x=0, int y=0, int starting_size=MinimumSize)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_f_i_f_e_1_1_quad_node.html">Node</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_quad_tree.html#afdc1f13dd541c3a3f4bc15931fa904d0">find_container</a> (int x, int y, int w, int h)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename Visitor &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">Visitor &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_quad_tree.html#ac7b360cca7f7cc45e594bcca7e4aeeac">apply_visitor</a> (Visitor &amp;visitor)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename DataType, int MinimumSize = 128&gt;<br/>
class FIFE::QuadTree&lt; DataType, MinimumSize &gt;</h3>

<p>Dynamic <a class="el" href="class_f_i_f_e_1_1_quad_tree.html">QuadTree</a> A space partitioning tree automatically expanding to adjust to any object size put into the data structure. </p>

<p>Definition at line <a class="el" href="quadtree_8h_source.html#l00150">150</a> of file <a class="el" href="quadtree_8h_source.html">quadtree.h</a>.</p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a64401058efd63c8cacb404a1dd1042bf"></a><!-- doxytag: member="FIFE::QuadTree::QuadTree" ref="a64401058efd63c8cacb404a1dd1042bf" args="(int x=0, int y=0, int starting_size=MinimumSize)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename DataType, int MinimumSize = 128&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_f_i_f_e_1_1_quad_tree.html">FIFE::QuadTree</a>&lt; DataType, MinimumSize &gt;::<a class="el" href="class_f_i_f_e_1_1_quad_tree.html">QuadTree</a> </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>x</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>y</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>starting_size</em> = <code>MinimumSize</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Create a new <a class="el" href="class_f_i_f_e_1_1_quad_tree.html">QuadTree</a> </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">x</td><td>The X position of the starting node. </td></tr>
    <tr><td class="paramname">y</td><td>The Y position of the starting node. </td></tr>
    <tr><td class="paramname">starting_size</td><td>The width and height of the starting node. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="quadtree_8h_source.html#l00159">159</a> of file <a class="el" href="quadtree_8h_source.html">quadtree.h</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ac7b360cca7f7cc45e594bcca7e4aeeac"></a><!-- doxytag: member="FIFE::QuadTree::apply_visitor" ref="ac7b360cca7f7cc45e594bcca7e4aeeac" args="(Visitor &amp;visitor)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename DataType, int MinimumSize = 128&gt; </div>
<div class="memtemplate">
template&lt;typename Visitor &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">Visitor&amp; <a class="el" href="class_f_i_f_e_1_1_quad_tree.html">FIFE::QuadTree</a>&lt; DataType, MinimumSize &gt;::apply_visitor </td>
          <td>(</td>
          <td class="paramtype">Visitor &amp;&#160;</td>
          <td class="paramname"><em>visitor</em></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Apply a visitor recursively to the <a class="el" href="class_f_i_f_e_1_1_quad_tree.html">QuadTree</a> </p>

<p>Definition at line <a class="el" href="quadtree_8h_source.html#l00190">190</a> of file <a class="el" href="quadtree_8h_source.html">quadtree.h</a>.</p>

</div>
</div>
<a class="anchor" id="afdc1f13dd541c3a3f4bc15931fa904d0"></a><!-- doxytag: member="FIFE::QuadTree::find_container" ref="afdc1f13dd541c3a3f4bc15931fa904d0" args="(int x, int y, int w, int h)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename DataType , int MinimumSize&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_f_i_f_e_1_1_quad_node.html">QuadNode</a>&lt; DataType, MinimumSize &gt; * <a class="el" href="class_f_i_f_e_1_1_quad_tree.html">FIFE::QuadTree</a>&lt; DataType, MinimumSize &gt;::find_container </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>y</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>w</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>h</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Find a container node for a given rectangle. This guarantees to return a Node with the following properties: 1.) The node contains the rectangle (as defined by the contains function). 2.) All subnodes can not contain the rectangle or it has the MinimumSize. This function will extend the tree automatically so that this guarantee can be fulfilled. This function is optimized for sequential access. This means accessing different rectangles that are 'near' to each other will be fast. </p>
<dl class="warning"><dt><b>Warning:</b></dt><dd>If you put different sized objects in (for example) lists in the quadnode, the returned node will <b>not</b> contain all objects which might intersect with the given rectangle. </dd></dl>

<p>Definition at line <a class="el" href="quadtree_8h_source.html#l00359">359</a> of file <a class="el" href="quadtree_8h_source.html">quadtree.h</a>.</p>

<p>References <a class="el" href="quadtree_8h_source.html#l00298">FIFE::QuadNode&lt; DataType, MinimumSize &gt;::create_parent()</a>, and <a class="el" href="quadtree_8h_source.html#l00254">FIFE::QuadNode&lt; DataType, MinimumSize &gt;::find_container()</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>engine/core/util/structures/<a class="el" href="quadtree_8h_source.html">quadtree.h</a></li>
</ul>
</div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="namespace_f_i_f_e.html">FIFE</a>      </li>
      <li class="navelem"><a class="el" href="class_f_i_f_e_1_1_quad_tree.html">QuadTree</a>      </li>
      <li class="footer">Generated on Sun Jul 10 2011 for FIFE by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </li>
    </ul>
  </div>
<!-- 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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</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>


</body>
</html>