Sophie

Sophie

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

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/region.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/region.h</h1><a href="region_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) 2000 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_REGION_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define __CS_IENGINE_REGION_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="structiCameraPosition.html" title="A camera position.">iCameraPosition</a>;
<a name="l00033"></a>00033 <span class="keyword">struct </span><a class="code" href="structiMaterialWrapper.html" title="A material wrapper is an engine-level object that wraps around an actual material...">iMaterialWrapper</a>;
<a name="l00034"></a>00034 <span class="keyword">struct </span><a class="code" href="structiMeshWrapper.html" title="A mesh wrapper is an engine-level object that wraps around an actual mesh object...">iMeshWrapper</a>;
<a name="l00035"></a>00035 <span class="keyword">struct </span><a class="code" href="structiMeshFactoryWrapper.html" title="A mesh factory wrapper is an engine-level object that wraps around a mesh object...">iMeshFactoryWrapper</a>;
<a name="l00036"></a>00036 <span class="keyword">struct </span><a class="code" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a>;
<a name="l00037"></a>00037 <span class="keyword">struct </span><a class="code" href="structiSector.html" title="The iSector interface is used to work with &amp;quot;sectors&amp;quot;.">iSector</a>;
<a name="l00038"></a>00038 <span class="keyword">struct </span><a class="code" href="structiTextureWrapper.html" title="A texture wrapper is an engine-level object that wraps around an actual texture (iTextureHandle)...">iTextureWrapper</a>;
<a name="l00039"></a>00039 
<a name="l00050"></a><a class="code" href="structiRegion.html">00050</a> <span class="keyword">struct </span><a class="code" href="structiRegion.html" title="A region.">iRegion</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="l00051"></a>00051 {
<a name="l00052"></a>00052   SCF_INTERFACE(<a class="code" href="structiRegion.html" title="A region.">iRegion</a>, 2,1,0);
<a name="l00054"></a>00054   <span class="keyword">virtual</span> <a class="code" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a> *<a class="code" href="structiRegion.html#75a405bbb29d58d06929280d32d8a0db" title="Get the iObject for this region.">QueryObject</a>() = 0;
<a name="l00055"></a>00055 
<a name="l00059"></a>00059   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiRegion.html#8ead00c536e895b9316a6c8d9281fab4" title="Add an object to this region.">Add</a> (<a class="code" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a> *obj) = 0;
<a name="l00060"></a>00060 
<a name="l00064"></a>00064   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiRegion.html#ca7aaccffd239ad4b31dcdb08113afd9" title="Remove an object from this region.">Remove</a> (<a class="code" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a> *obj) = 0;
<a name="l00065"></a>00065 
<a name="l00070"></a>00070   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiRegion.html#23cea0f6a46d22747e6348b78ab36c33" title="Clear this region without removing the entities in it.">Clear</a> () = 0;
<a name="l00071"></a>00071 
<a name="l00075"></a>00075   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiRegion.html#8af636613b654b9addd6b072c9026361" title="Delete all entities in this region.">DeleteAll</a> () = 0;
<a name="l00076"></a>00076 
<a name="l00080"></a>00080   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiRegion.html#c8ac238857b5828f9fc5f55beb000c7b" title="Prepare all textures and materials in this region.">PrepareTextures</a> () = 0;
<a name="l00081"></a>00081 
<a name="l00085"></a>00085   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiRegion.html#e3c8d9b4ce4bfc1e6a3cf700ace715f6" title="Do lighting calculations (or read from cache).">ShineLights</a> () = 0;
<a name="l00086"></a>00086 
<a name="l00093"></a>00093   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiRegion.html#cf0a31210a67628ec28b16c4879978cf" title="Prepare all objects in this region.">Prepare</a> () = 0;
<a name="l00094"></a>00094 
<a name="l00096"></a>00096   <span class="keyword">virtual</span> <a class="code" href="structiSector.html" title="The iSector interface is used to work with &amp;quot;sectors&amp;quot;.">iSector</a> *<a class="code" href="structiRegion.html#e92e635c013f857196f078b85436b8f4" title="Find a sector in this region by name.">FindSector</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *iName) = 0;
<a name="l00098"></a>00098   <span class="keyword">virtual</span> <a class="code" href="structiMeshWrapper.html" title="A mesh wrapper is an engine-level object that wraps around an actual mesh object...">iMeshWrapper</a> *<a class="code" href="structiRegion.html#3bdb88277cc96b8ad834a301d53b631e" title="Find a sprite in this region by name.">FindMeshObject</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *iName) = 0;
<a name="l00100"></a>00100   <span class="keyword">virtual</span> <a class="code" href="structiMeshFactoryWrapper.html" title="A mesh factory wrapper is an engine-level object that wraps around a mesh object...">iMeshFactoryWrapper</a> *<a class="code" href="structiRegion.html#3dc23ff6e625040c9aa9f576bc4aaa91" title="Find a mesh factory in this region by name.">FindMeshFactory</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *iName) = 0;
<a name="l00102"></a>00102   <span class="keyword">virtual</span> <a class="code" href="structiTextureWrapper.html" title="A texture wrapper is an engine-level object that wraps around an actual texture (iTextureHandle)...">iTextureWrapper</a> *<a class="code" href="structiRegion.html#d8cdd4094036d9c957d6e59d26094ae6" title="Find a texture in this region by name.">FindTexture</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *iName) = 0;
<a name="l00104"></a>00104   <span class="keyword">virtual</span> <a class="code" href="structiMaterialWrapper.html" title="A material wrapper is an engine-level object that wraps around an actual material...">iMaterialWrapper</a> *<a class="code" href="structiRegion.html#ba8f6358d59b6d9b48a2af910e6d8630" title="Find a material in this region by name.">FindMaterial</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *iName) = 0;
<a name="l00106"></a>00106   <span class="keyword">virtual</span> <a class="code" href="structiCameraPosition.html" title="A camera position.">iCameraPosition</a> *<a class="code" href="structiRegion.html#cb795221e56d03fc3581ddeb2ee6e937" title="Find a camera position in this region by name.">FindCameraPosition</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *iName) = 0;
<a name="l00107"></a>00107 
<a name="l00113"></a>00113   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiRegion.html#e49c519014c34dee4884dd3cef9919c1" title="Check if some object is in this region.">IsInRegion</a> (<a class="code" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a>* obj) = 0;
<a name="l00114"></a>00114 };
<a name="l00115"></a>00115 
<a name="l00122"></a><a class="code" href="structiRegionList.html">00122</a> <span class="keyword">struct </span><a class="code" href="structiRegionList.html" title="A list of region objects.">iRegionList</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="l00123"></a>00123 {
<a name="l00124"></a>00124   SCF_INTERFACE(<a class="code" href="structiRegionList.html" title="A list of region objects.">iRegionList</a>, 2,0,0);
<a name="l00126"></a>00126   <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiRegionList.html#437bf8987958ee6f76edbf502f80a2d4" title="Return the number of regions in this list.">GetCount</a> () <span class="keyword">const</span> = 0;
<a name="l00127"></a>00127 
<a name="l00129"></a>00129   <span class="keyword">virtual</span> <a class="code" href="structiRegion.html" title="A region.">iRegion</a> *<a class="code" href="structiRegionList.html#87d792ddc27b7f0bdbc19dc5390da0b9" title="Return a region by index.">Get</a> (<span class="keywordtype">int</span> n) <span class="keyword">const</span> = 0;
<a name="l00130"></a>00130 
<a name="l00132"></a>00132   <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiRegionList.html#15202e660f3305d5da89c66ba577dce5" title="Add a region.">Add</a> (<a class="code" href="structiRegion.html" title="A region.">iRegion</a> *obj) = 0;
<a name="l00133"></a>00133 
<a name="l00135"></a>00135   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiRegionList.html#855016ee22f79dc9d6c0a94541af1e3b" title="Remove a region.">Remove</a> (<a class="code" href="structiRegion.html" title="A region.">iRegion</a> *obj) = 0;
<a name="l00136"></a>00136 
<a name="l00138"></a>00138   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiRegionList.html#855016ee22f79dc9d6c0a94541af1e3b" title="Remove a region.">Remove</a> (<span class="keywordtype">int</span> n) = 0;
<a name="l00139"></a>00139 
<a name="l00141"></a>00141   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiRegionList.html#c0960fcd904eadea89bed1584e5d2d7e" title="Remove all regions.">RemoveAll</a> () = 0;
<a name="l00142"></a>00142 
<a name="l00144"></a>00144   <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiRegionList.html#bbc3b8c8c6088f3dfb3ab516471f5e41" title="Find a region and return its index.">Find</a> (<a class="code" href="structiRegion.html" title="A region.">iRegion</a> *obj) <span class="keyword">const</span> = 0;
<a name="l00145"></a>00145 
<a name="l00147"></a>00147   <span class="keyword">virtual</span> <a class="code" href="structiRegion.html" title="A region.">iRegion</a> *<a class="code" href="structiRegionList.html#9ef9ed1d0f4ba1b2c7ce60f9efbbb946" title="Find a region by name.">FindByName</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *Name) <span class="keyword">const</span> = 0;
<a name="l00148"></a>00148 };
<a name="l00149"></a>00149 
<a name="l00152"></a>00152 <span class="preprocessor">#endif // __CS_IENGINE_REGION_H__</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