![]() |
Public API Reference |
![]() |
Model that defines the surface of a plane. More...
#include <cstool/noise/model/plane.h>
Public Member Functions | |
const CS::Math::Noise::Module::Module & | GetModule () const |
Returns the noise module that is used to generate the output values. | |
double | GetValue (double x, double z) const |
Returns the output value from the noise module given the ( x, z ) coordinates of the specified input value located on the surface of the plane. | |
Plane () | |
Constructor. | |
Plane (const CS::Math::Noise::Module::Module &module) | |
Constructor. | |
void | SetModule (const CS::Math::Noise::Module::Module &module) |
Sets the noise module that is used to generate the output values. |
Model that defines the surface of a plane.
This model returns an output value from a noise module given the coordinates of an input value located on the surface of an ( x, z ) plane.
To generate an output value, pass the ( x, z ) coordinates of an input value to the GetValue() method.
This model is useful for creating:
This plane extends infinitely in both directions.
Constructor.
CS::Math::Noise::Model::Plane::Plane | ( | const CS::Math::Noise::Module::Module & | module | ) |
Constructor.
module | The noise module that is used to generate the output values. |
const CS::Math::Noise::Module::Module& CS::Math::Noise::Model::Plane::GetModule | ( | ) | const [inline] |
Returns the noise module that is used to generate the output values.
double CS::Math::Noise::Model::Plane::GetValue | ( | double | x, |
double | z | ||
) | const |
Returns the output value from the noise module given the ( x, z ) coordinates of the specified input value located on the surface of the plane.
x | The x coordinate of the input value. |
z | The z coordinate of the input value. |
This output value is generated by the noise module passed to the SetModule() method.
void CS::Math::Noise::Model::Plane::SetModule | ( | const CS::Math::Noise::Module::Module & | module | ) | [inline] |