VTK  9.2.5
vtkNamedColors.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkNamedColors.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 =========================================================================*/
183 #ifndef vtkNamedColors_h
184 #define vtkNamedColors_h
185 
186 #include "vtkColor.h" // Needed for vtkColor[34]ub
187 #include "vtkCommonColorModule.h" // For export macro
188 #include "vtkObject.h"
189 #include "vtkStdString.h" // Needed for arguments
190 #include "vtkStringArray.h" // For returning color names
191 
192 class vtkNamedColorsDataStore;
193 class vtkColorStringParser;
194 
195 class VTKCOMMONCOLOR_EXPORT vtkNamedColors : public vtkObject
196 {
197 public:
198  vtkTypeMacro(vtkNamedColors, vtkObject);
199 
206  void PrintSelf(ostream& os, vtkIndent indent) override;
207 
211  static vtkNamedColors* New();
212 
217 
222  void ResetColors();
223 
228 
236 
244  void GetColor(const vtkStdString& name, unsigned char& r, unsigned char& g, unsigned char& b,
245  unsigned char& a);
246 
254  void GetColor(const vtkStdString& name, unsigned char rgba[4]);
255 
262  void GetColor(const vtkStdString& name, vtkColor4ub& rgba);
263 
271 
279  void GetColor(const vtkStdString& name, double& r, double& g, double& b, double& a);
280 
288  void GetColor(const vtkStdString& name, double rgba[4]);
289 
296  void GetColor(const vtkStdString& name, vtkColor4d& rgba);
297 
305 
313 
321  void GetColor(const vtkStdString& name, double& r, double& g, double& b);
322 
330  void GetColorRGB(const vtkStdString& name, double rgb[3]);
331 
338  void GetColor(const vtkStdString& name, vtkColor3ub& rgb);
339 
346  void GetColor(const vtkStdString& name, vtkColor3d& rgb);
347 
354  virtual void SetColor(const vtkStdString& name, const unsigned char& r, const unsigned char& g,
355  const unsigned char& b, const unsigned char& a = 255);
356 
363  virtual void SetColor(const vtkStdString& name, const double& r, const double& g, const double& b,
364  const double& a = 1);
365 
374  virtual void SetColor(const vtkStdString& name, const unsigned char rgba[4]);
375 
382  virtual void SetColor(const vtkStdString& name, const vtkColor4ub& rgba);
383 
390  virtual void SetColor(const vtkStdString& name, const vtkColor3ub& rgb);
391 
399  virtual void SetColor(const vtkStdString& name, const double rgba[4]);
400 
407  virtual void SetColor(const vtkStdString& name, const vtkColor4d& rgba);
408 
415  virtual void SetColor(const vtkStdString& name, const vtkColor3d& rgb);
416 
424 
434 
438  void GetColorNames(vtkStringArray* colorNames);
439 
451 
465 
479 
485 
491 
499  void SetColor(const vtkStdString& name, const vtkStdString& htmlString);
500 
501 protected:
503  ~vtkNamedColors() override;
504 
505 private:
507 
510  vtkNamedColorsDataStore* Colors;
511  vtkColorStringParser* Parser;
513 
514  vtkNamedColors(const vtkNamedColors&) = delete;
515  void operator=(const vtkNamedColors&) = delete;
516 };
517 
518 #endif /* vtkNamedColors_h */
Some derived classes for the different colors commonly used.
Definition: vtkColor.h:304
a simple class to control print indentation
Definition: vtkIndent.h:119
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:82
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:108
a vtkAbstractArray subclass for strings
@ name
Definition: vtkX3D.h:225