VTK  9.2.6
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=========================================================================*/
73#ifndef vtkGenericClip_h
74#define vtkGenericClip_h
75
76#include "vtkFiltersGenericModule.h" // For export macro
78
80
81class vtkPointData;
82class vtkCellData;
84
85class VTKFILTERSGENERIC_EXPORT vtkGenericClip : public vtkUnstructuredGridAlgorithm
86{
87public:
89 void PrintSelf(ostream& os, vtkIndent indent) override;
90
96
98
103 vtkSetMacro(Value, double);
104 vtkGetMacro(Value, double);
106
108
116 vtkSetMacro(InsideOut, vtkTypeBool);
117 vtkGetMacro(InsideOut, vtkTypeBool);
118 vtkBooleanMacro(InsideOut, vtkTypeBool);
120
122
128 vtkGetObjectMacro(ClipFunction, vtkImplicitFunction);
130
132
138 vtkSetMacro(GenerateClipScalars, vtkTypeBool);
139 vtkGetMacro(GenerateClipScalars, vtkTypeBool);
140 vtkBooleanMacro(GenerateClipScalars, vtkTypeBool);
142
144
148 vtkSetMacro(GenerateClippedOutput, vtkTypeBool);
149 vtkGetMacro(GenerateClippedOutput, vtkTypeBool);
150 vtkBooleanMacro(GenerateClippedOutput, vtkTypeBool);
152
154
160 vtkSetClampMacro(MergeTolerance, double, 0.0001, 0.25);
161 vtkGetMacro(MergeTolerance, double);
163
165
169 virtual int GetNumberOfOutputs();
171
173
178 vtkGetObjectMacro(Locator, vtkIncrementalPointLocator);
180
186
191
193
197 vtkGetStringMacro(InputScalarsSelection);
198 void SelectInputScalars(const char* fieldName) { this->SetInputScalarsSelection(fieldName); }
200
201protected:
203 ~vtkGenericClip() override;
204
207
209
212 double Value;
214
217
219 vtkSetStringMacro(InputScalarsSelection);
220
221 // Used internal by vtkGenericAdaptorCell::Clip()
225
226private:
227 vtkGenericClip(const vtkGenericClip&) = delete;
228 void operator=(const vtkGenericClip&) = delete;
229};
230
231#endif
represent and manipulate cell attribute data
Definition vtkCellData.h:51
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:49
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