VTK  9.1.0
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
69
70class VTKFILTERSGENERAL_EXPORT vtkClipDataSet : public vtkUnstructuredGridAlgorithm
71{
72public:
74 void PrintSelf(ostream& os, vtkIndent indent) override;
75
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
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
165
167
172 vtkGetObjectMacro(Locator, vtkIncrementalPointLocator);
174
180
185
187
192 vtkSetClampMacro(OutputPointsPrecision, int, SINGLE_PRECISION, DEFAULT_PRECISION);
193 vtkGetMacro(OutputPointsPrecision, int);
195
196protected:
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*);
215 // The observer to report progress from the internal readers.
217
218 // helper functions
220
222 vtkDataSet* input, vtkUnstructuredGrid* output, vtkInformationVector** inputVector);
223
226
227private:
228 vtkClipDataSet(const vtkClipDataSet&) = delete;
229 void operator=(const vtkClipDataSet&) = delete;
230};
231
232#endif
Superclass for all sources, filters, and sinks in VTK.
Definition: vtkAlgorithm.h:64
supports function callbacks
clip any dataset with user-specified implicit function or input scalar data
int FillInputPortInformation(int port, vtkInformation *info) override
Fill the input port information objects for this algorithm.
vtkTypeBool GenerateClippedOutput
vtkUnstructuredGrid * GetClippedOutput()
Return the Clipped output.
vtkCallbackCommand * InternalProgressObserver
virtual void SetClipFunction(vtkImplicitFunction *)
Specify the implicit function with which to perform the clipping.
~vtkClipDataSet() override
static void InternalProgressCallbackFunction(vtkObject *, unsigned long, void *clientdata, void *)
vtkTypeBool InsideOut
void ClipVolume(vtkDataSet *input, vtkUnstructuredGrid *output)
vtkIncrementalPointLocator * Locator
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called by the superclass.
void SetLocator(vtkIncrementalPointLocator *locator)
Specify a spatial locator for merging points.
int ClipPoints(vtkDataSet *input, vtkUnstructuredGrid *output, vtkInformationVector **inputVector)
vtkImplicitFunction * ClipFunction
vtkClipDataSet(vtkImplicitFunction *cf=nullptr)
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 InternalProgressCallback(vtkAlgorithm *algorithm)
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void CreateDefaultLocator()
Create default locator.
vtkTypeBool GenerateClipScalars
abstract class to specify dataset behavior
Definition: vtkDataSet.h:57
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:34
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
abstract base class for most VTK objects
Definition: vtkObject.h:63
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