VTK  9.0.1
vtkClipDataSet.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkClipDataSet.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 =========================================================================*/
60 #ifndef vtkClipDataSet_h
61 #define vtkClipDataSet_h
62 
63 #include "vtkFiltersGeneralModule.h" // For export macro
65 
66 class vtkCallbackCommand;
69 
70 class VTKFILTERSGENERAL_EXPORT vtkClipDataSet : public vtkUnstructuredGridAlgorithm
71 {
72 public:
74  void PrintSelf(ostream& os, vtkIndent indent) override;
75 
80  static vtkClipDataSet* New();
81 
83 
89  vtkSetMacro(Value, double);
90  vtkGetMacro(Value, double);
92 
94 
99  vtkSetMacro(UseValueAsOffset, bool);
100  vtkGetMacro(UseValueAsOffset, bool);
101  vtkBooleanMacro(UseValueAsOffset, bool);
103 
105 
113  vtkSetMacro(InsideOut, vtkTypeBool);
114  vtkGetMacro(InsideOut, vtkTypeBool);
115  vtkBooleanMacro(InsideOut, vtkTypeBool);
117 
119 
124  virtual void SetClipFunction(vtkImplicitFunction*);
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 
164  vtkUnstructuredGrid* GetClippedOutput();
165 
167 
171  void SetLocator(vtkIncrementalPointLocator* locator);
172  vtkGetObjectMacro(Locator, vtkIncrementalPointLocator);
174 
179  void CreateDefaultLocator();
180 
184  vtkMTimeType GetMTime() override;
185 
187 
192  vtkSetClampMacro(OutputPointsPrecision, int, SINGLE_PRECISION, DEFAULT_PRECISION);
193  vtkGetMacro(OutputPointsPrecision, int);
195 
196 protected:
197  vtkClipDataSet(vtkImplicitFunction* cf = nullptr);
198  ~vtkClipDataSet() override;
199 
201  int FillInputPortInformation(int port, vtkInformation* info) override;
203 
206  double Value;
208 
211 
212  // Callback registered with the InternalProgressObserver.
213  static void InternalProgressCallbackFunction(vtkObject*, unsigned long, void* clientdata, void*);
214  void InternalProgressCallback(vtkAlgorithm* algorithm);
215  // The observer to report progress from the internal readers.
217 
218  // helper functions
219  void ClipVolume(vtkDataSet* input, vtkUnstructuredGrid* output);
220 
221  int ClipPoints(
222  vtkDataSet* input, vtkUnstructuredGrid* output, vtkInformationVector** inputVector);
223 
226 
227 private:
228  vtkClipDataSet(const vtkClipDataSet&) = delete;
229  void operator=(const vtkClipDataSet&) = delete;
230 };
231 
232 #endif
abstract interface for implicit functions
vtkIncrementalPointLocator * Locator
virtual int RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
This is called by the superclass.
abstract base class for most VTK objects
Definition: vtkObject.h:62
Store vtkAlgorithm input/output information.
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:293
abstract class to specify dataset behavior
Definition: vtkDataSet.h:56
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.
vtkTypeBool GenerateClipScalars
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.
supports function callbacks
Superclass for all sources, filters, and sinks in VTK.
Definition: vtkAlgorithm.h:62
a simple class to control print indentation
Definition: vtkIndent.h:33
dataset represents arbitrary combinations of all possible cell types
vtkImplicitFunction * ClipFunction
virtual vtkMTimeType GetMTime()
Return this object's modified time.
vtkTypeBool GenerateClippedOutput
Superclass for algorithms that produce only unstructured grid as output.
vtkCallbackCommand * InternalProgressObserver
clip any dataset with user-specified implicit function or input scalar data
Store zero or more vtkInformation instances.
vtkTypeBool InsideOut