C# Class LibNoise.Builder.NoiseMapBuilderCylinder

Builds a cylindrical noise map. This class builds a noise map by filling it with coherent-noise values generated from the surface of a cylinder. This class describes these input values using an (angle, height) coordinate system. After generating the coherent-noise value from the input value, it then "flattens" these coordinates onto a plane so that it can write the values into a two-dimensional noise map. The cylinder model has a radius of 1.0 unit and has infinite height. The cylinder is oriented along the y axis. Its center is at the origin. The x coordinate in the noise map represents the angle around the cylinder's y axis. The y coordinate in the noise map represents the height above the x-z plane. The application must provide the lower and upper angle bounds of the noise map, in degrees, and the lower and upper height bounds of the noise map, in units.
Inheritance: NoiseMapBuilder
Show file Open project: everbytes/LibNoise Class Usage Examples

Public Methods

Method Description
Build ( ) : void

Builds the noise map. @pre SetBounds() was previously called. @pre NoiseMap was previously defined. @pre a SourceModule was previously defined. @pre The width and height values specified by SetSize() are positive. @pre The width and height values specified by SetSize() do not exceed the maximum possible width and height for the noise map. @post The original contents of the destination noise map is destroyed. @throw noise::ArgumentException See the preconditions. If this method is successful, the destination noise map contains the coherent-noise values from the noise module specified by the SourceModule.
NoiseMapBuilderCylinder ( ) : System

Default constructor
SetBounds ( float lowerAngleBound, float upperAngleBound, float lowerHeightBound, float upperHeightBound ) : void

Sets the boundaries of the planar noise map. @pre The lower Angle boundary is less than the upper Angle boundary. @pre The lower Height boundary is less than the upper Height boundary. @throw ArgumentException See the preconditions.

Method Details

Build() public method

Builds the noise map. @pre SetBounds() was previously called. @pre NoiseMap was previously defined. @pre a SourceModule was previously defined. @pre The width and height values specified by SetSize() are positive. @pre The width and height values specified by SetSize() do not exceed the maximum possible width and height for the noise map. @post The original contents of the destination noise map is destroyed. @throw noise::ArgumentException See the preconditions. If this method is successful, the destination noise map contains the coherent-noise values from the noise module specified by the SourceModule.
public Build ( ) : void
return void

NoiseMapBuilderCylinder() public method

Default constructor
public NoiseMapBuilderCylinder ( ) : System
return System

SetBounds() public method

Sets the boundaries of the planar noise map. @pre The lower Angle boundary is less than the upper Angle boundary. @pre The lower Height boundary is less than the upper Height boundary. @throw ArgumentException See the preconditions.
public SetBounds ( float lowerAngleBound, float upperAngleBound, float lowerHeightBound, float upperHeightBound ) : void
lowerAngleBound float The lower Angle boundary of the noise map, in units.
upperAngleBound float The upper Angle boundary of the noise map, in units.
lowerHeightBound float The lower Height boundary of the noise map, in units.
upperHeightBound float The upper Height boundary of the noise map, in units.
return void