VTK: Filters/General/vtkWarpScalar.h Source File

| VTK 9.3.1

vtkWarpScalar.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
38 #ifndef vtkWarpScalar_h
39 #define vtkWarpScalar_h
40
41 #include "vtkFiltersGeneralModule.h" // For export macro
42 #include "vtkPointSetAlgorithm.h"
43
44 VTK_ABI_NAMESPACE_BEGIN
45 class vtkCellArray;
46 class vtkDataArray;
47 class vtkDataSet;
48 class vtkDataSetAttributes;
49 class vtkIdTypeArray;
50 class vtkPointSet;
51 class vtkUnsignedCharArray;
52
53 class VTKFILTERSGENERAL_EXPORT vtkWarpScalar : public vtkPointSetAlgorithm
54 {
55 public:
57
61 static vtkWarpScalar* New();
62 vtkTypeMacro(vtkWarpScalar, vtkPointSetAlgorithm);
63 void PrintSelf(ostream& os, vtkIndent indent) override;
65
67
70 vtkSetMacro(ScaleFactor, double);
71 vtkGetMacro(ScaleFactor, double);
73
75
79 vtkSetMacro(UseNormal, vtkTypeBool);
80 vtkGetMacro(UseNormal, vtkTypeBool);
81 vtkBooleanMacro(UseNormal, vtkTypeBool);
83
85
89 vtkSetVector3Macro(Normal, double);
90 vtkGetVectorMacro(Normal, double, 3);
92
94
99 vtkSetMacro(XYPlane, vtkTypeBool);
100 vtkGetMacro(XYPlane, vtkTypeBool);
101 vtkBooleanMacro(XYPlane, vtkTypeBool);
103
105
110 vtkSetMacro(OutputPointsPrecision, int);
111 vtkGetMacro(OutputPointsPrecision, int);
113
115
123 vtkGetMacro(GenerateEnclosure, bool);
124 vtkSetMacro(GenerateEnclosure, bool);
125 vtkBooleanMacro(GenerateEnclosure, bool);
127
128 int FillInputPortInformation(int port, vtkInformation* info) override;
129
130 protected:
131 vtkWarpScalar();
132 ~vtkWarpScalar() override;
133
134 int RequestDataObject(vtkInformation* request, vtkInformationVector** inputVector,
135 vtkInformationVector* outputVector) override;
136 int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
137
141 unsigned int GetInputDimension(vtkDataSet* input);
145 void BuildSideWalls(vtkPointSet* output, int nInputPoints, vtkUnsignedCharArray* boundaryCells,
146 vtkIdTypeArray* boundaryFaceIndexes);
150 void AppendArrays(vtkDataSetAttributes* setData);
151
152 double ScaleFactor;
153 vtkTypeBool UseNormal;
154 double Normal[3];
155 vtkTypeBool XYPlane;
156 int OutputPointsPrecision;
157 bool GenerateEnclosure = false;
158
159 private:
160 vtkWarpScalar(const vtkWarpScalar&) = delete;
161 void operator=(const vtkWarpScalar&) = delete;
162 };
163
164 VTK_ABI_NAMESPACE_END
165 #endif
vtkCellArray
object to represent cell connectivity
Definition: vtkCellArray.h:185
vtkDataArray
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:54
vtkDataSetAttributes
represent and manipulate attribute data in a dataset
Definition: vtkDataSetAttributes.h:65
vtkDataSet
abstract class to specify dataset behavior
Definition: vtkDataSet.h:62
vtkIdTypeArray
dynamic, self-adjusting array of vtkIdType
Definition: vtkIdTypeArray.h:37
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:38
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:40
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:72
vtkPointSetAlgorithm
Superclass for algorithms that produce output of the same type as input.
Definition: vtkPointSetAlgorithm.h:33
vtkPointSet
concrete class for storing a set of points
Definition: vtkPointSet.h:68
vtkUnsignedCharArray
dynamic, self-adjusting array of unsigned char
Definition: vtkUnsignedCharArray.h:40
vtkWarpScalar
deform geometry with scalar data
Definition: vtkWarpScalar.h:54
vtkWarpScalar::UseNormal
vtkTypeBool UseNormal
Definition: vtkWarpScalar.h:153
vtkWarpScalar::~vtkWarpScalar
~vtkWarpScalar() override
vtkWarpScalar::RequestDataObject
int RequestDataObject(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
This is called by the superclass.
vtkWarpScalar::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Standard methods for instantiation, obtaining type information, and printing.
vtkWarpScalar::ScaleFactor
double ScaleFactor
Definition: vtkWarpScalar.h:152
vtkWarpScalar::GetInputDimension
unsigned int GetInputDimension(vtkDataSet *input)
Check the topological dimension of the data set (only used when SideWallsActive)
vtkWarpScalar::XYPlane
vtkTypeBool XYPlane
Definition: vtkWarpScalar.h:155
vtkWarpScalar::vtkWarpScalar
vtkWarpScalar()
vtkWarpScalar::RequestData
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called by the superclass.
vtkWarpScalar::AppendArrays
void AppendArrays(vtkDataSetAttributes *setData)
Append the values in the arrays of the array attribute collection to themselves.
vtkWarpScalar::BuildSideWalls
void BuildSideWalls(vtkPointSet *output, int nInputPoints, vtkUnsignedCharArray *boundaryCells, vtkIdTypeArray *boundaryFaceIndexes)
When GenerateEnclosure is active, construct the cells between the base and warped surfaces.
vtkWarpScalar::OutputPointsPrecision
int OutputPointsPrecision
Definition: vtkWarpScalar.h:156
vtkWarpScalar::New
static vtkWarpScalar * New()
Standard methods for instantiation, obtaining type information, and printing.
vtkWarpScalar::FillInputPortInformation
int FillInputPortInformation(int port, vtkInformation *info) override
Fill the input port information objects for this algorithm.
vtkX3D::Normal
@ Normal
Definition: vtkX3D.h:45
vtkX3D::info
@ info
Definition: vtkX3D.h:376
vtkX3D::port
@ port
Definition: vtkX3D.h:447
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:64
vtkPointSetAlgorithm.h