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);
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 
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 
160  virtual int GetNumberOfOutputs();
162 
164 
169  vtkGetObjectMacro(Locator,vtkIncrementalPointLocator);
171 
177 
182 
184 
188  vtkGetStringMacro(InputScalarsSelection);
189  void SelectInputScalars(const char *fieldName)
190  {this->SetInputScalarsSelection(fieldName);}
192 
193 protected:
196 
199 
201 
204  double Value;
206 
209 
211  vtkSetStringMacro(InputScalarsSelection);
212 
213  // Used internal by vtkGenericAdaptorCell::Clip()
217 
218 private:
219  vtkGenericClip(const vtkGenericClip&) VTK_DELETE_FUNCTION;
220  void operator=(const vtkGenericClip&) VTK_DELETE_FUNCTION;
221 };
222 
223 #endif
vtkGenericClip::MergeTolerance
double MergeTolerance
Definition: vtkGenericClip.h:208
vtkPointData
represent and manipulate point attribute data
Definition: vtkPointData.h:38
vtkGenericClip::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent)
Methods invoked by print to print information about the object including superclasses.
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:42
vtkGenericClip::GetNumberOfOutputs
virtual int GetNumberOfOutputs()
vtkGenericClip::InputScalarsSelection
char * InputScalarsSelection
Definition: vtkGenericClip.h:210
vtkGenericClip::FillInputPortInformation
int FillInputPortInformation(int, vtkInformation *)
Fill the input port information objects for this algorithm.
vtkGenericClip::SecondaryPD
vtkPointData * SecondaryPD
Definition: vtkGenericClip.h:215
vtkGenericClip::vtkGenericClip
vtkGenericClip(vtkImplicitFunction *cf=NULL)
vtkGenericClip::InternalPD
vtkPointData * InternalPD
Definition: vtkGenericClip.h:211
vtkGenericClip::SelectInputScalars
void SelectInputScalars(const char *fieldName)
Definition: vtkGenericClip.h:189
vtkGenericClip::New
static vtkGenericClip * New()
Construct with user-specified implicit function; InsideOut turned off; value set to 0....
vtkGenericClip::~vtkGenericClip
~vtkGenericClip()
vtkMTimeType
vtkTypeUInt64 vtkMTimeType
Definition: vtkType.h:248
vtkImplicitFunction
abstract interface for implicit functions
Definition: vtkImplicitFunction.h:59
vtkGenericClip::GetClippedOutput
vtkUnstructuredGrid * GetClippedOutput()
Return the Clipped output.
vtkGenericClip::SecondaryCD
vtkCellData * SecondaryCD
Definition: vtkGenericClip.h:216
vtkGenericClip::GenerateClippedOutput
int GenerateClippedOutput
Definition: vtkGenericClip.h:207
vtkCellData
represent and manipulate cell attribute data
Definition: vtkCellData.h:39
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkGenericClip::CreateDefaultLocator
void CreateDefaultLocator()
Create default locator.
vtkIncrementalPointLocator
Abstract class in support of both point location and point insertion.
Definition: vtkIncrementalPointLocator.h:52
vtkGenericClip::GetMTime
vtkMTimeType GetMTime()
Return the mtime also considering the locator and clip function.
vtkGenericClip::InsideOut
int InsideOut
Definition: vtkGenericClip.h:203
vtkGenericClip
clip any dataset with an implicit function or scalar data
Definition: vtkGenericClip.h:77
vtkGetStringMacro
vtkGetStringMacro(ExtensionsString)
Returns a string listing all available extensions.
vtkGenericClip::RequestData
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
This is called by the superclass.
vtkBooleanMacro
vtkBooleanMacro(IgnoreDriverBugs, bool)
Updates the extensions string.
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:87
vtkSetMacro
vtkSetMacro(IgnoreDriverBugs, bool)
Updates the extensions string.
vtkGenericClip::GenerateClipScalars
int GenerateClipScalars
Definition: vtkGenericClip.h:205
vtkGenericClip::Value
double Value
Definition: vtkGenericClip.h:204
vtkUnstructuredGridAlgorithm.h
vtkUnstructuredGridAlgorithm
Superclass for algorithms that produce only unstructured grid as output.
Definition: vtkUnstructuredGridAlgorithm.h:41
vtkGenericClip::SetLocator
void SetLocator(vtkIncrementalPointLocator *locator)
Specify a spatial locator for merging points.
vtkUnstructuredGrid
dataset represents arbitrary combinations of all possible cell types
Definition: vtkUnstructuredGrid.h:83
vtkGenericClip::Locator
vtkIncrementalPointLocator * Locator
Definition: vtkGenericClip.h:202
vtkGenericClip::ClipFunction
vtkImplicitFunction * ClipFunction
Definition: vtkGenericClip.h:200
vtkGenericClip::SetClipFunction
virtual void SetClipFunction(vtkImplicitFunction *)
Specify the implicit function with which to perform the clipping.