Sophie

Sophie

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

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: csOBBFrozen 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>csOBBFrozen Class Reference<br>
<small>
[<a class="el" href="group__geom__utils.html">Geometry utilities</a>]</small>
</h1><!-- doxytag: class="csOBBFrozen" -->Version of the <a class="el" href="classcsOBB.html" title="Oriented bounding box (OBB).">csOBB</a> with frozen corners (for optimization purposes).  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="obb_8h-source.html">csgeom/obb.h</a>&gt;</code>
<p>

<p>
<a href="classcsOBBFrozen-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">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsOBBFrozen.html#e2a12214d87918fdcb3507a8d319cce2">Copy</a> (const <a class="el" href="classcsOBB.html">csOBB</a> &amp;obb, const <a class="el" href="classcsReversibleTransform.html">csReversibleTransform</a> &amp;trans)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copy a normal OBB and freeze the corners.  <a href="#e2a12214d87918fdcb3507a8d319cce2"></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="classcsOBBFrozen.html#026eb209f2e67cefb7e91f150d3dee4d">Copy</a> (const <a class="el" href="classcsOBB.html">csOBB</a> &amp;obb)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copy a normal OBB and freeze the corners.  <a href="#026eb209f2e67cefb7e91f150d3dee4d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsOBBFrozen.html#9168c804f388ab994363a1da76968414">csOBBFrozen</a> (const <a class="el" href="classcsOBB.html">csOBB</a> &amp;obb, const <a class="el" href="classcsReversibleTransform.html">csReversibleTransform</a> &amp;trans)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a frozen OBB from a normal OBB.  <a href="#9168c804f388ab994363a1da76968414"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsOBBFrozen.html#0fb32200a431f765186fd8ffe7974654">csOBBFrozen</a> (const <a class="el" href="classcsOBB.html">csOBB</a> &amp;obb)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a frozen OBB from a normal OBB.  <a href="#0fb32200a431f765186fd8ffe7974654"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsOBBFrozen.html#c9f7687915d88215e567de2aec977fd3">csOBBFrozen</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create an empty <a class="el" href="classcsOBBFrozen.html" title="Version of the csOBB with frozen corners (for optimization purposes).">csOBBFrozen</a> which is not initialized.  <a href="#c9f7687915d88215e567de2aec977fd3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classcsVector3.html">csVector3</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsOBBFrozen.html#c39390dc6ce5996d99ef14c7adfcadc5">GetCorner</a> (int corner) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get one corner from the OBB.  <a href="#c39390dc6ce5996d99ef14c7adfcadc5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsOBBFrozen.html#4757e0809b051029b8f99fe391798be0">ProjectOBB</a> (float fov, float sx, float sy, <a class="el" href="classcsBox2.html">csBox2</a> &amp;sbox, float &amp;min_z, float &amp;max_z)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Project this OBB to a 2D screen space box.  <a href="#4757e0809b051029b8f99fe391798be0"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Version of the <a class="el" href="classcsOBB.html" title="Oriented bounding box (OBB).">csOBB</a> with frozen corners (for optimization purposes). 
<p>Definition at line <a class="el" href="obb_8h-source.html#l00117">117</a> of file <a class="el" href="obb_8h-source.html">obb.h</a>.</p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="c9f7687915d88215e567de2aec977fd3"></a><!-- doxytag: member="csOBBFrozen::csOBBFrozen" ref="c9f7687915d88215e567de2aec977fd3" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">csOBBFrozen::csOBBFrozen           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create an empty <a class="el" href="classcsOBBFrozen.html" title="Version of the csOBB with frozen corners (for optimization purposes).">csOBBFrozen</a> which is not initialized. 
<p>

<p>Definition at line <a class="el" href="obb_8h-source.html#l00142">142</a> of file <a class="el" href="obb_8h-source.html">obb.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="0fb32200a431f765186fd8ffe7974654"></a><!-- doxytag: member="csOBBFrozen::csOBBFrozen" ref="0fb32200a431f765186fd8ffe7974654" args="(const csOBB &amp;obb)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">csOBBFrozen::csOBBFrozen           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classcsOBB.html">csOBB</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>obb</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create a frozen OBB from a normal OBB. 
<p>

