vtkPVGeneralSettings.h

Go to the documentation of this file.

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

#include "vtkObject.h"
#include "vtkRemotingSettingsModule.h" //needed for exports
#include "vtkSmartPointer.h"           // needed for vtkSmartPointer.

#include <string>

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

  static vtkPVGeneralSettings* GetInstance();


  void SetAutoConvertProperties(bool val);
  bool GetAutoConvertProperties();


  vtkGetMacro(BlockColorsDistinctValues, int);
  vtkSetMacro(BlockColorsDistinctValues, int);


  vtkGetMacro(AutoApply, bool);
  vtkSetMacro(AutoApply, bool);


  vtkGetMacro(AutoApplyDelay, int);
  vtkSetMacro(AutoApplyDelay, int);


  vtkGetMacro(AutoApplyActiveOnly, bool);
  vtkSetMacro(AutoApplyActiveOnly, bool);


  vtkGetMacro(DefaultViewType, std::string);
  vtkSetMacro(DefaultViewType, std::string);


  vtkGetMacro(InterfaceLanguage, std::string);
  vtkSetMacro(InterfaceLanguage, std::string);

  enum
  {
    DEFAULT_TIME_STEP_UNCHANGED,
    DEFAULT_TIME_STEP_FIRST,
    DEFAULT_TIME_STEP_LAST
  };


  enum
  {
    AUTOMATICALLY_SHOW_AND_HIDE_SCALAR_BARS = 0,
    AUTOMATICALLY_HIDE_SCALAR_BARS = 1,
    MANUAL_SCALAR_BARS = 2
  };
  vtkGetMacro(ScalarBarMode, int);
  void SetScalarBarMode(int);


  void SetCacheGeometryForAnimation(bool val);
  bool GetCacheGeometryForAnimation();


  void SetAnimationGeometryCacheLimit(unsigned long val);
  vtkGetMacro(AnimationGeometryCacheLimit, unsigned long);

  enum RealNumberNotation
  {
    MIXED = 0,
    SCIENTIFIC,
    FIXED,
    FULL
  };


  vtkSetMacro(AnimationTimeNotation, int);
  vtkGetMacro(AnimationTimeNotation, int);


  vtkSetMacro(AnimationTimeShortestAccuratePrecision, bool);
  vtkGetMacro(AnimationTimeShortestAccuratePrecision, bool);


  vtkSetMacro(AnimationTimePrecision, int);
  vtkGetMacro(AnimationTimePrecision, int);


  vtkSetMacro(ShowAnimationShortcuts, bool);
  vtkGetMacro(ShowAnimationShortcuts, bool);
  vtkBooleanMacro(ShowAnimationShortcuts, bool);


  vtkSetMacro(ResetDisplayEmptyViews, bool);
  vtkGetMacro(ResetDisplayEmptyViews, bool);
  vtkBooleanMacro(ResetDisplayEmptyViews, bool);


  vtkSetMacro(RealNumberDisplayedNotation, int);
  vtkGetMacro(RealNumberDisplayedNotation, int);


  vtkSetMacro(RealNumberDisplayedShortestAccuratePrecision, bool);
  vtkGetMacro(RealNumberDisplayedShortestAccuratePrecision, bool);


  vtkSetMacro(RealNumberDisplayedPrecision, int);
  vtkGetMacro(RealNumberDisplayedPrecision, int);


  vtkSetMacro(FullNotationLowExponent, int);
  vtkGetMacro(FullNotationLowExponent, int);


  vtkSetMacro(FullNotationHighExponent, int);
  vtkGetMacro(FullNotationHighExponent, int);

  void SetInheritRepresentationProperties(bool val);

  // Description:
  // When plotting data with nonpositive values, ignore the standard warning
  // and draw only the data with positive values.
  void SetIgnoreNegativeLogAxisWarning(bool val);
  bool GetIgnoreNegativeLogAxisWarning();

  enum
  {
    ALL_IN_ONE = 0,
    SEPARATE_DISPLAY_PROPERTIES = 1,
    SEPARATE_VIEW_PROPERTIES = 2,
    ALL_SEPARATE = 3
  };

  vtkSetMacro(PropertiesPanelMode, int);
  vtkGetMacro(PropertiesPanelMode, int);


  vtkSetMacro(LockPanels, bool);
  vtkGetMacro(LockPanels, bool);


  void SetLoadAllVariables(bool val);
  bool GetLoadAllVariables();


  void SetLoadNoChartVariables(bool val);
  bool GetLoadNoChartVariables();


  vtkSetClampMacro(GUIFontSize, int, 8, VTK_INT_MAX);
  vtkGetMacro(GUIFontSize, int);


  vtkSetMacro(GUIOverrideFont, bool);
  vtkGetMacro(GUIOverrideFont, bool);


  vtkSetMacro(ColorByBlockColorsOnApply, bool);
  vtkGetMacro(ColorByBlockColorsOnApply, bool);


  void SetEnableStreaming(bool);
  vtkGetMacro(EnableStreaming, bool);
  vtkBooleanMacro(EnableStreaming, bool);


  void SetUseAcceleratedFilters(bool);
  bool GetUseAcceleratedFilters();
  vtkBooleanMacro(UseAcceleratedFilters, bool);


  vtkGetMacro(SelectOnClickMultiBlockInspector, bool);
  vtkSetMacro(SelectOnClickMultiBlockInspector, bool);


  static int GetNumberOfCallbackThreads();
  static void SetNumberOfCallbackThreads(int);


  static int GetNumberOfSMPThreads();
  static void SetNumberOfSMPThreads(int);

protected:
  vtkPVGeneralSettings() = default;
  ~vtkPVGeneralSettings() override = default;

  int BlockColorsDistinctValues = 7;
  bool AutoApply = false;
  int AutoApplyDelay = 0;
  bool AutoApplyActiveOnly = false;
  std::string DefaultViewType = "RenderView";
  std::string InterfaceLanguage = "en";
  int ScalarBarMode = AUTOMATICALLY_HIDE_SCALAR_BARS;
  bool CacheGeometryForAnimation = false;
  unsigned long AnimationGeometryCacheLimit = 0;
  int AnimationTimeNotation = MIXED;
  bool AnimationTimeShortestAccuratePrecision = false;
  int AnimationTimePrecision = 6;
  bool ShowAnimationShortcuts = false;
  int RealNumberDisplayedNotation = MIXED;
  bool RealNumberDisplayedShortestAccuratePrecision = false;
  int RealNumberDisplayedPrecision = 6;
  int FullNotationLowExponent = -6;
  int FullNotationHighExponent = 20;
  bool ResetDisplayEmptyViews = false;
  int PropertiesPanelMode = ALL_IN_ONE;
  bool LockPanels = false;
  int GUIFontSize = 0;
  bool GUIOverrideFont = false;
  bool ColorByBlockColorsOnApply = true;
  bool EnableStreaming = false;
  bool SelectOnClickMultiBlockInspector = true;

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

  static vtkSmartPointer<vtkPVGeneralSettings> Instance;
};

#endif