VTK  9.3.0
vtkNamedColors.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
62#ifndef vtkNamedColors_h
63#define vtkNamedColors_h
64
65#include "vtkColor.h" // Needed for vtkColor[34]ub
66#include "vtkCommonColorModule.h" // For export macro
67#include "vtkObject.h"
68#include "vtkStdString.h" // Needed for arguments
69#include "vtkStringArray.h" // For returning color names
70
71VTK_ABI_NAMESPACE_BEGIN
72class vtkNamedColorsDataStore;
73class vtkColorStringParser;
74
75class VTKCOMMONCOLOR_EXPORT vtkNamedColors : public vtkObject
76{
77public:
78 vtkTypeMacro(vtkNamedColors, vtkObject);
79
86 void PrintSelf(ostream& os, vtkIndent indent) override;
87
92
97
103
107 bool ColorExists(const vtkStdString& name);
108
116
124 void GetColor(const vtkStdString& name, unsigned char& r, unsigned char& g, unsigned char& b,
125 unsigned char& a);
126
134 void GetColor(const vtkStdString& name, unsigned char rgba[4]);
135
142 void GetColor(const vtkStdString& name, vtkColor4ub& rgba);
143
151
159 void GetColor(const vtkStdString& name, double& r, double& g, double& b, double& a);
160
168 void GetColor(const vtkStdString& name, double rgba[4]);
169
176 void GetColor(const vtkStdString& name, vtkColor4d& rgba);
177
185
193
201 void GetColor(const vtkStdString& name, double& r, double& g, double& b);
202
210 void GetColorRGB(const vtkStdString& name, double rgb[3]);
211
218 void GetColor(const vtkStdString& name, vtkColor3ub& rgb);
219
226 void GetColor(const vtkStdString& name, vtkColor3d& rgb);
227
234 virtual void SetColor(const vtkStdString& name, const unsigned char& r, const unsigned char& g,
235 const unsigned char& b, const unsigned char& a = 255);
236
243 virtual void SetColor(const vtkStdString& name, const double& r, const double& g, const double& b,
244 const double& a = 1);
245
254 virtual void SetColor(const vtkStdString& name, const unsigned char rgba[4]);
255
262 virtual void SetColor(const vtkStdString& name, const vtkColor4ub& rgba);
263
270 virtual void SetColor(const vtkStdString& name, const vtkColor3ub& rgb);
271
279 virtual void SetColor(const vtkStdString& name, const double rgba[4]);
280
287 virtual void SetColor(const vtkStdString& name, const vtkColor4d& rgba);
288
295 virtual void SetColor(const vtkStdString& name, const vtkColor3d& rgb);
296
303 void RemoveColor(const vtkStdString& name);
304
314
318 void GetColorNames(vtkStringArray* colorNames);
319
331
345
359
365
371
379 void SetColor(const vtkStdString& name, const vtkStdString& htmlString);
380
381protected:
383 ~vtkNamedColors() override;
384
385private:
387
390 vtkNamedColorsDataStore* Colors;
391 vtkColorStringParser* Parser;
393
394 vtkNamedColors(const vtkNamedColors&) = delete;
395 void operator=(const vtkNamedColors&) = delete;
396};
397
398VTK_ABI_NAMESPACE_END
399#endif /* vtkNamedColors_h */
Some derived classes for the different colors commonly used.
Definition vtkColor.h:184
a simple class to control print indentation
Definition vtkIndent.h:29
A class holding colors and their names.
virtual void SetColor(const vtkStdString &name, const vtkColor4ub &rgba)
Set the color by name.
virtual void SetColor(const vtkStdString &name, const double &r, const double &g, const double &b, const double &a=1)
Set the color by name.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkColor4d GetColor4d(const vtkStdString &name)
Get the color by name.
void GetColor(const vtkStdString &name, vtkColor4d &rgba)
Get the color by name.
~vtkNamedColors() override
void GetColorRGB(const vtkStdString &name, double rgb[3])
Get the color by name.
void GetColor(const vtkStdString &name, vtkColor3ub &rgb)
Get the color by name.
void GetColor(const vtkStdString &name, vtkColor3d &rgb)
Get the color by name.
vtkStdString GetSynonyms()
Return a string of synonyms such as cyan/aqua and magenta/fuchsia.
virtual void SetColor(const vtkStdString &name, const unsigned char &r, const unsigned char &g, const unsigned char &b, const unsigned char &a=255)
Set the color by name.
virtual void SetColor(const vtkStdString &name, const vtkColor3ub &rgb)
Set the color by name.
vtkColor3ub HTMLColorToRGB(const vtkStdString &colorString)
Return a vtkColor3ub instance from an HTML color string in any of the following formats:
virtual void SetColor(const vtkStdString &name, const unsigned char rgba[4])
Set the color by name.
virtual void SetColor(const vtkStdString &name, const vtkColor4d &rgba)
Set the color by name.
void GetColor(const vtkStdString &name, unsigned char rgba[4])
Get the color by name.
vtkColor3d GetColor3d(const vtkStdString &name)
Get the color by name.
vtkStdString RGBAToHTMLColor(const vtkColor4ub &rgba)
Given a vtkColor4ub instance as input color return a valid HTML color string in the rgba(r,...
void ResetColors()
Reset the colors in the color map to the original colors.
virtual void SetColor(const vtkStdString &name, const double rgba[4])
Set the color by name.
vtkStdString RGBToHTMLColor(const vtkColor3ub &rgb)
Given a vtkColor3ub instance as input color return a valid HTML color string in the #RRGGBB format.
vtkColor3ub GetColor3ub(const vtkStdString &name)
Get the color by name.
virtual void SetColor(const vtkStdString &name, const vtkColor3d &rgb)
Set the color by name.
void GetColor(const vtkStdString &name, unsigned char &r, unsigned char &g, unsigned char &b, unsigned char &a)
Get the color by name.
vtkColor4ub GetColor4ub(const vtkStdString &name)
Get the color by name.
void SetColor(const vtkStdString &name, const vtkStdString &htmlString)
Set the color by name.
void GetColor(const vtkStdString &name, double &r, double &g, double &b)
Get the color by name.
void RemoveColor(const vtkStdString &name)
Remove the color by name.
int GetNumberOfColors()
Get the number of colors.
void GetColor(const vtkStdString &name, double rgba[4])
Get the color by name.
void GetColor(const vtkStdString &name, double &r, double &g, double &b, double &a)
Get the color by name.
vtkStdString GetColorNames()
Return a string of color names with each name delimited by a line feed.
bool ColorExists(const vtkStdString &name)
Return true if the color exists.
void GetColorNames(vtkStringArray *colorNames)
Return a string array of color names.
void GetColor(const vtkStdString &name, vtkColor4ub &rgba)
Get the color by name.
static vtkNamedColors * New()
Create a new vtkNamedColors object.
vtkColor4ub HTMLColorToRGBA(const vtkStdString &colorString)
Return a vtkColor4ub instance from an HTML color string in any of the following formats:
abstract base class for most VTK objects
Definition vtkObject.h:49
Wrapper around std::string to keep symbols short.
a vtkAbstractArray subclass for strings