|
@@ -0,0 +1,191 @@
|
|
|
+.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
|
+.. DO NOT EDIT THIS FILE, but the SimplexNoise.xml source instead.
|
|
|
+.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
+
|
|
|
+.. _class_SimplexNoise:
|
|
|
+
|
|
|
+SimplexNoise
|
|
|
+============
|
|
|
+
|
|
|
+**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
|
|
|
+
|
|
|
+**Category:** Core
|
|
|
+
|
|
|
+Brief Description
|
|
|
+-----------------
|
|
|
+
|
|
|
+Noise generator based on Open Simplex.
|
|
|
+
|
|
|
+Properties
|
|
|
+----------
|
|
|
+
|
|
|
++---------------------------+----------------------------------------------------+
|
|
|
+| :ref:`float<class_float>` | :ref:`lacunarity<class_SimplexNoise_lacunarity>` |
|
|
|
++---------------------------+----------------------------------------------------+
|
|
|
+| :ref:`int<class_int>` | :ref:`octaves<class_SimplexNoise_octaves>` |
|
|
|
++---------------------------+----------------------------------------------------+
|
|
|
+| :ref:`float<class_float>` | :ref:`period<class_SimplexNoise_period>` |
|
|
|
++---------------------------+----------------------------------------------------+
|
|
|
+| :ref:`float<class_float>` | :ref:`persistance<class_SimplexNoise_persistance>` |
|
|
|
++---------------------------+----------------------------------------------------+
|
|
|
+| :ref:`int<class_int>` | :ref:`seed<class_SimplexNoise_seed>` |
|
|
|
++---------------------------+----------------------------------------------------+
|
|
|
+
|
|
|
+Methods
|
|
|
+-------
|
|
|
+
|
|
|
++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| :ref:`Image<class_Image>` | :ref:`get_image<class_SimplexNoise_get_image>` **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height **)** |
|
|
|
++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| :ref:`float<class_float>` | :ref:`get_noise_2d<class_SimplexNoise_get_noise_2d>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)** |
|
|
|
++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| :ref:`float<class_float>` | :ref:`get_noise_2dv<class_SimplexNoise_get_noise_2dv>` **(** :ref:`Vector2<class_Vector2>` pos **)** |
|
|
|
++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| :ref:`float<class_float>` | :ref:`get_noise_3d<class_SimplexNoise_get_noise_3d>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y, :ref:`float<class_float>` z **)** |
|
|
|
++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| :ref:`float<class_float>` | :ref:`get_noise_3dv<class_SimplexNoise_get_noise_3dv>` **(** :ref:`Vector3<class_Vector3>` pos **)** |
|
|
|
++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| :ref:`float<class_float>` | :ref:`get_noise_4d<class_SimplexNoise_get_noise_4d>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y, :ref:`float<class_float>` z, :ref:`float<class_float>` w **)** |
|
|
|
++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+| :ref:`Image<class_Image>` | :ref:`get_seamless_image<class_SimplexNoise_get_seamless_image>` **(** :ref:`int<class_int>` size **)** |
|
|
|
++----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
+
|
|
|
+Description
|
|
|
+-----------
|
|
|
+
|
|
|
+This resource allows you to configure and sample a fractal noise space.
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+Here is a brief usage example that configures a SimplexNoise and gets samples at various positions and dimensions:
|
|
|
+
|
|
|
+::
|
|
|
+
|
|
|
+ var noise = SimplexNoise.new()
|
|
|
+
|
|
|
+ # Configure
|
|
|
+ noise.seed = randi()
|
|
|
+ noise.octaves = 4
|
|
|
+ noise.period = 20.0
|
|
|
+ noise.persistance = 0.8
|
|
|
+
|
|
|
+ #Sample
|
|
|
+ print("Values:")
|
|
|
+ print(noise.get_noise_2d(1.0,1.0))
|
|
|
+ print(noise.get_noise_3d(0.5,3.0,15.0))
|
|
|
+ print(noise.get_noise_3d(0.5,1.9,4.7,0.0))
|
|
|
+
|
|
|
+Property Descriptions
|
|
|
+---------------------
|
|
|
+
|
|
|
+ .. _class_SimplexNoise_lacunarity:
|
|
|
+
|
|
|
+- :ref:`float<class_float>` **lacunarity**
|
|
|
+
|
|
|
++----------+-----------------------+
|
|
|
+| *Setter* | set_lacunarity(value) |
|
|
|
++----------+-----------------------+
|
|
|
+| *Getter* | get_lacunarity() |
|
|
|
++----------+-----------------------+
|
|
|
+
|
|
|
+Difference in period between :ref:`octaves<class_SimplexNoise_octaves>`.
|
|
|
+
|
|
|
+ .. _class_SimplexNoise_octaves:
|
|
|
+
|
|
|
+- :ref:`int<class_int>` **octaves**
|
|
|
+
|
|
|
++----------+--------------------+
|
|
|
+| *Setter* | set_octaves(value) |
|
|
|
++----------+--------------------+
|
|
|
+| *Getter* | get_octaves() |
|
|
|
++----------+--------------------+
|
|
|
+
|
|
|
+Number of Simplex Noise layers that are sampled to get the fractal noise.
|
|
|
+
|
|
|
+ .. _class_SimplexNoise_period:
|
|
|
+
|
|
|
+- :ref:`float<class_float>` **period**
|
|
|
+
|
|
|
++----------+-------------------+
|
|
|
+| *Setter* | set_period(value) |
|
|
|
++----------+-------------------+
|
|
|
+| *Getter* | get_period() |
|
|
|
++----------+-------------------+
|
|
|
+
|
|
|
+Period of the base octave.
|
|
|
+
|
|
|
+A lower period results in a higher frequancy noise (more value changes across the same distance).
|
|
|
+
|
|
|
+ .. _class_SimplexNoise_persistance:
|
|
|
+
|
|
|
+- :ref:`float<class_float>` **persistance**
|
|
|
+
|
|
|
++----------+------------------------+
|
|
|
+| *Setter* | set_persistance(value) |
|
|
|
++----------+------------------------+
|
|
|
+| *Getter* | get_persistance() |
|
|
|
++----------+------------------------+
|
|
|
+
|
|
|
+Contribuiton factor of the different octaves.
|
|
|
+
|
|
|
+A ``persistance`` value of 1 means all the octaves have the same contribution, a value of 0.5 means each octave contributes half as much as the previous one.
|
|
|
+
|
|
|
+ .. _class_SimplexNoise_seed:
|
|
|
+
|
|
|
+- :ref:`int<class_int>` **seed**
|
|
|
+
|
|
|
++----------+-----------------+
|
|
|
+| *Setter* | set_seed(value) |
|
|
|
++----------+-----------------+
|
|
|
+| *Getter* | get_seed() |
|
|
|
++----------+-----------------+
|
|
|
+
|
|
|
+Seed used to generate random values, different seeds will generate different noise maps.
|
|
|
+
|
|
|
+Method Descriptions
|
|
|
+-------------------
|
|
|
+
|
|
|
+ .. _class_SimplexNoise_get_image:
|
|
|
+
|
|
|
+- :ref:`Image<class_Image>` **get_image** **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height **)**
|
|
|
+
|
|
|
+Generate a noise image with the requested ``width`` and ``height``, based on the current noise parameters.
|
|
|
+
|
|
|
+ .. _class_SimplexNoise_get_noise_2d:
|
|
|
+
|
|
|
+- :ref:`float<class_float>` **get_noise_2d** **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)**
|
|
|
+
|
|
|
+2D noise value -1,1 at position ``x``,``y``.
|
|
|
+
|
|
|
+ .. _class_SimplexNoise_get_noise_2dv:
|
|
|
+
|
|
|
+- :ref:`float<class_float>` **get_noise_2dv** **(** :ref:`Vector2<class_Vector2>` pos **)**
|
|
|
+
|
|
|
+2D noise value -1,1 at position ``pos.x``,``pos.y``.
|
|
|
+
|
|
|
+ .. _class_SimplexNoise_get_noise_3d:
|
|
|
+
|
|
|
+- :ref:`float<class_float>` **get_noise_3d** **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y, :ref:`float<class_float>` z **)**
|
|
|
+
|
|
|
+3D noise value -1,1 at position ``x``,``y``,``z``.
|
|
|
+
|
|
|
+ .. _class_SimplexNoise_get_noise_3dv:
|
|
|
+
|
|
|
+- :ref:`float<class_float>` **get_noise_3dv** **(** :ref:`Vector3<class_Vector3>` pos **)**
|
|
|
+
|
|
|
+3D noise value -1,1 at position ``pos.x``,``pos.y``,``pos.z``.
|
|
|
+
|
|
|
+ .. _class_SimplexNoise_get_noise_4d:
|
|
|
+
|
|
|
+- :ref:`float<class_float>` **get_noise_4d** **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y, :ref:`float<class_float>` z, :ref:`float<class_float>` w **)**
|
|
|
+
|
|
|
+4D noise value -1,1 at position ``x``,``y``,``z``,``w``.
|
|
|
+
|
|
|
+ .. _class_SimplexNoise_get_seamless_image:
|
|
|
+
|
|
|
+- :ref:`Image<class_Image>` **get_seamless_image** **(** :ref:`int<class_int>` size **)**
|
|
|
+
|
|
|
+Generate a tileable noise image, based on the current noise parameters.
|
|
|
+
|
|
|
+Generated seamless images are always square (``size``\ x``size``).
|
|
|
+
|