Painter1DBase.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-2022.
//
// 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/KERNEL/MSSpectrum.h>

#include <QPainterPath>

class QPainter;
class QPenStyle;

namespace OpenMS
{
  class LayerData1DBase;
  class LayerData1DChrom;
  class LayerData1DIonMobility;
  class LayerData1DPeak;
  class Plot1DCanvas;

  class OPENMS_GUI_DLLAPI Painter1DBase
  {
  public:
    virtual ~Painter1DBase() = default;

    virtual void paint(QPainter* painter, Plot1DCanvas* canvas, int layer_index) = 0;

    static void drawDashedLine(const QPoint& from, const QPoint& to, QPainter* painter, const QColor color);

    static void drawCross(const QPoint& position, QPainter* painter, const int size = 8);

    static void drawCaret(const QPoint& position, QPainter* painter, const int size = 8);

    static QPainterPath getOpenArrow(int arrow_width)
    { // arrow definition
      QPainterPath arrow;
      arrow.moveTo(QPointF(0, 0));
      arrow.lineTo(QPointF(-arrow_width, 4));
      arrow.moveTo(QPointF(0, 0));
      arrow.lineTo(QPointF(-arrow_width, -4));
      return arrow;
    }
    static QPainterPath getClosedArrow(int arrow_width)
    { // arrow definition
      QPainterPath arrow;
      arrow.moveTo(QPointF(0, 0));
      arrow.lineTo(QPointF(-arrow_width, 4));
      arrow.lineTo(QPointF(-arrow_width, -4));
      arrow.closeSubpath();
      return arrow;
    }

    static QRectF drawLineWithArrows(QPainter* painter, const QPen& pen, const QPoint& start, const QPoint& end, 
                                     const QPainterPath& arrow_start = QPainterPath(),
                                     const QPainterPath& arrow_end = QPainterPath());

    void drawAnnotations_(const LayerData1DBase* layer, QPainter& painter, Plot1DCanvas* canvas) const;
  };

  class OPENMS_GUI_DLLAPI Painter1DPeak : public Painter1DBase
  {
  public:
    Painter1DPeak(const LayerData1DPeak* parent);

    void paint(QPainter*, Plot1DCanvas* canvas, int layer_index) override;

  protected:
    void drawMZAtInterestingPeaks_(QPainter& painter, Plot1DCanvas* canvas, MSSpectrum::ConstIterator v_begin, MSSpectrum::ConstIterator v_end) const;

    const LayerData1DPeak* layer_; 
  };

  class OPENMS_GUI_DLLAPI Painter1DChrom : public Painter1DBase
  {
  public:
    Painter1DChrom(const LayerData1DChrom* parent);

    void paint(QPainter*, Plot1DCanvas* canvas, int layer_index) override;

  protected:
    const LayerData1DChrom* layer_; 
  };

  class OPENMS_GUI_DLLAPI Painter1DIonMobility : public Painter1DBase
  {
  public:
    Painter1DIonMobility(const LayerData1DIonMobility* parent);

    void paint(QPainter*, Plot1DCanvas* canvas, int layer_index) override;

  protected:
    const LayerData1DIonMobility* layer_; 
  };

} // namespace OpenMS