MultiGradient.h

Go to the documentation of this file.

// --------------------------------------------------------------------------
//                   OpenMS -- Open-Source Mass Spectrometry
// --------------------------------------------------------------------------
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
// ETH Zurich, and Freie Universitaet Berlin 2002-2018.
//
// This software is released under a three-clause BSD license:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of any author or any participating institution
//    may be used to endorse or promote products derived from this software
//    without specific prior written permission.
// For a full list of authors, refer to the file AUTHORS.
// --------------------------------------------------------------------------
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
// INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// --------------------------------------------------------------------------
// $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_;

  };

}