VTK  9.5.20250805
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
151#ifndef vtkColorSeries_h
152#define vtkColorSeries_h
153
154#include "vtkColor.h" // Needed for vtkColor[34]ub
155#include "vtkCommonColorModule.h" // For export macro
156#include "vtkObject.h"
157#include "vtkStdString.h" // Needed for arguments
158#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
159
160VTK_ABI_NAMESPACE_BEGIN
161class vtkLookupTable;
162
163class VTKCOMMONCOLOR_EXPORT VTK_MARSHALAUTO vtkColorSeries : public vtkObject
164{
165public:
166 vtkTypeMacro(vtkColorSeries, vtkObject);
167 void PrintSelf(ostream& os, vtkIndent indent) override;
168
173
178 {
180 SPECTRUM = 0,
304 CUSTOM
305 };
306
313 {
315 ORDINAL = 0,
317 CATEGORICAL
318 };
319
321
328 virtual void SetColorScheme(int scheme);
329 virtual int SetColorSchemeByName(const vtkStdString& schemeName);
331
336
341
345 virtual void SetColorSchemeName(const vtkStdString& name);
346
350 virtual int GetColorScheme() const;
351
355 virtual int GetNumberOfColors() const;
356
362 virtual void SetNumberOfColors(int numColors);
363
368 vtkColor3ub GetColor(int index) const;
369
375
380 virtual void SetColor(int index, const vtkColor3ub& color);
381
385 virtual void AddColor(const vtkColor3ub& color);
386
390 virtual void InsertColor(int index, const vtkColor3ub& color);
391
395 virtual void RemoveColor(int index);
396
400 virtual void ClearColors();
401
405 virtual void DeepCopy(vtkColorSeries* chartColors);
406
414 void BuildLookupTable(vtkLookupTable* lkup, int lutIndexing = CATEGORICAL);
415
426 vtkLookupTable* CreateLookupTable(int lutIndexing = CATEGORICAL);
427
428protected:
430 ~vtkColorSeries() override;
431
436 virtual void CopyOnWrite();
437
439
442 class Private;
443 Private* Storage;
445
450
453
454private:
455 vtkColorSeries(const vtkColorSeries&) = delete;
456 void operator=(const vtkColorSeries&) = delete;
457};
458
459VTK_ABI_NAMESPACE_END
460#endif // vtkColorSeries_h
Some derived classes for the different colors commonly used.
Definition vtkColor.h:203
stores a list of colors.
int ColorScheme
The color scheme being used.
static vtkColorSeries * New()
Create a new vtkColorSeries with the SPECTRUM color scheme.
void BuildLookupTable(vtkLookupTable *lkup, int lutIndexing=CATEGORICAL)
Populate a lookup table with all the colors in the current scheme.
LUTMode
An enum defining how lookup tables should be used: either as a list of discrete colors to choose from...
virtual void AddColor(const vtkColor3ub &color)
Adds the color to the end of the list.
virtual int GetColorScheme() const
Return the ID of the color scheme currently in use.
~vtkColorSeries() override
virtual int GetNumberOfColors() const
Get the number of colors available in the current color scheme.
virtual vtkStdString GetColorSchemeName() const
Get the color scheme that is currently being used.
virtual int SetColorSchemeByName(const vtkStdString &schemeName)
Set the color scheme that should be used.
vtkColor3ub GetColor(int index) const
Get the color at the specified index.
vtkColor3ub GetColorRepeating(int index) const
Get the color at the specified index.
virtual void DeepCopy(vtkColorSeries *chartColors)
Make a deep copy of the supplied object.
vtkStdString ColorSchemeName
The color scheme being used.
virtual void ClearColors()
Clears the list of colors.
virtual void SetColorSchemeName(const vtkStdString &name)
Set the name of the current color scheme.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkLookupTable * CreateLookupTable(int lutIndexing=CATEGORICAL)
Create a new lookup table with all the colors in the current scheme.
virtual void RemoveColor(int index)
Removes the color at the specified index in the list.
virtual void SetColor(int index, const vtkColor3ub &color)
Set the color at the specified index.
ColorSchemes
Enum of the available color schemes.
@ BREWER_DIVERGING_SPECTRAL_5
diverging spectral ColorBrewer scheme (5 colors)
@ WILD_FLOWER
7 colors from blue to magenta.
@ BREWER_DIVERGING_SPECTRAL_4
diverging spectral ColorBrewer scheme (4 colors)
@ BLUES
7 different blues.
@ BREWER_DIVERGING_BROWN_BLUE_GREEN_6
brown-blue-green diverging ColorBrewer scheme (6 colors)
@ BREWER_SEQUENTIAL_BLUE_PURPLE_4
blue to purple sequential ColorBrewer scheme (4 colors)
@ BREWER_QUALITATIVE_ACCENT
qualitative ColorBrewer scheme good for accenting
@ BREWER_DIVERGING_BROWN_BLUE_GREEN_11
brown-blue-green diverging ColorBrewer scheme (11 colors)
@ BREWER_QUALITATIVE_SET1
a qualitative ColorBrewer scheme useful for color set members
@ BREWER_QUALITATIVE_PASTEL2
a qualitative ColorBrewer scheme composed of pastel colors
@ BREWER_SEQUENTIAL_BLUE_GREEN_5
blue to green sequential ColorBrewer scheme (5 colors)
@ BREWER_SEQUENTIAL_BLUE_PURPLE_5
blue to purple sequential ColorBrewer scheme (5 colors)
@ BREWER_DIVERGING_BROWN_BLUE_GREEN_7
brown-blue-green diverging ColorBrewer scheme (7 colors)
@ BREWER_DIVERGING_BROWN_BLUE_GREEN_5
brown-blue-green diverging ColorBrewer scheme (5 colors)
@ BREWER_DIVERGING_PURPLE_ORANGE_6
purple-grey-orange diverging ColorBrewer scheme (6 colors)
@ BREWER_DIVERGING_BROWN_BLUE_GREEN_8
brown-blue-green diverging ColorBrewer scheme (8 colors)
@ BREWER_DIVERGING_BROWN_BLUE_GREEN_3
brown-blue-green diverging ColorBrewer scheme (3 colors)
@ BREWER_DIVERGING_PURPLE_ORANGE_9
purple-grey-orange diverging ColorBrewer scheme (9 colors)
@ BREWER_SEQUENTIAL_YELLOW_ORANGE_BROWN_4
yellow-orange-brown sequential ColorBrewer scheme (4 colors)
@ BREWER_DIVERGING_SPECTRAL_3
diverging spectral ColorBrewer scheme (3 colors)
@ BREWER_SEQUENTIAL_BLUE_GREEN_4
blue to green sequential ColorBrewer scheme (4 colors)
@ BREWER_DIVERGING_SPECTRAL_11
diverging spectral ColorBrewer scheme (11 colors)
@ BREWER_SEQUENTIAL_YELLOW_ORANGE_BROWN_7
yellow-orange-brown sequential ColorBrewer scheme (7 colors)
@ BREWER_SEQUENTIAL_BLUE_PURPLE_7
blue to purple sequential ColorBrewer scheme (7 colors)
@ BREWER_SEQUENTIAL_BLUE_PURPLE_3
blue to purple sequential ColorBrewer scheme (3 colors)
@ BREWER_QUALITATIVE_PAIRED
a qualitative ColorBrewer scheme with pairs of matching colors
@ BREWER_DIVERGING_SPECTRAL_10
diverging spectral ColorBrewer scheme (10 colors)
@ BREWER_QUALITATIVE_DARK2
a dark set of qualitative colors from ColorBrewer
@ BREWER_DIVERGING_BROWN_BLUE_GREEN_4
brown-blue-green diverging ColorBrewer scheme (4 colors)
@ BREWER_DIVERGING_SPECTRAL_6
diverging spectral ColorBrewer scheme (6 colors)
@ BREWER_SEQUENTIAL_BLUE_GREEN_9
blue to green sequential ColorBrewer scheme (9 colors)
@ BREWER_DIVERGING_PURPLE_ORANGE_8
purple-grey-orange diverging ColorBrewer scheme (8 colors)
@ BREWER_DIVERGING_PURPLE_ORANGE_5
purple-grey-orange diverging ColorBrewer scheme (5 colors)
@ BREWER_QUALITATIVE_SET3
a qualitative ColorBrewer scheme useful for color set members
@ BREWER_DIVERGING_BROWN_BLUE_GREEN_9
brown-blue-green diverging ColorBrewer scheme (9 colors)
@ BREWER_SEQUENTIAL_BLUE_GREEN_3
blue to green sequential ColorBrewer scheme (3 colors)
@ BREWER_DIVERGING_PURPLE_ORANGE_11
purple-grey-orange diverging ColorBrewer scheme (11 colors)
@ CITRUS
6 colors from green to orange.
@ BREWER_DIVERGING_PURPLE_ORANGE_3
purple-grey-orange diverging ColorBrewer scheme (3 colors)
@ BREWER_SEQUENTIAL_BLUE_PURPLE_6
blue to purple sequential ColorBrewer scheme (6 colors)
@ BREWER_SEQUENTIAL_BLUE_GREEN_8
blue to green sequential ColorBrewer scheme (8 colors)
@ BREWER_SEQUENTIAL_BLUE_PURPLE_8
blue to purple sequential ColorBrewer scheme (8 colors)
@ BREWER_SEQUENTIAL_BLUE_PURPLE_9
blue to purple sequential ColorBrewer scheme (9 colors)
@ BREWER_SEQUENTIAL_YELLOW_ORANGE_BROWN_3
yellow-orange-brown sequential ColorBrewer scheme (3 colors)
@ BREWER_SEQUENTIAL_YELLOW_ORANGE_BROWN_6
yellow-orange-brown sequential ColorBrewer scheme (6 colors)
@ WARM
6 warm colors (red to yellow).
@ BREWER_DIVERGING_PURPLE_ORANGE_10
purple-grey-orange diverging ColorBrewer scheme (10 colors)
@ BREWER_DIVERGING_SPECTRAL_8
diverging spectral ColorBrewer scheme (8 colors)
@ BREWER_SEQUENTIAL_YELLOW_ORANGE_BROWN_9
yellow-orange-brown sequential ColorBrewer scheme (9 colors)
@ BREWER_SEQUENTIAL_YELLOW_ORANGE_BROWN_8
yellow-orange-brown sequential ColorBrewer scheme (8 colors)
@ BREWER_SEQUENTIAL_BLUE_GREEN_7
blue to green sequential ColorBrewer scheme (7 colors)
@ BREWER_SEQUENTIAL_YELLOW_ORANGE_BROWN_5
yellow-orange-brown sequential ColorBrewer scheme (5 colors)
@ BREWER_DIVERGING_PURPLE_ORANGE_7
purple-grey-orange diverging ColorBrewer scheme (7 colors)
@ BREWER_QUALITATIVE_SET2
a qualitative ColorBrewer scheme useful for color set members
@ BREWER_DIVERGING_SPECTRAL_9
diverging spectral ColorBrewer scheme (9 colors)
@ BREWER_SEQUENTIAL_BLUE_GREEN_6
blue to green sequential ColorBrewer scheme (6 colors)
@ BREWER_DIVERGING_SPECTRAL_7
diverging spectral ColorBrewer scheme (7 colors)
@ BREWER_DIVERGING_PURPLE_ORANGE_4
purple-grey-orange diverging ColorBrewer scheme (4 colors)
@ BREWER_DIVERGING_BROWN_BLUE_GREEN_10
brown-blue-green diverging ColorBrewer scheme (10 colors)
@ BREWER_QUALITATIVE_PASTEL1
a qualitative ColorBrewer scheme composed of pastel colors
@ COOL
7 cool colors (green to purple).
virtual void CopyOnWrite()
If the current scheme is a predefined (read-only) scheme, copy the current colors to a new scheme and...
virtual void InsertColor(int index, const vtkColor3ub &color)
Inserts the color at the specified index in the list.
virtual void SetNumberOfColors(int numColors)
Set the number of colors to be stored in a non-default color scheme.
int GetNumberOfColorSchemes() const
Return the number of schemes currently defined.
virtual void SetColorScheme(int scheme)
Set the color scheme that should be used.
a simple class to control print indentation
Definition vtkIndent.h:108
map scalar values into colors via a lookup table
abstract base class for most VTK objects
Definition vtkObject.h:162
Wrapper around std::string to keep symbols short.
#define VTK_MARSHALAUTO
#define VTK_NEWINSTANCE