VTK  9.1.0
vtkImplicitVolume.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkImplicitVolume.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
59 #ifndef vtkImplicitVolume_h
60 #define vtkImplicitVolume_h
61 
62 #include "vtkCommonDataModelModule.h" // For export macro
63 #include "vtkImplicitFunction.h"
64 
65 class vtkIdList;
66 class vtkImageData;
67 
68 class VTKCOMMONDATAMODEL_EXPORT vtkImplicitVolume : public vtkImplicitFunction
69 {
70 public:
72  void PrintSelf(ostream& os, vtkIndent indent) override;
73 
79 
85  vtkMTimeType GetMTime() override;
86 
88 
93  double EvaluateFunction(double x[3]) override;
95 
99  void EvaluateGradient(double x[3], double n[3]) override;
100 
102 
105  virtual void SetVolume(vtkImageData*);
106  vtkGetObjectMacro(Volume, vtkImageData);
108 
110 
113  vtkSetMacro(OutValue, double);
114  vtkGetMacro(OutValue, double);
116 
118 
121  vtkSetVector3Macro(OutGradient, double);
122  vtkGetVector3Macro(OutGradient, double);
124 
125 protected:
127  ~vtkImplicitVolume() override;
128 
129  vtkImageData* Volume; // the structured points
130  double OutValue;
131  double OutGradient[3];
132  // to replace a static
134 
135 private:
136  vtkImplicitVolume(const vtkImplicitVolume&) = delete;
137  void operator=(const vtkImplicitVolume&) = delete;
138 };
139 
140 #endif
vtkImplicitVolume::PointIds
vtkIdList * PointIds
Definition: vtkImplicitVolume.h:133
vtkImplicitFunction::EvaluateFunction
virtual double EvaluateFunction(double x[3])=0
Evaluate function at position x-y-z and return value.
vtkImplicitVolume::Volume
vtkImageData * Volume
Definition: vtkImplicitVolume.h:129
vtkImplicitVolume::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkImplicitFunction
abstract interface for implicit functions
Definition: vtkImplicitFunction.h:80
vtkImageData
topologically and geometrically regular array of data
Definition: vtkImageData.h:157
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:113
vtkIdList
list of point or cell ids
Definition: vtkIdList.h:140
vtkImplicitVolume::SetVolume
virtual void SetVolume(vtkImageData *)
Specify the volume for the implicit function.
vtkImplicitVolume::~vtkImplicitVolume
~vtkImplicitVolume() override
vtkImplicitVolume::GetMTime
vtkMTimeType GetMTime() override
Returns the mtime also considering the volume.
vtkImplicitVolume::vtkImplicitVolume
vtkImplicitVolume()
vtkImplicitVolume::New
static vtkImplicitVolume * New()
Construct an vtkImplicitVolume with no initial volume; the OutValue set to a large negative number; a...
vtkImplicitVolume
treat a volume as if it were an implicit function
Definition: vtkImplicitVolume.h:69
vtkImplicitFunction.h
vtkImplicitVolume::EvaluateFunction
double EvaluateFunction(double x[3]) override
Evaluate the ImplicitVolume.
vtkImplicitVolume::EvaluateGradient
void EvaluateGradient(double x[3], double n[3]) override
Evaluate ImplicitVolume gradient.
vtkImplicitVolume::OutValue
double OutValue
Definition: vtkImplicitVolume.h:130
vtkMTimeType
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:287