vpColor.h

/****************************************************************************
 *
 * $Id: vpColor.h 5126 2015-01-05 22:07:11Z fspindle $
 *
 * This file is part of the ViSP software.
 * Copyright (C) 2005 - 2014 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://www.irisa.fr/lagadic/visp/visp.html for more information.
 * 
 * This software was developed at:
 * INRIA Rennes - Bretagne Atlantique
 * Campus Universitaire de Beaulieu
 * 35042 Rennes Cedex
 * France
 * http://www.irisa.fr/lagadic
 *
 * 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 <visp/vpConfig.h>
#include <visp/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];
  };

};

#endif