<!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::Select Class Reference<br>
<small>
[<a class="el" href="group__selectormodules.html">Selector Modules</a>]</small>
</h1><code>#include <<a class="el" href="select_8h-source.html">select.h</a>></code>
<p>
<p>Inheritance diagram for noise::module::Select:
<p><center><img src="classnoise_1_1module_1_1Select.png" usemap="#noise::module::Select_map" border="0" alt=""></center>
<map name="noise::module::Select_map">
<area href="classnoise_1_1module_1_1Module.html" alt="noise::module::Module" shape="rect" coords="0,0,136,24">
</map>
<a href="classnoise_1_1module_1_1Select-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Noise module that outputs the value selected from one of two source modules chosen by the output value from a control module.
<p>
<div align="center">
<img src="moduleselect.png" alt="moduleselect.png">
</div>
<p>
Unlike most other noise modules, the index value assigned to a source module determines its role in the selection operation:<ul>
<li>Source module 0 (upper left in the diagram) outputs a value.</li><li>Source module 1 (lower left in the diagram) outputs a value.</li><li>Source module 2 (bottom of the diagram) is known as the <em>control module</em>. The control module determines the value to select. If the output value from the control module is within a range of values known as the <em>selection range</em>, this noise module outputs the value from the source module with an index value of 1. Otherwise, this noise module outputs the value from the source module with an index value of 0.</li></ul>
<p>
To specify the bounds of the selection range, call the <a class="el" href="classnoise_1_1module_1_1Select.html#a7">SetBounds()</a> method.<p>
An application can pass the control module to the <a class="el" href="classnoise_1_1module_1_1Select.html#a8">SetControlModule()</a> method instead of the <a class="el" href="classnoise_1_1module_1_1Module.html#a5">SetSourceModule()</a> method. This may make the application code easier to read.<p>
By default, there is an abrupt transition between the output values from the two source modules at the selection-range boundary. To smooth the transition, pass a non-zero value to the <a class="el" href="classnoise_1_1module_1_1Select.html#a9">SetEdgeFalloff()</a> method. Higher values result in a smoother transition.<p>
This noise module requires three source modules.
<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_1Select.html#a0">Select</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">const <a class="el" href="classnoise_1_1module_1_1Module.html">Module</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classnoise_1_1module_1_1Select.html#a1">GetControlModule</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the control module. <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_1Select.html#a2">GetEdgeFalloff</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the falloff value at the edge transition. <a href="#a2"></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_1Select.html#a3">GetLowerBound</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the lower bound of the selection range. <a href="#a3"></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_1Select.html#a4">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="#a4"></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_1Select.html#a5">GetUpperBound</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the upper bound of the selection range. <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_1Select.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_1Select.html#a7">SetBounds</a> (double lowerBound, double upperBound)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the lower and upper bounds of the selection range. <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_1Select.html#a8">SetControlModule</a> (const <a class="el" href="classnoise_1_1module_1_1Module.html">Module</a> &controlModule)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the control module. <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_1Select.html#a9">SetEdgeFalloff</a> (double edgeFalloff)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the falloff value at the edge transition. <a href="#a9"></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::Select::m_edgeFalloff"></a>
double </td><td class="memItemRight" valign="bottom"><a class="el" href="classnoise_1_1module_1_1Select.html#p0">m_edgeFalloff</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Edge-falloff value. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="p1" doxytag="noise::module::Select::m_lowerBound"></a>
double </td><td class="memItemRight" valign="bottom"><a class="el" href="classnoise_1_1module_1_1Select.html#p1">m_lowerBound</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Lower bound of the selection range. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="p2" doxytag="noise::module::Select::m_upperBound"></a>
double </td><td class="memItemRight" valign="bottom"><a class="el" href="classnoise_1_1module_1_1Select.html#p2">m_upperBound</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Upper bound of the selection range. <br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="noise::module::Select::Select"></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">Select::Select </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 falloff value at the edge transition is set to <a class="el" href="group__selectormodules.html#ga0">noise::module::DEFAULT_SELECT_EDGE_FALLOFF</a>.<p>
The default lower bound of the selection range is set to <a class="el" href="group__selectormodules.html#ga1">noise::module::DEFAULT_SELECT_LOWER_BOUND</a>.<p>
The default upper bound of the selection range is set to <a class="el" href="group__selectormodules.html#ga2">noise::module::DEFAULT_SELECT_UPPER_BOUND</a>. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a1" doxytag="noise::module::Select::GetControlModule"></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">const <a class="el" href="classnoise_1_1module_1_1Module.html">Module</a>& noise::module::Select::GetControlModule </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 control module.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>A reference to the control module.</dd></dl>
<dl compact><dt><b>Precondition:</b></dt><dd>A control module has been added to this noise module via a call to <a class="el" href="classnoise_1_1module_1_1Module.html#a5">SetSourceModule()</a> or <a class="el" href="classnoise_1_1module_1_1Select.html#a8">SetControlModule()</a>.</dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>noise::ExceptionNoModule</em> </td><td>See the preconditions for more information.</td></tr>
</table>
</dl>
The control module determines the output value to select. If the output value from the control module is within a range of values known as the <em>selection range</em>, the <a class="el" href="classnoise_1_1module_1_1Select.html#a6">GetValue()</a> method outputs the value from the source module with an index value of 1. Otherwise, this method outputs the value from the source module with an index value of 0. </td>
</tr>
</table>
<a class="anchor" name="a2" doxytag="noise::module::Select::GetEdgeFalloff"></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::Select::GetEdgeFalloff </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 falloff value at the edge transition.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The falloff value at the edge transition.</dd></dl>
The falloff value is the width of the edge transition at either edge of the selection range.<p>
By default, there is an abrupt transition between the output values from the two source modules at the selection-range boundary. </td>
</tr>
</table>
<a class="anchor" name="a3" doxytag="noise::module::Select::GetLowerBound"></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::Select::GetLowerBound </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 lower bound of the selection range.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The lower bound of the selection range.</dd></dl>
If the output value from the control module is within the selection range, the <a class="el" href="classnoise_1_1module_1_1Select.html#a6">GetValue()</a> method outputs the value from the source module with an index value of 1. Otherwise, this method outputs the value from the source module with an index value of 0. </td>
</tr>
</table>
<a class="anchor" name="a4" doxytag="noise::module::Select::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::Select::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="a5" doxytag="noise::module::Select::GetUpperBound"></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::Select::GetUpperBound </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 upper bound of the selection range.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The upper bound of the selection range.</dd></dl>
If the output value from the control module is within the selection range, the <a class="el" href="classnoise_1_1module_1_1Select.html#a6">GetValue()</a> method outputs the value from the source module with an index value of 1. Otherwise, this method outputs the value from the source module with an index value of 0. </td>
</tr>
</table>
<a class="anchor" name="a6" doxytag="noise::module::Select::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 Select::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_1Select.html#a4">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::Select::SetBounds"></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 Select::SetBounds </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">double </td>
<td class="mdname" nowrap> <em>lowerBound</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>upperBound</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Sets the lower and upper bounds of the selection range.
<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>lowerBound</em> </td><td>The lower bound. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>upperBound</em> </td><td>The upper bound.</td></tr>
</table>
</dl>
<dl compact><dt><b>Precondition:</b></dt><dd>The lower bound must be less than or equal to the upper bound.</dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>noise::ExceptionInvalidParam</em> </td><td>An invalid parameter was specified; see the preconditions for more information.</td></tr>
</table>
</dl>
If the output value from the control module is within the selection range, the <a class="el" href="classnoise_1_1module_1_1Select.html#a6">GetValue()</a> method outputs the value from the source module with an index value of 1. Otherwise, this method outputs the value from the source module with an index value of 0. </td>
</tr>
</table>
<a class="anchor" name="a8" doxytag="noise::module::Select::SetControlModule"></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::Select::SetControlModule </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classnoise_1_1module_1_1Module.html">Module</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>controlModule</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 control module.
<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>controlModule</em> </td><td>The control module.</td></tr>
</table>
</dl>
The control module determines the output value to select. If the output value from the control module is within a range of values known as the <em>selection range</em>, the <a class="el" href="classnoise_1_1module_1_1Select.html#a6">GetValue()</a> method outputs the value from the source module with an index value of 1. Otherwise, this method outputs the value from the source module with an index value of 0.<p>
This method assigns the control module an index value of 2. Passing the control module to this method produces the same results as passing the control module to the <a class="el" href="classnoise_1_1module_1_1Module.html#a5">SetSourceModule()</a> method while assigning that noise module an index value of 2.<p>
This control module must exist throughout the lifetime of this noise module unless another control module replaces that control module. </td>
</tr>
</table>
<a class="anchor" name="a9" doxytag="noise::module::Select::SetEdgeFalloff"></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 Select::SetEdgeFalloff </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">double </td>
<td class="mdname1" valign="top" nowrap> <em>edgeFalloff</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 falloff value at the edge transition.
<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>edgeFalloff</em> </td><td>The falloff value at the edge transition.</td></tr>
</table>
</dl>
The falloff value is the width of the edge transition at either edge of the selection range.<p>
By default, there is an abrupt transition between the values from the two source modules at the boundaries of the selection range.<p>
For example, if the selection range is 0.5 to 0.8, and the edge falloff value is 0.1, then the <a class="el" href="classnoise_1_1module_1_1Select.html#a6">GetValue()</a> method outputs:<ul>
<li>the output value from the source module with an index value of 0 if the output value from the control module is less than 0.4 ( = 0.5 - 0.1).</li><li>a linear blend between the two output values from the two source modules if the output value from the control module is between 0.4 ( = 0.5 - 0.1) and 0.6 ( = 0.5 + 0.1).</li><li>the output value from the source module with an index value of 1 if the output value from the control module is between 0.6 ( = 0.5 + 0.1) and 0.7 ( = 0.8 - 0.1).</li><li>a linear blend between the output values from the two source modules if the output value from the control module is between 0.7 ( = 0.8 - 0.1 ) and 0.9 ( = 0.8 + 0.1).</li><li>the output value from the source module with an index value of 0 if the output value from the control module is greater than 0.9 ( = 0.8 + 0.1). </li></ul>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="select_8h-source.html">select.h</a><li>select.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>
