VTK
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
72
73class VTKFILTERSGENERAL_EXPORT vtkClipDataSet : public vtkUnstructuredGridAlgorithm
74{
75public:
77 void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
78
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,int);
117 vtkGetMacro(InsideOut,int);
118 vtkBooleanMacro(InsideOut,int);
120
122
128 vtkGetObjectMacro(ClipFunction,vtkImplicitFunction);
130
132
138 vtkSetMacro(GenerateClipScalars,int);
139 vtkGetMacro(GenerateClipScalars,int);
140 vtkBooleanMacro(GenerateClipScalars,int);
142
144
148 vtkSetMacro(GenerateClippedOutput,int);
149 vtkGetMacro(GenerateClippedOutput,int);
150 vtkBooleanMacro(GenerateClippedOutput,int);
152
154
160 vtkSetClampMacro(MergeTolerance,double,0.0001,0.25);
161 vtkGetMacro(MergeTolerance,double);
163
168
170
175 vtkGetObjectMacro(Locator,vtkIncrementalPointLocator);
177
183
187 vtkMTimeType GetMTime() VTK_OVERRIDE;
188
190
195 vtkSetClampMacro(OutputPointsPrecision, int, SINGLE_PRECISION, DEFAULT_PRECISION);
196 vtkGetMacro(OutputPointsPrecision, int);
198
199protected:
201 ~vtkClipDataSet() VTK_OVERRIDE;
202
203 int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) VTK_OVERRIDE;
204 int FillInputPortInformation(int port, vtkInformation *info) VTK_OVERRIDE;
205 vtkImplicitFunction *ClipFunction;
206
208 int InsideOut;
209 double Value;
210 int GenerateClipScalars;
211
212 int GenerateClippedOutput;
213 double MergeTolerance;
214
215 // Callback registered with the InternalProgressObserver.
216 static void InternalProgressCallbackFunction(vtkObject*, unsigned long,
217 void* clientdata, void*);
218 void InternalProgressCallback(vtkAlgorithm *algorithm);
219 // The observer to report progress from the internal readers.
220 vtkCallbackCommand* InternalProgressObserver;
221
222 //helper functions
223 void ClipVolume(vtkDataSet *input, vtkUnstructuredGrid *output);
224
225 int ClipPoints(vtkDataSet* input, vtkUnstructuredGrid* output,
226 vtkInformationVector** inputVector);
227
228 bool UseValueAsOffset;
229 int OutputPointsPrecision;
230
231private:
232 vtkClipDataSet(const vtkClipDataSet&) VTK_DELETE_FUNCTION;
233 void operator=(const vtkClipDataSet&) VTK_DELETE_FUNCTION;
234};
235
236#endif
Superclass for all sources, filters, and sinks in VTK.
Definition: vtkAlgorithm.h:60
supports function callbacks
clip any dataset with user-specified implicit function or input scalar data
vtkUnstructuredGrid * GetClippedOutput()
Return the Clipped output.
virtual void SetClipFunction(vtkImplicitFunction *)
Specify the implicit function with which to perform the clipping.
void SetLocator(vtkIncrementalPointLocator *locator)
Specify a spatial locator for merging points.
vtkMTimeType GetMTime() override
Return the mtime also considering the locator and clip function.
static vtkClipDataSet * New()
Construct with user-specified implicit function; InsideOut turned off; value set to 0....
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void CreateDefaultLocator()
Create default locator.
abstract class to specify dataset behavior
Definition: vtkDataSet.h:63
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:40
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
abstract base class for most VTK objects
Definition: vtkObject.h:60
Superclass for algorithms that produce only unstructured grid as output.
dataset represents arbitrary combinations of all possible cell types
@ info
Definition: vtkX3D.h:376
@ port
Definition: vtkX3D.h:447
vtkSetMacro(IgnoreDriverBugs, bool)
Updates the extensions string.
vtkBooleanMacro(IgnoreDriverBugs, bool)
Updates the extensions string.
vtkTypeUInt64 vtkMTimeType
Definition: vtkType.h:248