<!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: iTerraSampler 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>iTerraSampler Struct Reference</h1><!-- doxytag: class="iTerraSampler" --><!-- doxytag: inherits="iBase" -->TerraSampler objects are used for the actual queries of terrain data Sampler regions are requested from the <a class="el" href="structiTerraFormer.html" title="TerraFormer objects are used to retrieve terrain data.">iTerraFormer</a> plugin, and sampled for data via the Sample methods.
<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 iTerraSampler:</div>
<div class="dynsection">
<p><center><img src="structiTerraSampler__inherit__graph.png" border="0" usemap="#iTerraSampler__inherit__map" alt="Inheritance graph"></center>
<map name="iTerraSampler__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="32,7,88,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiTerraSampler-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="structiTerraSampler.html#76cd679d4324fd353f3714899974bb84">Cleanup</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Hint to the sampler that no data will be retrieved from it for a while. <a href="#76cd679d4324fd353f3714899974bb84"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <br>
<a class="el" href="classcsArray.html">csArray</a><br>
< <a class="el" href="structiMaterialWrapper.html">iMaterialWrapper</a> * > & </td><td class="memItemRight" valign="bottom"><a class="el" href="structiTerraSampler.html#8bb1a6d7397e199334692a57d382303d">GetMaterialPalette</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the material palette used by this sampler region. <a href="#8bb1a6d7397e199334692a57d382303d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classcsBox2.html">csBox2</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="structiTerraSampler.html#106829cd15993fb0f1809e3fe5bd3fa3">GetRegion</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the sample region specified when the sampler was created. <a href="#106829cd15993fb0f1809e3fe5bd3fa3"></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="structiTerraSampler.html#828366416605a3f62bd8b959420540e2">GetResolution</a> (<a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> &resx, <a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> &resz) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve both sampling resolutions specified when the sampler was created. <a href="#828366416605a3f62bd8b959420540e2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="structiTerraSampler.html#ef438df3926069d71a12f16f93d0f222">GetVersion</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the version number of this sampler. <a href="#ef438df3926069d71a12f16f93d0f222"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const float * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiTerraSampler.html#2af3d3a59423408c66dbf0a515da2dfb">SampleFloat</a> (<a class="el" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd">csStringID</a> type)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sample float data of the specified from the region. <a href="#2af3d3a59423408c66dbf0a515da2dfb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const int * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiTerraSampler.html#7fda35d639d4d2dfd272608d4be26337">SampleInteger</a> (<a class="el" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd">csStringID</a> type)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sample integer data of the specified from the region. <a href="#7fda35d639d4d2dfd272608d4be26337"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classcsVector2.html">csVector2</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiTerraSampler.html#cd944b5a12e7369b4ea8b0fd62fcb7d3">SampleVector2</a> (<a class="el" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd">csStringID</a> type)=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 of the specified from the region. <a href="#cd944b5a12e7369b4ea8b0fd62fcb7d3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classcsVector3.html">csVector3</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiTerraSampler.html#45c268a085fbf472806153e6a4b1d61a">SampleVector3</a> (<a class="el" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd">csStringID</a> type)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sample <a class="el" href="classcsVector3.html" title="A 3D vector.">csVector3</a> data of the specified from the region. <a href="#45c268a085fbf472806153e6a4b1d61a"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
TerraSampler objects are used for the actual queries of terrain data Sampler regions are requested from the <a class="el" href="structiTerraFormer.html" title="TerraFormer objects are used to retrieve terrain data.">iTerraFormer</a> plugin, and sampled for data via the Sample methods.
<p>Definition at line <a class="el" href="terraform_8h-source.html#l00105">105</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="76cd679d4324fd353f3714899974bb84"></a><!-- doxytag: member="iTerraSampler::Cleanup" ref="76cd679d4324fd353f3714899974bb84" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iTerraSampler::Cleanup </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Hint to the sampler that no data will be retrieved from it for a while.
<p>
This may give the sampler a chance to release data it's been caching for faster retrieval, and thereby save memory. This is a hint only, and may be ignored by the underlying implementation. Arrays returned by Sample calls are not guaranteed to be valid after Cleanup has been called, and must be considered invalid.
</div>
</div><p>
<a class="anchor" name="8bb1a6d7397e199334692a57d382303d"></a><!-- doxytag: member="iTerraSampler::GetMaterialPalette" ref="8bb1a6d7397e199334692a57d382303d" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classcsArray.html">csArray</a><<a class="el" href="structiMaterialWrapper.html">iMaterialWrapper</a>*>& iTerraSampler::GetMaterialPalette </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieve the material palette used by this sampler region.
<p>
Null entries are allowed.
</div>
</div><p>
<a class="anchor" name="106829cd15993fb0f1809e3fe5bd3fa3"></a><!-- doxytag: member="iTerraSampler::GetRegion" ref="106829cd15993fb0f1809e3fe5bd3fa3" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classcsBox2.html">csBox2</a>& iTerraSampler::GetRegion </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieve the sample region specified when the sampler was created.
<p>
</div>
</div><p>
<a class="anchor" name="828366416605a3f62bd8b959420540e2"></a><!-- doxytag: member="iTerraSampler::GetResolution" ref="828366416605a3f62bd8b959420540e2" args="(uint &resx, uint &resz) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iTerraSampler::GetResolution </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> & </td>
<td class="paramname"> <em>resx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> & </td>
<td class="paramname"> <em>resz</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieve both sampling resolutions specified when the sampler was created.
<p>
</div>
</div><p>
<a class="anchor" name="ef438df3926069d71a12f16f93d0f222"></a><!-- doxytag: member="iTerraSampler::GetVersion" ref="ef438df3926069d71a12f16f93d0f222" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual unsigned int iTerraSampler::GetVersion </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieve the version number of this sampler.
<p>
This will be increased whenever any terrain data in this region changes, and should thereby be used as a dirty indicator.
</div>
</div><p>
<a class="anchor" name="2af3d3a59423408c66dbf0a515da2dfb"></a><!-- doxytag: member="iTerraSampler::SampleFloat" ref="2af3d3a59423408c66dbf0a515da2dfb" args="(csStringID type)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const float* iTerraSampler::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>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sample float data of the specified from the region.
<p>
Data is sampled in a grid (regular or irregular) with the square resolution specified when the sampler was created. The returned array is guaranteed to be valid until Cleanup is called.
</div>
</div><p>
<a class="anchor" name="7fda35d639d4d2dfd272608d4be26337"></a><!-- doxytag: member="iTerraSampler::SampleInteger" ref="7fda35d639d4d2dfd272608d4be26337" args="(csStringID type)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const int* iTerraSampler::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>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sample integer data of the specified from the region.
<p>
Data is sampled in a grid (regular or irregular) with the square resolution specified when the sampler was created. The returned array is guaranteed to be valid until Cleanup is called.
</div>
</div><p>
<a class="anchor" name="cd944b5a12e7369b4ea8b0fd62fcb7d3"></a><!-- doxytag: member="iTerraSampler::SampleVector2" ref="cd944b5a12e7369b4ea8b0fd62fcb7d3" args="(csStringID type)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classcsVector2.html">csVector2</a>* iTerraSampler::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>
<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 of the specified from the region.
<p>
Data is sampled in a grid (regular or irregular) with the square resolution specified when the sampler was created. The returned array is guaranteed to be valid until Cleanup is called.
</div>
</div><p>
<a class="anchor" name="45c268a085fbf472806153e6a4b1d61a"></a><!-- doxytag: member="iTerraSampler::SampleVector3" ref="45c268a085fbf472806153e6a4b1d61a" args="(csStringID type)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classcsVector3.html">csVector3</a>* iTerraSampler::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>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sample <a class="el" href="classcsVector3.html" title="A 3D vector.">csVector3</a> data of the specified from the region.
<p>
Data is sampled in a grid (regular or irregular) with the square resolution specified when the sampler was created. The returned array is guaranteed to be valid until Cleanup is called.
</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
>
3831
