VTK  9.2.6
vtkClipVolume.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkClipVolume.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=========================================================================*/
64#ifndef vtkClipVolume_h
65#define vtkClipVolume_h
66
67#include "vtkFiltersGeneralModule.h" // For export macro
69
70class vtkCellData;
71class vtkDataArray;
72class vtkIdList;
74class vtkMergePoints;
76class vtkPointData;
78class vtkPoints;
80class vtkCell;
81class vtkTetra;
82class vtkCellArray;
83class vtkIdTypeArray;
85
86class VTKFILTERSGENERAL_EXPORT vtkClipVolume : public vtkUnstructuredGridAlgorithm
87{
88public:
90 void PrintSelf(ostream& os, vtkIndent indent) override;
91
96 static vtkClipVolume* New();
97
99
104 vtkSetMacro(Value, double);
105 vtkGetMacro(Value, double);
107
109
116 vtkSetMacro(InsideOut, vtkTypeBool);
117 vtkGetMacro(InsideOut, vtkTypeBool);
118 vtkBooleanMacro(InsideOut, vtkTypeBool);
120
122
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
157
159
165 vtkSetMacro(Mixed3DCellGeneration, vtkTypeBool);
166 vtkGetMacro(Mixed3DCellGeneration, vtkTypeBool);
167 vtkBooleanMacro(Mixed3DCellGeneration, vtkTypeBool);
169
171
176 vtkSetClampMacro(MergeTolerance, double, 0.0001, 0.25);
177 vtkGetMacro(MergeTolerance, double);
179
181
186 vtkGetObjectMacro(Locator, vtkIncrementalPointLocator);
188
194
199
200protected:
202 ~vtkClipVolume() override;
203
205
207 int FillInputPortInformation(int port, vtkInformation* info) override;
208
209 void ClipTets(double value, vtkTetra* clipTetra, vtkDataArray* clipScalars,
210 vtkDataArray* cellScalars, vtkIdList* tetraIds, vtkPoints* tetraPts, vtkPointData* inPD,
211 vtkPointData* outPD, vtkCellData* inCD, vtkIdType cellId, vtkCellData* outCD,
212 vtkCellData* clippedCD, int insideOut);
213 void ClipVoxel(double value, vtkDataArray* cellScalars, int flip, double origin[3],
214 double spacing[3], vtkIdList* cellIds, vtkPoints* cellPts, vtkPointData* inPD,
215 vtkPointData* outPD, vtkCellData* inCD, vtkIdType cellId, vtkCellData* outCD,
216 vtkCellData* clippedCD);
217
221 double Value;
227
228private:
229 vtkOrderedTriangulator* Triangulator;
230
231 // Used temporarily to pass data around
232 vtkIdType NumberOfCells;
233 vtkCellArray* Connectivity;
235 vtkIdType NumberOfClippedCells;
236 vtkCellArray* ClippedConnectivity;
237 vtkUnsignedCharArray* ClippedTypes;
238
239private:
240 vtkClipVolume(const vtkClipVolume&) = delete;
241 void operator=(const vtkClipVolume&) = delete;
242};
243
244#endif
object to represent cell connectivity
Definition: vtkCellArray.h:187
represent and manipulate cell attribute data
Definition: vtkCellData.h:42
abstract class to specify cell behavior
Definition: vtkCell.h:61
clip volume data with user-specified implicit function or input scalar data
Definition: vtkClipVolume.h:87
vtkUnstructuredGrid * ClippedOutput
void ClipTets(double value, vtkTetra *clipTetra, vtkDataArray *clipScalars, vtkDataArray *cellScalars, vtkIdList *tetraIds, vtkPoints *tetraPts, vtkPointData *inPD, vtkPointData *outPD, vtkCellData *inCD, vtkIdType cellId, vtkCellData *outCD, vtkCellData *clippedCD, int insideOut)
vtkClipVolume(vtkImplicitFunction *cf=nullptr)
vtkTypeBool GenerateClipScalars
void ClipVoxel(double value, vtkDataArray *cellScalars, int flip, double origin[3], double spacing[3], vtkIdList *cellIds, vtkPoints *cellPts, vtkPointData *inPD, vtkPointData *outPD, vtkCellData *inCD, vtkIdType cellId, vtkCellData *outCD, vtkCellData *clippedCD)
vtkTypeBool InsideOut
virtual void SetClipFunction(vtkImplicitFunction *)
Specify the implicit function with which to perform the clipping.
vtkTypeBool GenerateClippedOutput
vtkIncrementalPointLocator * Locator
vtkMTimeType GetMTime() override
Return the mtime also considering the locator and clip function.
static vtkClipVolume * New()
Construct with user-specified implicit function; InsideOut turned off; value set to 0....
vtkImplicitFunction * ClipFunction
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
~vtkClipVolume() override
void ReportReferences(vtkGarbageCollector *) override
int FillInputPortInformation(int port, vtkInformation *info) override
Fill the input port information objects for this algorithm.
void CreateDefaultLocator()
Create default locator.
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called by the superclass.
double MergeTolerance
vtkTypeBool Mixed3DCellGeneration
void SetLocator(vtkIncrementalPointLocator *locator)
Set / Get a spatial locator for merging points.
vtkUnstructuredGrid * GetClippedOutput()
Return the clipped output.
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:56
Detect and break reference loops.
list of point or cell ids
Definition: vtkIdList.h:34
dynamic, self-adjusting array of vtkIdType
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.
merge exactly coincident points
helper class to generate triangulations
represent and manipulate point attribute data
Definition: vtkPointData.h:42
represent and manipulate 3D points
Definition: vtkPoints.h:40
a 3D cell that represents a tetrahedron
Definition: vtkTetra.h:45
dynamic, self-adjusting array of unsigned char
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
int vtkIdType
Definition: vtkType.h:332
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:287