VTK  9.2.6
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 =========================================================================*/
63 #ifndef vtkClipDataSet_h
64 #define vtkClipDataSet_h
65 
66 #include "vtkFiltersGeneralModule.h" // For export macro
68 
69 class vtkCallbackCommand;
72 
73 class VTKFILTERSGENERAL_EXPORT vtkClipDataSet : public vtkUnstructuredGridAlgorithm
74 {
75 public:
77  void PrintSelf(ostream& os, vtkIndent indent) override;
78 
83  static vtkClipDataSet* New();
84 
86 
92  vtkSetMacro(Value, double);
93  vtkGetMacro(Value, double);
95 
97 
102  vtkSetMacro(UseValueAsOffset, bool);
103  vtkGetMacro(UseValueAsOffset, bool);
104  vtkBooleanMacro(UseValueAsOffset, bool);
106 
108 
116  vtkSetMacro(InsideOut, vtkTypeBool);
117  vtkGetMacro(InsideOut, vtkTypeBool);
118  vtkBooleanMacro(InsideOut, vtkTypeBool);
120 
122 
127  virtual void SetClipFunction(vtkImplicitFunction*);
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 
167  vtkUnstructuredGrid* GetClippedOutput();
168 
170 
174  void SetLocator(vtkIncrementalPointLocator* locator);
175  vtkGetObjectMacro(Locator, vtkIncrementalPointLocator);
177 
182  void CreateDefaultLocator();
183 
187  vtkMTimeType GetMTime() override;
188 
190 
195  vtkSetClampMacro(OutputPointsPrecision, int, SINGLE_PRECISION, DEFAULT_PRECISION);
196  vtkGetMacro(OutputPointsPrecision, int);
198 
199 protected:
200  vtkClipDataSet(vtkImplicitFunction* cf = nullptr);
201  ~vtkClipDataSet() override;
202 
204  int FillInputPortInformation(int port, vtkInformation* info) override;
206 
209  double Value;
211 
214 
215  // Callback registered with the InternalProgressObserver.
216  static void InternalProgressCallbackFunction(vtkObject*, unsigned long, void* clientdata, void*);
217  void InternalProgressCallback(vtkAlgorithm* algorithm);
218  // The observer to report progress from the internal readers.
220 
221  // helper functions
222  void ClipVolume(vtkDataSet* input, vtkUnstructuredGrid* output);
223 
224  int ClipPoints(
225  vtkDataSet* input, vtkUnstructuredGrid* output, vtkInformationVector** inputVector);
226 
229 
230 private:
231  vtkClipDataSet(const vtkClipDataSet&) = delete;
232  void operator=(const vtkClipDataSet&) = delete;
233 };
234 
235 #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:287
abstract class to specify dataset behavior
Definition: vtkDataSet.h:62
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:39
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