<!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: iShadowBlockList 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 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 Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<h1>iShadowBlockList Struct Reference<br>
<small>
[<a class="el" href="group__engine3d__light.html">Lighting</a>]</small>
</h1><!-- doxytag: class="iShadowBlockList" --><!-- doxytag: inherits="iBase" -->This is a list of shadow blocks.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="shadows_8h-source.html">iengine/shadows.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iShadowBlockList:</div>
<div class="dynsection">
<p><center><img src="structiShadowBlockList__inherit__graph.png" border="0" usemap="#iShadowBlockList__inherit__map" alt="Inheritance graph"></center>
<map name="iShadowBlockList__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="43,7,99,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiShadowBlockList-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 </td><td class="memItemRight" valign="bottom"><a class="el" href="structiShadowBlockList.html#9dc1850939a80ffbb7860858c3cbe18e">DeleteAllShadows</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy all shadow lists and shadows in the list. <a href="#9dc1850939a80ffbb7860858c3cbe18e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiShadowBlockList.html#6a932376491f6e3de5f7bda64de547c9">FromCurrentRegion</a> (<a class="el" href="structiShadowBlock.html">iShadowBlock</a> *block)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the shadow block belongs to the current region. <a href="#6a932376491f6e3de5f7bda64de547c9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiShadowBlock.html">iShadowBlock</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiShadowBlockList.html#1f855bb4c212db37f860ab5083b87964">GetFirstShadowBlock</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get first shadow block in the list. <a href="#1f855bb4c212db37f860ab5083b87964"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiShadowBlock.html">iShadowBlock</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiShadowBlockList.html#3dee8ef1ff480af4fb1a999080d49714">GetLastShadowBlock</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get last shadow block in the list. <a href="#3dee8ef1ff480af4fb1a999080d49714"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiShadowBlock.html">iShadowBlock</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiShadowBlockList.html#389f3d4ff7bc67e2acb5c5f6aa97a857">GetNextShadowBlock</a> (<a class="el" href="structiShadowBlock.html">iShadowBlock</a> *s)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get next shadow block. <a href="#389f3d4ff7bc67e2acb5c5f6aa97a857"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiShadowBlock.html">iShadowBlock</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiShadowBlockList.html#1033022e46a47259f114cd6d11e7243e">GetPreviousShadowBlock</a> (<a class="el" href="structiShadowBlock.html">iShadowBlock</a> *s)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get previous shadow block. <a href="#1033022e46a47259f114cd6d11e7243e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiShadowIterator.html">iShadowIterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiShadowBlockList.html#7d7a0e277baa5a485c2e7074204524d6">GetShadowIterator</a> (const <a class="el" href="classcsBox3.html">csBox3</a> &bbox, bool reverse=false)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get an iterator to iterate over all shadows in this list. <a href="#7d7a0e277baa5a485c2e7074204524d6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiShadowIterator.html">iShadowIterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiShadowBlockList.html#14cac2f4a26f7866d56f9b2586305392">GetShadowIterator</a> (bool reverse=false)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get an iterator to iterate over all shadows in this list. <a href="#14cac2f4a26f7866d56f9b2586305392"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structiShadowBlockList.html#97d31f5dfb97e2bc705aaa96b974691f">MarkNewRegion</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Mark a new region of shadow blocks. <a href="#97d31f5dfb97e2bc705aaa96b974691f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiShadowBlock.html">iShadowBlock</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiShadowBlockList.html#e116879ad69d13774111a405ff74c44a">NewShadowBlock</a> (int num_shadows=30)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new shadow block and append to the list. <a href="#e116879ad69d13774111a405ff74c44a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiShadowBlockList.html#49ba3a96511b65eb6b2afc44dce4e08c">RemoveLastShadowBlock</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove the last shadow block from this list. <a href="#49ba3a96511b65eb6b2afc44dce4e08c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiShadowBlockList.html#61a23c38219a6564a9581b665383aa46">RestoreRegion</a> (<a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> prev)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Restore a region (as parameter use the number returned by <a class="el" href="structiShadowBlockList.html#97d31f5dfb97e2bc705aaa96b974691f" title="Mark a new region of shadow blocks.">MarkNewRegion()</a>). <a href="#61a23c38219a6564a9581b665383aa46"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This is a list of shadow blocks.
<p>
An <a class="el" href="structiShadowReceiver.html" title="An object that is interested in getting shadow information.">iShadowReceiver</a> will get such a list.
<p>Definition at line <a class="el" href="shadows_8h-source.html#l00140">140</a> of file <a class="el" href="shadows_8h-source.html">shadows.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="9dc1850939a80ffbb7860858c3cbe18e"></a><!-- doxytag: member="iShadowBlockList::DeleteAllShadows" ref="9dc1850939a80ffbb7860858c3cbe18e" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iShadowBlockList::DeleteAllShadows </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destroy all shadow lists and shadows in the list.
<p>
</div>
</div><p>
<a class="anchor" name="6a932376491f6e3de5f7bda64de547c9"></a><!-- doxytag: member="iShadowBlockList::FromCurrentRegion" ref="6a932376491f6e3de5f7bda64de547c9" args="(iShadowBlock *block)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iShadowBlockList::FromCurrentRegion </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiShadowBlock.html">iShadowBlock</a> * </td>
<td class="paramname"> <em>block</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns true if the shadow block belongs to the current region.
<p>
</div>
</div><p>
<a class="anchor" name="1f855bb4c212db37f860ab5083b87964"></a><!-- doxytag: member="iShadowBlockList::GetFirstShadowBlock" ref="1f855bb4c212db37f860ab5083b87964" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiShadowBlock.html">iShadowBlock</a>* iShadowBlockList::GetFirstShadowBlock </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get first shadow block in the list.
<p>
</div>
</div><p>
<a class="anchor" name="3dee8ef1ff480af4fb1a999080d49714"></a><!-- doxytag: member="iShadowBlockList::GetLastShadowBlock" ref="3dee8ef1ff480af4fb1a999080d49714" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiShadowBlock.html">iShadowBlock</a>* iShadowBlockList::GetLastShadowBlock </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get last shadow block in the list.
<p>
</div>
</div><p>
<a class="anchor" name="389f3d4ff7bc67e2acb5c5f6aa97a857"></a><!-- doxytag: member="iShadowBlockList::GetNextShadowBlock" ref="389f3d4ff7bc67e2acb5c5f6aa97a857" args="(iShadowBlock *s)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiShadowBlock.html">iShadowBlock</a>* iShadowBlockList::GetNextShadowBlock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiShadowBlock.html">iShadowBlock</a> * </td>
<td class="paramname"> <em>s</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get next shadow block.
<p>
</div>
</div><p>
<a class="anchor" name="1033022e46a47259f114cd6d11e7243e"></a><!-- doxytag: member="iShadowBlockList::GetPreviousShadowBlock" ref="1033022e46a47259f114cd6d11e7243e" args="(iShadowBlock *s)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiShadowBlock.html">iShadowBlock</a>* iShadowBlockList::GetPreviousShadowBlock </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiShadowBlock.html">iShadowBlock</a> * </td>
<td class="paramname"> <em>s</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get previous shadow block.
<p>
</div>
</div><p>
<a class="anchor" name="7d7a0e277baa5a485c2e7074204524d6"></a><!-- doxytag: member="iShadowBlockList::GetShadowIterator" ref="7d7a0e277baa5a485c2e7074204524d6" args="(const csBox3 &bbox, bool reverse=false)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiShadowIterator.html">iShadowIterator</a>* iShadowBlockList::GetShadowIterator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classcsBox3.html">csBox3</a> & </td>
<td class="paramname"> <em>bbox</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>reverse</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get an iterator to iterate over all shadows in this list.
<p>
This version will test the bounding boxes of all shadow blocks and only iterate over the shadow blocks that are potentially relevant (i.e. that potentially shadow the given bounding box).
</div>
</div><p>
<a class="anchor" name="14cac2f4a26f7866d56f9b2586305392"></a><!-- doxytag: member="iShadowBlockList::GetShadowIterator" ref="14cac2f4a26f7866d56f9b2586305392" args="(bool reverse=false)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiShadowIterator.html">iShadowIterator</a>* iShadowBlockList::GetShadowIterator </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>reverse</em> = <code>false</code> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get an iterator to iterate over all shadows in this list.
<p>
</div>
</div><p>
<a class="anchor" name="97d31f5dfb97e2bc705aaa96b974691f"></a><!-- doxytag: member="iShadowBlockList::MarkNewRegion" ref="97d31f5dfb97e2bc705aaa96b974691f" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> iShadowBlockList::MarkNewRegion </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Mark a new region of shadow blocks.
<p>
This is usually called after entering a portal and it allows us to easily restore the shadow list upto the point of the last portal traversal. Returns the original region.
</div>
</div><p>
<a class="anchor" name="e116879ad69d13774111a405ff74c44a"></a><!-- doxytag: member="iShadowBlockList::NewShadowBlock" ref="e116879ad69d13774111a405ff74c44a" args="(int num_shadows=30)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiShadowBlock.html">iShadowBlock</a>* iShadowBlockList::NewShadowBlock </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>num_shadows</em> = <code>30</code> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create a new shadow block and append to the list.
<p>
</div>
</div><p>
<a class="anchor" name="49ba3a96511b65eb6b2afc44dce4e08c"></a><!-- doxytag: member="iShadowBlockList::RemoveLastShadowBlock" ref="49ba3a96511b65eb6b2afc44dce4e08c" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iShadowBlockList::RemoveLastShadowBlock </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove the last shadow block from this list.
<p>
</div>
</div><p>
<a class="anchor" name="61a23c38219a6564a9581b665383aa46"></a><!-- doxytag: member="iShadowBlockList::RestoreRegion" ref="61a23c38219a6564a9581b665383aa46" args="(uint32 prev)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iShadowBlockList::RestoreRegion </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> </td>
<td class="paramname"> <em>prev</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Restore a region (as parameter use the number returned by <a class="el" href="structiShadowBlockList.html#97d31f5dfb97e2bc705aaa96b974691f" title="Mark a new region of shadow blocks.">MarkNewRegion()</a>).
<p>
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>iengine/<a class="el" href="shadows_8h-source.html">shadows.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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
3648
