Sophie

Sophie

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

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: csFrustumContext 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>csFrustumContext Class Reference<br>
<small>
[<a class="el" href="group__engine3d__vis.html">Visibility</a>]</small>
</h1><!-- doxytag: class="csFrustumContext" -->This structure keeps track of the current frustum context.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="fview_8h-source.html">iengine/fview.h</a>&gt;</code>
<p>

<p>
<a href="classcsFrustumContext-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsFrustumContext.html#8d9529a7cdfeb808c820a076e721b0b5">csFrustumContext</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#8d9529a7cdfeb808c820a076e721b0b5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsFrustum.html">csFrustum</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsFrustumContext.html#446fa5acfd77aec8d11b785a035a6172">GetLightFrustum</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the light frustum.  <a href="#446fa5acfd77aec8d11b785a035a6172"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structiShadowBlockList.html">iShadowBlockList</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsFrustumContext.html#3687bd43d70a24429f54519b51758c17">GetShadows</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the list of shadows.  <a href="#3687bd43d70a24429f54519b51758c17"></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="classcsFrustumContext.html#11e711bfe5c5ad66dbd347882e29f708">IsMirrored</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Is mirrored.  <a href="#11e711bfe5c5ad66dbd347882e29f708"></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="classcsFrustumContext.html#334326b0a807d1ec04d5872ab01d6eb4">IsShared</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get shared.  <a href="#334326b0a807d1ec04d5872ab01d6eb4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b58e123182e2dc3d986450eed61ab86e"></a><!-- doxytag: member="csFrustumContext::operator=" ref="b58e123182e2dc3d986450eed61ab86e" args="(csFrustumContext const &amp;c)" -->
<a class="el" href="classcsFrustumContext.html">csFrustumContext</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsFrustumContext.html#b58e123182e2dc3d986450eed61ab86e">operator=</a> (<a class="el" href="classcsFrustumContext.html">csFrustumContext</a> const &amp;c)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsFrustumContext.html#430767d78adfed510892cc7cd648376b">SetLightFrustum</a> (<a class="el" href="classcsFrustum.html">csFrustum</a> *lf)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the light frustum.  <a href="#430767d78adfed510892cc7cd648376b"></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="classcsFrustumContext.html#26896dde326a133382a80bf56e11627a">SetMirrored</a> (bool m)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set/Disable mirrored space (default false).  <a href="#26896dde326a133382a80bf56e11627a"></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="classcsFrustumContext.html#c5ad78936f83d4c4fa58f2da4eba85aa">SetNewLightFrustum</a> (<a class="el" href="classcsPtr.html">csPtr</a>&lt; <a class="el" href="classcsFrustum.html">csFrustum</a> &gt; lf)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a new (already IncRef'd) light frustrum.  <a href="#c5ad78936f83d4c4fa58f2da4eba85aa"></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="classcsFrustumContext.html#86ae993cd6787fa649a1db507939ad98">SetNewShadows</a> (<a class="el" href="classcsPtr.html">csPtr</a>&lt; <a class="el" href="structiShadowBlockList.html">iShadowBlockList</a> &gt; shad, bool sh=false)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a new (already IncRef'd) list of shadows.  <a href="#86ae993cd6787fa649a1db507939ad98"></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="classcsFrustumContext.html#84c9c8b78d5b6c195a4fef645fac3dc1">SetShadows</a> (<a class="el" href="structiShadowBlockList.html">iShadowBlockList</a> *shad, bool sh=true)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the list of shadows.  <a href="#84c9c8b78d5b6c195a4fef645fac3dc1"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This structure keeps track of the current frustum context. 
<p>
It is used by <a class="el" href="structiFrustumView.html" title="This structure represents all information needed for the frustum visibility calculator...">iFrustumView</a>. When recursing through a portal a new frustum context will be created and set in place of the old one. 
<p>Definition at line <a class="el" href="fview_8h-source.html#l00066">66</a> of file <a class="el" href="fview_8h-source.html">fview.h</a>.</p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="8d9529a7cdfeb808c820a076e721b0b5"></a><!-- doxytag: member="csFrustumContext::csFrustumContext" ref="8d9529a7cdfeb808c820a076e721b0b5" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">csFrustumContext::csFrustumContext           </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>
Constructor. 
<p>

<p>Definition at line <a class="el" href="fview_8h-source.html#l00092">92</a> of file <a class="el" href="fview_8h-source.html">fview.h</a>.</p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="446fa5acfd77aec8d11b785a035a6172"></a><!-- doxytag: member="csFrustumContext::GetLightFrustum" ref="446fa5acfd77aec8d11b785a035a6172" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classcsFrustum.html">csFrustum</a>* csFrustumContext::GetLightFrustum           </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>
Get the light frustum. 
<p>

