vpColorBlindFriendlyPalette.h

/*
 * ViSP, open source Visual Servoing Platform software.
 * Copyright (C) 2005 - 2025 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:
 * Palette of colors that is said to be color-blind people friendly.
 * This palette has been found on https://jfly.uni-koeln.de/color/#see
 */
 
#ifndef _vpColorBlindFliendlyPalette_h_
#define _vpColorBlindFliendlyPalette_h_
 
#include <iostream>
 
#include <visp3/core/vpConfig.h>
#include <visp3/core/vpColor.h>
 
#if (VISP_CXX_STANDARD > VISP_CXX_STANDARD_98)
BEGIN_VISP_NAMESPACE
class VISP_EXPORT vpColorBlindFriendlyPalette
{
public:
  typedef enum class Palette
  {
    Black = 0,     
    Orange = 1,    
    SkyBlue = 2,   
    Green = 3,     
    Yellow = 4,    
    Blue = 5,      
    Vermillon = 6, 
    Purple = 7,    
    COUNT = 8      
  }Palette;
 
  static std::vector<std::string> s_paletteNames; 

  vpColorBlindFriendlyPalette();

  vpColorBlindFriendlyPalette(const Palette &colorID);

  vpColorBlindFriendlyPalette(const std::string &nameColor);

  Palette get_colorID() const;

  vpColor to_vpColor() const;

  std::vector<unsigned char> to_RGB() const;

  std::vector<double> to_colorRatio() const;

  bool set_fromString(const std::string &nameColor);

  std::string to_string() const;

  static std::string getAvailableColorsNames(const std::string &prefix = "", const std::string &separator = " ", const std::string &suffix = "");
private:
  static std::vector<vpColor> s_palette; 

  static unsigned int to_uint(const Palette &colorID);

  static std::string to_string(const Palette &colorID);
 
  Palette m_colorID; 
};
END_VISP_NAMESPACE

  std::ostream &operator<<(std::ostream &os, const VISP_NAMESPACE_ADDRESSING vpColorBlindFriendlyPalette &color);

std::istream &operator>>(std::istream &is, VISP_NAMESPACE_ADDRESSING vpColorBlindFriendlyPalette &color);
 
#endif
#endif // _vpColorBlindFliendlyPalette_h_