vtkPVGeneralSettings.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: ParaView
4  Module: vtkPVGeneralSettings.h
5 
6  Copyright (c) Kitware, Inc.
7  All rights reserved.
8  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html 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 vtkPVGeneralSettings_h
27 #define vtkPVGeneralSettings_h
28 
29 #include "vtkObject.h"
30 #include "vtkParaViewDeprecation.h" // for PARAVIEW_DEPRECATED_IN_5_10_0
31 #include "vtkRemotingSettingsModule.h" //needed for exports
32 #include "vtkSmartPointer.h" // needed for vtkSmartPointer.
33 
35 {
36 public:
37  static vtkPVGeneralSettings* New();
39  void PrintSelf(ostream& os, vtkIndent indent) override;
40 
44  static vtkPVGeneralSettings* GetInstance();
45 
47 
53  void SetAutoConvertProperties(bool val);
54  bool GetAutoConvertProperties();
56 
58 
64  vtkGetMacro(BlockColorsDistinctValues, int);
65  vtkSetMacro(BlockColorsDistinctValues, int);
67 
69 
73  vtkGetMacro(AutoApply, bool);
74  vtkSetMacro(AutoApply, bool);
76 
78 
83  vtkGetMacro(AutoApplyDelay, int);
84  vtkSetMacro(AutoApplyDelay, int);
86 
88 
92  vtkGetMacro(AutoApplyActiveOnly, bool);
93  vtkSetMacro(AutoApplyActiveOnly, bool);
95 
97 
100  PARAVIEW_DEPRECATED_IN_5_10_0("AutoMPI is no longer supported")
101  void SetEnableAutoMPI(bool);
102  PARAVIEW_DEPRECATED_IN_5_10_0("AutoMPI is no longer supported")
103  bool GetEnableAutoMPI();
104  PARAVIEW_DEPRECATED_IN_5_10_0("AutoMPI is no longer supported")
105  void SetAutoMPILimit(int val);
106  PARAVIEW_DEPRECATED_IN_5_10_0("AutoMPI is no longer supported")
107  int GetAutoMPILimit();
109 
111 
114  vtkGetStringMacro(DefaultViewType);
115  vtkSetStringMacro(DefaultViewType);
117 
121  enum
122  {
125  DEFAULT_TIME_STEP_LAST
126  };
127 
129 
132  enum
133  {
134  AUTOMATICALLY_SHOW_AND_HIDE_SCALAR_BARS = 0,
135  AUTOMATICALLY_HIDE_SCALAR_BARS = 1,
136  MANUAL_SCALAR_BARS = 2
137  };
138  vtkGetMacro(ScalarBarMode, int);
139  void SetScalarBarMode(int);
141 
143 
146  void SetCacheGeometryForAnimation(bool val);
147  bool GetCacheGeometryForAnimation();
149 
151 
154  void SetAnimationGeometryCacheLimit(unsigned long val);
155  vtkGetMacro(AnimationGeometryCacheLimit, unsigned long);
157 
159 
162  vtkSetClampMacro(AnimationTimePrecision, int, 1, 17);
163  vtkGetMacro(AnimationTimePrecision, int);
165 
166  enum
167  {
168  MIXED = 0,
170  FIXED
171  };
172 
174 
178  vtkSetMacro(AnimationTimeNotation, int);
179  vtkGetMacro(AnimationTimeNotation, int);
181 
183 
186  vtkSetMacro(ShowAnimationShortcuts, bool);
187  vtkGetMacro(ShowAnimationShortcuts, bool);
188  vtkBooleanMacro(ShowAnimationShortcuts, bool);
190 
192 
196  vtkSetMacro(ResetDisplayEmptyViews, bool);
197  vtkGetMacro(ResetDisplayEmptyViews, bool);
198  vtkBooleanMacro(ResetDisplayEmptyViews, bool);
200 
202 
205  enum
206  {
207  DISPLAY_REALNUMBERS_USING_SCIENTIFIC_NOTATION = 1,
209  };
213  vtkSetMacro(RealNumberDisplayedNotation, int);
214  vtkGetMacro(RealNumberDisplayedNotation, int);
216 
218 
221  vtkSetMacro(RealNumberDisplayedPrecision, int);
222  vtkGetMacro(RealNumberDisplayedPrecision, int);
224 
228  void SetInheritRepresentationProperties(bool val);
229 
230  // Description:
231  // When plotting data with nonpositive values, ignore the standard warning
232  // and draw only the data with positive values.
233  void SetIgnoreNegativeLogAxisWarning(bool val);
234  bool GetIgnoreNegativeLogAxisWarning();
235 
236  enum
237  {
238  ALL_IN_ONE = 0,
239  SEPARATE_DISPLAY_PROPERTIES = 1,
240  SEPARATE_VIEW_PROPERTIES = 2,
241  ALL_SEPARATE = 3
242  };
244 
247  vtkSetMacro(PropertiesPanelMode, int);
248  vtkGetMacro(PropertiesPanelMode, int);
250 
252 
255  vtkSetMacro(LockPanels, bool);
256  vtkGetMacro(LockPanels, bool);
258 
260 
263  void SetLoadAllVariables(bool val);
264  bool GetLoadAllVariables();
266 
268 
271  void SetLoadNoChartVariables(bool val);
272  bool GetLoadNoChartVariables();
274 
276 
279  vtkSetClampMacro(GUIFontSize, int, 8, VTK_INT_MAX);
280  vtkGetMacro(GUIFontSize, int);
282 
284 
287  vtkSetMacro(GUIOverrideFont, bool);
288  vtkGetMacro(GUIOverrideFont, bool);
290 
292 
295  vtkSetClampMacro(ConsoleFontSize, int, 8, VTK_INT_MAX);
296  vtkGetMacro(ConsoleFontSize, int);
298 
300 
303  vtkSetMacro(ColorByBlockColorsOnApply, bool);
304  vtkGetMacro(ColorByBlockColorsOnApply, bool);
306 
308 
311  void SetEnableStreaming(bool);
312  vtkGetMacro(EnableStreaming, bool);
313  vtkBooleanMacro(EnableStreaming, bool);
315 
317 
320  void SetUseAcceleratedFilters(bool);
321  bool GetUseAcceleratedFilters();
322  vtkBooleanMacro(UseAcceleratedFilters, bool);
324 
326 
330  vtkGetMacro(SelectOnClickMultiBlockInspector, bool);
331  vtkSetMacro(SelectOnClickMultiBlockInspector, bool);
333 
334 protected:
336  ~vtkPVGeneralSettings() override;
337 
339  bool AutoApply;
340  int AutoApplyDelay = 0;
360 
361 private:
363  void operator=(const vtkPVGeneralSettings&) = delete;
364 
366 };
367 
368 #endif
#define PARAVIEW_DEPRECATED_IN_5_10_0(reason)
void PrintSelf(ostream &os, vtkIndent indent) VTK_OVERRIDE
unsigned long AnimationGeometryCacheLimit
#define VTKREMOTINGSETTINGS_EXPORT
static vtkObject * New()
void operator=(const vtkObjectBase &)
object for general options.