<!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: iMeshGeneratorGeometry 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>iMeshGeneratorGeometry Struct Reference<br>
<small>
[<a class="el" href="group__engine3d.html">Crystal Space 3D Engine</a>]</small>
</h1><!-- doxytag: class="iMeshGeneratorGeometry" --><!-- doxytag: inherits="iBase" -->This interface defines one piece of geometry for the mesh generator.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="meshgen_8h-source.html">iengine/meshgen.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iMeshGeneratorGeometry:</div>
<div class="dynsection">
<p><center><img src="structiMeshGeneratorGeometry__inherit__graph.png" border="0" usemap="#iMeshGeneratorGeometry__inherit__map" alt="Inheritance graph"></center>
<map name="iMeshGeneratorGeometry__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="73,7,129,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiMeshGeneratorGeometry-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="structiMeshGeneratorGeometry.html#0aef7e1d81386582ae2bacddc08f9c31">AddDensityMaterialFactor</a> (<a class="el" href="structiMaterialWrapper.html">iMaterialWrapper</a> *material, float factor)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a density factor based on a material. <a href="#0aef7e1d81386582ae2bacddc08f9c31"></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="structiMeshGeneratorGeometry.html#832731106d0c0c4c3b72dd1710be0fcf">AddFactory</a> (<a class="el" href="structiMeshFactoryWrapper.html">iMeshFactoryWrapper</a> *factory, float maxdist)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a factory and the maximum distance after which this factory will no longer be used. <a href="#832731106d0c0c4c3b72dd1710be0fcf"></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="structiMeshGeneratorGeometry.html#22a49631cbb0270847773a6f47db5344">AddPosition</a> (const <a class="el" href="classcsVector2.html">csVector2</a> &pos)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add position for placing mesh (only material factor will influence it). <a href="#22a49631cbb0270847773a6f47db5344"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="structiMeshGeneratorGeometry.html#b78ad6b7493c7e0d5902e42c93704bd8">GetDensity</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the density. <a href="#b78ad6b7493c7e0d5902e42c93704bd8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <br>
<a class="el" href="structiMeshFactoryWrapper.html">iMeshFactoryWrapper</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiMeshGeneratorGeometry.html#3a3aa2cc066cc7cd3fc5bc760f44875c">GetFactory</a> (size_t idx)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a specified factory. <a href="#3a3aa2cc066cc7cd3fc5bc760f44875c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structiMeshGeneratorGeometry.html#c99fc5abc9b81611b0cb77b572afb37d">GetFactoryCount</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of factories for this geometry. <a href="#c99fc5abc9b81611b0cb77b572afb37d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="structiMeshGeneratorGeometry.html#7b370e8d1dc3b2034da5ee12e709ed94">GetMaximumDistance</a> (size_t idx)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a specified maximum distance. <a href="#7b370e8d1dc3b2034da5ee12e709ed94"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="structiMeshGeneratorGeometry.html#760a52e5b206c1ef08bbffaa018bf684">GetRadius</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the radius for this object. <a href="#760a52e5b206c1ef08bbffaa018bf684"></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="structiMeshGeneratorGeometry.html#dce7fe42cd635e6ece65468a0dc07101">RemoveFactory</a> (size_t idx)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove a factory. <a href="#dce7fe42cd635e6ece65468a0dc07101"></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="structiMeshGeneratorGeometry.html#1cefdf489fdf6be703355d95e9a2d1a2">SetDefaultDensityMaterialFactor</a> (float factor)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the default factor to use in case the material found on the meshes is not any of the ones defined in the material factory table. <a href="#1cefdf489fdf6be703355d95e9a2d1a2"></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="structiMeshGeneratorGeometry.html#d16b99bdac3b2d9d83627ceed3c644fa">SetDensity</a> (float density)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the density. <a href="#d16b99bdac3b2d9d83627ceed3c644fa"></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="structiMeshGeneratorGeometry.html#98ed2b83fc83a236737143cad1a5412d">SetDensityMap</a> (<a class="el" href="structiTerraFormer.html">iTerraFormer</a> *map, float factor, const <a class="el" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd">csStringID</a> &type)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a density map in grayscale with factor. <a href="#98ed2b83fc83a236737143cad1a5412d"></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="structiMeshGeneratorGeometry.html#2e45eaa76e6287ba3f8ee77bd130f50f">SetRadius</a> (float radius)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the radius for this object. <a href="#2e45eaa76e6287ba3f8ee77bd130f50f"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This interface defines one piece of geometry for the mesh generator.
<p>
Main creators of instances implementing this interface:<ul>
<li><a class="el" href="structiMeshGenerator.html#2f7491f446b357854b6d457cfcc6fc6a" title="Create a geometry specification for this mesh generator.">iMeshGenerator::CreateGeometry()</a></li></ul>
<p>
Main ways to get pointers to this interface:<ul>
<li><a class="el" href="structiMeshGenerator.html#1563770807c8c7d4444cc3aebca98b55" title="Get a specific geometry.">iMeshGenerator::GetGeometry()</a></li></ul>
<p>
Main users of this interface:<ul>
<li><a class="el" href="structiMeshGenerator.html" title="iMeshGenerator defines the interface for a mesh generator.">iMeshGenerator</a> </li></ul>
<p>Definition at line <a class="el" href="meshgen_8h-source.html#l00050">50</a> of file <a class="el" href="meshgen_8h-source.html">meshgen.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="0aef7e1d81386582ae2bacddc08f9c31"></a><!-- doxytag: member="iMeshGeneratorGeometry::AddDensityMaterialFactor" ref="0aef7e1d81386582ae2bacddc08f9c31" args="(iMaterialWrapper *material, float factor)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iMeshGeneratorGeometry::AddDensityMaterialFactor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiMaterialWrapper.html">iMaterialWrapper</a> * </td>
<td class="paramname"> <em>material</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"> <em>factor</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>
Add a density factor based on a material.
<p>
The base density will be used to try a number of positions in every cell. Then for that position it will determine the material that is hit. If that material is listed in the density factor table then that factor will be used to determine if the position should be used or not. Setting a factor of 0 here will disable the material. Setting a factor of 1 will give full density.
</div>
</div><p>
<a class="anchor" name="832731106d0c0c4c3b72dd1710be0fcf"></a><!-- doxytag: member="iMeshGeneratorGeometry::AddFactory" ref="832731106d0c0c4c3b72dd1710be0fcf" args="(iMeshFactoryWrapper *factory, float maxdist)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iMeshGeneratorGeometry::AddFactory </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiMeshFactoryWrapper.html">iMeshFactoryWrapper</a> * </td>
<td class="paramname"> <em>factory</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"> <em>maxdist</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>
Add a factory and the maximum distance after which this factory will no longer be used.
<p>
The minimum distance will be calculated from the maximum distance used for other factories in this geometry.
</div>
</div><p>
<a class="anchor" name="22a49631cbb0270847773a6f47db5344"></a><!-- doxytag: member="iMeshGeneratorGeometry::AddPosition" ref="22a49631cbb0270847773a6f47db5344" args="(const csVector2 &pos)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iMeshGeneratorGeometry::AddPosition </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classcsVector2.html">csVector2</a> & </td>
<td class="paramname"> <em>pos</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add position for placing mesh (only material factor will influence it).
<p>
</div>
</div><p>
<a class="anchor" name="b78ad6b7493c7e0d5902e42c93704bd8"></a><!-- doxytag: member="iMeshGeneratorGeometry::GetDensity" ref="b78ad6b7493c7e0d5902e42c93704bd8" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual float iMeshGeneratorGeometry::GetDensity </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>
Get the density.
<p>
</div>
</div><p>
<a class="anchor" name="3a3aa2cc066cc7cd3fc5bc760f44875c"></a><!-- doxytag: member="iMeshGeneratorGeometry::GetFactory" ref="3a3aa2cc066cc7cd3fc5bc760f44875c" args="(size_t idx)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiMeshFactoryWrapper.html">iMeshFactoryWrapper</a>* iMeshGeneratorGeometry::GetFactory </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>idx</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a specified factory.
<p>
</div>
</div><p>
<a class="anchor" name="c99fc5abc9b81611b0cb77b572afb37d"></a><!-- doxytag: member="iMeshGeneratorGeometry::GetFactoryCount" ref="c99fc5abc9b81611b0cb77b572afb37d" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual size_t iMeshGeneratorGeometry::GetFactoryCount </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>
Get the number of factories for this geometry.
<p>
</div>
</div><p>
<a class="anchor" name="7b370e8d1dc3b2034da5ee12e709ed94"></a><!-- doxytag: member="iMeshGeneratorGeometry::GetMaximumDistance" ref="7b370e8d1dc3b2034da5ee12e709ed94" args="(size_t idx)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual float iMeshGeneratorGeometry::GetMaximumDistance </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>idx</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a specified maximum distance.
<p>
</div>
</div><p>
<a class="anchor" name="760a52e5b206c1ef08bbffaa018bf684"></a><!-- doxytag: member="iMeshGeneratorGeometry::GetRadius" ref="760a52e5b206c1ef08bbffaa018bf684" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual float iMeshGeneratorGeometry::GetRadius </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>
Get the radius for this object.
<p>
</div>
</div><p>
<a class="anchor" name="dce7fe42cd635e6ece65468a0dc07101"></a><!-- doxytag: member="iMeshGeneratorGeometry::RemoveFactory" ref="dce7fe42cd635e6ece65468a0dc07101" args="(size_t idx)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iMeshGeneratorGeometry::RemoveFactory </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>idx</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove a factory.
<p>
</div>
</div><p>
<a class="anchor" name="1cefdf489fdf6be703355d95e9a2d1a2"></a><!-- doxytag: member="iMeshGeneratorGeometry::SetDefaultDensityMaterialFactor" ref="1cefdf489fdf6be703355d95e9a2d1a2" args="(float factor)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iMeshGeneratorGeometry::SetDefaultDensityMaterialFactor </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"> <em>factor</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the default factor to use in case the material found on the meshes is not any of the ones defined in the material factory table.
<p>
By default the default factor is 0. This means that as soon as you use SetDensityMaterialFactor() above then on every material that is not listed there will be no foliage generated. The default factor is NOT used in case the material factor table is empty.
</div>
</div><p>
<a class="anchor" name="d16b99bdac3b2d9d83627ceed3c644fa"></a><!-- doxytag: member="iMeshGeneratorGeometry::SetDensity" ref="d16b99bdac3b2d9d83627ceed3c644fa" args="(float density)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iMeshGeneratorGeometry::SetDensity </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"> <em>density</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the density.
<p>
The density is defined as the number of objects in every 1x1 square. Default density is 1. <dl compact><dt><b><a class="el" href="todo.html#_todo000012">Todo:</a></b></dt><dd>add density map support. </dd></dl>
</div>
</div><p>
<a class="anchor" name="98ed2b83fc83a236737143cad1a5412d"></a><!-- doxytag: member="iMeshGeneratorGeometry::SetDensityMap" ref="98ed2b83fc83a236737143cad1a5412d" args="(iTerraFormer *map, float factor, const csStringID &type)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iMeshGeneratorGeometry::SetDensityMap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiTerraFormer.html">iTerraFormer</a> * </td>
<td class="paramname"> <em>map</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"> <em>factor</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd">csStringID</a> & </td>
<td class="paramname"> <em>type</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>
Set a density map in grayscale with factor.
<p>
The base density will be used to try a number of positions in every cell. Density map will be used to affect base density at given point. So for given point density will be based on base density * value from density map * map factor.
</div>
</div><p>
<a class="anchor" name="2e45eaa76e6287ba3f8ee77bd130f50f"></a><!-- doxytag: member="iMeshGeneratorGeometry::SetRadius" ref="2e45eaa76e6287ba3f8ee77bd130f50f" args="(float radius)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iMeshGeneratorGeometry::SetRadius </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"> <em>radius</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the radius for this object.
<p>
No other objects will be generated within this radius. If this radius is 0 then there is no limitation on object generation (i.e. objects can be put on top of each other if the random generator decides to do that). Default is 0.
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>iengine/<a class="el" href="meshgen_8h-source.html">meshgen.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
>
3255
