vpColor.h

/*
 * ViSP, open source Visual Servoing Platform software.
 * Copyright (C) 2005 - 2024 by Inria. All rights reserved.
 *
 * This software is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * See the file LICENSE.txt at the root directory of this source
 * distribution for additional information about the GNU GPL.
 *
 * For using ViSP with software that can not be combined with the GNU
 * GPL, please contact Inria about acquiring a ViSP Professional
 * Edition License.
 *
 * See https://visp.inria.fr for more information.
 *
 * This software was developed at:
 * Inria Rennes - Bretagne Atlantique
 * Campus Universitaire de Beaulieu
 * 35042 Rennes Cedex
 * France
 *
 * If you have questions regarding the use of this file, please contact
 * Inria at visp@inria.fr
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 *
 * Description:
 * Color definition.
 */
 
#ifndef VP_COLOR_H
#define VP_COLOR_H
 
#include <visp3/core/vpConfig.h>
#include <visp3/core/vpRGBa.h>
 
BEGIN_VISP_NAMESPACE
  #include <visp3/gui/vpDisplayD3D.h>
  #include <visp3/gui/vpDisplayGDI.h>
  #include <visp3/gui/vpDisplayGTK.h>
  #include <visp3/gui/vpDisplayOpenCV.h>
  #include <visp3/gui/vpDisplayX.h>
 
  #ifdef ENABLE_VISP_NAMESPACE
  using namespace VISP_NAMESPACE_NAME;
  #endif
 
  int main()
  {
    vpImage<unsigned char> I(240, 320); // Create a black grey level image
 
    vpDisplay *d;
 
    // Depending on the detected third party libraries, we instantiate here the
    // first video device which is available
  #if defined(VISP_HAVE_X11)
    d = new vpDisplayX;
  #elif defined(VISP_HAVE_GTK)
    d = new vpDisplayGTK;
  #elif defined(VISP_HAVE_GDI)
    d = new vpDisplayGDI;
  #elif defined(VISP_HAVE_D3D9)
    d = new vpDisplayD3D;
  #elif defined(HAVE_OPENCV_HIGHGUI)
    d = new vpDisplayOpenCV;
  #endif
 
    // Initialize the display with the image I. Display and image are
    // now link together.
  #ifdef VISP_HAVE_DISPLAY
    d->init(I);
  #endif
 
    // Set the display background with image I content
    vpDisplay::display(I);
 
    // Draw a filled circle with the predefined blue color
    vpDisplay::displayCircle(I, 100, 200, 30, vpColor::blue, true);
 
    // Creation of a new brown color with its RGB values
    vpColor color(128, 100, 50);
 
    // Draw a brown rectangle in the display overlay (foreground)
    vpDisplay::displayRectangle(I, 10, 10, 100, 20, color, true);
 
    // Flush the foreground and background display
    vpDisplay::flush(I);
 
    delete d;
  }
  \endcode
 
*/
class VISP_EXPORT vpColor : public vpRGBa
{
public:
  typedef enum
  {
    id_black = 0,  
    id_white,      
    id_lightGray,  
    id_gray,       
    id_darkGray,   
    id_lightRed,   
    id_red,        
    id_darkRed,    
    id_lightGreen, 
    id_green,      
    id_darkGreen,  
    id_lightBlue,  
    id_blue,       
    id_darkBlue,   
    id_yellow,     
    id_cyan,       
    id_orange,     
    id_purple,     
 
    id_unknown 
 
  } vpColorIdentifier;
 
  vpColorIdentifier id; 
 
  /* Predefined colors. */
  static const vpColor black;
  static const vpColor white;
  static const vpColor lightGray;
  static const vpColor gray;
  static const vpColor darkGray;
  static const vpColor lightRed;
  static const vpColor red;
  static const vpColor darkRed;
  static const vpColor lightGreen;
  static const vpColor green;
  static const vpColor darkGreen;
  static const vpColor lightBlue;
  static const vpColor blue;
  static const vpColor darkBlue;
  static const vpColor yellow;
  static const vpColor cyan;
  static const vpColor orange;
  static const vpColor purple;
  static const vpColor none;
 
  static const unsigned int nbColors;
  static const vpColor allColors[];

  inline vpColor() : vpRGBa(), id(id_unknown) { }

#if (VISP_CXX_STANDARD > VISP_CXX_STANDARD_98)
  vpColor(const vpColor &) = default;
  virtual ~vpColor() = default;
#else
  virtual ~vpColor() { }
#endif
  inline vpColor(unsigned char r, unsigned char g, unsigned char b,
                 vpColor::vpColorIdentifier cid = vpColor::id_unknown)
    : vpRGBa(r, g, b), id(cid)
  { }

  inline vpColor(unsigned char r, unsigned char g, unsigned char b, unsigned char alpha,
                 vpColor::vpColorIdentifier cid = vpColor::id_unknown)
    : vpRGBa(r, g, b, alpha), id(cid)
  { }

