VTK  9.0.1
vtkDataArraySelection.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkDataArraySelection.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 =========================================================================*/
26 #ifndef vtkDataArraySelection_h
27 #define vtkDataArraySelection_h
28 
29 #include "vtkCommonCoreModule.h" // For export macro
30 #include "vtkObject.h"
31 
32 class vtkDataArraySelectionInternals;
33 
34 class VTKCOMMONCORE_EXPORT vtkDataArraySelection : public vtkObject
35 {
36 public:
38  void PrintSelf(ostream& os, vtkIndent indent) override;
39  static vtkDataArraySelection* New();
40 
48  void EnableArray(const char* name);
49 
57  void DisableArray(const char* name);
58 
63  int ArrayIsEnabled(const char* name) const;
64 
68  int ArrayExists(const char* name) const;
69 
76  void EnableAllArrays();
77 
84  void DisableAllArrays();
85 
89  int GetNumberOfArrays() const;
90 
94  int GetNumberOfArraysEnabled() const;
95 
99  const char* GetArrayName(int index) const;
100 
104  int GetArrayIndex(const char* name) const;
105 
110  int GetEnabledArrayIndex(const char* name) const;
111 
115  int GetArraySetting(int index) const;
116 
120  int GetArraySetting(const char* name) const { return this->ArrayIsEnabled(name); }
121 
129  void SetArraySetting(const char* name, int status);
130 
136  void RemoveAllArrays();
137 
151  int AddArray(const char* name, bool state = true);
152 
158  void RemoveArrayByIndex(int index);
159 
165  void RemoveArrayByName(const char* name);
166 
168 
180  void SetArrays(const char* const* names, int numArrays);
181  void SetArraysWithDefault(const char* const* names, int numArrays, int defaultStatus);
183 
189  void CopySelections(vtkDataArraySelection* selections);
190 
199  void Union(vtkDataArraySelection* other);
200 
202 
207  vtkSetMacro(UnknownArraySetting, int);
208  vtkGetMacro(UnknownArraySetting, int);
210 protected:
212  ~vtkDataArraySelection() override;
213 
214  // Internal implementation details.
215  vtkDataArraySelectionInternals* Internal;
216 
218 
219 private:
221  void operator=(const vtkDataArraySelection&) = delete;
222 };
223 
224 #endif
vtkObject::New
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
vtkDataArraySelection::Internal
vtkDataArraySelectionInternals * Internal
Definition: vtkDataArraySelection.h:215
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:62
vtkDataArraySelection
Store on/off settings for data arrays for a vtkSource.
Definition: vtkDataArraySelection.h:34
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkObject::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkDataArraySelection::UnknownArraySetting
int UnknownArraySetting
Definition: vtkDataArraySelection.h:217
vtkX3D::name
@ name
Definition: vtkX3D.h:225
vtkObject.h
vtkX3D::index
@ index
Definition: vtkX3D.h:252
vtkDataArraySelection::GetArraySetting
int GetArraySetting(const char *name) const
Get whether the array is enabled/disable using its name.
Definition: vtkDataArraySelection.h:120