MultiGradient.h

Go to the documentation of this file.

// Copyright (c) 2002-2023, The OpenMS Team -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors: Marc Sturm $
// --------------------------------------------------------------------------
 
#pragma once
 
// OpenMS_GUI config
#include <OpenMS/VISUAL/OpenMS_GUIConfig.h>
 
//OpenMS
#include <OpenMS/CONCEPT/Types.h>
#include <OpenMS/CONCEPT/Macros.h>
#include <OpenMS/CONCEPT/Exception.h>
#include <OpenMS/DATASTRUCTURES/String.h>
 
//QT
#include <QtGui/QColor>
 
//STL
#include <map>
#include <vector>
#include <cmath>
 
namespace OpenMS
{
 
  class OPENMS_GUI_DLLAPI MultiGradient
  {
public:
    static MultiGradient getDefaultGradientLinearIntensityMode();
 
    static MultiGradient getDefaultGradientLogarithmicIntensityMode();
 
    enum InterpolationMode
    {
      IM_LINEAR,        
      IM_STAIRS         
    };
 
    MultiGradient();
 
    MultiGradient(const MultiGradient & multigradient);
 
    ~MultiGradient();
 
    MultiGradient & operator=(const MultiGradient & rhs);
 
    void insert(double position, QColor color);
    bool remove(double position);
    bool exists(double position);
    UInt position(UInt index);
    QColor color(UInt index);
 
 
    QColor interpolatedColorAt(double position) const;
    QColor interpolatedColorAt(double position, double min, double max) const;
 
    void activatePrecalculationMode(double min, double max, UInt steps);
    void deactivatePrecalculationMode();
 
    inline Int precalculatedColorIndex( double position ) const
    {
      OPENMS_PRECONDITION(pre_.size() != 0, "MultiGradient::precalculatedColorIndex(double): Precalculation mode not activated!");
      OPENMS_PRECONDITION(position >= pre_min_, (String("MultiGradient::precalculatedColorIndex(double): position ") + position + " out of specified range (" + pre_min_ + "-" + (pre_min_ + pre_size_) + ")!").c_str());
 
      Int index = (Int)((position - pre_min_) / pre_size_ * pre_steps_);
 
      return qBound( 0, index, (Int)pre_.size() - 1 );
    }
 
    inline QColor precalculatedColorByIndex( Int index ) const
    {
      OPENMS_PRECONDITION(pre_.size() != 0, "MultiGradient::precalculatedColorByIndex(Int): Precalculation mode not activated!");
      OPENMS_PRECONDITION( index >= 0, "MultiGradient::precalculatedColorByIndex(Int): negative indexes not allowed");
      OPENMS_PRECONDITION( index < (Int)pre_.size(), (String("MultiGradient::indexedColor(Int): index ") + index + " out of specified range (0-" + pre_.size() + ")!").c_str());
 
      return pre_[index];
    }
 
    inline QColor precalculatedColorAt(double position) const
    {
      return precalculatedColorByIndex( precalculatedColorIndex( position ) );
    }
 
    Size size() const;
 
    Size precalculatedSize() const
    {
        return pre_.size();
    }
 
    void setInterpolationMode(InterpolationMode mode);
    InterpolationMode getInterpolationMode() const;
 
    std::string toString() const;
    void fromString(const std::string & gradient);
 
protected:
    std::map<double, QColor> pos_col_;
    InterpolationMode interpolation_mode_;
    std::vector<QColor> pre_;
    double pre_min_;
    double pre_size_;
    UInt pre_steps_;
 
  };
 
}