ColorSet.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: The Bio++ Development Group
//
// SPDX-License-Identifier: CECILL-2.1

#ifndef BPP_GRAPHICS_COLORSET_H
#define BPP_GRAPHICS_COLORSET_H


#include "../Utils/MapTools.h"
#include "RgbColor.h"

// From the STL:
#include <vector>

namespace bpp
{
class ColorSet
{
public:
  ColorSet() {}
  virtual ~ColorSet() {}

public:
  virtual const RGBColor& getColor(const std::string& name) const = 0;

  virtual const RGBColor& getColor(unsigned int index) const = 0;

  virtual std::vector<std::string> getColorNames() const = 0;

  virtual size_t getNumberOfColors() const = 0;
};


class AbstractColorSet :
  public ColorSet
{
protected:
  std::map<std::string, RGBColor> colors_;

public:
  AbstractColorSet() : colors_() {}
  virtual ~AbstractColorSet() {}

public:
  const RGBColor& getColor(const std::string& name) const
  {
    std::map<std::string, RGBColor>::const_iterator it = colors_.find(name);
    if (it != colors_.end()) return it->second;
    else throw Exception("AbstractColorSet::getColor(name): no color with name " + name);
  }

  const RGBColor& getColor(unsigned int index) const
  {
    if (index >= colors_.size()) throw IndexOutOfBoundsException("AbstractColorSet::getColor(index): invalid index.", index, 0, colors_.size() - 1);
    std::map<std::string, RGBColor>::const_iterator it = colors_.begin();
    for (unsigned int i = 0; i < index; i++) { it++;}
    return it->second;
  }

  std::vector<std::string> getColorNames() const { return MapTools::getKeys(colors_); }

  size_t getNumberOfColors() const { return colors_.size(); }
};
} // end of namespace bpp;
#endif // BPP_GRAPHICS_COLORSET_H