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
71 #ifndef vtkNamedColors_h
72 #define vtkNamedColors_h
73 
74 #include "vtkColor.h" // Needed for vtkColor[34]ub
75 #include "vtkCommonColorModule.h" // For export macro
76 #include "vtkObject.h"
77 #include "vtkStdString.h" // Needed for arguments
78 #include "vtkStringArray.h" // For returning color names
79 
80 VTK_ABI_NAMESPACE_BEGIN
81 class vtkNamedColorsDataStore;
82 class vtkColorStringParser;
83 
84 class VTKCOMMONCOLOR_EXPORT vtkNamedColors : public vtkObject
85 {
86 public:
87  vtkTypeMacro(vtkNamedColors, vtkObject);
88 
95  void PrintSelf(ostream& os, vtkIndent indent) override;
96 
100  static vtkNamedColors* New();
101 
106 
111  void ResetColors();
112 
117 
125 
133  void GetColor(const vtkStdString& name, unsigned char& r, unsigned char& g, unsigned char& b,
134  unsigned char& a);
135 
143  void GetColor(const vtkStdString& name, unsigned char rgba[4]);
144 
151  void GetColor(const vtkStdString& name, vtkColor4ub& rgba);
152 
160 
168  void GetColor(const vtkStdString& name, double& r, double& g, double& b, double& a);
169 
177  void GetColor(const vtkStdString& name, double rgba[4]);
178 
185  void GetColor(const vtkStdString& name, vtkColor4d& rgba);
186 
194 
202 
210  void GetColor(const vtkStdString& name, double& r, double& g, double& b);
211 
219  void GetColorRGB(const vtkStdString& name, double rgb[3]);
220 
227  void GetColor(const vtkStdString& name, vtkColor3ub& rgb);
228 
235  void GetColor(const vtkStdString& name, vtkColor3d& rgb);
236 
243  virtual void SetColor(const vtkStdString& name, const unsigned char& r, const unsigned char& g,
244  const unsigned char& b, const unsigned char& a = 255);
245 
252  virtual void SetColor(const vtkStdString& name, const double& r, const double& g, const double& b,
253  const double& a = 1);
254 
263  virtual void SetColor(const vtkStdString& name, const unsigned char rgba[4]);
264 
271  virtual void SetColor(const vtkStdString& name, const vtkColor4ub& rgba);
272 
279  virtual void SetColor(const vtkStdString& name, const vtkColor3ub& rgb);
280 
288  virtual void SetColor(const vtkStdString& name, const double rgba[4]);
289 
296  virtual void SetColor(const vtkStdString& name, const vtkColor4d& rgba);
297 
304  virtual void SetColor(const vtkStdString& name, const vtkColor3d& rgb);
305 
313 
323 
327  void GetColorNames(vtkStringArray* colorNames);
328 
340 
354 
368 
374 
380 
388  void SetColor(const vtkStdString& name, const vtkStdString& htmlString);
389 
390 protected:
392  ~vtkNamedColors() override;
393 
394 private:
396 
399  vtkNamedColorsDataStore* Colors;
400  vtkColorStringParser* Parser;
402 
403  vtkNamedColors(const vtkNamedColors&) = delete;
404  void operator=(const vtkNamedColors&) = delete;
405 };
406 
407 VTK_ABI_NAMESPACE_END
408 #endif /* vtkNamedColors_h */
Some derived classes for the different colors commonly used.
Definition: vtkColor.h:193
a simple class to control print indentation
Definition: vtkIndent.h:38
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.
static vtkNamedColors * New()
Create a new vtkNamedColors object.
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.
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:61
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:38
a vtkAbstractArray subclass for strings
@ name
Definition: vtkX3D.h:219