1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
/*=========================================================================
Program: Visualization Toolkit
Module: vtkPerlinNoise.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.
=========================================================================*/
/**
* @class vtkPerlinNoise
* @brief an implicit function that implements Perlin noise
*
* vtkPerlinNoise computes a Perlin noise field as an implicit function.
* vtkPerlinNoise is a concrete implementation of vtkImplicitFunction.
* Perlin noise, originally described by Ken Perlin, is a non-periodic and
* continuous noise function useful for modeling real-world objects.
*
* The amplitude and frequency of the noise pattern are adjustable. This
* implementation of Perlin noise is derived closely from Greg Ward's version
* in Graphics Gems II.
*
* @sa
* vtkImplicitFunction
*/
#ifndef vtkPerlinNoise_h
#define vtkPerlinNoise_h
#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkImplicitFunction.h"
VTK_ABI_NAMESPACE_BEGIN
class VTKCOMMONDATAMODEL_EXPORT vtkPerlinNoise : public vtkImplicitFunction
{
public:
vtkTypeMacro(vtkPerlinNoise, vtkImplicitFunction);
void PrintSelf(ostream& os, vtkIndent indent) override;
/**
* Instantiate the class.
*/
static vtkPerlinNoise* New();
///@{
/**
* Evaluate PerlinNoise function.
*/
using vtkImplicitFunction::EvaluateFunction;
double EvaluateFunction(double x[3]) override;
///@}
/**
* Evaluate PerlinNoise gradient. Currently, the method returns a 0
* gradient.
*/
void EvaluateGradient(double x[3], double n[3]) override;
///@{
/**
* Set/get the frequency, or physical scale, of the noise function
* (higher is finer scale). The frequency can be adjusted per axis, or
* the same for all axes.
*/
vtkSetVector3Macro(Frequency, double);
vtkGetVectorMacro(Frequency, double, 3);
///@}
///@{
/**
* Set/get the phase of the noise function. This parameter can be used to
* shift the noise function within space (perhaps to avoid a beat with a
* noise pattern at another scale). Phase tends to repeat about every
* unit, so a phase of 0.5 is a half-cycle shift.
*/
vtkSetVector3Macro(Phase, double);
vtkGetVectorMacro(Phase, double, 3);
///@}
///@{
/**
* Set/get the amplitude of the noise function. Amplitude can be negative.
* The noise function varies randomly between -|Amplitude| and |Amplitude|.
* Therefore the range of values is 2*|Amplitude| large.
* The initial amplitude is 1.
*/
vtkSetMacro(Amplitude, double);
vtkGetMacro(Amplitude, double);
///@}
protected:
vtkPerlinNoise();
~vtkPerlinNoise() override = default;
double Frequency[3];
double Phase[3];
double Amplitude;
private:
vtkPerlinNoise(const vtkPerlinNoise&) = delete;
void operator=(const vtkPerlinNoise&) = delete;
};
VTK_ABI_NAMESPACE_END
#endif
|
