perlin_noise.h

/*
**  UICore
**  Copyright (c) 1997-2015 The UICore Team
**
**  This software is provided 'as-is', without any express or implied
**  warranty.  In no event will the authors be held liable for any damages
**  arising from the use of this software.
**
**  Permission is granted to anyone to use this software for any purpose,
**  including commercial applications, and to alter it and redistribute it
**  freely, subject to the following restrictions:
**
**  1. The origin of this software must not be misrepresented; you must not
**     claim that you wrote the original software. If you use this software
**     in a product, an acknowledgment in the product documentation would be
**     appreciated but is not required.
**  2. Altered source versions must be plainly marked as such, and must not be
**     misrepresented as being the original software.
**  3. This notice may not be removed or altered from any source distribution.
**
**  Note: Some of the libraries UICore may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Mark Page
*/

#pragma once

#include <memory>
#include "pixel_buffer.h"

namespace uicore
{
    class PerlinNoise
    {
    public:
        static std::shared_ptr<PerlinNoise> create();

        virtual PixelBufferPtr create_noise1d(float start_x, float end_x) = 0;

        virtual PixelBufferPtr create_noise2d(float start_x, float end_x, float start_y, float end_y) = 0;

        virtual PixelBufferPtr create_noise3d(float start_x, float end_x, float start_y, float end_y, float z_position) = 0;

        virtual PixelBufferPtr create_noise4d(float start_x, float end_x, float start_y, float end_y, float z_position, float w_position) = 0;

        virtual Size size() const = 0;

        virtual TextureFormat format() const = 0;

        virtual float amplitude() const = 0;

        virtual int octaves() const = 0;

        virtual void set_permutations(const unsigned char *table, unsigned int size = 256) = 0;

        void set_size(int width = 256, int height = 256) { set_size(Size(width, height)); }

        virtual void set_size(const Size &size) = 0;

        virtual void set_format(TextureFormat texture_format = tf_rgb8) = 0;

        virtual void set_amplitude(float amplitude = 1.0f) = 0;

        virtual void set_octaves(int octaves = 1) = 0;
    };

    typedef std::shared_ptr<PerlinNoise> PerlinNoisePtr;
}