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 =========================================================================*/
83 #ifndef vtkGenericClip_h
84 #define vtkGenericClip_h
85 
86 #include "vtkFiltersGenericModule.h" // For export macro
88 
90 
91 class vtkPointData;
92 class vtkCellData;
94 
95 class VTKFILTERSGENERIC_EXPORT vtkGenericClip : public vtkUnstructuredGridAlgorithm
96 {
97 public:
99  void PrintSelf(ostream& os, vtkIndent indent) override;
100 
105  static vtkGenericClip* New();
106 
108 
113  vtkSetMacro(Value, double);
114  vtkGetMacro(Value, double);
116 
118 
126  vtkSetMacro(InsideOut, vtkTypeBool);
127  vtkGetMacro(InsideOut, vtkTypeBool);
128  vtkBooleanMacro(InsideOut, vtkTypeBool);
130 
132 
138  vtkGetObjectMacro(ClipFunction, vtkImplicitFunction);
140 
142 
148  vtkSetMacro(GenerateClipScalars, vtkTypeBool);
149  vtkGetMacro(GenerateClipScalars, vtkTypeBool);
150  vtkBooleanMacro(GenerateClipScalars, vtkTypeBool);
152 
154 
158  vtkSetMacro(GenerateClippedOutput, vtkTypeBool);
159  vtkGetMacro(GenerateClippedOutput, vtkTypeBool);
160  vtkBooleanMacro(GenerateClippedOutput, vtkTypeBool);
162 
164 
170  vtkSetClampMacro(MergeTolerance, double, 0.0001, 0.25);
171  vtkGetMacro(MergeTolerance, double);
173 
175 
179  virtual int GetNumberOfOutputs();
181 
183 
188  vtkGetObjectMacro(Locator, vtkIncrementalPointLocator);
190 
196 
200  vtkMTimeType GetMTime() override;
201 
203 
207  vtkGetStringMacro(InputScalarsSelection);
208  void SelectInputScalars(const char* fieldName) { this->SetInputScalarsSelection(fieldName); }
210 
211 protected:
213  ~vtkGenericClip() override;
214 
217 
219 
222  double Value;
224 
227 
229  vtkSetStringMacro(InputScalarsSelection);
230 
231  // Used internal by vtkGenericAdaptorCell::Clip()
235 
236 private:
237  vtkGenericClip(const vtkGenericClip&) = delete;
238  void operator=(const vtkGenericClip&) = delete;
239 };
240 
241 #endif
represent and manipulate cell attribute data
Definition: vtkCellData.h:151
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
vtkPointData * InternalPD
~vtkGenericClip() override
vtkUnstructuredGrid * GetClippedOutput()
Return the Clipped output.
vtkTypeBool GenerateClipScalars
vtkPointData * SecondaryPD
char * InputScalarsSelection
virtual int GetNumberOfOutputs()
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.
static vtkGenericClip * New()
Construct with user-specified implicit function; InsideOut turned off; value set to 0....
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:119
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
represent and manipulate point attribute data
Definition: vtkPointData.h:151
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