.. index:: pair: class; EE::Math::PerlinNoise
.. _doxid-class_e_e_1_1_math_1_1_perlin_noise:

class EE::Math::PerlinNoise
===========================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Perlin noise can be used to generate gradients, textures and effects. For more information go to `http://en.wikipedia.org/wiki/Perlin_noise <http://en.wikipedia.org/wiki/Perlin_noise>`__ \* To get a better understanding of the variables to generate the noise, visit `http://freespace.virgin.net/hugo.elias/models/m_perlin.htm <http://freespace.virgin.net/hugo.elias/models/m_perlin.htm>`__. :ref:`More...<details-class_e_e_1_1_math_1_1_perlin_noise>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <perlinnoise.hpp>
	
	class PerlinNoise {
	public:
		// construction
	
		:target:`~PerlinNoise<doxid-class_e_e_1_1_math_1_1_perlin_noise_1a14570ddfae2a3f18241559ad2c8e3b56>`();

		// methods
	
		void :ref:`init<doxid-class_e_e_1_1_math_1_1_perlin_noise_1a9780156a3c71db341abd651db505785c>`();
		:ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` :ref:`getPerlinNoise2D<doxid-class_e_e_1_1_math_1_1_perlin_noise_1a48e88e47d169db6a13980f70ab7f5b89>`(:ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` x, :ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` y);
		void :target:`setOctaves<doxid-class_e_e_1_1_math_1_1_perlin_noise_1aa4c12bd1b848bea73e02ea04367d9779>`(const int& octaves);
		void :target:`setPersistence<doxid-class_e_e_1_1_math_1_1_perlin_noise_1abc26c63243e3ade6af70135e872d1b64>`(const :ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>`& pers);
		void :target:`setFrequency<doxid-class_e_e_1_1_math_1_1_perlin_noise_1a254ffd6298cbdb6f95cacef6223b6545>`(const :ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>`& freq);
		void :target:`setAmplitude<doxid-class_e_e_1_1_math_1_1_perlin_noise_1a7625368e852432388959385d6c7cf9b1>`(const :ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>`& amp);
		void :target:`setFrequencyOctaveDep<doxid-class_e_e_1_1_math_1_1_perlin_noise_1a791f4e0a35b16c3bdc0b99fc9b6dc902>`(const bool& dep);
		void :target:`setAmplitudeOctaveDep<doxid-class_e_e_1_1_math_1_1_perlin_noise_1aec3c8b53f0b9f83192b8e2180ef53c21>`(const bool& dep);
		int :target:`getOctaves<doxid-class_e_e_1_1_math_1_1_perlin_noise_1af25bc9214c24cee03b4f04321959142a>`() const;
		:ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` :target:`getPersistence<doxid-class_e_e_1_1_math_1_1_perlin_noise_1a957d0889e34063183a6deab9a0a76dc1>`() const;
		:ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` :target:`getFrequency<doxid-class_e_e_1_1_math_1_1_perlin_noise_1aecd54cb5de68352644ce4f6138850199>`() const;
		:ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` :target:`getAmplitude<doxid-class_e_e_1_1_math_1_1_perlin_noise_1af20efe5f5e5d37f99ef7277f155b3cbb>`() const;
		bool :target:`getFrequencyOctaveDep<doxid-class_e_e_1_1_math_1_1_perlin_noise_1a355dfa3f3a357027cc611198bbca4304>`() const;
		bool :target:`getAmplitudeOctaveDep<doxid-class_e_e_1_1_math_1_1_perlin_noise_1a441396fecf3e216a1323b14f2cfce6cb>`() const;
	};
.. _details-class_e_e_1_1_math_1_1_perlin_noise:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

Perlin noise can be used to generate gradients, textures and effects. For more information go to `http://en.wikipedia.org/wiki/Perlin_noise <http://en.wikipedia.org/wiki/Perlin_noise>`__ \* To get a better understanding of the variables to generate the noise, visit `http://freespace.virgin.net/hugo.elias/models/m_perlin.htm <http://freespace.virgin.net/hugo.elias/models/m_perlin.htm>`__.

Methods
-------

.. index:: pair: function; init
.. _doxid-class_e_e_1_1_math_1_1_perlin_noise_1a9780156a3c71db341abd651db505785c:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void init()

Reset the initial values

.. index:: pair: function; getPerlinNoise2D
.. _doxid-class_e_e_1_1_math_1_1_perlin_noise_1a48e88e47d169db6a13980f70ab7f5b89:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` getPerlinNoise2D(:ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` x, :ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` y)



.. rubric:: Returns:

The noise value for the 2D coordinates