vpColor.h

/****************************************************************************
 *
 * This file is part of the ViSP software.
 * Copyright (C) 2005 - 2015 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
 * ("GPL") version 2 as published by the Free Software Foundation.
 * 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 http://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.
 *
 * Authors:
 * Eric Marchand
 * Fabien Spindler
 *
 *****************************************************************************/


#ifndef vpColor_hh
#define vpColor_hh


#include <visp3/core/vpConfig.h>
#include <visp3/core/vpRGBa.h>

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)
  {};
  inline vpColor(unsigned char r, unsigned char g, unsigned char b,
     vpColor::vpColorIdentifier cid=vpColor::id_unknown)
    : vpRGBa(r, g, b), id(cid)
  {};
  inline virtual ~vpColor() {};

  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) {
    this->R = r;
    this->G = g;
    this->B = b;
    this->A = 0;
    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)

vpColor const __declspec(selectany) vpColor::black  = vpColor(0, 0, 0, id_black);
vpColor const __declspec(selectany) vpColor::white  = vpColor(255, 255, 255, id_white);
vpColor const __declspec(selectany) vpColor::lightGray  = vpColor(192, 192, 192, id_lightGray);
vpColor const __declspec(selectany) vpColor::gray  = vpColor(128, 128, 128, id_gray);
vpColor const __declspec(selectany) vpColor::darkGray  = vpColor(64, 64, 64, id_darkGray);
vpColor const __declspec(selectany) vpColor::lightRed  = vpColor(255, 140, 140, id_lightRed);
vpColor const __declspec(selectany) vpColor::red    = vpColor(255, 0, 0, id_red);
vpColor const __declspec(selectany) vpColor::darkRed  = vpColor(128, 0, 0, id_darkRed);
vpColor const __declspec(selectany) vpColor::lightGreen  = vpColor(140, 255, 140, id_lightGreen);
vpColor const __declspec(selectany) vpColor::green  = vpColor(0, 255, 0, id_green);
vpColor const __declspec(selectany) vpColor::darkGreen  = vpColor(0, 128, 0, id_darkGreen);
vpColor const __declspec(selectany) vpColor::lightBlue  = vpColor(140, 140, 255, id_lightBlue);
vpColor const __declspec(selectany) vpColor::blue   = vpColor(0, 0, 255, id_blue);
vpColor const __declspec(selectany) vpColor::darkBlue  = vpColor(0, 0, 128, id_darkBlue);
vpColor const __declspec(selectany) vpColor::yellow = vpColor(255, 255, 0, id_yellow);
vpColor const __declspec(selectany) vpColor::cyan   = vpColor(0, 255, 255, id_cyan);
vpColor const __declspec(selectany) vpColor::orange = vpColor(255, 165, 0, id_orange);
vpColor const __declspec(selectany) vpColor::purple = vpColor(128, 0, 128, id_purple);
vpColor const __declspec(selectany) vpColor::none = vpColor(0, 0, 0, id_unknown);

const __declspec(selectany) unsigned int vpColor::nbColors = 18;

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

#endif