VTK
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=========================================================================*/
36#ifndef vtkSampleFunction_h
37#define vtkSampleFunction_h
38
39#include "vtkImagingHybridModule.h" // For export macro
40#include "vtkImageAlgorithm.h"
41
43class vtkDataArray;
44
45class VTKIMAGINGHYBRID_EXPORT vtkSampleFunction : public vtkImageAlgorithm
46{
47public:
49 void PrintSelf(ostream& os, vtkIndent indent);
50
56
58
62 vtkGetObjectMacro(ImplicitFunction,vtkImplicitFunction);
64
66
69 vtkSetMacro(OutputScalarType,int);
70 vtkGetMacro(OutputScalarType,int);
72 {this->SetOutputScalarType(VTK_DOUBLE);}
74 {this->SetOutputScalarType(VTK_FLOAT);}
76 {this->SetOutputScalarType(VTK_LONG);}
78 {this->SetOutputScalarType(VTK_UNSIGNED_LONG);};
80 {this->SetOutputScalarType(VTK_INT);}
82 {this->SetOutputScalarType(VTK_UNSIGNED_INT);}
84 {this->SetOutputScalarType(VTK_SHORT);}
86 {this->SetOutputScalarType(VTK_UNSIGNED_SHORT);}
88 {this->SetOutputScalarType(VTK_CHAR);}
90 {this->SetOutputScalarType(VTK_UNSIGNED_CHAR);}
92
96 void SetSampleDimensions(int i, int j, int k);
97
99
102 void SetSampleDimensions(int dim[3]);
103 vtkGetVectorMacro(SampleDimensions,int,3);
105
107
111 void SetModelBounds(const double bounds[6]);
112 void SetModelBounds(double xMin, double xMax,
113 double yMin, double yMax,
114 double zMin, double zMax);
115 vtkGetVectorMacro(ModelBounds,double,6);
117
119
124 vtkSetMacro(Capping,int);
125 vtkGetMacro(Capping,int);
126 vtkBooleanMacro(Capping,int);
128
130
133 vtkSetMacro(CapValue,double);
134 vtkGetMacro(CapValue,double);
136
138
141 vtkSetMacro(ComputeNormals,int);
142 vtkGetMacro(ComputeNormals,int);
143 vtkBooleanMacro(ComputeNormals,int);
145
147
151 vtkSetStringMacro(ScalarArrayName);
152 vtkGetStringMacro(ScalarArrayName);
154
156
160 vtkSetStringMacro(NormalArrayName);
161 vtkGetStringMacro(NormalArrayName);
163
168
169protected:
178
180
182
188
190 int SampleDimensions[3];
191 double ModelBounds[6];
193 double CapValue;
198
199private:
200 vtkSampleFunction(const vtkSampleFunction&) VTK_DELETE_FUNCTION;
201 void operator=(const vtkSampleFunction&) VTK_DELETE_FUNCTION;
202};
203
204#endif
205
206
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:55
general representation of visualization data
Definition: vtkDataObject.h:65
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:40
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()
void SetOutputScalarTypeToUnsignedInt()
void SetOutputScalarTypeToUnsignedLong()
void SetOutputScalarTypeToUnsignedShort()
virtual int RequestInformation(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
Subclasses can reimplement this method to collect information from their inputs and set information f...
void SetSampleDimensions(int i, int j, int k)
Specify the dimensions of the data on which to sample.
vtkMTimeType GetMTime()
Return the MTime also considering the implicit function.
vtkSampleFunction()
Default constructor.
void SetOutputScalarTypeToChar()
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 PrintSelf(ostream &os, vtkIndent indent)
Methods invoked by print to print information about the object including superclasses.
void ExecuteDataWithInformation(vtkDataObject *, vtkInformation *)
This is a convenience method that is implemented in many subclasses instead of RequestData.
void SetModelBounds(double xMin, double xMax, double yMin, double yMax, double zMin, double zMax)
void ReportReferences(vtkGarbageCollector *) override
void SetOutputScalarTypeToLong()
void SetOutputScalarTypeToDouble()
void SetOutputScalarTypeToFloat()
void Cap(vtkDataArray *s)
void SetModelBounds(const double bounds[6])
Specify the region in space over which the sampling occurs.
void SetOutputScalarTypeToUnsignedChar()
vtkSetMacro(IgnoreDriverBugs, bool)
Updates the extensions string.
vtkBooleanMacro(IgnoreDriverBugs, bool)
Updates the extensions string.
vtkGetStringMacro(ExtensionsString)
Returns a string listing all available extensions.
#define VTK_SHORT
Definition: vtkType.h:52
vtkTypeUInt64 vtkMTimeType
Definition: vtkType.h:248
#define VTK_UNSIGNED_INT
Definition: vtkType.h:55
#define VTK_DOUBLE
Definition: vtkType.h:59
#define VTK_UNSIGNED_CHAR
Definition: vtkType.h:51
#define VTK_UNSIGNED_SHORT
Definition: vtkType.h:53
#define VTK_INT
Definition: vtkType.h:54
#define VTK_FLOAT
Definition: vtkType.h:58
#define VTK_CHAR
Definition: vtkType.h:49
#define VTK_UNSIGNED_LONG
Definition: vtkType.h:57
#define VTK_LONG
Definition: vtkType.h:56