Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 267

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: csBSPTree Class Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
 <tr height="59">
  <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
  <td class="head"><h2>Public API Reference</h2></td>
 </tr>
 <tr height="11">
  <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
 </tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li class="current"><a href="classes.html"><span>Classes</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<div class="tabs">
  <ul>
    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul>
</div>
<h1>csBSPTree Class Reference<br>
<small>
[<a class="el" href="group__geom__utils.html">Geometry utilities</a>]</small>
</h1><!-- doxytag: class="csBSPTree" -->This BSP-tree is a binary tree that organizes a triangle mesh.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="bsptree_8h-source.html">csgeom/bsptree.h</a>&gt;</code>
<p>

<p>
<a href="classcsBSPTree-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <br>
<a class="el" href="classcsDirtyAccessArray.html">csDirtyAccessArray</a><br>
&lt; int &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsBSPTree.html#1900357a43ea658a759d3d0523d7ab5d">Back2Front</a> (const <a class="el" href="classcsVector3.html">csVector3</a> &amp;pos)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Traverse the tree from back to front.  <a href="#1900357a43ea658a759d3d0523d7ab5d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsBSPTree.html#0aa65e0aded3caef1627a568cae1a8e1">Build</a> (<a class="el" href="structcsTriangle.html">csTriangle</a> *triangles, int num_triangles, <a class="el" href="classcsVector3.html">csVector3</a> *vertices)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Build the BSP tree given the set of triangles.  <a href="#0aa65e0aded3caef1627a568cae1a8e1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsBSPTree.html#147b54ff47911e1e95225ab96e552913">Clear</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clear the BSP-tree.  <a href="#147b54ff47911e1e95225ab96e552913"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsBSPTree.html#b6ddd9d8922b393110ddd79929c54365">csBSPTree</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a new empty BSP-tree.  <a href="#b6ddd9d8922b393110ddd79929c54365"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsBSPTree.html#3296ec9d9d59a031fc5c3911bdae5bcc">~csBSPTree</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destroy the BSP-tree.  <a href="#3296ec9d9d59a031fc5c3911bdae5bcc"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This BSP-tree is a binary tree that organizes a triangle mesh. 
<p>
This tree will not split triangles. If a triangle needs to be split then it will be put in the two nodes. 
<p>Definition at line <a class="el" href="bsptree_8h-source.html#l00045">45</a> of file <a class="el" href="bsptree_8h-source.html">bsptree.h</a>.</p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="b6ddd9d8922b393110ddd79929c54365"></a><!-- doxytag: member="csBSPTree::csBSPTree" ref="b6ddd9d8922b393110ddd79929c54365" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">csBSPTree::csBSPTree           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create a new empty BSP-tree. 
<p>

</div>
</div><p>
<a class="anchor" name="3296ec9d9d59a031fc5c3911bdae5bcc"></a><!-- doxytag: member="csBSPTree::~csBSPTree" ref="3296ec9d9d59a031fc5c3911bdae5bcc" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">csBSPTree::~csBSPTree           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Destroy the BSP-tree. 
<p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="1900357a43ea658a759d3d0523d7ab5d"></a><!-- doxytag: member="csBSPTree::Back2Front" ref="1900357a43ea658a759d3d0523d7ab5d" args="(const csVector3 &amp;pos)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="classcsDirtyAccessArray.html">csDirtyAccessArray</a>&lt;int&gt;&amp; csBSPTree::Back2Front           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classcsVector3.html">csVector3</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>pos</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Traverse the tree from back to front. 
<p>
This will return an array containing the triangle indices in back2front order. The array will not contain double elements. 
</div>
</div><p>
<a class="anchor" name="0aa65e0aded3caef1627a568cae1a8e1"></a><!-- doxytag: member="csBSPTree::Build" ref="0aa65e0aded3caef1627a568cae1a8e1" args="(csTriangle *triangles, int num_triangles, csVector3 *vertices)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void csBSPTree::Build           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structcsTriangle.html">csTriangle</a> *&nbsp;</td>
          <td class="paramname"> <em>triangles</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>num_triangles</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classcsVector3.html">csVector3</a> *&nbsp;</td>
          <td class="paramname"> <em>vertices</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Build the BSP tree given the set of triangles. 
<p>

</div>
</div><p>
<a class="anchor" name="147b54ff47911e1e95225ab96e552913"></a><!-- doxytag: member="csBSPTree::Clear" ref="147b54ff47911e1e95225ab96e552913" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void csBSPTree::Clear           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Clear the BSP-tree. 
<p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csgeom/<a class="el" href="bsptree_8h-source.html">bsptree.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by 
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 
</small></address> </div></body> </html>