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=========================================================================*/
61#ifndef vtkGenericClip_h
62#define vtkGenericClip_h
63
64#include "vtkFiltersGenericModule.h" // For export macro
66
68
69class vtkPointData;
70class vtkCellData;
72
73class VTKFILTERSGENERIC_EXPORT vtkGenericClip : public vtkUnstructuredGridAlgorithm
74{
75public:
77 void PrintSelf(ostream& os, vtkIndent indent) override;
78
84
86
91 vtkSetMacro(Value, double);
92 vtkGetMacro(Value, double);
94
96
104 vtkSetMacro(InsideOut, vtkTypeBool);
105 vtkGetMacro(InsideOut, vtkTypeBool);
106 vtkBooleanMacro(InsideOut, vtkTypeBool);
108
110
116 vtkGetObjectMacro(ClipFunction, vtkImplicitFunction);
118
120
126 vtkSetMacro(GenerateClipScalars, vtkTypeBool);
127 vtkGetMacro(GenerateClipScalars, vtkTypeBool);
128 vtkBooleanMacro(GenerateClipScalars, vtkTypeBool);
130
132
136 vtkSetMacro(GenerateClippedOutput, vtkTypeBool);
137 vtkGetMacro(GenerateClippedOutput, vtkTypeBool);
138 vtkBooleanMacro(GenerateClippedOutput, vtkTypeBool);
140
142
148 vtkSetClampMacro(MergeTolerance, double, 0.0001, 0.25);
149 vtkGetMacro(MergeTolerance, double);
151
153
157 virtual int GetNumberOfOutputs();
159
161
166 vtkGetObjectMacro(Locator, vtkIncrementalPointLocator);
168
174
179
181
185 vtkGetStringMacro(InputScalarsSelection);
186 void SelectInputScalars(const char* fieldName) { this->SetInputScalarsSelection(fieldName); }
188
189protected:
191 ~vtkGenericClip() override;
192
195
197
200 double Value;
202
205
207 vtkSetStringMacro(InputScalarsSelection);
208
209 // Used internal by vtkGenericAdaptorCell::Clip()
213
214private:
215 vtkGenericClip(const vtkGenericClip&) = delete;
216 void operator=(const vtkGenericClip&) = delete;
217};
218
219#endif
represent and manipulate cell attribute data
Definition: vtkCellData.h:33
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:34
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
represent and manipulate point attribute data
Definition: vtkPointData.h:33
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