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 "vtkRemotingSettingsModule.h" //needed for exports
31 #include "vtkSmartPointer.h" // needed for vtkSmartPointer.
32 
34 {
35 public:
36  static vtkPVGeneralSettings* New();
38  void PrintSelf(ostream& os, vtkIndent indent) override;
39 
43  static vtkPVGeneralSettings* GetInstance();
44 
46 
52  void SetAutoConvertProperties(bool val);
53  bool GetAutoConvertProperties();
55 
57 
63  vtkGetMacro(BlockColorsDistinctValues, int);
64  vtkSetMacro(BlockColorsDistinctValues, int);
66 
68 
71  vtkGetMacro(AutoApply, bool);
72  vtkSetMacro(AutoApply, bool);
74 
76 
79  vtkGetMacro(AutoApplyActiveOnly, bool);
80  vtkSetMacro(AutoApplyActiveOnly, bool);
82 
84 
87  void SetEnableAutoMPI(bool);
88  bool GetEnableAutoMPI();
90 
92 
95  void SetAutoMPILimit(int val);
96  int GetAutoMPILimit();
98 
100 
103  vtkGetStringMacro(DefaultViewType);
104  vtkSetStringMacro(DefaultViewType);
106 
110  enum
111  {
114  DEFAULT_TIME_STEP_LAST
115  };
116 
118 
121  vtkGetMacro(TransferFunctionResetMode, int);
122  vtkSetMacro(TransferFunctionResetMode, int);
124 
126 
129  enum
130  {
131  AUTOMATICALLY_SHOW_AND_HIDE_SCALAR_BARS = 0,
132  AUTOMATICALLY_HIDE_SCALAR_BARS = 1,
133  MANUAL_SCALAR_BARS = 2
134  };
135  vtkGetMacro(ScalarBarMode, int);
136  void SetScalarBarMode(int);
138 
140 
143  void SetCacheGeometryForAnimation(bool val);
144  bool GetCacheGeometryForAnimation();
146 
148 
151  void SetAnimationGeometryCacheLimit(unsigned long val);
152  vtkGetMacro(AnimationGeometryCacheLimit, unsigned long);
154 
156 
159  vtkSetClampMacro(AnimationTimePrecision, int, 1, 17);
160  vtkGetMacro(AnimationTimePrecision, int);
162 
163  enum
164  {
165  MIXED = 0,
167  FIXED
168  };
169 
171 
175  vtkSetMacro(AnimationTimeNotation, int);
176  vtkGetMacro(AnimationTimeNotation, int);
178 
180 
183  vtkSetMacro(ShowAnimationShortcuts, bool);
184  vtkGetMacro(ShowAnimationShortcuts, bool);
185  vtkBooleanMacro(ShowAnimationShortcuts, bool);
187 
189 
193  vtkSetMacro(ResetDisplayEmptyViews, bool);
194  vtkGetMacro(ResetDisplayEmptyViews, bool);
195  vtkBooleanMacro(ResetDisplayEmptyViews, bool);
197 
199 
202  enum
203  {
204  DISPLAY_REALNUMBERS_USING_SCIENTIFIC_NOTATION = 1,
206  };
210  vtkSetMacro(RealNumberDisplayedNotation, int);
211  vtkGetMacro(RealNumberDisplayedNotation, int);
213 
215 
218  vtkSetMacro(RealNumberDisplayedPrecision, int);
219  vtkGetMacro(RealNumberDisplayedPrecision, int);
221 
225  void SetInheritRepresentationProperties(bool val);
226 
227  // Description:
228  // When plotting data with nonpositive values, ignore the standard warning
229  // and draw only the data with positive values.
230  void SetIgnoreNegativeLogAxisWarning(bool val);
231  bool GetIgnoreNegativeLogAxisWarning();
232 
233  enum
234  {
235  ALL_IN_ONE = 0,
236  SEPARATE_DISPLAY_PROPERTIES = 1,
237  SEPARATE_VIEW_PROPERTIES = 2,
238  ALL_SEPARATE = 3
239  };
241 
244  vtkSetMacro(PropertiesPanelMode, int);
245  vtkGetMacro(PropertiesPanelMode, int);
247 
249 
252  vtkSetMacro(LockPanels, bool);
253  vtkGetMacro(LockPanels, bool);
255 
257 
260  void SetLoadAllVariables(bool val);
261  bool GetLoadAllVariables();
263 
265 
268  void SetLoadNoChartVariables(bool val);
269  bool GetLoadNoChartVariables();
271 
273 
276  vtkSetClampMacro(GUIFontSize, int, 8, VTK_INT_MAX);
277  vtkGetMacro(GUIFontSize, int);
279 
281 
284  vtkSetMacro(GUIOverrideFont, bool);
285  vtkGetMacro(GUIOverrideFont, bool);
287 
289 
292  vtkSetClampMacro(ConsoleFontSize, int, 8, VTK_INT_MAX);
293  vtkGetMacro(ConsoleFontSize, int);
295 
297 
300  vtkSetMacro(ColorByBlockColorsOnApply, bool);
301  vtkGetMacro(ColorByBlockColorsOnApply, bool);
303 
305 
308  void SetEnableStreaming(bool);
309  vtkGetMacro(EnableStreaming, bool);
310  vtkBooleanMacro(EnableStreaming, bool);
312 
313 protected:
315  ~vtkPVGeneralSettings() override;
316 
318  bool AutoApply;
338 
339 private:
341  void operator=(const vtkPVGeneralSettings&) = delete;
342 
344 };
345 
346 #endif
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.