LayerData1DBase.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-2021.
//
// 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: Chris Bielow $
// $Authors: Chris Bielow $
// --------------------------------------------------------------------------

#pragma once

#include <OpenMS/VISUAL/LayerDataBase.h>
#include <OpenMS/VISUAL/ANNOTATION/Annotations1DContainer.h>

class QWidget;

namespace OpenMS
{
  class Annotation1DItem;

  class OPENMS_GUI_DLLAPI LayerData1DBase : public virtual LayerDataBase
  {
  public:
    // rule of 0

    virtual std::unique_ptr<Painter1DBase> getPainter1D() const = 0;

    virtual RangeAllType getRangeForArea(const RangeAllType partial_range) const = 0;

    virtual QMenu* getContextMenuAnnotation(Annotation1DItem* annot_item, bool& need_repaint) = 0;


    virtual Annotation1DItem* addPeakAnnotation(const PeakIndex& peak_index, const QString& text, const QColor& color) = 0;


    String getDecoratedName() const override;
        
    const Annotations1DContainer& getCurrentAnnotations() const
    {
      return annotations_1d_[current_idx_];
    }

    Annotations1DContainer& getCurrentAnnotations()
    {
      return annotations_1d_[current_idx_];
    }

    const Annotations1DContainer& getAnnotations(Size spectrum_index) const
    {
      return annotations_1d_[spectrum_index];
    }

    Annotations1DContainer& getAnnotations(Size spectrum_index)
    {
      return annotations_1d_[spectrum_index];
    }
    Size getCurrentIndex() const
    {
      return current_idx_;
    }

    void setCurrentIndex(Size index);

    virtual bool hasIndex(Size index) const = 0;

    bool flipped = false;

    std::vector<QColor> peak_colors_1d;

  protected:
    Size current_idx_ = 0;

    std::vector<Annotations1DContainer> annotations_1d_ = std::vector<Annotations1DContainer>(1);
  };

}// namespace OpenMS