vtkParametricRandomHills.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkParametricRandomHills.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef vtkParametricRandomHills_h
#define vtkParametricRandomHills_h

#include "vtkCommonComputationalGeometryModule.h" // For export macro
#include "vtkParametricFunction.h"

class vtkDoubleArray;
class vtkMinimalStandardRandomSequence;

class VTKCOMMONCOMPUTATIONALGEOMETRY_EXPORT 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(void);

    vtkMinimalStandardRandomSequence *randomSequenceGenerator;

    void MakeTheHillData(void);

    bool ParametersChanged();

    void CopyParameters();


    vtkDoubleArray *hillData;
};

#endif