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 =========================================================================*/
35 #ifndef vtkSampleFunction_h
36 #define vtkSampleFunction_h
37 
38 #include "vtkImagingHybridModule.h" // For export macro
39 #include "vtkImageAlgorithm.h"
40 
42 class vtkDataArray;
43 
45 {
46 public:
48  void PrintSelf(ostream& os, vtkIndent indent);
49 
54 
56 
60 
62 
63  vtkSetMacro(OutputScalarType,int);
64  vtkGetMacro(OutputScalarType,int);
66  {this->SetOutputScalarType(VTK_DOUBLE);}
68  {this->SetOutputScalarType(VTK_FLOAT);}
70  {this->SetOutputScalarType(VTK_LONG);}
72  {this->SetOutputScalarType(VTK_UNSIGNED_LONG);};
74  {this->SetOutputScalarType(VTK_INT);}
76  {this->SetOutputScalarType(VTK_UNSIGNED_INT);}
78  {this->SetOutputScalarType(VTK_SHORT);}
80  {this->SetOutputScalarType(VTK_UNSIGNED_SHORT);}
82  {this->SetOutputScalarType(VTK_CHAR);}
84  {this->SetOutputScalarType(VTK_UNSIGNED_CHAR);}
86 
88  void SetSampleDimensions(int i, int j, int k);
89 
91 
92  void SetSampleDimensions(int dim[3]);
93  vtkGetVectorMacro(SampleDimensions,int,3);
95 
97 
99  void SetModelBounds(const double bounds[6]);
100  void SetModelBounds(double xMin, double xMax,
101  double yMin, double yMax,
102  double zMin, double zMax);
103  vtkGetVectorMacro(ModelBounds,double,6);
105 
107 
110  vtkSetMacro(Capping,int);
111  vtkGetMacro(Capping,int);
112  vtkBooleanMacro(Capping,int);
114 
116 
117  vtkSetMacro(CapValue,double);
118  vtkGetMacro(CapValue,double);
120 
122 
123  vtkSetMacro(ComputeNormals,int);
124  vtkGetMacro(ComputeNormals,int);
125  vtkBooleanMacro(ComputeNormals,int);
127 
129 
131  vtkSetStringMacro(ScalarArrayName);
132  vtkGetStringMacro(ScalarArrayName);
134 
136 
138  vtkSetStringMacro(NormalArrayName);
139  vtkGetStringMacro(NormalArrayName);
141 
143  unsigned long GetMTime();
144 
145 protected:
152 
154 
156 
162 
164  int SampleDimensions[3];
165  double ModelBounds[6];
166  int Capping;
167  double CapValue;
172 
173 private:
174  vtkSampleFunction(const vtkSampleFunction&); // Not implemented.
175  void operator=(const vtkSampleFunction&); // Not implemented.
176 };
177 
178 #endif
179 
180 
vtkSampleFunction::SetOutputScalarTypeToFloat
void SetOutputScalarTypeToFloat()
Definition: vtkSampleFunction.h:67
vtkGetObjectMacro
#define vtkGetObjectMacro(name, type)
Definition: vtkSetGet.h:232
vtkSampleFunction::SetModelBounds
void SetModelBounds(double xMin, double xMax, double yMin, double yMax, double zMin, double zMax)
vtkSampleFunction::Capping
int Capping
Definition: vtkSampleFunction.h:166
VTK_UNSIGNED_INT
#define VTK_UNSIGNED_INT
Definition: vtkType.h:32
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:41
VTK_UNSIGNED_SHORT
#define VTK_UNSIGNED_SHORT
Definition: vtkType.h:30
vtkgl::s
GLdouble s
Definition: vtkgl.h:11594
vtkTypeMacro
#define vtkTypeMacro(thisClass, superclass)
Definition: vtkSetGet.h:642
vtkImageAlgorithm.h
vtkSampleFunction::SetOutputScalarTypeToShort
void SetOutputScalarTypeToShort()
Definition: vtkSampleFunction.h:77
vtkDataArray
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:55
vtkImageAlgorithm
Generic algorithm superclass for image algs.
Definition: vtkImageAlgorithm.h:40
vtkImagingHybridModule.h
vtkSampleFunction::GetMTime
unsigned long GetMTime()
vtkSampleFunction::ScalarArrayName
char * ScalarArrayName
Definition: vtkSampleFunction.h:170
vtkGetVectorMacro
#define vtkGetVectorMacro(name, type, count)
Definition: vtkSetGet.h:424
vtkSampleFunction::SetOutputScalarTypeToDouble
void SetOutputScalarTypeToDouble()
Definition: vtkSampleFunction.h:65
vtkSampleFunction::OutputScalarType
int OutputScalarType
Definition: vtkSampleFunction.h:163
VTKIMAGINGHYBRID_EXPORT
#define VTKIMAGINGHYBRID_EXPORT
Definition: vtkImagingHybridModule.h:15
vtkImplicitFunction
abstract interface for implicit functions
Definition: vtkImplicitFunction.h:58
vtkSampleFunction::SetOutputScalarTypeToUnsignedShort
void SetOutputScalarTypeToUnsignedShort()
Definition: vtkSampleFunction.h:79
vtkSampleFunction::NormalArrayName
char * NormalArrayName
Definition: vtkSampleFunction.h:171
vtkSampleFunction::SetOutputScalarTypeToUnsignedLong
void SetOutputScalarTypeToUnsignedLong()
Definition: vtkSampleFunction.h:71
vtkSampleFunction::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent)
VTK_CHAR
#define VTK_CHAR
Definition: vtkType.h:26
vtkSampleFunction::CapValue
double CapValue
Definition: vtkSampleFunction.h:167
vtkSampleFunction
sample an implicit function over a structured point set
Definition: vtkSampleFunction.h:45
vtkSampleFunction::SetOutputScalarTypeToUnsignedChar
void SetOutputScalarTypeToUnsignedChar()
Definition: vtkSampleFunction.h:83
vtkSampleFunction::SetImplicitFunction
virtual void SetImplicitFunction(vtkImplicitFunction *)
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkSetStringMacro
#define vtkSetStringMacro(name)
Definition: vtkSetGet.h:104
VTK_FLOAT
#define VTK_FLOAT
Definition: vtkType.h:35
VTK_DOUBLE
#define VTK_DOUBLE
Definition: vtkType.h:36
VTK_UNSIGNED_CHAR
#define VTK_UNSIGNED_CHAR
Definition: vtkType.h:28
vtkSampleFunction::SetOutputScalarTypeToLong
void SetOutputScalarTypeToLong()
Definition: vtkSampleFunction.h:69
VTK_LONG
#define VTK_LONG
Definition: vtkType.h:33
vtkGetMacro
#define vtkGetMacro(name, type)
Definition: vtkSetGet.h:93
vtkSampleFunction::~vtkSampleFunction
~vtkSampleFunction()
vtkSampleFunction::SetOutputScalarTypeToInt
void SetOutputScalarTypeToInt()
Definition: vtkSampleFunction.h:73
vtkGetStringMacro
vtkGetStringMacro(ExtensionsString)
vtkGarbageCollector
Detect and break reference loops.
Definition: vtkGarbageCollector.h:99
VTK_UNSIGNED_LONG
#define VTK_UNSIGNED_LONG
Definition: vtkType.h:34
vtkBooleanMacro
vtkBooleanMacro(IgnoreDriverBugs, bool)
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:86
vtkSetMacro
vtkSetMacro(IgnoreDriverBugs, bool)
VTK_SHORT
#define VTK_SHORT
Definition: vtkType.h:29
vtkSampleFunction::Cap
void Cap(vtkDataArray *s)
vtkSampleFunction::SetSampleDimensions
void SetSampleDimensions(int dim[3])
vtkSampleFunction::ImplicitFunction
vtkImplicitFunction * ImplicitFunction
Definition: vtkSampleFunction.h:168
vtkSampleFunction::SetSampleDimensions
void SetSampleDimensions(int i, int j, int k)
vtkSampleFunction::SetOutputScalarTypeToChar
void SetOutputScalarTypeToChar()
Definition: vtkSampleFunction.h:81
vtkSampleFunction::ReportReferences
virtual void ReportReferences(vtkGarbageCollector *)
vtkSampleFunction::SetOutputScalarTypeToUnsignedInt
void SetOutputScalarTypeToUnsignedInt()
Definition: vtkSampleFunction.h:75
VTK_INT
#define VTK_INT
Definition: vtkType.h:31
vtkSampleFunction::ExecuteDataWithInformation
void ExecuteDataWithInformation(vtkDataObject *, vtkInformation *)
vtkSampleFunction::vtkSampleFunction
vtkSampleFunction()
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:65
vtkSampleFunction::New
static vtkSampleFunction * New()
vtkSampleFunction::ComputeNormals
int ComputeNormals
Definition: vtkSampleFunction.h:169
vtkSampleFunction::RequestInformation
virtual int RequestInformation(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
vtkSampleFunction::SetModelBounds
void SetModelBounds(const double bounds[6])