vtkPVRepresentedArrayListSettings.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkPVRepresentedArrayListSettings_h
#define vtkPVRepresentedArrayListSettings_h

#include "vtkObject.h"
#include "vtkParaViewDeprecation.h" // for PARAVIEW_DEPRECATED_IN_5_12_0
#include "vtkRemotingViewsModule.h" //needed for exports
#include "vtkSmartPointer.h"        // needed for vtkSmartPointer

#include <string>
#include <vector>

class vtkStringArray;
class vtkDataArraySelection;
namespace vtksys
{
class RegularExpression;
}

class VTKREMOTINGVIEWS_EXPORT vtkPVRepresentedArrayListSettings : public vtkObject
{
public:
  static vtkPVRepresentedArrayListSettings* New();
  vtkTypeMacro(vtkPVRepresentedArrayListSettings, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkPVRepresentedArrayListSettings* GetInstance();


  virtual void SetNumberOfFilterExpressions(int n);
  virtual int GetNumberOfFilterExpressions();


  virtual void SetFilterExpression(int i, const char* expression);
  virtual const char* GetFilterExpression(int i);


  vtkSetMacro(ComputeArrayMagnitude, bool);
  virtual void SetArrayMagnitudeException(int idx, int ncomp);
  virtual void SetNumberOfArrayMagnitudeExceptions(int nexceptions);

  virtual bool ShouldUseMagnitudeMode(int ncomp) const;


  virtual void SetNumberOfChartsDefaultXAxis(int n);
  virtual int GetNumberOfChartsDefaultXAxis() const;
  virtual void SetChartsDefaultXAxis(int i, const char* expression);
  virtual const char* GetChartsDefaultXAxis(int i) const;
  virtual const std::vector<std::string>& GetAllChartsDefaultXAxis() const;


  virtual void SetNumberOfChartsHiddenAttributes(int n);
  virtual int GetNumberOfChartsHiddenAttributes() const;
  virtual void SetChartsHiddenAttributes(int i, const char* expression);
  virtual const std::vector<vtksys::RegularExpression>& GetAllChartsHiddenAttributes() const;
  virtual bool GetSeriesVisibilityDefault(const char* name) const;


  PARAVIEW_DEPRECATED_IN_5_12_0("See vtkPVIOSettings::SetNumberOfExcludedNameFilters instead")
  virtual void SetNumberOfExcludedNameFilters(int n);

  PARAVIEW_DEPRECATED_IN_5_12_0("See vtkPVIOSettings::GetNumberOfExcludedNameFilters instead")
  virtual int GetNumberOfExcludedNameFilters();

  PARAVIEW_DEPRECATED_IN_5_12_0("See vtkPVIOSettings::SetExcludedNameFilter instead")
  virtual void SetExcludedNameFilter(int i, const char* expression);

  PARAVIEW_DEPRECATED_IN_5_12_0("See vtkPVIOSettings::GetExcludedNameFilter instead")
  virtual const char* GetExcludedNameFilter(int i);

  PARAVIEW_DEPRECATED_IN_5_12_0("See vtkPVIOSettings::GetAllNameFilters instead")
  vtkStringArray* GetAllNameFilters();

protected:
  vtkPVRepresentedArrayListSettings();
  ~vtkPVRepresentedArrayListSettings() override;

private:
  vtkPVRepresentedArrayListSettings(const vtkPVRepresentedArrayListSettings&) = delete;
  void operator=(const vtkPVRepresentedArrayListSettings&) = delete;

  static vtkSmartPointer<vtkPVRepresentedArrayListSettings> Instance;

  bool ComputeArrayMagnitude = true;

  class vtkInternals;
  vtkInternals* Internals;
};

#endif