<!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: iTerraFormer 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>iTerraFormer Struct Reference</h1><!-- doxytag: class="iTerraFormer" --><!-- doxytag: inherits="iBase" -->TerraFormer objects are used to retrieve terrain data.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="terraform_8h-source.html">ivaria/terraform.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iTerraFormer:</div>
<div class="dynsection">
<p><center><img src="structiTerraFormer__inherit__graph.png" border="0" usemap="#iTerraFormer__inherit__map" alt="Inheritance graph"></center>
<map name="iTerraFormer__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="28,7,84,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiTerraFormer-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 <a class="el" href="classcsVector2.html">csVector2</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structiTerraFormer.html#b633ddb581019186d6d3cd2f38e06fb9">GetIntegerMapSize</a> (<a class="el" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd">csStringID</a> type)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the integer map dimensions. <a href="#b633ddb581019186d6d3cd2f38e06fb9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classcsPtr.html">csPtr</a><br>
< <a class="el" href="structiTerraSampler.html">iTerraSampler</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structiTerraFormer.html#bb285d17f95b42f7d4f1de86ed2f77c6">GetSampler</a> (<a class="el" href="classcsBox2.html">csBox2</a> region, unsigned int resx, unsigned int resy=0)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a sampler region from the terraformer. <a href="#bb285d17f95b42f7d4f1de86ed2f77c6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiObject.html">iObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiTerraFormer.html#7427abca5e20db09805b940c515f5662">QueryObject</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the <a class="el" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a> for this interface. <a href="#7427abca5e20db09805b940c515f5662"></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="structiTerraFormer.html#abf2fa836114d3ffc57e5b18bace0bcc">SampleFloat</a> (<a class="el" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd">csStringID</a> type, float x, float z, float &value)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sample float data at a given spot on the terrain. <a href="#abf2fa836114d3ffc57e5b18bace0bcc"></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="structiTerraFormer.html#a446b3ba91f735f18c51992f1da4d238">SampleInteger</a> (<a class="el" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd">csStringID</a> type, float x, float z, int &value)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sample integer data at a given spot on the terrain. <a href="#a446b3ba91f735f18c51992f1da4d238"></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="structiTerraFormer.html#ddf4c500363a8ccc719e019dd66f11f6">SampleVector2</a> (<a class="el" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd">csStringID</a> type, float x, float z, <a class="el" href="classcsVector2.html">csVector2</a> &value)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sample <a class="el" href="classcsVector2.html" title="A 2D vector.">csVector2</a> data at a given spot on the terrain. <a href="#ddf4c500363a8ccc719e019dd66f11f6"></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="structiTerraFormer.html#c8911b3a4c04810965bc5589f1a4856e">SampleVector3</a> (<a class="el" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd">csStringID</a> type, float x, float z, <a class="el" href="classcsVector3.html">csVector3</a> &value)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sample <a class="el" href="classcsVector2.html" title="A 2D vector.">csVector2</a> data at a given spot on the terrain. <a href="#c8911b3a4c04810965bc5589f1a4856e"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
TerraFormer objects are used to retrieve terrain data.
<p>
All data is retrieved in blocks, from sampler regions.
<p>Definition at line <a class="el" href="terraform_8h-source.html#l00041">41</a> of file <a class="el" href="terraform_8h-source.html">terraform.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="b633ddb581019186d6d3cd2f38e06fb9"></a><!-- doxytag: member="iTerraFormer::GetIntegerMapSize" ref="b633ddb581019186d6d3cd2f38e06fb9" args="(csStringID type)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classcsVector2.html">csVector2</a> iTerraFormer::GetIntegerMapSize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd">csStringID</a> </td>
<td class="paramname"> <em>type</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the integer map dimensions.
<p>
</div>
</div><p>
<a class="anchor" name="bb285d17f95b42f7d4f1de86ed2f77c6"></a><!-- doxytag: member="iTerraFormer::GetSampler" ref="bb285d17f95b42f7d4f1de86ed2f77c6" args="(csBox2 region, unsigned int resx, unsigned int resy=0)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classcsPtr.html">csPtr</a><<a class="el" href="structiTerraSampler.html">iTerraSampler</a>> iTerraFormer::GetSampler </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classcsBox2.html">csBox2</a> </td>
<td class="paramname"> <em>region</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>resx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>resy</em> = <code>0</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 a sampler region from the terraformer.
<p>
The sampler region will be used for all actual data retrieval.
</div>
</div><p>
<a class="anchor" name="7427abca5e20db09805b940c515f5662"></a><!-- doxytag: member="iTerraFormer::QueryObject" ref="7427abca5e20db09805b940c515f5662" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiObject.html">iObject</a>* iTerraFormer::QueryObject </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 the <a class="el" href="structiObject.html" title="This interface is an SCF interface for encapsulating csObject.">iObject</a> for this interface.
<p>
</div>
</div><p>
<a class="anchor" name="abf2fa836114d3ffc57e5b18bace0bcc"></a><!-- doxytag: member="iTerraFormer::SampleFloat" ref="abf2fa836114d3ffc57e5b18bace0bcc" args="(csStringID type, float x, float z, float &value)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iTerraFormer::SampleFloat </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd">csStringID</a> </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"> <em>z</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float & </td>
<td class="paramname"> <em>value</em></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>
Sample float data at a given spot on the terrain.
<p>
Note that this should only be used when single heights are needed. For multiple samples in a grid a sampler should be used. Returns true if the requested type was returned, and false otherwise.
</div>
</div><p>
<a class="anchor" name="a446b3ba91f735f18c51992f1da4d238"></a><!-- doxytag: member="iTerraFormer::SampleInteger" ref="a446b3ba91f735f18c51992f1da4d238" args="(csStringID type, float x, float z, int &value)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iTerraFormer::SampleInteger </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd">csStringID</a> </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"> <em>z</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int & </td>
<td class="paramname"> <em>value</em></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>
Sample integer data at a given spot on the terrain.
<p>
Note that this should only be used when single samples are needed. For multiple samples in a grid a sampler should be used. Returns true if the requested type was returned, and false otherwise.
</div>
</div><p>
<a class="anchor" name="ddf4c500363a8ccc719e019dd66f11f6"></a><!-- doxytag: member="iTerraFormer::SampleVector2" ref="ddf4c500363a8ccc719e019dd66f11f6" args="(csStringID type, float x, float z, csVector2 &value)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iTerraFormer::SampleVector2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd">csStringID</a> </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"> <em>z</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classcsVector2.html">csVector2</a> & </td>
<td class="paramname"> <em>value</em></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>
Sample <a class="el" href="classcsVector2.html" title="A 2D vector.">csVector2</a> data at a given spot on the terrain.
<p>
Note that this should only be used when single samples are needed. For multiple samples in a grid a sampler should be used. Returns true if the requested type was returned, and false otherwise.
</div>
</div><p>
<a class="anchor" name="c8911b3a4c04810965bc5589f1a4856e"></a><!-- doxytag: member="iTerraFormer::SampleVector3" ref="c8911b3a4c04810965bc5589f1a4856e" args="(csStringID type, float x, float z, csVector3 &value)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iTerraFormer::SampleVector3 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd">csStringID</a> </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"> <em>z</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classcsVector3.html">csVector3</a> & </td>
<td class="paramname"> <em>value</em></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>
Sample <a class="el" href="classcsVector2.html" title="A 2D vector.">csVector2</a> data at a given spot on the terrain.
<p>
Note that this should only be used when single samples are needed. For multiple samples in a grid a sampler should be used. Returns true if the requested type was returned, and false otherwise.
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>ivaria/<a class="el" href="terraform_8h-source.html">terraform.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
>
3828
