<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>libnoise: Documentation</title>
<link rel='stylesheet' type='text/css' href='doxygen.css'>
<meta http-equiv='Content-Type' content='text/html; charset=ISO-8859-1'>
</head>
<body>
<table class='layout'>
<tr>
<td class='sidebar' rowspan='2'>
<p>
Navigation menu
</p>
<ul class='toc'>
<li>
<a href='http://libnoise.sourceforge.net/index.html'>Main</a>
</li>
<li>
<a href='http://libnoise.sourceforge.net/downloads/index.html'>Downloads</a>
</li>
<li>
<a href='http://libnoise.sourceforge.net/coherentnoise/index.html'>What is coherent noise?</a>
</li>
<li>
<a href='http://libnoise.sourceforge.net/noisegen/index.html'>Generating coherent noise</a>
</li>
<li>
<a href='http://libnoise.sourceforge.net/glossary/index.html'>Glossary</a>
</li>
<li>
<a href='http://libnoise.sourceforge.net/examples/index.html'>Examples</a>
<ul class='toc'>
<li>
<a href='http://libnoise.sourceforge.net/examples/textures/index.html'>Procedural textures</a>
</li>
<li>
<a href='http://libnoise.sourceforge.net/examples/complexplanet/index.html'>Complex planetary surface</a>
</li>
<li>
<a href='http://libnoise.sourceforge.net/examples/worms/index.html'>Perlin worms</a>
</li>
</ul>
</li>
<li>
<strong>Docs</strong>
</li>
<li>
<a href='tutorials/index.html'>Tutorials</a>
<ul class='toc'>
<li>
<a href='http://libnoise.sourceforge.net/tutorials/tutorial1.html'>Tutorial 1</a>
</li>
<li>
<a href='http://libnoise.sourceforge.net/tutorials/tutorial2.html'>Tutorial 2</a>
</li>
<li>
<a href='http://libnoise.sourceforge.net/tutorials/tutorial3.html'>Tutorial 3</a>
</li>
<li>
<a href='http://libnoise.sourceforge.net/tutorials/tutorial4.html'>Tutorial 4</a>
</li>
<li>
<a href='http://libnoise.sourceforge.net/tutorials/tutorial5.html'>Tutorial 5</a>
</li>
<li>
<a href='http://libnoise.sourceforge.net/tutorials/tutorial6.html'>Tutorial 6</a>
</li>
<li>
<a href='http://libnoise.sourceforge.net/tutorials/tutorial7.html'>Tutorial 7</a>
</li>
<li>
<a href='http://libnoise.sourceforge.net/tutorials/tutorial8.html'>Tutorial 8</a>
</li>
</ul>
</li>
<li>
<a href='http://libnoise.sourceforge.net/cvs/index.html'>CVS</a>
</li>
<li>
<a href='http://libnoise.sourceforge.net/links/index.html'>Links</a>
</li>
</ul>
</td>
<td class='header'>
<p>
<img src='libnoise.png' alt='libnoise logo'>
</p>
<p>
A portable, open-source, coherent noise-generating library for C++
</p>
<hr>
</td>
</tr>
<tr>
<td class='content'>
<!-- start rich gooey content -->
<!-- Generated by Doxygen 1.3.9.1 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a></div>
<h1>noise::module::Turbulence Class Reference<br>
<small>
[<a class="el" href="group__transformermodules.html">Transformer Modules</a>]</small>
</h1><code>#include <<a class="el" href="turbulence_8h-source.html">turbulence.h</a>></code>
<p>
<p>Inheritance diagram for noise::module::Turbulence:
<p><center><img src="classnoise_1_1module_1_1Turbulence.png" usemap="#noise::module::Turbulence_map" border="0" alt=""></center>
<map name="noise::module::Turbulence_map">
<area href="classnoise_1_1module_1_1Module.html" alt="noise::module::Module" shape="rect" coords="0,0,158,24">
</map>
<a href="classnoise_1_1module_1_1Turbulence-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Noise module that randomly displaces the input value before returning the output value from a source module.
<p>
<div align="center">
<img src="moduleturbulence.png" alt="moduleturbulence.png">
</div>
<p>
<em><a class="el" href="classnoise_1_1module_1_1Turbulence.html">Turbulence</a></em> is the pseudo-random displacement of the input value. The <a class="el" href="classnoise_1_1module_1_1Turbulence.html#a6">GetValue()</a> method randomly displaces the ( <em>x</em>, <em>y</em>, <em>z</em> ) coordinates of the input value before retrieving the output value from the source module. To control the turbulence, an application can modify its frequency, its power, and its roughness.<p>
The frequency of the turbulence determines how rapidly the displacement amount changes. To specify the frequency, call the <a class="el" href="classnoise_1_1module_1_1Turbulence.html#a7">SetFrequency()</a> method.<p>
The power of the turbulence determines the scaling factor that is applied to the displacement amount. To specify the power, call the <a class="el" href="classnoise_1_1module_1_1Turbulence.html#a8">SetPower()</a> method.<p>
The roughness of the turbulence determines the roughness of the changes to the displacement amount. Low values smoothly change the displacement amount. High values roughly change the displacement amount, which produces more "kinky" changes. To specify the roughness, call the <a class="el" href="classnoise_1_1module_1_1Turbulence.html#a9">SetRoughness()</a> method.<p>
Use of this noise module may require some trial and error. Assuming that you are using a generator module as the source module, you should first:<ul>
<li>Set the frequency to the same frequency as the source module.</li><li>Set the power to the reciprocal of the frequency.</li></ul>
<p>
From these initial frequency and power values, modify these values until this noise module produce the desired changes in your terrain or texture. For example:<ul>
<li>Low frequency (1/8 initial frequency) and low power (1/8 initial power) produces very minor, almost unnoticeable changes.</li><li>Low frequency (1/8 initial frequency) and high power (8 times initial power) produces "ropey" lava-like terrain or marble-like textures.</li><li>High frequency (8 times initial frequency) and low power (1/8 initial power) produces a noisy version of the initial terrain or texture.</li><li>High frequency (8 times initial frequency) and high power (8 times initial power) produces nearly pure noise, which isn't entirely useful.</li></ul>
<p>
Displacing the input values result in more realistic terrain and textures. If you are generating elevations for terrain height maps, you can use this noise module to produce more realistic mountain ranges or terrain features that look like flowing lava rock. If you are generating values for textures, you can use this noise module to produce realistic marble-like or "oily" textures.<p>
Internally, there are three <a class="el" href="classnoise_1_1module_1_1Perlin.html">noise::module::Perlin</a> noise modules that displace the input value; one for the <em>x</em>, one for the <em>y</em>, and one for the <em>z</em> coordinate.<p>
This noise module requires one source module.
<p>
<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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classnoise_1_1module_1_1Turbulence.html#a0">Turbulence</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classnoise_1_1module_1_1Turbulence.html#a1">GetFrequency</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the frequency of the turbulence. <a href="#a1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classnoise_1_1module_1_1Turbulence.html#a2">GetPower</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the power of the turbulence. <a href="#a2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classnoise_1_1module_1_1Turbulence.html#a3">GetRoughnessCount</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the roughness of the turbulence. <a href="#a3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classnoise_1_1module_1_1Turbulence.html#a4">GetSeed</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the seed value of the internal Perlin-noise modules that are used to displace the input values. <a href="#a4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classnoise_1_1module_1_1Turbulence.html#a5">GetSourceModuleCount</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of source modules required by this noise module. <a href="#a5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual double </td><td class="memItemRight" valign="bottom"><a class="el" href="classnoise_1_1module_1_1Turbulence.html#a6">GetValue</a> (double x, double y, double z) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Generates an output value given the coordinates of the specified input value. <a href="#a6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classnoise_1_1module_1_1Turbulence.html#a7">SetFrequency</a> (double frequency)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the frequency of the turbulence. <a href="#a7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classnoise_1_1module_1_1Turbulence.html#a8">SetPower</a> (double power)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the power of the turbulence. <a href="#a8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classnoise_1_1module_1_1Turbulence.html#a9">SetRoughness</a> (int roughness)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the roughness of the turbulence. <a href="#a9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classnoise_1_1module_1_1Turbulence.html#a10">SetSeed</a> (int seed)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the seed value of the internal noise modules that are used to displace the input values. <a href="#a10"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="p0" doxytag="noise::module::Turbulence::m_power"></a>
double </td><td class="memItemRight" valign="bottom"><a class="el" href="classnoise_1_1module_1_1Turbulence.html#p0">m_power</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The power (scale) of the displacement. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="p1" doxytag="noise::module::Turbulence::m_xDistortModule"></a>
<a class="el" href="classnoise_1_1module_1_1Perlin.html">Perlin</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classnoise_1_1module_1_1Turbulence.html#p1">m_xDistortModule</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Noise module that displaces the <em>x</em> coordinate. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="p2" doxytag="noise::module::Turbulence::m_yDistortModule"></a>
<a class="el" href="classnoise_1_1module_1_1Perlin.html">Perlin</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classnoise_1_1module_1_1Turbulence.html#p2">m_yDistortModule</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Noise module that displaces the <em>y</em> coordinate. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="p3" doxytag="noise::module::Turbulence::m_zDistortModule"></a>
<a class="el" href="classnoise_1_1module_1_1Perlin.html">Perlin</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classnoise_1_1module_1_1Turbulence.html#p3">m_zDistortModule</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Noise module that displaces the <em>z</em> coordinate. <br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="noise::module::Turbulence::Turbulence"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">Turbulence::Turbulence </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Constructor.
<p>
The default frequency is set to <a class="el" href="group__transformermodules.html#ga9">noise::module::DEFAULT_TURBULENCE_FREQUENCY</a>.<p>
The default power is set to <a class="el" href="group__transformermodules.html#ga10">noise::module::DEFAULT_TURBULENCE_POWER</a>.<p>
The default roughness is set to <a class="el" href="group__transformermodules.html#ga11">noise::module::DEFAULT_TURBULENCE_ROUGHNESS</a>.<p>
The default seed value is set to <a class="el" href="group__transformermodules.html#ga12">noise::module::DEFAULT_TURBULENCE_SEED</a>. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a1" doxytag="noise::module::Turbulence::GetFrequency"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">double Turbulence::GetFrequency </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns the frequency of the turbulence.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The frequency of the turbulence.</dd></dl>
The frequency of the turbulence determines how rapidly the displacement amount changes. </td>
</tr>
</table>
<a class="anchor" name="a2" doxytag="noise::module::Turbulence::GetPower"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">double noise::module::Turbulence::GetPower </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns the power of the turbulence.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The power of the turbulence.</dd></dl>
The power of the turbulence determines the scaling factor that is applied to the displacement amount. </td>
</tr>
</table>
<a class="anchor" name="a3" doxytag="noise::module::Turbulence::GetRoughnessCount"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int noise::module::Turbulence::GetRoughnessCount </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns the roughness of the turbulence.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The roughness of the turbulence.</dd></dl>
The roughness of the turbulence determines the roughness of the changes to the displacement amount. Low values smoothly change the displacement amount. High values roughly change the displacement amount, which produces more "kinky" changes. </td>
</tr>
</table>
<a class="anchor" name="a4" doxytag="noise::module::Turbulence::GetSeed"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int Turbulence::GetSeed </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns the seed value of the internal Perlin-noise modules that are used to displace the input values.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The seed value.</dd></dl>
Internally, there are three <a class="el" href="classnoise_1_1module_1_1Perlin.html">noise::module::Perlin</a> noise modules that displace the input value; one for the <em>x</em>, one for the <em>y</em>, and one for the <em>z</em> coordinate. </td>
</tr>
</table>
<a class="anchor" name="a5" doxytag="noise::module::Turbulence::GetSourceModuleCount"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual int noise::module::Turbulence::GetSourceModuleCount </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns the number of source modules required by this noise module.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The number of source modules required by this noise module. </dd></dl>
<p>
Implements <a class="el" href="classnoise_1_1module_1_1Module.html#a3">noise::module::Module</a>. </td>
</tr>
</table>
<a class="anchor" name="a6" doxytag="noise::module::Turbulence::GetValue"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">double Turbulence::GetValue </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">double </td>
<td class="mdname" nowrap> <em>x</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>double </td>
<td class="mdname" nowrap> <em>y</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>double </td>
<td class="mdname" nowrap> <em>z</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"> const<code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Generates an output value given the coordinates of the specified input value.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>x</em> </td><td>The <em>x</em> coordinate of the input value. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>y</em> </td><td>The <em>y</em> coordinate of the input value. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>z</em> </td><td>The <em>z</em> coordinate of the input value.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The output value.</dd></dl>
<dl compact><dt><b>Precondition:</b></dt><dd>All source modules required by this noise module have been passed to the <a class="el" href="classnoise_1_1module_1_1Module.html#a5">SetSourceModule()</a> method.</dd></dl>
Before an application can call this method, it must first connect all required source modules via the <a class="el" href="classnoise_1_1module_1_1Module.html#a5">SetSourceModule()</a> method. If these source modules are not connected to this noise module, this method raises a debug assertion.<p>
To determine the number of source modules required by this noise module, call the <a class="el" href="classnoise_1_1module_1_1Turbulence.html#a5">GetSourceModuleCount()</a> method.
<p>
Implements <a class="el" href="classnoise_1_1module_1_1Module.html#a4">noise::module::Module</a>. </td>
</tr>
</table>
<a class="anchor" name="a7" doxytag="noise::module::Turbulence::SetFrequency"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void noise::module::Turbulence::SetFrequency </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">double </td>
<td class="mdname1" valign="top" nowrap> <em>frequency</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Sets the frequency of the turbulence.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>frequency</em> </td><td>The frequency of the turbulence.</td></tr>
</table>
</dl>
The frequency of the turbulence determines how rapidly the displacement amount changes. </td>
</tr>
</table>
<a class="anchor" name="a8" doxytag="noise::module::Turbulence::SetPower"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void noise::module::Turbulence::SetPower </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">double </td>
<td class="mdname1" valign="top" nowrap> <em>power</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Sets the power of the turbulence.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>power</em> </td><td>The power of the turbulence.</td></tr>
</table>
</dl>
The power of the turbulence determines the scaling factor that is applied to the displacement amount. </td>
</tr>
</table>
<a class="anchor" name="a9" doxytag="noise::module::Turbulence::SetRoughness"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void noise::module::Turbulence::SetRoughness </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>roughness</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Sets the roughness of the turbulence.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>roughness</em> </td><td>The roughness of the turbulence.</td></tr>
</table>
</dl>
The roughness of the turbulence determines the roughness of the changes to the displacement amount. Low values smoothly change the displacement amount. High values roughly change the displacement amount, which produces more "kinky" changes.<p>
Internally, there are three <a class="el" href="classnoise_1_1module_1_1Perlin.html">noise::module::Perlin</a> noise modules that displace the input value; one for the <em>x</em>, one for the <em>y</em>, and one for the <em>z</em> coordinate. The roughness value is equal to the number of octaves used by the <a class="el" href="classnoise_1_1module_1_1Perlin.html">noise::module::Perlin</a> noise modules. </td>
</tr>
</table>
<a class="anchor" name="a10" doxytag="noise::module::Turbulence::SetSeed"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void Turbulence::SetSeed </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>seed</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Sets the seed value of the internal noise modules that are used to displace the input values.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>seed</em> </td><td>The seed value.</td></tr>
</table>
</dl>
Internally, there are three <a class="el" href="classnoise_1_1module_1_1Perlin.html">noise::module::Perlin</a> noise modules that displace the input value; one for the <em>x</em>, one for the <em>y</em>, and one for the <em>z</em> coordinate. This noise module assigns the following seed values to the <a class="el" href="classnoise_1_1module_1_1Perlin.html">noise::module::Perlin</a> noise modules:<ul>
<li>It assigns the seed value (<em>seed</em> + 0) to the <em>x</em> noise module.</li><li>It assigns the seed value (<em>seed</em> + 1) to the <em>y</em> noise module.</li><li>It assigns the seed value (<em>seed</em> + 2) to the <em>z</em> noise module. </li></ul>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="turbulence_8h-source.html">turbulence.h</a><li>turbulence.cpp</ul>
<!-- end rich gooey content -->
</td>
</tr>
<tr>
<td class='footer' colspan='2'>
<p>
© 2003-2005 Jason Bevins
</p>
<p>
<a href='http://www.doxygen.org/'><img src='doxygen.png' alt='Doxygen logo'></a>
<br>
The libnoise source documentation was generated by <a href='http://www.doxygen.org/'>doxygen</a> 1.3.9.1
</p>
</td>
</tr>
</table>
</body>
</html>
