![]() |
Public API Reference |
![]() |
Noise module that raises the output value from a first source module to the power of the output value from a second source module. More...
#include <cstool/noise/module/power.h>
Public Member Functions | |
virtual int | GetSourceModuleCount () const |
Returns the number of source modules required by this noise module. | |
virtual double | GetValue (double x, double y, double z) const |
Generates an output value given the coordinates of the specified input value. | |
Power () | |
Constructor. |
Noise module that raises the output value from a first source module to the power of the output value from a second source module.
The first source module must have an index value of 0.
The second source module must have an index value of 1.
This noise module requires two source modules.
Constructor.
virtual int CS::Math::Noise::Module::Power::GetSourceModuleCount | ( | ) | const [inline, virtual] |
Returns the number of source modules required by this noise module.
Implements CS::Math::Noise::Module::Module.
virtual double CS::Math::Noise::Module::Power::GetValue | ( | double | x, |
double | y, | ||
double | z | ||
) | const [virtual] |
Generates an output value given the coordinates of the specified input value.
x | The x coordinate of the input value. |
y | The y coordinate of the input value. |
z | The z coordinate of the input value. |
Before an application can call this method, it must first connect all required source modules via the SetSourceModule() method. If these source modules are not connected to this noise module, this method raises a debug assertion.
To determine the number of source modules required by this noise module, call the GetSourceModuleCount() method.
Implements CS::Math::Noise::Module::Module.