VTK  9.3.1
vtkColorSeries.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
3 
39 #ifndef vtkColorSeries_h
40 #define vtkColorSeries_h
41 
42 #include "vtkColor.h" // Needed for vtkColor[34]ub
43 #include "vtkCommonColorModule.h" // For export macro
44 #include "vtkObject.h"
45 #include "vtkStdString.h" // Needed for arguments
46 
47 VTK_ABI_NAMESPACE_BEGIN
48 class vtkLookupTable;
49 
50 class VTKCOMMONCOLOR_EXPORT vtkColorSeries : public vtkObject
51 {
52 public:
53  vtkTypeMacro(vtkColorSeries, vtkObject);
54  void PrintSelf(ostream& os, vtkIndent indent) override;
55 
59  static vtkColorSeries* New();
60 
65  {
67  SPECTRUM = 0,
191  CUSTOM
192  };
193 
199  enum LUTMode
200  {
202  ORDINAL = 0,
204  CATEGORICAL
205  };
206 
208 
215  virtual void SetColorScheme(int scheme);
216  virtual int SetColorSchemeByName(const vtkStdString& schemeName);
218 
222  int GetNumberOfColorSchemes() const;
223 
227  virtual vtkStdString GetColorSchemeName() const;
228 
232  virtual void SetColorSchemeName(const vtkStdString& name);
233 
237  virtual int GetColorScheme() const;
238 
242  virtual int GetNumberOfColors() const;
243 
249  virtual void SetNumberOfColors(int numColors);
250 
255  vtkColor3ub GetColor(int index) const;
256 
261  vtkColor3ub GetColorRepeating(int index) const;
262 
267  virtual void SetColor(int index, const vtkColor3ub& color);
268 
272  virtual void AddColor(const vtkColor3ub& color);
273 
277  virtual void InsertColor(int index, const vtkColor3ub& color);
278 
282  virtual void RemoveColor(int index);
283 
287  virtual void ClearColors();
288 
292  virtual void DeepCopy(vtkColorSeries* chartColors);
293 
301  void BuildLookupTable(vtkLookupTable* lkup, int lutIndexing = CATEGORICAL);
302 
313  vtkLookupTable* CreateLookupTable(int lutIndexing = CATEGORICAL);
314 
315 protected:
316  vtkColorSeries();
317  ~vtkColorSeries() override;
318 
323  virtual void CopyOnWrite();
324 
326 
329  class Private;
330  Private* Storage;
332 
337 
340 
341 private:
342  vtkColorSeries(const vtkColorSeries&) = delete;
343  void operator=(const vtkColorSeries&) = delete;
344 };
345 
346 VTK_ABI_NAMESPACE_END
347 #endif // vtkColorSeries_h
purple-grey-orange diverging ColorBrewer scheme (8 colors)
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:28
diverging spectral ColorBrewer scheme (4 colors)
blue to green sequential ColorBrewer scheme (5 colors)
diverging spectral ColorBrewer scheme (5 colors)
brown-blue-green diverging ColorBrewer scheme (5 colors)
a qualitative ColorBrewer scheme useful for color set members
yellow-orange-brown sequential ColorBrewer scheme (7 colors)
a qualitative ColorBrewer scheme useful for color set members
abstract base class for most VTK objects
Definition: vtkObject.h:51
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
yellow-orange-brown sequential ColorBrewer scheme (8 colors)
7 different blues.
diverging spectral ColorBrewer scheme (3 colors)
blue to green sequential ColorBrewer scheme (4 colors)
7 cool colors (green to purple).
brown-blue-green diverging ColorBrewer scheme (3 colors)
yellow-orange-brown sequential ColorBrewer scheme (3 colors)
blue to purple sequential ColorBrewer scheme (5 colors)
blue to purple sequential ColorBrewer scheme (7 colors)
ColorSchemes
Enum of the available color schemes.
map scalar values into colors via a lookup table
purple-grey-orange diverging ColorBrewer scheme (9 colors)
blue to green sequential ColorBrewer scheme (6 colors)
a qualitative ColorBrewer scheme composed of pastel colors
brown-blue-green diverging ColorBrewer scheme (7 colors)
brown-blue-green diverging ColorBrewer scheme (6 colors)
brown-blue-green diverging ColorBrewer scheme (4 colors)
purple-grey-orange diverging ColorBrewer scheme (5 colors)
yellow-orange-brown sequential ColorBrewer scheme (9 colors)
brown-blue-green diverging ColorBrewer scheme (8 colors)
int ColorScheme
The color scheme being used.
diverging spectral ColorBrewer scheme (7 colors)
purple-grey-orange diverging ColorBrewer scheme (11 colors)
purple-grey-orange diverging ColorBrewer scheme (6 colors)
blue to purple sequential ColorBrewer scheme (3 colors)
yellow-orange-brown sequential ColorBrewer scheme (5 colors)
purple-grey-orange diverging ColorBrewer scheme (4 colors)
brown-blue-green diverging ColorBrewer scheme (10 colors)
Some derived classes for the different colors commonly used.
Definition: vtkColor.h:183
blue to purple sequential ColorBrewer scheme (8 colors)
a simple class to control print indentation
Definition: vtkIndent.h:28
a qualitative ColorBrewer scheme useful for color set members
yellow-orange-brown sequential ColorBrewer scheme (6 colors)
blue to green sequential ColorBrewer scheme (3 colors)
7 colors from blue to magenta.
a qualitative ColorBrewer scheme with pairs of matching colors
purple-grey-orange diverging ColorBrewer scheme (10 colors)
a dark set of qualitative colors from ColorBrewer
blue to green sequential ColorBrewer scheme (9 colors)
LUTMode
An enum defining how lookup tables should be used: either as a list of discrete colors to choose from...
#define VTK_NEWINSTANCE
purple-grey-orange diverging ColorBrewer scheme (7 colors)
qualitative ColorBrewer scheme good for accenting
brown-blue-green diverging ColorBrewer scheme (11 colors)
diverging spectral ColorBrewer scheme (11 colors)
brown-blue-green diverging ColorBrewer scheme (9 colors)
vtkStdString ColorSchemeName
The color scheme being used.
blue to green sequential ColorBrewer scheme (7 colors)
stores a list of colors.
a qualitative ColorBrewer scheme composed of pastel colors
blue to purple sequential ColorBrewer scheme (6 colors)
purple-grey-orange diverging ColorBrewer scheme (3 colors)
blue to green sequential ColorBrewer scheme (8 colors)
6 colors from green to orange.
diverging spectral ColorBrewer scheme (9 colors)
blue to purple sequential ColorBrewer scheme (9 colors)
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on...
Private * Storage
diverging spectral ColorBrewer scheme (6 colors)
yellow-orange-brown sequential ColorBrewer scheme (4 colors)
blue to purple sequential ColorBrewer scheme (4 colors)
diverging spectral ColorBrewer scheme (10 colors)
diverging spectral ColorBrewer scheme (8 colors)
6 warm colors (red to yellow).