VTK  9.1.0
vtkIdFilter.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkIdFilter.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 =========================================================================*/
139 #ifndef vtkIdFilter_h
140 #define vtkIdFilter_h
141 
142 #include "vtkDataSetAlgorithm.h"
143 #include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_0_0
144 #include "vtkFiltersCoreModule.h" // For export macro
145 
146 class VTKFILTERSCORE_EXPORT vtkIdFilter : public vtkDataSetAlgorithm
147 {
148 public:
150  void PrintSelf(ostream& os, vtkIndent indent) override;
151 
156  static vtkIdFilter* New();
157 
159 
162  vtkSetMacro(PointIds, vtkTypeBool);
163  vtkGetMacro(PointIds, vtkTypeBool);
164  vtkBooleanMacro(PointIds, vtkTypeBool);
166 
168 
171  vtkSetMacro(CellIds, vtkTypeBool);
172  vtkGetMacro(CellIds, vtkTypeBool);
173  vtkBooleanMacro(CellIds, vtkTypeBool);
175 
177 
182  vtkSetMacro(FieldData, vtkTypeBool);
183  vtkGetMacro(FieldData, vtkTypeBool);
184  vtkBooleanMacro(FieldData, vtkTypeBool);
186 
188 
192  VTK_DEPRECATED_IN_9_0_0("Use vtkIdFilter::SetCellIdsArrayName")
193  void SetIdsArrayName(const char*);
194  VTK_DEPRECATED_IN_9_0_0("Use vtkIdFilter::GetCellIdsArrayName")
195  const char* GetIdsArrayName();
197 
199 
203  vtkSetStringMacro(PointIdsArrayName);
204  vtkGetStringMacro(PointIdsArrayName);
206 
208 
212  vtkSetStringMacro(CellIdsArrayName);
213  vtkGetStringMacro(CellIdsArrayName);
215 protected:
217  ~vtkIdFilter() override;
218 
220 
221  vtkTypeBool PointIds;
222  vtkTypeBool CellIds;
223  vtkTypeBool FieldData;
224  char* PointIdsArrayName;
225  char* CellIdsArrayName;
226 
227 private:
228  vtkIdFilter(const vtkIdFilter&) = delete;
229  void operator=(const vtkIdFilter&) = delete;
230 };
231 
232 #endif
Superclass for algorithms that produce output of the same type as input.
generate scalars or field data from point and cell ids
Definition: vtkIdFilter.h:147
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
static vtkIdFilter * New()
Construct object with PointIds and CellIds on; and ids being generated as scalars.
a simple class to control print indentation
Definition: vtkIndent.h:113
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
int vtkTypeBool
Definition: vtkABI.h:69
#define VTK_DEPRECATED_IN_9_0_0(reason)