  inline vpColor(const vpColor &color, unsigned char alpha) : vpRGBa(color.R, color.G, color.B, alpha), id(color.id) { }
 
#if (VISP_CXX_STANDARD > VISP_CXX_STANDARD_98)
  vpColor &operator=(const vpColor &) = default;
#endif
  friend VISP_EXPORT bool operator==(const vpColor &c1, const vpColor &c2);
  friend VISP_EXPORT bool operator!=(const vpColor &c1, const vpColor &c2);
  inline void setColor(unsigned char r, unsigned char g, unsigned char b, unsigned char a = vpRGBa::alpha_default)
  {
    this->R = r;
    this->G = g;
    this->B = b;
    this->A = a;
    id = id_unknown;
  }

  static inline vpColor getColor(const unsigned int &i) { return vpColor::allColors[i % vpColor::nbColors]; }
};
 
// In this file if windows
#if defined(VISP_USE_MSVC) && defined(visp_EXPORTS)
VP_ATTRIBUTE_NO_DESTROY vpColor const __declspec(selectany) vpColor::black = vpColor(0, 0, 0, id_black);
VP_ATTRIBUTE_NO_DESTROY vpColor const __declspec(selectany) vpColor::white = vpColor(255, 255, 255, id_white);
VP_ATTRIBUTE_NO_DESTROY vpColor const __declspec(selectany) vpColor::lightGray = vpColor(192, 192, 192, id_lightGray);
VP_ATTRIBUTE_NO_DESTROY vpColor const __declspec(selectany) vpColor::gray = vpColor(128, 128, 128, id_gray);
VP_ATTRIBUTE_NO_DESTROY vpColor const __declspec(selectany) vpColor::darkGray = vpColor(64, 64, 64, id_darkGray);
VP_ATTRIBUTE_NO_DESTROY vpColor const __declspec(selectany) vpColor::lightRed = vpColor(255, 140, 140, id_lightRed);
VP_ATTRIBUTE_NO_DESTROY vpColor const __declspec(selectany) vpColor::red = vpColor(255, 0, 0, id_red);
VP_ATTRIBUTE_NO_DESTROY vpColor const __declspec(selectany) vpColor::darkRed = vpColor(128, 0, 0, id_darkRed);
VP_ATTRIBUTE_NO_DESTROY vpColor const __declspec(selectany) vpColor::lightGreen = vpColor(140, 255, 140, id_lightGreen);
VP_ATTRIBUTE_NO_DESTROY vpColor const __declspec(selectany) vpColor::green = vpColor(0, 255, 0, id_green);
VP_ATTRIBUTE_NO_DESTROY vpColor const __declspec(selectany) vpColor::darkGreen = vpColor(0, 128, 0, id_darkGreen);
VP_ATTRIBUTE_NO_DESTROY vpColor const __declspec(selectany) vpColor::lightBlue = vpColor(140, 140, 255, id_lightBlue);
VP_ATTRIBUTE_NO_DESTROY vpColor const __declspec(selectany) vpColor::blue = vpColor(0, 0, 255, id_blue);
VP_ATTRIBUTE_NO_DESTROY vpColor const __declspec(selectany) vpColor::darkBlue = vpColor(0, 0, 128, id_darkBlue);
VP_ATTRIBUTE_NO_DESTROY vpColor const __declspec(selectany) vpColor::yellow = vpColor(255, 255, 0, id_yellow);
VP_ATTRIBUTE_NO_DESTROY vpColor const __declspec(selectany) vpColor::cyan = vpColor(0, 255, 255, id_cyan);
VP_ATTRIBUTE_NO_DESTROY vpColor const __declspec(selectany) vpColor::orange = vpColor(255, 165, 0, id_orange);
VP_ATTRIBUTE_NO_DESTROY vpColor const __declspec(selectany) vpColor::purple = vpColor(128, 0, 128, id_purple);
VP_ATTRIBUTE_NO_DESTROY vpColor const __declspec(selectany) vpColor::none = vpColor(0, 0, 0, id_unknown);
 
VP_ATTRIBUTE_NO_DESTROY const __declspec(selectany) unsigned int vpColor::nbColors = 18;

VP_ATTRIBUTE_NO_DESTROY vpColor const __declspec(selectany) vpColor::allColors[vpColor::nbColors] = {
  vpColor::blue,       // 12
  vpColor::green,      // 9
  vpColor::red,        // 6
  vpColor::cyan,       // 15
  vpColor::purple,     // 4
  vpColor::yellow,     // 14
  vpColor::orange,     // 16
  vpColor::lightBlue,  // 11
  vpColor::lightGreen, // 8
  vpColor::lightRed,   // 5
  vpColor::darkBlue,   // 13
  vpColor::darkGreen,  // 10
  vpColor::darkRed,    // 7
  vpColor::lightGray,  // 2
  vpColor::gray,       // 3
  vpColor::darkGray,   // 4
  vpColor::black,      // 0
  vpColor::white
};     // 17
 
#endif
END_VISP_NAMESPACE
#endif