VTK
vtkGenericClip.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkGenericClip.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 vtkGenericClip_h
65 #define vtkGenericClip_h
66 
67 #include "vtkFiltersGenericModule.h" // For export macro
69 
71 
72 class vtkPointData;
73 class vtkCellData;
75 
76 class VTKFILTERSGENERIC_EXPORT vtkGenericClip : public vtkUnstructuredGridAlgorithm
77 {
78 public:
80  void PrintSelf(ostream& os, vtkIndent indent) override;
81 
86  static vtkGenericClip *New();
87 
89 
94  vtkSetMacro(Value,double);
95  vtkGetMacro(Value,double);
97 
99 
107  vtkSetMacro(InsideOut,int);
108  vtkGetMacro(InsideOut,int);
109  vtkBooleanMacro(InsideOut,int);
111 
113 
118  virtual void SetClipFunction(vtkImplicitFunction*);
119  vtkGetObjectMacro(ClipFunction,vtkImplicitFunction);
121 
123 
129  vtkSetMacro(GenerateClipScalars,int);
130  vtkGetMacro(GenerateClipScalars,int);
131  vtkBooleanMacro(GenerateClipScalars,int);
133 
135 
139  vtkSetMacro(GenerateClippedOutput,int);
140  vtkGetMacro(GenerateClippedOutput,int);
141  vtkBooleanMacro(GenerateClippedOutput,int);
143 
145 
151  vtkSetClampMacro(MergeTolerance,double,0.0001,0.25);
152  vtkGetMacro(MergeTolerance,double);
154 
156 
159  vtkUnstructuredGrid *GetClippedOutput();
160  virtual int GetNumberOfOutputs();
162 
164 
168  void SetLocator(vtkIncrementalPointLocator *locator);
169  vtkGetObjectMacro(Locator,vtkIncrementalPointLocator);
171 
176  void CreateDefaultLocator();
177 
181  vtkMTimeType GetMTime() override;
182 
184 
188  vtkGetStringMacro(InputScalarsSelection);
189  void SelectInputScalars(const char *fieldName)
190  {this->SetInputScalarsSelection(fieldName);}
192 
193 protected:
194  vtkGenericClip(vtkImplicitFunction *cf=nullptr);
195  ~vtkGenericClip() override;
196 
198  int FillInputPortInformation(int, vtkInformation*) override;
199 
201 
204  double Value;
206 
209 
211  vtkSetStringMacro(InputScalarsSelection);
212 
213  // Used internal by vtkGenericAdaptorCell::Clip()
217 
218 private:
219  vtkGenericClip(const vtkGenericClip&) = delete;
220  void operator=(const vtkGenericClip&) = delete;
221 };
222 
223 #endif
abstract interface for implicit functions
virtual int RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
This is called by the superclass.
represent and manipulate point attribute data
Definition: vtkPointData.h:37
Store vtkAlgorithm input/output information.
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:300
clip any dataset with an implicit function or scalar data
vtkIncrementalPointLocator * Locator
represent and manipulate cell attribute data
Definition: vtkCellData.h:38
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.
void SelectInputScalars(const char *fieldName)
If you want to clip by an arbitrary array, then set its name here.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkPointData * SecondaryPD
char * InputScalarsSelection
a simple class to control print indentation
Definition: vtkIndent.h:39
dataset represents arbitrary combinations of all possible cell types
virtual vtkMTimeType GetMTime()
Return this object's modified time.
vtkCellData * SecondaryCD
vtkGetStringMacro(ExtensionsString)
Returns a string listing all available extensions.
Superclass for algorithms that produce only unstructured grid as output.
vtkSetMacro(IgnoreDriverBugs, bool)
When set known driver bugs are ignored during driver feature detection.
vtkPointData * InternalPD
vtkImplicitFunction * ClipFunction
Store zero or more vtkInformation instances.
vtkBooleanMacro(IgnoreDriverBugs, bool)
When set known driver bugs are ignored during driver feature detection.