/**
 * PANDA 3D SOFTWARE
 * Copyright (c) Carnegie Mellon University.  All rights reserved.
 *
 * All use of this software is subject to the terms of the revised BSD
 * license.  You should have received a copy of this license along
 * with this source code in a file named "LICENSE."
 *
 * @file perlinNoise3.h
 * @author drose
 * @date 2005-10-05
 */

#ifndef PERLINNOISE3_H
#define PERLINNOISE3_H

#include "pandabase.h"
#include "perlinNoise.h"

/**
 * This class provides an implementation of Perlin noise for 3 variables.
 * This code is loosely based on the reference implementation at
 * http://mrl.nyu.edu/~perlin/noise/ .
 */
class EXPCL_PANDA_MATHUTIL PerlinNoise3 : public PerlinNoise {
PUBLISHED:
  INLINE PerlinNoise3();
  INLINE explicit PerlinNoise3(double sx, double sy, double sz,
                               int table_size = 256,
                               unsigned long seed = 0);
  INLINE PerlinNoise3(const PerlinNoise3 &copy);
  INLINE void operator = (const PerlinNoise3 &copy);

  INLINE void set_scale(double scale);
  INLINE void set_scale(double sx, double sy, double sz);
  INLINE void set_scale(const LVecBase3f &scale);
  INLINE void set_scale(const LVecBase3d &scale);

  INLINE double noise(double x, double y, double z) const;
  INLINE float noise(const LVecBase3f &value) const;
  double noise(const LVecBase3d &value) const;

  INLINE double operator ()(double x, double y, double z) const;
  INLINE float operator ()(const LVecBase3f &value) const;
  INLINE double operator ()(const LVecBase3d &value) const;

private:
  void init_unscaled_xform();
  INLINE static double grad(int hash, double x, double y, double z);

private:
  LMatrix4d _unscaled_xform;
  LMatrix4d _input_xform;
};

#include "perlinNoise3.I"

#endif