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
111
112
113
114
115
116
117
118
119
120
121
|
/*=========================================================================
Program: Visualization Toolkit
Module: vtkImplicitVolume.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 vtkImplicitVolume
* @brief treat a volume as if it were an implicit function
*
* vtkImplicitVolume treats a volume (e.g., structured point dataset)
* as if it were an implicit function. This means it computes a function
* value and gradient. vtkImplicitVolume is a concrete implementation of
* vtkImplicitFunction.
*
* vtkImplicitDataSet computes the function (at the point x) by performing
* cell interpolation. That is, it finds the cell containing x, and then
* uses the cell's interpolation functions to compute an interpolated
* scalar value at x. (A similar approach is used to find the
* gradient, if requested.) Points outside of the dataset are assigned
* the value of the ivar OutValue, and the gradient value OutGradient.
*
* @warning
* The input volume data is only updated when GetMTime() is called.
* Works for 3D structured points datasets, 0D-2D datasets won't work properly.
*
* @sa
* vtkImplicitFunction vtkImplicitDataSet vtkClipPolyData vtkCutter
* vtkImplicitWindowFunction
*/
#ifndef vtkImplicitVolume_h
#define vtkImplicitVolume_h
#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkImplicitFunction.h"
class vtkIdList;
class vtkImageData;
class VTKCOMMONDATAMODEL_EXPORT vtkImplicitVolume : public vtkImplicitFunction
{
public:
vtkTypeMacro(vtkImplicitVolume, vtkImplicitFunction);
void PrintSelf(ostream& os, vtkIndent indent) override;
/**
* Construct an vtkImplicitVolume with no initial volume; the OutValue
* set to a large negative number; and the OutGradient set to (0,0,1).
*/
static vtkImplicitVolume* New();
/**
* Returns the mtime also considering the volume. This also calls Update
* on the volume, and it therefore must be called before the function is
* evaluated.
*/
vtkMTimeType GetMTime() override;
//@{
/**
* Evaluate the ImplicitVolume. This returns the interpolated scalar value
* at x[3].
*/
using vtkImplicitFunction::EvaluateFunction;
double EvaluateFunction(double x[3]) override;
//@}
/**
* Evaluate ImplicitVolume gradient.
*/
void EvaluateGradient(double x[3], double n[3]) override;
//@{
/**
* Specify the volume for the implicit function.
*/
virtual void SetVolume(vtkImageData*);
vtkGetObjectMacro(Volume, vtkImageData);
//@}
//@{
/**
* Set the function value to use for points outside of the dataset.
*/
vtkSetMacro(OutValue, double);
vtkGetMacro(OutValue, double);
//@}
//@{
/**
* Set the function gradient to use for points outside of the dataset.
*/
vtkSetVector3Macro(OutGradient, double);
vtkGetVector3Macro(OutGradient, double);
//@}
protected:
vtkImplicitVolume();
~vtkImplicitVolume() override;
vtkImageData* Volume; // the structured points
double OutValue;
double OutGradient[3];
// to replace a static
vtkIdList* PointIds;
private:
vtkImplicitVolume(const vtkImplicitVolume&) = delete;
void operator=(const vtkImplicitVolume&) = delete;
};
#endif
|
