dox/Common/Color/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 "vtkCommonColorModule.h" // For export macro
#include "vtkObject.h"
#include "vtkColor.h" // Needed for vtkColor[34]ub
#include "vtkStdString.h" // Needed for arguments
#include "vtkStringArray.h" // For returning color names

class vtkNamedColorsDataStore;

class VTKCOMMONCOLOR_EXPORT vtkNamedColors : public vtkObject
{
public:
  vtkTypeMacro(vtkNamedColors, vtkObject);

  virtual void PrintSelf(ostream &os, vtkIndent indent);

  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);


  void SetColor(const vtkStdString & name,
                const unsigned char & r, const unsigned char & g,
                const unsigned char & b, const unsigned char & a = 255);


  void SetColor(const vtkStdString & name,
                const double & r, const double & g,
                const double & b, const double & a = 1);

  void SetColor(const vtkStdString & name, const unsigned char rgba[4]);

  void SetColor(const vtkStdString & name, const vtkColor4ub & rgba);

  void SetColor(const vtkStdString & name, const vtkColor3ub & rgb);

  void SetColor(const vtkStdString & name, const double rgba[4]);

  void SetColor(const vtkStdString & name, const vtkColor4d & rgba);

  void SetColor(const vtkStdString & name, const vtkColor3d & rgb);

  void RemoveColor(const vtkStdString & name);

  vtkStdString GetColorNames();

  void GetColorNames(vtkStringArray * colorNames);

  vtkStdString GetSynonyms();

protected:
  vtkNamedColors();
  virtual ~vtkNamedColors();

private:
  vtkNamedColorsDataStore *Colors;

  vtkNamedColors(const vtkNamedColors&);  // Not implemented.
  void operator=(const vtkNamedColors&);  // Not implemented.
};

#endif /* __vtkNamedColors_h */