VTK  9.1.0
vtkViewTheme.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkViewTheme.h
5
6 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7 All rights reserved.
8 See Copyright.txt or http://www.kitware.com/Copyright.htm 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=========================================================================*/
15/*-------------------------------------------------------------------------
16 Copyright 2008 Sandia Corporation.
17 Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
18 the U.S. Government retains certain rights in this software.
19-------------------------------------------------------------------------*/
33#ifndef vtkViewTheme_h
34#define vtkViewTheme_h
35
36#include "vtkObject.h"
37#include "vtkViewsCoreModule.h" // For export macro
38
40class vtkTextProperty;
41
42class VTKVIEWSCORE_EXPORT vtkViewTheme : public vtkObject
43{
44public:
45 static vtkViewTheme* New();
46 vtkTypeMacro(vtkViewTheme, vtkObject);
47 void PrintSelf(ostream& os, vtkIndent indent) override;
48
50
53 vtkSetMacro(PointSize, double);
54 vtkGetMacro(PointSize, double);
56
58
61 vtkSetMacro(LineWidth, double);
62 vtkGetMacro(LineWidth, double);
64
66
70 vtkSetVector3Macro(PointColor, double);
71 vtkGetVector3Macro(PointColor, double);
72 vtkSetMacro(PointOpacity, double);
73 vtkGetMacro(PointOpacity, double);
75
77
82 virtual void SetPointHueRange(double mn, double mx);
83 virtual void SetPointHueRange(double rng[2]);
84 virtual double* GetPointHueRange();
85 virtual void GetPointHueRange(double& mn, double& mx);
86 virtual void GetPointHueRange(double rng[2]);
88
89 virtual void SetPointSaturationRange(double mn, double mx);
90 virtual void SetPointSaturationRange(double rng[2]);
91 virtual double* GetPointSaturationRange();
92 virtual void GetPointSaturationRange(double& mn, double& mx);
93 virtual void GetPointSaturationRange(double rng[2]);
94
95 virtual void SetPointValueRange(double mn, double mx);
96 virtual void SetPointValueRange(double rng[2]);
97 virtual double* GetPointValueRange();
98 virtual void GetPointValueRange(double& mn, double& mx);
99 virtual void GetPointValueRange(double rng[2]);
100
101 virtual void SetPointAlphaRange(double mn, double mx);
102 virtual void SetPointAlphaRange(double rng[2]);
103 virtual double* GetPointAlphaRange();
104 virtual void GetPointAlphaRange(double& mn, double& mx);
105 virtual void GetPointAlphaRange(double rng[2]);
106
108
111 vtkGetObjectMacro(PointLookupTable, vtkScalarsToColors);
114
116
119 vtkSetMacro(ScalePointLookupTable, bool);
120 vtkGetMacro(ScalePointLookupTable, bool);
121 vtkBooleanMacro(ScalePointLookupTable, bool);
123
125
129 vtkSetVector3Macro(CellColor, double);
130 vtkGetVector3Macro(CellColor, double);
131 vtkSetMacro(CellOpacity, double);
132 vtkGetMacro(CellOpacity, double);
134
136
141 virtual void SetCellHueRange(double mn, double mx);
142 virtual void SetCellHueRange(double rng[2]);
143 virtual double* GetCellHueRange();
144 virtual void GetCellHueRange(double& mn, double& mx);
145 virtual void GetCellHueRange(double rng[2]);
147
148 virtual void SetCellSaturationRange(double mn, double mx);
149 virtual void SetCellSaturationRange(double rng[2]);
150 virtual double* GetCellSaturationRange();
151 virtual void GetCellSaturationRange(double& mn, double& mx);
152 virtual void GetCellSaturationRange(double rng[2]);
153
154 virtual void SetCellValueRange(double mn, double mx);
155 virtual void SetCellValueRange(double rng[2]);
156 virtual double* GetCellValueRange();
157 virtual void GetCellValueRange(double& mn, double& mx);
158 virtual void GetCellValueRange(double rng[2]);
159
160 virtual void SetCellAlphaRange(double mn, double mx);
161 virtual void SetCellAlphaRange(double rng[2]);
162 virtual double* GetCellAlphaRange();
163 virtual void GetCellAlphaRange(double& mn, double& mx);
164 virtual void GetCellAlphaRange(double rng[2]);
165
167
170 vtkGetObjectMacro(CellLookupTable, vtkScalarsToColors);
173
175
178 vtkSetMacro(ScaleCellLookupTable, bool);
179 vtkGetMacro(ScaleCellLookupTable, bool);
180 vtkBooleanMacro(ScaleCellLookupTable, bool);
182
184
187 vtkSetVector3Macro(OutlineColor, double);
188 vtkGetVector3Macro(OutlineColor, double);
190
192
195 vtkSetVector3Macro(SelectedPointColor, double);
196 vtkGetVector3Macro(SelectedPointColor, double);
197 vtkSetMacro(SelectedPointOpacity, double);
198 vtkGetMacro(SelectedPointOpacity, double);
200
202
205 vtkSetVector3Macro(SelectedCellColor, double);
206 vtkGetVector3Macro(SelectedCellColor, double);
207 vtkSetMacro(SelectedCellOpacity, double);
208 vtkGetMacro(SelectedCellOpacity, double);
210
212
215 vtkSetVector3Macro(BackgroundColor, double);
216 vtkGetVector3Macro(BackgroundColor, double);
218
220
223 vtkSetVector3Macro(BackgroundColor2, double);
224 vtkGetVector3Macro(BackgroundColor2, double);
226
228
232 vtkGetObjectMacro(PointTextProperty, vtkTextProperty);
234
236
240 vtkGetObjectMacro(CellTextProperty, vtkTextProperty);
242
244
248 virtual void SetVertexLabelColor(double r, double g, double b);
249 virtual void SetVertexLabelColor(double c[3]) { this->SetVertexLabelColor(c[0], c[1], c[2]); }
250 virtual double* GetVertexLabelColor();
251 virtual void GetVertexLabelColor(double& r, double& g, double& b)
252 {
253 double* c = this->GetVertexLabelColor();
254 if (c)
255 {
256 r = c[0];
257 g = c[1];
258 b = c[2];
259 }
260 }
261 virtual void GetVertexLabelColor(double c[3]) { this->GetVertexLabelColor(c[0], c[1], c[2]); }
263
265
269 virtual void SetEdgeLabelColor(double r, double g, double b);
270 virtual void SetEdgeLabelColor(double c[3]) { this->SetEdgeLabelColor(c[0], c[1], c[2]); }
271 virtual double* GetEdgeLabelColor();
272 virtual void GetEdgeLabelColor(double& r, double& g, double& b)
273 {
274 double* c = this->GetEdgeLabelColor();
275 if (c)
276 {
277 r = c[0];
278 g = c[1];
279 b = c[2];
280 }
281 }
282 virtual void GetEdgeLabelColor(double c[3]) { this->GetEdgeLabelColor(c[0], c[1], c[2]); }
284
286
295
297
304
305protected:
307 ~vtkViewTheme() override;
308
309 double PointSize;
310 double LineWidth;
311
312 double PointColor[3];
314
315 double CellColor[3];
317
318 double OutlineColor[3];
319
320 double SelectedPointColor[3];
322 double SelectedCellColor[3];
324
325 double BackgroundColor[3];
326 double BackgroundColor2[3];
327
330
333
336
337private:
338 vtkViewTheme(const vtkViewTheme&) = delete;
339 void operator=(const vtkViewTheme&) = delete;
340};
341
342#endif
a simple class to control print indentation
Definition: vtkIndent.h:34
abstract base class for most VTK objects
Definition: vtkObject.h:63
Superclass for mapping scalar values to colors.
represent text properties.
Sets theme colors for a graphical view.
Definition: vtkViewTheme.h:43
bool LookupMatchesCellTheme(vtkScalarsToColors *s2c)
Whether a given lookup table matches the point or cell theme of this theme.
virtual void GetCellValueRange(double &mn, double &mx)
virtual void SetPointValueRange(double rng[2])
double PointOpacity
Definition: vtkViewTheme.h:313
virtual double * GetCellSaturationRange()
~vtkViewTheme() override
virtual void GetVertexLabelColor(double &r, double &g, double &b)
The color to use for labeling graph vertices.
Definition: vtkViewTheme.h:251
virtual double * GetCellHueRange()
The ranges to use in the cell lookup table.
virtual void SetCellValueRange(double mn, double mx)
vtkScalarsToColors * PointLookupTable
Definition: vtkViewTheme.h:328
virtual void SetPointValueRange(double mn, double mx)
virtual void SetPointHueRange(double mn, double mx)
The ranges to use in the point lookup table.
virtual void GetPointValueRange(double rng[2])
virtual void GetEdgeLabelColor(double &r, double &g, double &b)
The color to use for labeling graph edges.
Definition: vtkViewTheme.h:272
double SelectedPointOpacity
Definition: vtkViewTheme.h:321
double PointSize
Definition: vtkViewTheme.h:309
virtual void SetPointAlphaRange(double rng[2])
virtual void SetCellLookupTable(vtkScalarsToColors *lut)
Set/Get the cell lookup table.
virtual void SetPointAlphaRange(double mn, double mx)
virtual void SetCellHueRange(double mn, double mx)
The ranges to use in the cell lookup table.
virtual void GetCellAlphaRange(double &mn, double &mx)
virtual void GetEdgeLabelColor(double c[3])
The color to use for labeling graph edges.
Definition: vtkViewTheme.h:282
virtual void GetPointAlphaRange(double rng[2])
virtual void GetPointHueRange(double &mn, double &mx)
The ranges to use in the point lookup table.
virtual double * GetPointValueRange()
virtual void SetPointSaturationRange(double rng[2])
virtual double * GetPointSaturationRange()
static vtkViewTheme * CreateNeonTheme()
Convenience methods for creating some default view themes.
virtual void SetCellAlphaRange(double rng[2])
virtual void SetVertexLabelColor(double c[3])
The color to use for labeling graph vertices.
Definition: vtkViewTheme.h:249
bool ScalePointLookupTable
Definition: vtkViewTheme.h:331
virtual double * GetEdgeLabelColor()
The color to use for labeling graph edges.
virtual void GetPointSaturationRange(double rng[2])
virtual void SetCellSaturationRange(double mn, double mx)
virtual void GetCellValueRange(double rng[2])
virtual void SetCellValueRange(double rng[2])
double LineWidth
Definition: vtkViewTheme.h:310
virtual void GetCellSaturationRange(double rng[2])
virtual double * GetVertexLabelColor()
The color to use for labeling graph vertices.
virtual void GetVertexLabelColor(double c[3])
The color to use for labeling graph vertices.
Definition: vtkViewTheme.h:261
static vtkViewTheme * CreateOceanTheme()
Convenience methods for creating some default view themes.
vtkTextProperty * CellTextProperty
Definition: vtkViewTheme.h:335
virtual void GetCellHueRange(double rng[2])
The ranges to use in the cell lookup table.
virtual void SetPointSaturationRange(double mn, double mx)
vtkTextProperty * PointTextProperty
Definition: vtkViewTheme.h:334
virtual void SetCellAlphaRange(double mn, double mx)
virtual void GetPointSaturationRange(double &mn, double &mx)
virtual void GetPointValueRange(double &mn, double &mx)
virtual double * GetPointHueRange()
The ranges to use in the point lookup table.
virtual double * GetCellValueRange()
virtual void SetEdgeLabelColor(double c[3])
The color to use for labeling graph edges.
Definition: vtkViewTheme.h:270
virtual double * GetPointAlphaRange()
virtual void GetCellSaturationRange(double &mn, double &mx)
virtual void GetPointHueRange(double rng[2])
The ranges to use in the point lookup table.
virtual void SetEdgeLabelColor(double r, double g, double b)
The color to use for labeling graph edges.
bool LookupMatchesPointTheme(vtkScalarsToColors *s2c)
Whether a given lookup table matches the point or cell theme of this theme.
virtual void SetPointLookupTable(vtkScalarsToColors *lut)
Set/Get the point lookup table.
virtual void SetPointTextProperty(vtkTextProperty *tprop)
The text property to use for labeling points/vertices.
virtual void GetCellAlphaRange(double rng[2])
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual void SetPointHueRange(double rng[2])
The ranges to use in the point lookup table.
virtual void SetCellSaturationRange(double rng[2])
virtual void GetPointAlphaRange(double &mn, double &mx)
bool ScaleCellLookupTable
Definition: vtkViewTheme.h:332
vtkScalarsToColors * CellLookupTable
Definition: vtkViewTheme.h:329
virtual double * GetCellAlphaRange()
double SelectedCellOpacity
Definition: vtkViewTheme.h:323
static vtkViewTheme * CreateMellowTheme()
Convenience methods for creating some default view themes.
virtual void GetCellHueRange(double &mn, double &mx)
The ranges to use in the cell lookup table.
virtual void SetCellTextProperty(vtkTextProperty *tprop)
The text property to use for labeling edges/cells.
virtual void SetVertexLabelColor(double r, double g, double b)
The color to use for labeling graph vertices.
double CellOpacity
Definition: vtkViewTheme.h:316
virtual void SetCellHueRange(double rng[2])
The ranges to use in the cell lookup table.
static vtkViewTheme * New()