Sophie

Sophie

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

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: iengine/shadows.h Source File (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><a href="classes.html"><span>Classes</span></a></li>
    <li class="current"><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<h1>iengine/shadows.h</h1><a href="shadows_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment">    Crystal Space 3D engine</span>
<a name="l00003"></a>00003 <span class="comment">    Copyright (C) 2001 by Jorrit Tyberghein</span>
<a name="l00004"></a>00004 <span class="comment"></span>
<a name="l00005"></a>00005 <span class="comment">    This library is free software; you can redistribute it and/or</span>
<a name="l00006"></a>00006 <span class="comment">    modify it under the terms of the GNU Library General Public</span>
<a name="l00007"></a>00007 <span class="comment">    License as published by the Free Software Foundation; either</span>
<a name="l00008"></a>00008 <span class="comment">    version 2 of the License, or (at your option) any later version.</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment">    This library is distributed in the hope that it will be useful,</span>
<a name="l00011"></a>00011 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00012"></a>00012 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00013"></a>00013 <span class="comment">    Library General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment"></span>
<a name="l00015"></a>00015 <span class="comment">    You should have received a copy of the GNU Library General Public</span>
<a name="l00016"></a>00016 <span class="comment">    License along with this library; if not, write to the Free</span>
<a name="l00017"></a>00017 <span class="comment">    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00018"></a>00018 <span class="comment">*/</span>
<a name="l00019"></a>00019 
<a name="l00020"></a>00020 <span class="preprocessor">#ifndef __CS_IENGINE_SHADOWS_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define __CS_IENGINE_SHADOWS_H__</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include "<a class="code" href="scf_8h.html" title="Crystal Space Shared Class Facility (SCF).">csutil/scf.h</a>"</span>
<a name="l00031"></a>00031 
<a name="l00032"></a>00032 <span class="keyword">struct </span><a class="code" href="structiShadowBlock.html" title="A block of shadows represent the shadows that are casted by one iShadowCaster object...">iShadowBlock</a>;
<a name="l00033"></a>00033 <span class="keyword">struct </span><a class="code" href="structiShadowBlockList.html" title="This is a list of shadow blocks.">iShadowBlockList</a>;
<a name="l00034"></a>00034 
<a name="l00035"></a>00035 <span class="keyword">class </span><a class="code" href="classcsBox3.html" title="A bounding box in 3D space.">csBox3</a>;
<a name="l00036"></a>00036 <span class="keyword">class </span><a class="code" href="classcsFrustum.html" title="A general frustum.">csFrustum</a>;
<a name="l00037"></a>00037 <span class="keyword">class </span><a class="code" href="classcsPlane3.html" title="A plane in 3D space.">csPlane3</a>;
<a name="l00038"></a>00038 <span class="keyword">class </span><a class="code" href="classcsTransform.html" title="A class which defines a transformation from one coordinate system to another.">csTransform</a>;
<a name="l00039"></a>00039 <span class="keyword">class </span><a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a>;
<a name="l00040"></a>00040 
<a name="l00045"></a><a class="code" href="structiShadowIterator.html">00045</a> <span class="keyword">struct </span><a class="code" href="structiShadowIterator.html" title="A shadow iterator allows someone to iterate over all shadows in a iShadowBlock or...">iShadowIterator</a> : <span class="keyword">public</span> <span class="keyword">virtual</span> <a class="code" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one...">iBase</a>
<a name="l00046"></a>00046 {
<a name="l00047"></a>00047   SCF_INTERFACE(<a class="code" href="structiShadowIterator.html" title="A shadow iterator allows someone to iterate over all shadows in a iShadowBlock or...">iShadowIterator</a>, 2,0,0);
<a name="l00049"></a>00049   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiShadowIterator.html#82b8c267cc36e6a16a3b6ad967fd5e6c" title="Reset the iterator to start again.">Reset</a> () = 0;
<a name="l00051"></a>00051   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiShadowIterator.html#741caa7243a516cb4154f9f5bec7e4e5" title="Is there still an element in this iterator?">HasNext</a> () = 0;
<a name="l00053"></a>00053   <span class="keyword">virtual</span> <a class="code" href="classcsFrustum.html" title="A general frustum.">csFrustum</a>* <a class="code" href="structiShadowIterator.html#7a63e4cb07e4f05a1440454d27dd5251" title="Get the next shadow.">Next</a> () = 0;
<a name="l00055"></a>00055   <span class="keyword">virtual</span> <span class="keywordtype">void</span>* <a class="code" href="structiShadowIterator.html#4dfcd3d23026bd201b89f3fb4e63867c" title="Get the user data for the last shadow.">GetUserData</a> () = 0;
<a name="l00057"></a>00057   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiShadowIterator.html#01f05fa6f523b0bd0775e104793165e2" title="Return if the last shadow is relevant or not.">IsRelevant</a> () = 0;
<a name="l00059"></a>00059   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiShadowIterator.html#aeb5e2cd09c471bcd925925f4f1a966c" title="Mark the last shadow as relevant.">MarkRelevant</a> (<span class="keywordtype">bool</span> rel) = 0;
<a name="l00061"></a>00061   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiShadowIterator.html#27cb354f9dfae655117a608a9dbb2da1" title="Delete the last returned shadow.">DeleteCurrent</a> () = 0;
<a name="l00063"></a>00063   <span class="keyword">virtual</span> <a class="code" href="structiShadowBlock.html" title="A block of shadows represent the shadows that are casted by one iShadowCaster object...">iShadowBlock</a>* <a class="code" href="structiShadowIterator.html#a60ba990d8eaa324bdc649c102b851ed" title="Return the shadow list for the current element.">GetCurrentShadowBlock</a> () = 0;
<a name="l00065"></a>00065   <span class="keyword">virtual</span> <a class="code" href="structiShadowBlock.html" title="A block of shadows represent the shadows that are casted by one iShadowCaster object...">iShadowBlock</a>* <a class="code" href="structiShadowIterator.html#c4514deacc6581cb81d5752e932272f3" title="Return the shadow list for the next element.">GetNextShadowBlock</a> () = 0;
<a name="l00066"></a>00066 };
<a name="l00067"></a>00067 
<a name="l00072"></a><a class="code" href="structiShadowBlock.html">00072</a> <span class="keyword">struct </span><a class="code" href="structiShadowBlock.html" title="A block of shadows represent the shadows that are casted by one iShadowCaster object...">iShadowBlock</a> : <span class="keyword">public</span> <span class="keyword">virtual</span> <a class="code" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one...">iBase</a>
<a name="l00073"></a>00073 {
<a name="l00074"></a>00074   SCF_INTERFACE(<a class="code" href="structiShadowBlock.html" title="A block of shadows represent the shadows that are casted by one iShadowCaster object...">iShadowBlock</a>,2,0,0);
<a name="l00076"></a>00076   <span class="keyword">virtual</span> <a class="code" href="structiShadowIterator.html" title="A shadow iterator allows someone to iterate over all shadows in a iShadowBlock or...">iShadowIterator</a>* <a class="code" href="structiShadowBlock.html#3ffea49081e3da3057b84af74524ede2" title="Get an iterator to iterate over all shadows in this block.">GetShadowIterator</a> (<span class="keywordtype">bool</span> reverse = <span class="keyword">false</span>) = 0;
<a name="l00078"></a>00078   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiShadowBlock.html#934f5bf769bdbf87b142d90ea52fa96b" title="Dereference all shadows in the list.">DeleteShadows</a> () = 0;
<a name="l00079"></a>00079 
<a name="l00086"></a>00086   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiShadowBlock.html#551592ac2688d70e9b947a9e546b4df1" title="Copy all relevant shadow frustums from another shadow block into this block.">AddRelevantShadows</a> (<a class="code" href="structiShadowBlock.html" title="A block of shadows represent the shadows that are casted by one iShadowCaster object...">iShadowBlock</a>* source,
<a name="l00087"></a>00087     <a class="code" href="classcsTransform.html" title="A class which defines a transformation from one coordinate system to another.">csTransform</a>* trans = 0) = 0;
<a name="l00088"></a>00088 
<a name="l00094"></a>00094   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiShadowBlock.html#551592ac2688d70e9b947a9e546b4df1" title="Copy all relevant shadow frustums from another shadow block into this block.">AddRelevantShadows</a> (<a class="code" href="structiShadowBlockList.html" title="This is a list of shadow blocks.">iShadowBlockList</a>* source) = 0;
<a name="l00095"></a>00095 
<a name="l00101"></a>00101   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiShadowBlock.html#4bab86d1dbd4fd1b5b4fb753ce6c249e" title="Copy all shadow frustums from another shadow block list into this block.">AddAllShadows</a> (<a class="code" href="structiShadowBlockList.html" title="This is a list of shadow blocks.">iShadowBlockList</a>* source) = 0;
<a name="l00102"></a>00102 
<a name="l00108"></a>00108   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiShadowBlock.html#6ee891af82319bb4d175a22743947765" title="Add unique shadows.">AddUniqueRelevantShadows</a> (<a class="code" href="structiShadowBlockList.html" title="This is a list of shadow blocks.">iShadowBlockList</a>* source) = 0;
<a name="l00109"></a>00109 
<a name="l00115"></a>00115   <span class="keyword">virtual</span> <a class="code" href="classcsFrustum.html" title="A general frustum.">csFrustum</a>* <a class="code" href="structiShadowBlock.html#07e348d489142cb3c990806537fe5d45" title="Add a new frustum and return a reference.">AddShadow</a> (<span class="keyword">const</span> <a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a>&amp; origin, <span class="keywordtype">void</span>* userData,
<a name="l00116"></a>00116     <span class="keywordtype">int</span> num_verts, <a class="code" href="classcsPlane3.html" title="A plane in 3D space.">csPlane3</a>&amp; backplane) = 0;
<a name="l00117"></a>00117 
<a name="l00119"></a>00119   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiShadowBlock.html#299024bec4c70e9f02e4a351d0bdadeb" title="Unlink a shadow frustum from the list and dereference it.">UnlinkShadow</a> (<span class="keywordtype">int</span> idx) = 0;
<a name="l00120"></a>00120 
<a name="l00122"></a>00122   <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiShadowBlock.html#894e26d1ece4518223cd5e6d3fe0b9fc" title="Get the number of shadows in this list.">GetShadowCount</a> () = 0;
<a name="l00123"></a>00123 
<a name="l00125"></a>00125   <span class="keyword">virtual</span> <a class="code" href="classcsFrustum.html" title="A general frustum.">csFrustum</a>* <a class="code" href="structiShadowBlock.html#6cd1b0471333a7e8d57189cf1a9d9e68" title="Get the specified shadow.">GetShadow</a> (<span class="keywordtype">int</span> idx) = 0;
<a name="l00126"></a>00126 
<a name="l00130"></a>00130   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiShadowBlock.html#2b004307a1274e443d6a44a39f8974f0" title="Apply a transformation to all frustums in this list.">Transform</a> (<a class="code" href="classcsTransform.html" title="A class which defines a transformation from one coordinate system to another.">csTransform</a>* trans) = 0;
<a name="l00131"></a>00131 
<a name="l00133"></a>00133   <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classcsBox3.html" title="A bounding box in 3D space.">csBox3</a>&amp; <a class="code" href="structiShadowBlock.html#1f3570685042f040d5342999dcaf88f1" title="Get the bounding box of this shadow block.">GetBoundingBox</a> () = 0;
<a name="l00134"></a>00134 };
<a name="l00135"></a>00135 
<a name="l00140"></a><a class="code" href="structiShadowBlockList.html">00140</a> <span class="keyword">struct </span><a class="code" href="structiShadowBlockList.html" title="This is a list of shadow blocks.">iShadowBlockList</a> : <span class="keyword">public</span> <span class="keyword">virtual</span> <a class="code" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one...">iBase</a>
<a name="l00141"></a>00141 {
<a name="l00142"></a>00142   SCF_INTERFACE(<a class="code" href="structiShadowBlockList.html" title="This is a list of shadow blocks.">iShadowBlockList</a>,2,0,0);
<a name="l00144"></a>00144   <span class="keyword">virtual</span> <a class="code" href="structiShadowIterator.html" title="A shadow iterator allows someone to iterate over all shadows in a iShadowBlock or...">iShadowIterator</a>* <a class="code" href="structiShadowBlockList.html#14cac2f4a26f7866d56f9b2586305392" title="Get an iterator to iterate over all shadows in this list.">GetShadowIterator</a> (<span class="keywordtype">bool</span> reverse = <span class="keyword">false</span>) = 0;
<a name="l00151"></a>00151   <span class="keyword">virtual</span> <a class="code" href="structiShadowIterator.html" title="A shadow iterator allows someone to iterate over all shadows in a iShadowBlock or...">iShadowIterator</a>* <a class="code" href="structiShadowBlockList.html#14cac2f4a26f7866d56f9b2586305392" title="Get an iterator to iterate over all shadows in this list.">GetShadowIterator</a> (
<a name="l00152"></a>00152     <span class="keyword">const</span> <a class="code" href="classcsBox3.html" title="A bounding box in 3D space.">csBox3</a>&amp; bbox, <span class="keywordtype">bool</span> reverse = <span class="keyword">false</span>) = 0;
<a name="l00153"></a>00153 
<a name="l00155"></a>00155   <span class="keyword">virtual</span> <a class="code" href="structiShadowBlock.html" title="A block of shadows represent the shadows that are casted by one iShadowCaster object...">iShadowBlock</a>* <a class="code" href="structiShadowBlockList.html#e116879ad69d13774111a405ff74c44a" title="Create a new shadow block and append to the list.">NewShadowBlock</a> (<span class="keywordtype">int</span> num_shadows = 30) = 0;
<a name="l00156"></a>00156 
<a name="l00158"></a>00158   <span class="keyword">virtual</span> <a class="code" href="structiShadowBlock.html" title="A block of shadows represent the shadows that are casted by one iShadowCaster object...">iShadowBlock</a>* <a class="code" href="structiShadowBlockList.html#1f855bb4c212db37f860ab5083b87964" title="Get first shadow block in the list.">GetFirstShadowBlock</a> () = 0;
<a name="l00160"></a>00160   <span class="keyword">virtual</span> <a class="code" href="structiShadowBlock.html" title="A block of shadows represent the shadows that are casted by one iShadowCaster object...">iShadowBlock</a>* <a class="code" href="structiShadowBlockList.html#3dee8ef1ff480af4fb1a999080d49714" title="Get last shadow block in the list.">GetLastShadowBlock</a> () = 0;
<a name="l00162"></a>00162   <span class="keyword">virtual</span> <a class="code" href="structiShadowBlock.html" title="A block of shadows represent the shadows that are casted by one iShadowCaster object...">iShadowBlock</a>* <a class="code" href="structiShadowBlockList.html#389f3d4ff7bc67e2acb5c5f6aa97a857" title="Get next shadow block.">GetNextShadowBlock</a> (<a class="code" href="structiShadowBlock.html" title="A block of shadows represent the shadows that are casted by one iShadowCaster object...">iShadowBlock</a>* s) = 0;
<a name="l00164"></a>00164   <span class="keyword">virtual</span> <a class="code" href="structiShadowBlock.html" title="A block of shadows represent the shadows that are casted by one iShadowCaster object...">iShadowBlock</a>* <a class="code" href="structiShadowBlockList.html#1033022e46a47259f114cd6d11e7243e" title="Get previous shadow block.">GetPreviousShadowBlock</a> (<a class="code" href="structiShadowBlock.html" title="A block of shadows represent the shadows that are casted by one iShadowCaster object...">iShadowBlock</a>* s) = 0;
<a name="l00166"></a>00166   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiShadowBlockList.html#49ba3a96511b65eb6b2afc44dce4e08c" title="Remove the last shadow block from this list.">RemoveLastShadowBlock</a> () = 0;
<a name="l00168"></a>00168   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiShadowBlockList.html#9dc1850939a80ffbb7860858c3cbe18e" title="Destroy all shadow lists and shadows in the list.">DeleteAllShadows</a> () = 0;
<a name="l00169"></a>00169 
<a name="l00176"></a>00176   <span class="keyword">virtual</span> <a class="code" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e" title="unsigned 32-bit integer (0..4 294 967 295)">uint32</a> <a class="code" href="structiShadowBlockList.html#97d31f5dfb97e2bc705aaa96b974691f" title="Mark a new region of shadow blocks.">MarkNewRegion</a> () = 0;
<a name="l00177"></a>00177 
<a name="l00182"></a>00182   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiShadowBlockList.html#61a23c38219a6564a9581b665383aa46" title="Restore a region (as parameter use the number returned by MarkNewRegion()).">RestoreRegion</a> (<a class="code" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e" title="unsigned 32-bit integer (0..4 294 967 295)">uint32</a> prev) = 0;
<a name="l00183"></a>00183 
<a name="l00188"></a>00188   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiShadowBlockList.html#6a932376491f6e3de5f7bda64de547c9" title="Returns true if the shadow block belongs to the current region.">FromCurrentRegion</a> (<a class="code" href="structiShadowBlock.html" title="A block of shadows represent the shadows that are casted by one iShadowCaster object...">iShadowBlock</a>* block) = 0;
<a name="l00189"></a>00189 };
<a name="l00190"></a>00190 
<a name="l00193"></a>00193 <span class="preprocessor">#endif // __CS_IENGINE_SHADOWS_H__</span>
<a name="l00194"></a>00194 <span class="preprocessor"></span>
</pre></div><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>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional