VTK  9.1.0
vtkGenericClip.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkGenericClip.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=========================================================================*/
70#ifndef vtkGenericClip_h
71#define vtkGenericClip_h
72
73#include "vtkFiltersGenericModule.h" // For export macro
75
77
78class vtkPointData;
79class vtkCellData;
81
82class VTKFILTERSGENERIC_EXPORT vtkGenericClip : public vtkUnstructuredGridAlgorithm
83{
84public:
86 void PrintSelf(ostream& os, vtkIndent indent) override;
87
93
95
100 vtkSetMacro(Value, double);
101 vtkGetMacro(Value, double);
103
105
113 vtkSetMacro(InsideOut, vtkTypeBool);
114 vtkGetMacro(InsideOut, vtkTypeBool);
115 vtkBooleanMacro(InsideOut, vtkTypeBool);
117
119
125 vtkGetObjectMacro(ClipFunction, vtkImplicitFunction);
127
129
135 vtkSetMacro(GenerateClipScalars, vtkTypeBool);
136 vtkGetMacro(GenerateClipScalars, vtkTypeBool);
137 vtkBooleanMacro(GenerateClipScalars, vtkTypeBool);
139
141
145 vtkSetMacro(GenerateClippedOutput, vtkTypeBool);
146 vtkGetMacro(GenerateClippedOutput, vtkTypeBool);
147 vtkBooleanMacro(GenerateClippedOutput, vtkTypeBool);
149
151
157 vtkSetClampMacro(MergeTolerance, double, 0.0001, 0.25);
158 vtkGetMacro(MergeTolerance, double);
160
162
166 virtual int GetNumberOfOutputs();
168
170
175 vtkGetObjectMacro(Locator, vtkIncrementalPointLocator);
177
183
188
190
194 vtkGetStringMacro(InputScalarsSelection);
195 void SelectInputScalars(const char* fieldName) { this->SetInputScalarsSelection(fieldName); }
197
198protected:
200 ~vtkGenericClip() override;
201
204
206
209 double Value;
211
214
216 vtkSetStringMacro(InputScalarsSelection);
217
218 // Used internal by vtkGenericAdaptorCell::Clip()
222
223private:
224 vtkGenericClip(const vtkGenericClip&) = delete;
225 void operator=(const vtkGenericClip&) = delete;
226};
227
228#endif
represent and manipulate cell attribute data
Definition vtkCellData.h:42
clip any dataset with an implicit function or scalar data
vtkMTimeType GetMTime() override
Return the mtime also considering the locator and clip function.
vtkIncrementalPointLocator * Locator
vtkCellData * SecondaryCD
static vtkGenericClip * New()
Construct with user-specified implicit function; InsideOut turned off; value set to 0....
vtkPointData * InternalPD
~vtkGenericClip() override
vtkTypeBool GenerateClipScalars
vtkPointData * SecondaryPD
char * InputScalarsSelection
virtual int GetNumberOfOutputs()
Return the Clipped output.
vtkUnstructuredGrid * GetClippedOutput()
Return the Clipped output.
vtkTypeBool InsideOut
void SelectInputScalars(const char *fieldName)
If you want to clip by an arbitrary array, then set its name here.
virtual void SetClipFunction(vtkImplicitFunction *)
Specify the implicit function with which to perform the clipping.
vtkGenericClip(vtkImplicitFunction *cf=nullptr)
vtkTypeBool GenerateClippedOutput
int FillInputPortInformation(int, vtkInformation *) override
Fill the input port information objects for this algorithm.
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called by the superclass.
vtkImplicitFunction * ClipFunction
void CreateDefaultLocator()
Create default locator.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void SetLocator(vtkIncrementalPointLocator *locator)
Specify a spatial locator for merging points.
abstract interface for implicit functions
Abstract class in support of both point location and point insertion.
a simple class to control print indentation
Definition vtkIndent.h:43
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
represent and manipulate point attribute data
Superclass for algorithms that produce only unstructured grid as output.
dataset represents arbitrary combinations of all possible cell types
int vtkTypeBool
Definition vtkABI.h:69
vtkTypeUInt32 vtkMTimeType
Definition vtkType.h:287