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=========================================================================*/
32
33#ifndef vtkSampleFunction_h
34#define vtkSampleFunction_h
35
36#include "vtkImageAlgorithm.h"
37#include "vtkImagingHybridModule.h" // For export macro
38
40class vtkDataArray;
41
42class VTKIMAGINGHYBRID_EXPORT vtkSampleFunction : public vtkImageAlgorithm
43{
44public:
46 void PrintSelf(ostream& os, vtkIndent indent) override;
47
53
55
61
63
66 vtkSetMacro(OutputScalarType, int);
67 vtkGetMacro(OutputScalarType, int);
79
83 void SetSampleDimensions(int i, int j, int k);
84
86
89 void SetSampleDimensions(int dim[3]);
90 vtkGetVectorMacro(SampleDimensions, int, 3);
92
94
98 void SetModelBounds(const double bounds[6]);
99 void SetModelBounds(double xMin, double xMax, double yMin, double yMax, double zMin, double zMax);
100 vtkGetVectorMacro(ModelBounds, double, 6);
102
104
109 vtkSetMacro(Capping, vtkTypeBool);
110 vtkGetMacro(Capping, vtkTypeBool);
111 vtkBooleanMacro(Capping, vtkTypeBool);
113
115
118 vtkSetMacro(CapValue, double);
119 vtkGetMacro(CapValue, double);
121
123
128 vtkBooleanMacro(ComputeNormals, vtkTypeBool);
130
132
136 vtkSetStringMacro(ScalarArrayName);
137 vtkGetStringMacro(ScalarArrayName);
139
141
145 vtkSetStringMacro(NormalArrayName);
146 vtkGetStringMacro(NormalArrayName);
148
153
154protected:
163
165
167
171
174 double ModelBounds[6];
176 double CapValue;
181
182private:
183 vtkSampleFunction(const vtkSampleFunction&) = delete;
184 void operator=(const vtkSampleFunction&) = delete;
185};
186
187#endif
general representation of visualization data
Detect and break reference loops.
abstract interface for implicit functions
a simple class to control print indentation
Definition vtkIndent.h:40
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
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.
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.
static vtkSampleFunction * New()
Construct with ModelBounds=(-1,1,-1,1,-1,1), SampleDimensions=(50,50,50), Capping turned off,...
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
virtual void SetOutputScalarType(int)
Set what type of scalar data this source should generate.
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.
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 vtkDataArray
#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