VTK  9.2.6
vtkSampleFunction.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkSampleFunction.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 =========================================================================*/
142 #ifndef vtkSampleFunction_h
143 #define vtkSampleFunction_h
144 
145 #include "vtkImageAlgorithm.h"
146 #include "vtkImagingHybridModule.h" // For export macro
147 
148 class vtkImplicitFunction;
149 class vtkDataArray;
150 
151 class VTKIMAGINGHYBRID_EXPORT vtkSampleFunction : public vtkImageAlgorithm
152 {
153 public:
155  void PrintSelf(ostream& os, vtkIndent indent) override;
156 
162 
164 
168  vtkGetObjectMacro(ImplicitFunction, vtkImplicitFunction);
170 
172 
175  vtkSetMacro(OutputScalarType, int);
176  vtkGetMacro(OutputScalarType, int);
177  void SetOutputScalarTypeToDouble() { this->SetOutputScalarType(VTK_DOUBLE); }
178  void SetOutputScalarTypeToFloat() { this->SetOutputScalarType(VTK_FLOAT); }
179  void SetOutputScalarTypeToLong() { this->SetOutputScalarType(VTK_LONG); }
180  void SetOutputScalarTypeToUnsignedLong() { this->SetOutputScalarType(VTK_UNSIGNED_LONG); }
181  void SetOutputScalarTypeToInt() { this->SetOutputScalarType(VTK_INT); }
182  void SetOutputScalarTypeToUnsignedInt() { this->SetOutputScalarType(VTK_UNSIGNED_INT); }
183  void SetOutputScalarTypeToShort() { this->SetOutputScalarType(VTK_SHORT); }
184  void SetOutputScalarTypeToUnsignedShort() { this->SetOutputScalarType(VTK_UNSIGNED_SHORT); }
185  void SetOutputScalarTypeToChar() { this->SetOutputScalarType(VTK_CHAR); }
186  void SetOutputScalarTypeToUnsignedChar() { this->SetOutputScalarType(VTK_UNSIGNED_CHAR); }
188 
192  void SetSampleDimensions(int i, int j, int k);
193 
195 
198  void SetSampleDimensions(int dim[3]);
199  vtkGetVectorMacro(SampleDimensions, int, 3);
201 
203 
207  void SetModelBounds(const double bounds[6]);
208  void SetModelBounds(double xMin, double xMax, double yMin, double yMax, double zMin, double zMax);
209  vtkGetVectorMacro(ModelBounds, double, 6);
211 
213 
218  vtkSetMacro(Capping, vtkTypeBool);
219  vtkGetMacro(Capping, vtkTypeBool);
220  vtkBooleanMacro(Capping, vtkTypeBool);
222 
224 
227  vtkSetMacro(CapValue, double);
228  vtkGetMacro(CapValue, double);
230 
232 
235  vtkSetMacro(ComputeNormals, vtkTypeBool);
236  vtkGetMacro(ComputeNormals, vtkTypeBool);
237  vtkBooleanMacro(ComputeNormals, vtkTypeBool);
239 
241 
245  vtkSetStringMacro(ScalarArrayName);
246  vtkGetStringMacro(ScalarArrayName);
248 
250 
254  vtkSetStringMacro(NormalArrayName);
255  vtkGetStringMacro(NormalArrayName);
257 
261  vtkMTimeType GetMTime() override;
262 
263 protected:
272 
273  ~vtkSampleFunction() override;
274 
276 
279  void Cap(vtkDataArray* s);
280 
282  int SampleDimensions[3];
283  double ModelBounds[6];
285  double CapValue;
290 
291 private:
292  vtkSampleFunction(const vtkSampleFunction&) = delete;
293  void operator=(const vtkSampleFunction&) = delete;
294 };
295 
296 #endif
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:165
general representation of visualization data
Detect and break reference loops.
Generic algorithm superclass for image algs.
abstract interface for implicit functions
a simple class to control print indentation
Definition: vtkIndent.h:119
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
sample an implicit function over a structured point set
virtual void SetImplicitFunction(vtkImplicitFunction *)
Specify the implicit function to use to generate data.
void SetOutputScalarTypeToShort()
Set what type of scalar data this source should generate.
void SetOutputScalarTypeToUnsignedInt()
Set what type of scalar data this source should generate.
void SetOutputScalarTypeToUnsignedLong()
Set what type of scalar data this source should generate.
void SetOutputScalarTypeToUnsignedShort()
Set what type of scalar data this source should generate.
static vtkSampleFunction * New()
Construct with ModelBounds=(-1,1,-1,1,-1,1), SampleDimensions=(50,50,50), Capping turned off,...
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkMTimeType GetMTime() override
Return the MTime also considering the implicit function.
void SetSampleDimensions(int i, int j, int k)
Specify the dimensions of the data on which to sample.
void ExecuteDataWithInformation(vtkDataObject *, vtkInformation *) override
This is a convenience method that is implemented in many subclasses instead of RequestData.
vtkSampleFunction()
Default constructor.
void SetOutputScalarTypeToChar()
Set what type of scalar data this source should generate.
vtkImplicitFunction * ImplicitFunction
void SetSampleDimensions(int dim[3])
Specify the dimensions of the data on which to sample.
void SetModelBounds(double xMin, double xMax, double yMin, double yMax, double zMin, double zMax)
Specify the region in space over which the sampling occurs.
void ReportReferences(vtkGarbageCollector *) override
void SetOutputScalarTypeToLong()
Set what type of scalar data this source should generate.
~vtkSampleFunction() override
void SetOutputScalarTypeToDouble()
Set what type of scalar data this source should generate.
vtkTypeBool ComputeNormals
int RequestInformation(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
Subclasses can reimplement this method to collect information from their inputs and set information f...
void SetOutputScalarTypeToInt()
Set what type of scalar data this source should generate.
void SetOutputScalarTypeToFloat()
Set what type of scalar data this source should generate.
void Cap(vtkDataArray *s)
void SetModelBounds(const double bounds[6])
Specify the region in space over which the sampling occurs.
void SetOutputScalarTypeToUnsignedChar()
Set what type of scalar data this source should generate.
int vtkTypeBool
Definition: vtkABI.h:69
#define VTK_SHORT
Definition: vtkType.h:48
#define VTK_UNSIGNED_INT
Definition: vtkType.h:51
#define VTK_DOUBLE
Definition: vtkType.h:55
#define VTK_UNSIGNED_CHAR
Definition: vtkType.h:47
#define VTK_UNSIGNED_SHORT
Definition: vtkType.h:49
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:287
#define VTK_INT
Definition: vtkType.h:50
#define VTK_FLOAT
Definition: vtkType.h:54
#define VTK_CHAR
Definition: vtkType.h:45
#define VTK_UNSIGNED_LONG
Definition: vtkType.h:53
#define VTK_LONG
Definition: vtkType.h:52