CS::Math::Noise::Model::Line Class Reference
[Models]
Model that defines the displacement of a line segment. More...
#include <cstool/noise/model/line.h>
Detailed Description
Model that defines the displacement of a line segment.
This model returns an output value from a noise module given the one-dimensional coordinate of an input value located on a line segment, which can be used as displacements.
This class is useful for creating:
- roads and rivers
- disaffected college students
To generate an output value, pass an input value between 0.0 and 1.0 to the GetValue() method. 0.0 represents the start position of the line segment and 1.0 represents the end position of the line segment.
Definition at line 52 of file line.h.
Constructor & Destructor Documentation
Constructor.
Constructor.
- Parameters:
-
Member Function Documentation
Returns the noise module that is used to generate the output values.
- Returns:
- A reference to the noise module.
- Precondition:
- A noise module was passed to the SetModule() method.
Definition at line 84 of file line.h.
Returns the output value from the noise module given the one-dimensional coordinate of the specified input value located on the line segment.
- Parameters:
-
- Returns:
- The output value from the noise module.
- Precondition:
- A noise module was passed to the SetModule() method.
- The start and end points of the line segment were specified.
The output value is generated by the noise module passed to the SetModule() method. This value may be attenuated (moved toward 0.0) as p approaches either end of the line segment; this is the default behavior.
If the value is not to be attenuated, p can safely range outside the 0.0 to 1.0 range; the output value will be extrapolated along the line that this segment is part of.
The documentation for this class was generated from the following file:
Generated for Crystal Space 2.0 by doxygen 1.6.1