<p>Definition at line <a class="el" href="obb_8h-source.html#l00149">149</a> of file <a class="el" href="obb_8h-source.html">obb.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="9168c804f388ab994363a1da76968414"></a><!-- doxytag: member="csOBBFrozen::csOBBFrozen" ref="9168c804f388ab994363a1da76968414" args="(const csOBB &amp;obb, const csReversibleTransform &amp;trans)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">csOBBFrozen::csOBBFrozen           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classcsOBB.html">csOBB</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>obb</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classcsReversibleTransform.html">csReversibleTransform</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>trans</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create a frozen OBB from a normal OBB. 
<p>
The given transform is applied to the vertices AFTER the matrix of the obb is applied (using Other2This). 
<p>Definition at line <a class="el" href="obb_8h-source.html#l00160">160</a> of file <a class="el" href="obb_8h-source.html">obb.h</a>.</p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e2a12214d87918fdcb3507a8d319cce2"></a><!-- doxytag: member="csOBBFrozen::Copy" ref="e2a12214d87918fdcb3507a8d319cce2" args="(const csOBB &amp;obb, const csReversibleTransform &amp;trans)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void csOBBFrozen::Copy           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classcsOBB.html">csOBB</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>obb</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classcsReversibleTransform.html">csReversibleTransform</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>trans</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>
Copy a normal OBB and freeze the corners. 
<p>

</div>
</div><p>
<a class="anchor" name="026eb209f2e67cefb7e91f150d3dee4d"></a><!-- doxytag: member="csOBBFrozen::Copy" ref="026eb209f2e67cefb7e91f150d3dee4d" args="(const csOBB &amp;obb)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void csOBBFrozen::Copy           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classcsOBB.html">csOBB</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>obb</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Copy a normal OBB and freeze the corners. 
<p>

<p>Definition at line <a class="el" href="obb_8h-source.html#l00126">126</a> of file <a class="el" href="obb_8h-source.html">obb.h</a>.</p>

<p>References <a class="el" href="classcsOBB.html#cc55bb882adf052b7342128c130ccf2a">csOBB::GetCorner()</a>.</p>

</div>
</div><p>
<a class="anchor" name="c39390dc6ce5996d99ef14c7adfcadc5"></a><!-- doxytag: member="csOBBFrozen::GetCorner" ref="c39390dc6ce5996d99ef14c7adfcadc5" args="(int corner) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="classcsVector3.html">csVector3</a>&amp; csOBBFrozen::GetCorner           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>corner</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get one corner from the OBB. 
<p>

<p>Definition at line <a class="el" href="obb_8h-source.html#l00168">168</a> of file <a class="el" href="obb_8h-source.html">obb.h</a>.</p>

<p>References <a class="el" href="cssysdef_8h.html#c380bd47888ecfe73e7b7a40b6f827a1">CS_ASSERT</a>.</p>

</div>
</div><p>
<a class="anchor" name="4757e0809b051029b8f99fe391798be0"></a><!-- doxytag: member="csOBBFrozen::ProjectOBB" ref="4757e0809b051029b8f99fe391798be0" args="(float fov, float sx, float sy, csBox2 &amp;sbox, float &amp;min_z, float &amp;max_z)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool csOBBFrozen::ProjectOBB           </td>
          <td>(</td>
          <td class="paramtype">float&nbsp;</td>
          <td class="paramname"> <em>fov</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&nbsp;</td>
          <td class="paramname"> <em>sx</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&nbsp;</td>
          <td class="paramname"> <em>sy</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classcsBox2.html">csBox2</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>sbox</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float &amp;&nbsp;</td>
          <td class="paramname"> <em>min_z</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float &amp;&nbsp;</td>
          <td class="paramname"> <em>max_z</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>
Project this OBB to a 2D screen space box. 
<p>
Returns false if OBB is not on screen. 
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csgeom/<a class="el" href="obb_8h-source.html">obb.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>