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 
70 class vtkCellData;
71 class vtkDataArray;
72 class vtkIdList;
74 class vtkMergePoints;
76 class vtkPointData;
78 class vtkPoints;
80 class vtkCell;
81 class vtkTetra;
82 class vtkCellArray;
83 class vtkIdTypeArray;
85 
86 class VTKFILTERSGENERAL_EXPORT vtkClipVolume : public vtkUnstructuredGridAlgorithm
87 {
88 public:
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 
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 
156  vtkUnstructuredGrid* GetClippedOutput();
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 
185  void SetLocator(vtkIncrementalPointLocator* locator);
186  vtkGetObjectMacro(Locator, vtkIncrementalPointLocator);
188 
193  void CreateDefaultLocator();
194 
198  vtkMTimeType GetMTime() override;
199 
200 protected:
201  vtkClipVolume(vtkImplicitFunction* cf = nullptr);
202  ~vtkClipVolume() override;
203 
204  void ReportReferences(vtkGarbageCollector*) override;
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 
228 private:
229  vtkOrderedTriangulator* Triangulator;
230 
231  // Used temporarily to pass data around
232  vtkIdType NumberOfCells;
233  vtkCellArray* Connectivity;
234  vtkUnsignedCharArray* Types;
235  vtkIdType NumberOfClippedCells;
236  vtkCellArray* ClippedConnectivity;
237  vtkUnsignedCharArray* ClippedTypes;
238 
239 private:
240  vtkClipVolume(const vtkClipVolume&) = delete;
241  void operator=(const vtkClipVolume&) = delete;
242 };
243 
244 #endif
abstract interface for implicit functions
clip volume data with user-specified implicit function or input scalar data
Definition: vtkClipVolume.h:86
virtual int RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
This is called by the superclass.
represent and manipulate point attribute data
Definition: vtkPointData.h:41
Store vtkAlgorithm input/output information.
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:287
void ReportReferences(vtkGarbageCollector *) override
represent and manipulate cell attribute data
Definition: vtkCellData.h:41
static vtkUnstructuredGridAlgorithm * New()
Abstract class in support of both point location and point insertion.
helper class to generate triangulations
dynamic, self-adjusting array of vtkIdType
int vtkIdType
Definition: vtkType.h:332
int FillInputPortInformation(int port, vtkInformation *info) override
Fill the input port information objects for this algorithm.
Detect and break reference loops.
int vtkTypeBool
Definition: vtkABI.h:69
a 3D cell that represents a tetrahedron
Definition: vtkTetra.h:44
abstract class to specify cell behavior
Definition: vtkCell.h:60
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkTypeBool GenerateClipScalars
double MergeTolerance
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkIncrementalPointLocator * Locator
merge exactly coincident points
list of point or cell ids
Definition: vtkIdList.h:33
dataset represents arbitrary combinations of all possible cell types
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:55
virtual vtkMTimeType GetMTime()
Return this object's modified time.
vtkTypeBool Mixed3DCellGeneration
Superclass for algorithms that produce only unstructured grid as output.
dynamic, self-adjusting array of unsigned char
vtkUnstructuredGrid * ClippedOutput
object to represent cell connectivity
Definition: vtkCellArray.h:186
Store zero or more vtkInformation instances.
vtkTypeBool GenerateClippedOutput
vtkImplicitFunction * ClipFunction
vtkTypeBool InsideOut
represent and manipulate 3D points
Definition: vtkPoints.h:39