Sophie

Sophie

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

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: iBodyGroup Struct 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>iBodyGroup Struct Reference</h1><!-- doxytag: class="iBodyGroup" --><!-- doxytag: inherits="iBase" -->Body Group is a collection of bodies which don't collide with each other.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="dynamics_8h-source.html">ivaria/dynamics.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for iBodyGroup:</div>
<div class="dynsection">
<p><center><img src="structiBodyGroup__inherit__graph.png" border="0" usemap="#iBodyGroup__inherit__map" alt="Inheritance graph"></center>
<map name="iBodyGroup__inherit__map">
<area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="25,7,81,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="structiBodyGroup-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">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiBodyGroup.html#bd3b81009beb639e6c196938172bbbf7">AddBody</a> (<a class="el" href="structiRigidBody.html">iRigidBody</a> *body)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds a body to this group.  <a href="#bd3b81009beb639e6c196938172bbbf7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiBodyGroup.html#530db8a86458d230ed452c955fd3ef93">BodyInGroup</a> (<a class="el" href="structiRigidBody.html">iRigidBody</a> *body)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Tells whether the body is in this group or not.  <a href="#530db8a86458d230ed452c955fd3ef93"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiBodyGroup.html#6fcc1d79029c7c0c3d5b6681f8ac5598">RemoveBody</a> (<a class="el" href="structiRigidBody.html">iRigidBody</a> *body)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Removes a body from this group.  <a href="#6fcc1d79029c7c0c3d5b6681f8ac5598"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Body Group is a collection of bodies which don't collide with each other. 
<p>
This can speed up processing by manually avoiding certain collisions. For instance if you have a car built of many different bodies. The bodies can be collected into a group and the car will be treated as a single object.<p>
Main creators of instances implementing this interface:<ul>
<li><a class="el" href="structiDynamicSystem.html#2e3319edfec1797abc82a3112ca71998" title="Create a body group. Bodies in a group don&#39;t collide with each other.">iDynamicSystem::CreateGroup()</a></li></ul>
<p>
Main ways to get pointers to this interface:<ul>
<li><a class="el" href="structiRigidBody.html#1fdea1c1e51dfa11b26a8740fb868cf5" title="Returns which group a body belongs to.">iRigidBody::GetGroup()</a></li></ul>
<p>
Main users of this interface:<ul>
<li><a class="el" href="structiDynamicSystem.html" title="This is the interface for the dynamics core.">iDynamicSystem</a> </li></ul>

<p>Definition at line <a class="el" href="dynamics_8h-source.html#l00355">355</a> of file <a class="el" href="dynamics_8h-source.html">dynamics.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="bd3b81009beb639e6c196938172bbbf7"></a><!-- doxytag: member="iBodyGroup::AddBody" ref="bd3b81009beb639e6c196938172bbbf7" args="(iRigidBody *body)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iBodyGroup::AddBody           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiRigidBody.html">iRigidBody</a> *&nbsp;</td>
          <td class="paramname"> <em>body</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Adds a body to this group. 
<p>

</div>
</div><p>
<a class="anchor" name="530db8a86458d230ed452c955fd3ef93"></a><!-- doxytag: member="iBodyGroup::BodyInGroup" ref="530db8a86458d230ed452c955fd3ef93" args="(iRigidBody *body)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool iBodyGroup::BodyInGroup           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiRigidBody.html">iRigidBody</a> *&nbsp;</td>
          <td class="paramname"> <em>body</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Tells whether the body is in this group or not. 
<p>

</div>
</div><p>
<a class="anchor" name="6fcc1d79029c7c0c3d5b6681f8ac5598"></a><!-- doxytag: member="iBodyGroup::RemoveBody" ref="6fcc1d79029c7c0c3d5b6681f8ac5598" args="(iRigidBody *body)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iBodyGroup::RemoveBody           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiRigidBody.html">iRigidBody</a> *&nbsp;</td>
          <td class="paramname"> <em>body</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Removes a body from this group. 
<p>

</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>ivaria/<a class="el" href="dynamics_8h-source.html">dynamics.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>