vtkDataArraySelection.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkDataArraySelection.h
 
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
 
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.
 
=========================================================================*/
#ifndef vtkDataArraySelection_h
#define vtkDataArraySelection_h
 
#include "vtkCommonCoreModule.h" // For export macro
#include "vtkObject.h"
 
class vtkDataArraySelectionInternals;
 
class VTKCOMMONCORE_EXPORT vtkDataArraySelection : public vtkObject
{
public:
  vtkTypeMacro(vtkDataArraySelection, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
  static vtkDataArraySelection* New();
 
  void EnableArray(const char* name);
 
  void DisableArray(const char* name);
 
  int ArrayIsEnabled(const char* name) const;
 
  int ArrayExists(const char* name) const;
 
  void EnableAllArrays();
 
  void DisableAllArrays();
 
  int GetNumberOfArrays() const;
 
  int GetNumberOfArraysEnabled() const;
 
  const char* GetArrayName(int index) const;
 
  int GetArrayIndex(const char* name) const;
 
  int GetEnabledArrayIndex(const char* name) const;
 
  int GetArraySetting(int index) const;
 
  int GetArraySetting(const char* name) const { return this->ArrayIsEnabled(name); }
 
  void SetArraySetting(const char* name, int setting);
 
  void RemoveAllArrays();
 
  int AddArray(const char* name, bool state = true);
 
  void RemoveArrayByIndex(int index);
 
  void RemoveArrayByName(const char* name);
 
 
  void SetArrays(const char* const* names, int numArrays);
  void SetArraysWithDefault(const char* const* names, int numArrays, int defaultStatus);
 
  void CopySelections(vtkDataArraySelection* selections);
 
 
  void Union(vtkDataArraySelection* other) { this->Union(other, false); }
  void Union(vtkDataArraySelection* other, bool skipModified);
 
 
  vtkSetMacro(UnknownArraySetting, int);
  vtkGetMacro(UnknownArraySetting, int);
protected:
  vtkDataArraySelection();
  ~vtkDataArraySelection() override;
 
  // Internal implementation details.
  vtkDataArraySelectionInternals* Internal;
 
  int UnknownArraySetting;
 
private:
  vtkDataArraySelection(const vtkDataArraySelection&) = delete;
  void operator=(const vtkDataArraySelection&) = delete;
};
 
#endif