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 =========================================================================*/
30 #ifndef vtkIdFilter_h
31 #define vtkIdFilter_h
32 
33 #include "vtkDataSetAlgorithm.h"
34 #include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_0_0
35 #include "vtkFiltersCoreModule.h" // For export macro
36 
37 class VTKFILTERSCORE_EXPORT vtkIdFilter : public vtkDataSetAlgorithm
38 {
39 public:
41  void PrintSelf(ostream& os, vtkIndent indent) override;
42 
47  static vtkIdFilter* New();
48 
50 
53  vtkSetMacro(PointIds, vtkTypeBool);
54  vtkGetMacro(PointIds, vtkTypeBool);
55  vtkBooleanMacro(PointIds, vtkTypeBool);
57 
59 
62  vtkSetMacro(CellIds, vtkTypeBool);
63  vtkGetMacro(CellIds, vtkTypeBool);
64  vtkBooleanMacro(CellIds, vtkTypeBool);
66 
68 
73  vtkSetMacro(FieldData, vtkTypeBool);
74  vtkGetMacro(FieldData, vtkTypeBool);
75  vtkBooleanMacro(FieldData, vtkTypeBool);
77 
79 
83  VTK_DEPRECATED_IN_9_0_0("Use vtkIdFilter::SetCellIdsArrayName")
84  void SetIdsArrayName(const char*);
85  VTK_DEPRECATED_IN_9_0_0("Use vtkIdFilter::GetCellIdsArrayName")
86  const char* GetIdsArrayName();
88 
90 
94  vtkSetStringMacro(PointIdsArrayName);
95  vtkGetStringMacro(PointIdsArrayName);
97 
99 
103  vtkSetStringMacro(CellIdsArrayName);
104  vtkGetStringMacro(CellIdsArrayName);
106 protected:
108  ~vtkIdFilter() override;
109 
111 
112  vtkTypeBool PointIds;
113  vtkTypeBool CellIds;
114  vtkTypeBool FieldData;
115  char* PointIdsArrayName;
116  char* CellIdsArrayName;
117 
118 private:
119  vtkIdFilter(const vtkIdFilter&) = delete;
120  void operator=(const vtkIdFilter&) = delete;
121 };
122 
123 #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:38
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:34
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)