Sophie

Sophie

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

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: ivaria/terraform.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>ivaria/terraform.h</h1><a href="terraform_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">    Copyright (C) 2004 by Anders Stenberg, Daniel Duhprey</span>
<a name="l00003"></a>00003 <span class="comment"></span>
<a name="l00004"></a>00004 <span class="comment">    This library is free software; you can redistribute it and/or</span>
<a name="l00005"></a>00005 <span class="comment">    modify it under the terms of the GNU Library General Public</span>
<a name="l00006"></a>00006 <span class="comment">    License as published by the Free Software Foundation; either</span>
<a name="l00007"></a>00007 <span class="comment">    version 2 of the License, or (at your option) any later version.</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment">    This library is distributed in the hope that it will be useful,</span>
<a name="l00010"></a>00010 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00011"></a>00011 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00012"></a>00012 <span class="comment">    Library General Public License for more details.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment">    You should have received a copy of the GNU Library General Public</span>
<a name="l00015"></a>00015 <span class="comment">    License along with this library; if not, write to the Free</span>
<a name="l00016"></a>00016 <span class="comment">    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00017"></a>00017 <span class="comment">*/</span>
<a name="l00018"></a>00018 
<a name="l00019"></a>00019 <span class="preprocessor">#ifndef __CS_IVARIA_TERRAFORM_H__</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define __CS_IVARIA_TERRAFORM_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <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="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="csutil_2strset_8h.html" title="String-to-ID hash table.">csutil/strset.h</a>"</span>
<a name="l00028"></a>00028 
<a name="l00029"></a>00029 <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="l00030"></a>00030 <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="l00031"></a>00031 <span class="keyword">struct </span><a class="code" href="structiTerraSampler.html" title="TerraSampler objects are used for the actual queries of terrain data Sampler regions...">iTerraSampler</a>;
<a name="l00032"></a>00032 
<a name="l00033"></a>00033 <span class="keyword">class </span><a class="code" href="classcsBox2.html" title="A bounding box in 2D space.">csBox2</a>;
<a name="l00034"></a>00034 <span class="keyword">class </span><a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a>;
<a name="l00035"></a>00035 <span class="keyword">class </span><a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a>;
<a name="l00036"></a>00036 
<a name="l00041"></a><a class="code" href="structiTerraFormer.html">00041</a> <span class="keyword">struct </span><a class="code" href="structiTerraFormer.html" title="TerraFormer objects are used to retrieve terrain data.">iTerraFormer</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="l00042"></a>00042 {
<a name="l00043"></a>00043   SCF_INTERFACE (<a class="code" href="structiTerraFormer.html" title="TerraFormer objects are used to retrieve terrain data.">iTerraFormer</a>, 2, 0, 0);
<a name="l00044"></a>00044 
<a name="l00049"></a>00049   <span class="keyword">virtual</span> <a class="code" href="classcsPtr.html" title="A pointer encapsulator.">csPtr&lt;iTerraSampler&gt;</a> <a class="code" href="structiTerraFormer.html#bb285d17f95b42f7d4f1de86ed2f77c6" title="Get a sampler region from the terraformer.">GetSampler</a> (<a class="code" href="classcsBox2.html" title="A bounding box in 2D space.">csBox2</a> region, 
<a name="l00050"></a>00050     <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> resx, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> resy = 0) = 0;
<a name="l00051"></a>00051 
<a name="l00055"></a>00055   <span class="keyword">virtual</span> <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a> <a class="code" href="structiTerraFormer.html#b633ddb581019186d6d3cd2f38e06fb9" title="Get the integer map dimensions.">GetIntegerMapSize</a> (<a class="code" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd" title="An identifier for a string.">csStringID</a> type) = 0;
<a name="l00056"></a>00056 
<a name="l00063"></a>00063   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiTerraFormer.html#abf2fa836114d3ffc57e5b18bace0bcc" title="Sample float data at a given spot on the terrain.">SampleFloat</a> (<a class="code" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd" title="An identifier for a string.">csStringID</a> type, <span class="keywordtype">float</span> x, <span class="keywordtype">float</span> z, 
<a name="l00064"></a>00064     <span class="keywordtype">float</span> &amp;value) = 0;
<a name="l00065"></a>00065 
<a name="l00072"></a>00072   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiTerraFormer.html#ddf4c500363a8ccc719e019dd66f11f6" title="Sample csVector2 data at a given spot on the terrain.">SampleVector2</a> (<a class="code" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd" title="An identifier for a string.">csStringID</a> type, <span class="keywordtype">float</span> x, <span class="keywordtype">float</span> z, 
<a name="l00073"></a>00073     <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a> &amp;value) = 0;
<a name="l00074"></a>00074 
<a name="l00081"></a>00081   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiTerraFormer.html#c8911b3a4c04810965bc5589f1a4856e" title="Sample csVector2 data at a given spot on the terrain.">SampleVector3</a> (<a class="code" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd" title="An identifier for a string.">csStringID</a> type, <span class="keywordtype">float</span> x, <span class="keywordtype">float</span> z, 
<a name="l00082"></a>00082     <a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a> &amp;value) = 0;
<a name="l00083"></a>00083 
<a name="l00090"></a>00090   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiTerraFormer.html#a446b3ba91f735f18c51992f1da4d238" title="Sample integer data at a given spot on the terrain.">SampleInteger</a> (<a class="code" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd" title="An identifier for a string.">csStringID</a> type, <span class="keywordtype">float</span> x, <span class="keywordtype">float</span> z, 
<a name="l00091"></a>00091     <span class="keywordtype">int</span> &amp;value) = 0;
<a name="l00092"></a>00092   
<a name="l00096"></a>00096   <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="structiTerraFormer.html#7427abca5e20db09805b940c515f5662" title="Get the iObject for this interface.">QueryObject</a> () = 0;
<a name="l00097"></a>00097 };
<a name="l00098"></a>00098 
<a name="l00099"></a>00099 
<a name="l00105"></a><a class="code" href="structiTerraSampler.html">00105</a> <span class="keyword">struct </span><a class="code" href="structiTerraSampler.html" title="TerraSampler objects are used for the actual queries of terrain data Sampler regions...">iTerraSampler</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="l00106"></a>00106 {
<a name="l00107"></a>00107   SCF_INTERFACE (<a class="code" href="structiTerraSampler.html" title="TerraSampler objects are used for the actual queries of terrain data Sampler regions...">iTerraSampler</a>, 2, 0, 0);
<a name="l00108"></a>00108 
<a name="l00115"></a>00115   <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">float</span> *<a class="code" href="structiTerraSampler.html#2af3d3a59423408c66dbf0a515da2dfb" title="Sample float data of the specified from the region.">SampleFloat</a> (<a class="code" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd" title="An identifier for a string.">csStringID</a> type) = 0;
<a name="l00116"></a>00116 
<a name="l00123"></a>00123   <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a> *<a class="code" href="structiTerraSampler.html#cd944b5a12e7369b4ea8b0fd62fcb7d3" title="Sample csVector2 data of the specified from the region.">SampleVector2</a> (<a class="code" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd" title="An identifier for a string.">csStringID</a> type) = 0;
<a name="l00124"></a>00124 
<a name="l00131"></a>00131   <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a> *<a class="code" href="structiTerraSampler.html#45c268a085fbf472806153e6a4b1d61a" title="Sample csVector3 data of the specified from the region.">SampleVector3</a> (<a class="code" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd" title="An identifier for a string.">csStringID</a> type) = 0;
<a name="l00132"></a>00132 
<a name="l00139"></a>00139   <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">int</span> *<a class="code" href="structiTerraSampler.html#7fda35d639d4d2dfd272608d4be26337" title="Sample integer data of the specified from the region.">SampleInteger</a> (<a class="code" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd" title="An identifier for a string.">csStringID</a> type) = 0;
<a name="l00140"></a>00140 
<a name="l00145"></a>00145   <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classcsArray.html" title="A templated array class.">csArray&lt;iMaterialWrapper*&gt;</a> &amp;<a class="code" href="structiTerraSampler.html#8bb1a6d7397e199334692a57d382303d" title="Retrieve the material palette used by this sampler region.">GetMaterialPalette</a> () = 0;
<a name="l00146"></a>00146 
<a name="l00148"></a>00148   <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classcsBox2.html" title="A bounding box in 2D space.">csBox2</a> &amp;<a class="code" href="structiTerraSampler.html#106829cd15993fb0f1809e3fe5bd3fa3" title="Retrieve the sample region specified when the sampler was created.">GetRegion</a> () <span class="keyword">const</span> = 0;
<a name="l00149"></a>00149 
<a name="l00151"></a>00151   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiTerraSampler.html#828366416605a3f62bd8b959420540e2" title="Retrieve both sampling resolutions specified when the sampler was created.">GetResolution</a> (<a class="code" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14" title="Shortcut for default unsigned int.">uint</a> &amp;resx, <a class="code" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14" title="Shortcut for default unsigned int.">uint</a> &amp;resz) <span class="keyword">const</span> = 0;
<a name="l00152"></a>00152   
<a name="l00158"></a>00158   <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="structiTerraSampler.html#ef438df3926069d71a12f16f93d0f222" title="Retrieve the version number of this sampler.">GetVersion</a> () <span class="keyword">const</span> = 0;
<a name="l00159"></a>00159   
<a name="l00168"></a>00168   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiTerraSampler.html#76cd679d4324fd353f3714899974bb84" title="Hint to the sampler that no data will be retrieved from it for a while.">Cleanup</a> () = 0; 
<a name="l00169"></a>00169 };
<a name="l00170"></a>00170 
<a name="l00171"></a>00171 <span class="preprocessor">#endif // __CS_IVARIA_TERRAFORM_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