<p>Definition at line <a class="el" href="fview_8h-source.html#l00128">128</a> of file <a class="el" href="fview_8h-source.html">fview.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="3687bd43d70a24429f54519b51758c17"></a><!-- doxytag: member="csFrustumContext::GetShadows" ref="3687bd43d70a24429f54519b51758c17" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structiShadowBlockList.html">iShadowBlockList</a>* csFrustumContext::GetShadows           </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>
Get the list of shadows. 
<p>

<p>Definition at line <a class="el" href="fview_8h-source.html#l00107">107</a> of file <a class="el" href="fview_8h-source.html">fview.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="11e711bfe5c5ad66dbd347882e29f708"></a><!-- doxytag: member="csFrustumContext::IsMirrored" ref="11e711bfe5c5ad66dbd347882e29f708" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool csFrustumContext::IsMirrored           </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>
Is mirrored. 
<p>

<p>Definition at line <a class="el" href="fview_8h-source.html#l00136">136</a> of file <a class="el" href="fview_8h-source.html">fview.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="334326b0a807d1ec04d5872ab01d6eb4"></a><!-- doxytag: member="csFrustumContext::IsShared" ref="334326b0a807d1ec04d5872ab01d6eb4" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool csFrustumContext::IsShared           </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>
Get shared. 
<p>

<p>Definition at line <a class="el" href="fview_8h-source.html#l00121">121</a> of file <a class="el" href="fview_8h-source.html">fview.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="430767d78adfed510892cc7cd648376b"></a><!-- doxytag: member="csFrustumContext::SetLightFrustum" ref="430767d78adfed510892cc7cd648376b" args="(csFrustum *lf)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void csFrustumContext::SetLightFrustum           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classcsFrustum.html">csFrustum</a> *&nbsp;</td>
          <td class="paramname"> <em>lf</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the light frustum. 
<p>

<p>Definition at line <a class="el" href="fview_8h-source.html#l00124">124</a> of file <a class="el" href="fview_8h-source.html">fview.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="26896dde326a133382a80bf56e11627a"></a><!-- doxytag: member="csFrustumContext::SetMirrored" ref="26896dde326a133382a80bf56e11627a" args="(bool m)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void csFrustumContext::SetMirrored           </td>
          <td>(</td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>m</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set/Disable mirrored space (default false). 
<p>
Set this to true if the frustum starts in mirrored space. 
<p>Definition at line <a class="el" href="fview_8h-source.html#l00134">134</a> of file <a class="el" href="fview_8h-source.html">fview.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="c5ad78936f83d4c4fa58f2da4eba85aa"></a><!-- doxytag: member="csFrustumContext::SetNewLightFrustum" ref="c5ad78936f83d4c4fa58f2da4eba85aa" args="(csPtr&lt; csFrustum &gt; lf)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void csFrustumContext::SetNewLightFrustum           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classcsPtr.html">csPtr</a>&lt; <a class="el" href="classcsFrustum.html">csFrustum</a> &gt;&nbsp;</td>
          <td class="paramname"> <em>lf</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set a new (already IncRef'd) light frustrum. 
<p>

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

</div>
</div><p>
<a class="anchor" name="86ae993cd6787fa649a1db507939ad98"></a><!-- doxytag: member="csFrustumContext::SetNewShadows" ref="86ae993cd6787fa649a1db507939ad98" args="(csPtr&lt; iShadowBlockList &gt; shad, bool sh=false)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void csFrustumContext::SetNewShadows           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classcsPtr.html">csPtr</a>&lt; <a class="el" href="structiShadowBlockList.html">iShadowBlockList</a> &gt;&nbsp;</td>
          <td class="paramname"> <em>shad</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>sh</em> = <code>false</code></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>
Set a new (already IncRef'd) list of shadows. 
<p>

<p>Definition at line <a class="el" href="fview_8h-source.html#l00115">115</a> of file <a class="el" href="fview_8h-source.html">fview.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="84c9c8b78d5b6c195a4fef645fac3dc1"></a><!-- doxytag: member="csFrustumContext::SetShadows" ref="84c9c8b78d5b6c195a4fef645fac3dc1" args="(iShadowBlockList *shad, bool sh=true)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void csFrustumContext::SetShadows           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiShadowBlockList.html">iShadowBlockList</a> *&nbsp;</td>
          <td class="paramname"> <em>shad</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>sh</em> = <code>true</code></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>
Set the list of shadows. 
<p>

<p>Definition at line <a class="el" href="fview_8h-source.html#l00109">109</a> of file <a class="el" href="fview_8h-source.html">fview.h</a>.</p>

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