VTK  9.0.1
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 
69 class vtkPointData;
70 class vtkCellData;
72 
73 class VTKFILTERSGENERIC_EXPORT vtkGenericClip : public vtkUnstructuredGridAlgorithm
74 {
75 public:
77  void PrintSelf(ostream& os, vtkIndent indent) override;
78 
83  static vtkGenericClip* New();
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 
115  virtual void SetClipFunction(vtkImplicitFunction*);
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 
156  vtkUnstructuredGrid* GetClippedOutput();
157  virtual int GetNumberOfOutputs();
159 
161 
165  void SetLocator(vtkIncrementalPointLocator* locator);
166  vtkGetObjectMacro(Locator, vtkIncrementalPointLocator);
168 
173  void CreateDefaultLocator();
174 
178  vtkMTimeType GetMTime() override;
179 
181 
185  vtkGetStringMacro(InputScalarsSelection);
186  void SelectInputScalars(const char* fieldName) { this->SetInputScalarsSelection(fieldName); }
188 
189 protected:
190  vtkGenericClip(vtkImplicitFunction* cf = nullptr);
191  ~vtkGenericClip() override;
192 
194  int FillInputPortInformation(int, vtkInformation*) override;
195 
197 
200  double Value;
202 
205 
207  vtkSetStringMacro(InputScalarsSelection);
208 
209  // Used internal by vtkGenericAdaptorCell::Clip()
213 
214 private:
215  vtkGenericClip(const vtkGenericClip&) = delete;
216  void operator=(const vtkGenericClip&) = delete;
217 };
218 
219 #endif
abstract interface for implicit functions
virtual int RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
This is called by the superclass.
represent and manipulate point attribute data
Definition: vtkPointData.h:31
Store vtkAlgorithm input/output information.
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:293
clip any dataset with an implicit function or scalar data
vtkIncrementalPointLocator * Locator
represent and manipulate cell attribute data
Definition: vtkCellData.h:32
static vtkUnstructuredGridAlgorithm * New()
Abstract class in support of both point location and point insertion.
int FillInputPortInformation(int port, vtkInformation *info) override
Fill the input port information objects for this algorithm.
void SelectInputScalars(const char *fieldName)
If you want to clip by an arbitrary array, then set its name here.
int vtkTypeBool
Definition: vtkABI.h:69
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkPointData * SecondaryPD
char * InputScalarsSelection
a simple class to control print indentation
Definition: vtkIndent.h:33
dataset represents arbitrary combinations of all possible cell types
virtual vtkMTimeType GetMTime()
Return this object's modified time.
vtkCellData * SecondaryCD
vtkTypeBool GenerateClipScalars
Superclass for algorithms that produce only unstructured grid as output.
vtkPointData * InternalPD
vtkTypeBool GenerateClippedOutput
vtkImplicitFunction * ClipFunction
Store zero or more vtkInformation instances.
vtkTypeBool InsideOut