<!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::Curve Class Reference<br>
<small>
[<a class="el" href="group__modifiermodules.html">Modifier Modules</a>]</small>
</h1><code>#include <<a class="el" href="curve_8h-source.html">curve.h</a>></code>
<p>
<p>Inheritance diagram for noise::module::Curve:
<p><center><img src="classnoise_1_1module_1_1Curve.png" usemap="#noise::module::Curve_map" border="0" alt=""></center>
<map name="noise::module::Curve_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_1Curve-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Noise module that maps the output value from a source module onto an arbitrary function curve.
<p>
<div align="center">
<img src="modulecurve.png" alt="modulecurve.png">
</div>
<p>
This noise module maps the output value from the source module onto an application-defined curve. This curve is defined by a number of <em>control points</em>; each control point has an <em>input value</em> that maps to an <em>output value</em>. Refer to the following illustration:<p>
<div align="center">
<img src="curve.png" alt="curve.png">
</div>
<p>
To add the control points to this curve, call the <a class="el" href="classnoise_1_1module_1_1Curve.html#a2">AddControlPoint()</a> method.<p>
Since this curve is a cubic spline, an application must add a minimum of four control points to the curve. If this is not done, the <a class="el" href="classnoise_1_1module_1_1Curve.html#a7">GetValue()</a> method fails. Each control point can have any input and output value, although no two control points can have the same input value. There is no limit to the number of control points that can be added to the curve.<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"><a class="anchor" name="a0" doxytag="noise::module::Curve::Curve"></a>
</td><td class="memItemRight" valign="bottom"><a class="el" href="classnoise_1_1module_1_1Curve.html#a0">Curve</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1" doxytag="noise::module::Curve::~Curve"></a>
</td><td class="memItemRight" valign="bottom"><a class="el" href="classnoise_1_1module_1_1Curve.html#a1">~Curve</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <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_1Curve.html#a2">AddControlPoint</a> (double inputValue, double outputValue)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a control point to the curve. <a href="#a2"></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_1Curve.html#a3">ClearAllControlPoints</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Deletes all the control points on the curve. <a href="#a3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="structnoise_1_1module_1_1ControlPoint.html">ControlPoint</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classnoise_1_1module_1_1Curve.html#a4">GetControlPointArray</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to the array of control points on the curve. <a href="#a4"></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_1Curve.html#a5">GetControlPointCount</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of control points on the curve. <a href="#a5"></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_1Curve.html#a6">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="#a6"></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_1Curve.html#a7">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="#a7"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></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_1Curve.html#b0">FindInsertionPos</a> (double inputValue)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determines the array index in which to insert the control point into the internal control point array. <a href="#b0"></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_1Curve.html#b1">InsertAtPos</a> (int insertionPos, double inputValue, double outputValue)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Inserts the control point at the specified position in the internal control point array. <a href="#b1"></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::Curve::m_controlPointCount"></a>
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classnoise_1_1module_1_1Curve.html#p0">m_controlPointCount</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Number of control points on the curve. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="p1" doxytag="noise::module::Curve::m_pControlPoints"></a>
<a class="el" href="structnoise_1_1module_1_1ControlPoint.html">ControlPoint</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classnoise_1_1module_1_1Curve.html#p1">m_pControlPoints</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Array that stores the control points. <br></td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a2" doxytag="noise::module::Curve::AddControlPoint"></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 Curve::AddControlPoint </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">double </td>
<td class="mdname" nowrap> <em>inputValue</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>outputValue</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>
Adds a control point to the curve.
<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>inputValue</em> </td><td>The input value stored in the control point. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>outputValue</em> </td><td>The output value stored in the control point.</td></tr>
</table>
</dl>
<dl compact><dt><b>Precondition:</b></dt><dd>No two control points have the same input value.</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>
It does not matter which order these points are added. </td>
</tr>
</table>
<a class="anchor" name="a3" doxytag="noise::module::Curve::ClearAllControlPoints"></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 Curve::ClearAllControlPoints </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>
Deletes all the control points on the curve.
<p>
<dl compact><dt><b>Postcondition:</b></dt><dd>All points on the curve are deleted. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="b0" doxytag="noise::module::Curve::FindInsertionPos"></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 Curve::FindInsertionPos </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">double </td>
<td class="mdname1" valign="top" nowrap> <em>inputValue</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Determines the array index in which to insert the control point into the internal control point array.
<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>inputValue</em> </td><td>The input value of the control point.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The array index in which to insert the control point.</dd></dl>
<dl compact><dt><b>Precondition:</b></dt><dd>No two control points have the same input value.</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>
By inserting the control point at the returned array index, this class ensures that the control point array is sorted by input value. The code that maps a value onto the curve requires a sorted control point array. </td>
</tr>
</table>
<a class="anchor" name="a4" doxytag="noise::module::Curve::GetControlPointArray"></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="structnoise_1_1module_1_1ControlPoint.html">ControlPoint</a>* noise::module::Curve::GetControlPointArray </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 a pointer to the array of control points on the curve.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>A pointer to the array of control points.</dd></dl>
Before calling this method, call <a class="el" href="classnoise_1_1module_1_1Curve.html#a5">GetControlPointCount()</a> to determine the number of control points in this array.<p>
It is recommended that an application does not store this pointer for later use since the pointer to the array may change if the application calls another method of this object. </td>
</tr>
</table>
<a class="anchor" name="a5" doxytag="noise::module::Curve::GetControlPointCount"></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::Curve::GetControlPointCount </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 number of control points on the curve.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The number of control points on the curve. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a6" doxytag="noise::module::Curve::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::Curve::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="a7" doxytag="noise::module::Curve::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 Curve::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_1Curve.html#a6">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="b1" doxytag="noise::module::Curve::InsertAtPos"></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 Curve::InsertAtPos </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname" nowrap> <em>insertionPos</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>inputValue</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>outputValue</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Inserts the control point at the specified position in the internal control point array.
<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>insertionPos</em> </td><td>The zero-based array position in which to insert the control point. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>inputValue</em> </td><td>The input value stored in the control point. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>outputValue</em> </td><td>The output value stored in the control point.</td></tr>
</table>
</dl>
To make room for this new control point, this method reallocates the control point array and shifts all control points occurring after the insertion position up by one.<p>
Because the curve mapping algorithm used by this noise module requires that all control points in the array must be sorted by input value, the new control point should be inserted at the position in which the order is still preserved. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="curve_8h-source.html">curve.h</a><li>curve.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>
