UT_MxNoise.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        UT_MxNoise.h (UT Library, C++)
 *
 * COMMENTS:
 */

#ifndef __UT_MxNoise__
#define __UT_MxNoise__

#include "UT_API.h"
#include "UT_Vector2.h"
#include "UT_Vector3.h"
#include "UT_Vector4.h"

// Noise functions that implement Perlin noise compatible with MaterialX
class UT_API UT_MxNoise
{
public:
    template <bool TILED = false>
    static float        cellnoiseF(float P, uint period = 0);
    template <bool TILED = false>
    static float        cellnoiseF(const UT_Vector2 &P,
                                   uint period_x = 0, uint period_y = 0);
    template <bool TILED = false>
    static float        cellnoiseF(const UT_Vector3 &P,
                                   uint period_x = 0, uint period_y = 0,
                                   uint period_z = 0);
    template <bool TILED = false>
    static float        cellnoiseF(const UT_Vector4 &P,
                                   uint period_x = 0, uint period_y = 0,
                                   uint period_z = 0, uint period_w = 0);

    template <bool TILED = false>
    static UT_Vector3   cellnoiseV(float P, uint period = 0);
    template <bool TILED = false>
    static UT_Vector3   cellnoiseV(const UT_Vector2 &P,
                                   uint period_x = 0, uint period_y = 0);
    template <bool TILED = false>
    static UT_Vector3   cellnoiseV(const UT_Vector3 &P,
                                   uint period_x = 0, uint period_y = 0,
                                   uint period_z = 0);
    template <bool TILED = false>
    static UT_Vector3   cellnoiseV(const UT_Vector4 &P,
                                   uint period_x = 0, uint period_y = 0,
                                   uint period_z = 0, uint period_w = 0);

    template <bool TILED = false>
    static void perlin(float &result, const UT_Vector2 &P,
                       uint period_x = 0, uint period_y = 0);
    template <bool TILED = false>
    static void perlin(float &result, const UT_Vector3 &P,
                       uint period_x = 0, uint period_y = 0, uint period_z = 0);
    template <bool TILED = false>
    static void perlin(UT_Vector3 &result, const UT_Vector2 &P,
                       uint period_x = 0, uint period_y = 0);
    template <bool TILED = false>
    static void perlin(UT_Vector3 &result, const UT_Vector3 &P,
                       uint period_x = 0, uint period_y = 0, uint period_z = 0);

    template <bool TILED = false>
    static void worley(float &result, const UT_Vector2 &P, float jitter, int metric,
                       uint period_x = 0, uint period_y = 0);
    template <bool TILED = false>
    static void worley(UT_Vector2 &result, const UT_Vector2 &P, float jitter, int metric,
                       uint period_x = 0, uint period_y = 0);
    template <bool TILED = false>
    static void worley(UT_Vector3 &result, const UT_Vector2 &P, float jitter, int metric,
                       uint period_x = 0, uint period_y = 0);
    template <bool TILED = false>
    static void worley(float &result, const UT_Vector3 &P, float jitter, int metric,
                       uint period_x = 0, uint period_y = 0, uint period_z = 0);
    template <bool TILED = false>
    static void worley(UT_Vector2 &result, const UT_Vector3 &P, float jitter, int metric,
                       uint period_x = 0, uint period_y = 0, uint period_z = 0);
    template <bool TILED = false>
    static void worley(UT_Vector3 &result, const UT_Vector3 &P, float jitter, int metric,
                       uint period_x = 0, uint period_y = 0, uint period_z = 0);

    template <bool TILED = false>
    static void voronoi(const UT_Vector2 &P, float jitter, int metric, float &d1, UT_Vector2 &p1,
                        uint period_x = 0, uint period_y = 0);
    template <bool TILED = false>
    static void voronoi(const UT_Vector2 &P, float jitter, int metric,
                        float &d1, float &d2, UT_Vector2 &p1, UT_Vector2 &p2,
                        uint period_x = 0, uint period_y = 0);
    template <bool TILED = false>
    static void voronoi(const UT_Vector2 &P, float jitter, int metric,
                        float &d1, float &d2, float &d3, UT_Vector2 &p1, UT_Vector2 &p2, UT_Vector2 &p3,
                        uint period_x = 0, uint period_y = 0);
    template <bool TILED = false>
    static void voronoi(const UT_Vector3 &P, float jitter, int metric, float &d1, UT_Vector3 &p1,
                        uint period_x = 0, uint period_y = 0, uint period_z = 0);
    template <bool TILED = false>
    static void voronoi(const UT_Vector3 &P, float jitter, int metric,
                        float &d1, float &d2, UT_Vector3 &p1, UT_Vector3 &p2,
                        uint period_x = 0, uint period_y = 0, uint period_z = 0);
    template <bool TILED = false>
    static void voronoi(const UT_Vector3 &P, float jitter, int metric,
                        float &d1, float &d2, float &d3, UT_Vector3 &p1, UT_Vector3 &p2, UT_Vector3 &p3,
                        uint period_x = 0, uint period_y = 0, uint period_z = 0);

private:
};

#endif