vtkNamedColors.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkNamedColors.h
 
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
 
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.
 
=========================================================================*/
#ifndef vtkNamedColors_h
#define vtkNamedColors_h
 
#include "vtkColor.h"             // Needed for vtkColor[34]ub
#include "vtkCommonColorModule.h" // For export macro
#include "vtkObject.h"
#include "vtkStdString.h"   // Needed for arguments
#include "vtkStringArray.h" // For returning color names
 
class vtkNamedColorsDataStore;
class vtkColorStringParser;
 
class VTKCOMMONCOLOR_EXPORT vtkNamedColors : public vtkObject
{
public:
  vtkTypeMacro(vtkNamedColors, vtkObject);
 
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  static vtkNamedColors* New();
 
  int GetNumberOfColors();
 
  void ResetColors();
 
  bool ColorExists(const vtkStdString& name);
 
  vtkColor4ub GetColor4ub(const vtkStdString& name);
 
  void GetColor(const vtkStdString& name, unsigned char& r, unsigned char& g, unsigned char& b,
    unsigned char& a);
 
  void GetColor(const vtkStdString& name, unsigned char rgba[4]);
 
  void GetColor(const vtkStdString& name, vtkColor4ub& rgba);
 
  vtkColor4d GetColor4d(const vtkStdString& name);
 
  void GetColor(const vtkStdString& name, double& r, double& g, double& b, double& a);
 
  void GetColor(const vtkStdString& name, double rgba[4]);
 
  void GetColor(const vtkStdString& name, vtkColor4d& rgba);
 
  vtkColor3ub GetColor3ub(const vtkStdString& name);
 
  vtkColor3d GetColor3d(const vtkStdString& name);
 
  void GetColor(const vtkStdString& name, double& r, double& g, double& b);
 
  void GetColorRGB(const vtkStdString& name, double rgb[3]);
 
  void GetColor(const vtkStdString& name, vtkColor3ub& rgb);
 
  void GetColor(const vtkStdString& name, vtkColor3d& rgb);
 
  virtual void SetColor(const vtkStdString& name, const unsigned char& r, const unsigned char& g,
    const unsigned char& b, const unsigned char& a = 255);
 
  virtual void SetColor(const vtkStdString& name, const double& r, const double& g, const double& b,
    const double& a = 1);
 
  virtual void SetColor(const vtkStdString& name, const unsigned char rgba[4]);
 
  virtual void SetColor(const vtkStdString& name, const vtkColor4ub& rgba);
 
  virtual void SetColor(const vtkStdString& name, const vtkColor3ub& rgb);
 
  virtual void SetColor(const vtkStdString& name, const double rgba[4]);
 
  virtual void SetColor(const vtkStdString& name, const vtkColor4d& rgba);
 
  virtual void SetColor(const vtkStdString& name, const vtkColor3d& rgb);
 
  void RemoveColor(const vtkStdString& name);
 
  vtkStdString GetColorNames();
 
  void GetColorNames(vtkStringArray* colorNames);
 
  vtkStdString GetSynonyms();
 
  vtkColor4ub HTMLColorToRGBA(const vtkStdString& colorString);
 
  vtkColor3ub HTMLColorToRGB(const vtkStdString& colorString);
 
  vtkStdString RGBToHTMLColor(const vtkColor3ub& rgb);
 
  vtkStdString RGBAToHTMLColor(const vtkColor4ub& rgba);
 
  void SetColor(const vtkStdString& name, const vtkStdString& htmlString);
 
protected:
  vtkNamedColors();
  ~vtkNamedColors() override;
 
private:
 
  vtkNamedColorsDataStore* Colors;
  vtkColorStringParser* Parser;
 
  vtkNamedColors(const vtkNamedColors&) = delete;
  void operator=(const vtkNamedColors&) = delete;
};
 
#endif /* vtkNamedColors_h */