vtkParametricRandomHills.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkParametricRandomHills_h
#define vtkParametricRandomHills_h
 
#include "vtkCommonComputationalGeometryModule.h" // For export macro
#include "vtkParametricFunction.h"
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
 
VTK_ABI_NAMESPACE_BEGIN
class vtkDoubleArray;
class vtkMinimalStandardRandomSequence;
 
class VTKCOMMONCOMPUTATIONALGEOMETRY_EXPORT VTK_MARSHALAUTO vtkParametricRandomHills
  : public vtkParametricFunction
{
 
public:
  vtkTypeMacro(vtkParametricRandomHills, vtkParametricFunction);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  int GetDimension() override { return 2; }

  static vtkParametricRandomHills* New();


  vtkSetMacro(NumberOfHills, int);
  vtkGetMacro(NumberOfHills, int);


  vtkSetMacro(HillXVariance, double);
  vtkGetMacro(HillXVariance, double);


  vtkSetMacro(HillYVariance, double);
  vtkGetMacro(HillYVariance, double);


  vtkSetMacro(HillAmplitude, double);
  vtkGetMacro(HillAmplitude, double);


  vtkSetMacro(RandomSeed, int);
  vtkGetMacro(RandomSeed, int);


  vtkSetClampMacro(AllowRandomGeneration, vtkTypeBool, 0, 1);
  vtkGetMacro(AllowRandomGeneration, vtkTypeBool);
  vtkBooleanMacro(AllowRandomGeneration, vtkTypeBool);


  vtkSetMacro(XVarianceScaleFactor, double);
  vtkGetMacro(XVarianceScaleFactor, double);


  vtkSetMacro(YVarianceScaleFactor, double);
  vtkGetMacro(YVarianceScaleFactor, double);


  vtkSetMacro(AmplitudeScaleFactor, double);
  vtkGetMacro(AmplitudeScaleFactor, double);

  void Evaluate(double uvw[3], double Pt[3], double Duvw[9]) override;

  double EvaluateScalar(double uvw[3], double Pt[3], double Duvw[9]) override;
 
protected:
  vtkParametricRandomHills();
  ~vtkParametricRandomHills() override;
 
  // Variables
  int NumberOfHills;
  double HillXVariance;
  double HillYVariance;
  double HillAmplitude;
  int RandomSeed;
  double XVarianceScaleFactor;
  double YVarianceScaleFactor;
  double AmplitudeScaleFactor;
  vtkTypeBool AllowRandomGeneration;
 
  // These variables store the previous values of the above ones.
  int previousNumberOfHills;
  double previousHillXVariance;
  double previousHillYVariance;
  double previousHillAmplitude;
  int previousRandomSeed;
  double previousXVarianceScaleFactor;
  double previousYVarianceScaleFactor;
  double previousAmplitudeScaleFactor;
  int previousAllowRandomGeneration;
 
private:
  vtkParametricRandomHills(const vtkParametricRandomHills&) = delete;
  void operator=(const vtkParametricRandomHills&) = delete;

  void InitRNG(int RandomSeed);

  double Rand();

  vtkMinimalStandardRandomSequence* randomSequenceGenerator;

  void MakeTheHillData();

  bool ParametersChanged();

  void CopyParameters();


  vtkDoubleArray* hillData;
};
 
VTK_ABI_NAMESPACE_END
#endif