====== Heightfield:Generator:Perlin filter ======

===== Filter info =====

^  Description | Generate a heightfield using Perlin noise. |
^  Author | [[user>Aaron]] |
^  Plugin | [[bundywiki>plugins:calc:ZG_perlin|ZG_perlin]] ^

===== Looks like =====

| {{:plugins:calc:zeograph:filters:hf_gen_perlin.png|:plugins:calc:zeograph:filters:hf_gen_perlin.png}} |

===== Input pins =====

This filter has no input pins.

===== Output pins =====

^ Name ^ Type ^ Description ^
|  //hMap//  |  hvar  | A handle to the perlin heightmap created by the filter. |



===== Options =====

The [[plugins:calc:zeograph:userguide:filters:options|filter options]] window for the ''Perlin'' filter looks like:

| {{:plugins:calc:zeograph:filters:hf_gen_perlin_options.png|:plugins:calc:zeograph:filters:hf_gen_perlin_options.png}} |

The options are as follows:

^  Option name  ^  Data type  ^ Description ^
|  //Width//  |  int  | The desired width of the map (east-west), in pixels.  |
|  //Height//  |  int  | The desired height of the map (south-north), in pixels. |
|  //HorizScale//  |  float  | The desired horizontal spacing between map pixels, in metres.  |
|  //FeatureScale//  |  float  | The pixel size of the largest noise octave relative to the output map width/height. Low values give bumpy terrain, and large values give 'continental' terrain. A value of ~0.5 is typical.  |
|  //nOctaves//  |  int  | The number of noise octaves applied to the map. A low value gives smooth terrain, a large value gives rough terrain (but is slower to generate).  |
|  //Persistence//  |  float  | The noise octave amplitude propagation coefficient. A value of ~0.5 is typical. Larger values give rougher terrain.  |
|  //NoiseKey//  |  int  | A number used to seed the pseudorandom number generator used by the Perlin generator.  |

To edit any of the values, double left-click the mouse on them. 

===== Comments =====

==== Mosaic perlin maps? =====

To make mosaic perlin maps, first create the heightfield using [[plugins:calc:zeograph:filters:map_CreateMosaic|Map:CreateMosaic]], then pass the map to [[plugins:calc:zeograph:filters:hf_gen_Perlin2|Heightfield:Generator:Perlin2]]. The ''Perlin2'' filter behaves in much the same way as this filter, except that its settings are exposed as input pins rather than options.