Painter2DBase.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 <QRgb>
#include <OpenMS/VISUAL/OpenMS_GUIConfig.h>

#include <OpenMS/CONCEPT/Types.h>
#include <OpenMS/DATASTRUCTURES/ConvexHull2D.h>
#include <OpenMS/VISUAL/INTERFACES/IPeptideIds.h>

#include <vector>

class QPainter;
class QPenStyle;
class QPoint;
class String;

namespace OpenMS
{
  class ConsensusFeature;
  class LayerDataChrom;
  class LayerDataConsensus;
  class LayerDataFeature;
  class LayerDataIdent;
  class LayerDataIonMobility;
  class LayerDataPeak;
  struct PeakIndex;
  class Plot2DCanvas;

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

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


    virtual void highlightElement(QPainter* painter, Plot2DCanvas* canvas, const PeakIndex element);

  protected:
    static void paintIcon_(const QPoint& pos, const QRgb& color, const String& icon, Size s, QPainter& p);

    static void paintConvexHull_(QPainter& painter, Plot2DCanvas* canvas, const ConvexHull2D& hull, bool has_identifications);

    static void paintConvexHulls_(QPainter& painter, Plot2DCanvas* canvas, const std::vector<ConvexHull2D>& hulls, bool has_identifications);

    static void paintPeptideIDs_(QPainter* painter, Plot2DCanvas* canvas, const IPeptideIds::PepIds& ids, int layer_index);
  };

  class OPENMS_GUI_DLLAPI Painter2DPeak : public Painter2DBase
  {
  public:
    Painter2DPeak(const LayerDataPeak* parent);

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

  protected:
    void paintAllIntensities_(QPainter& painter, Plot2DCanvas* canvas, Size layer_index, double pen_width);

    void paintMaximumIntensities_(QPainter& painter, Plot2DCanvas* canvas, Size layer_index, Size rt_pixel_count, Size mz_pixel_count);


    void paintPrecursorPeaks_(QPainter& painter, Plot2DCanvas* canvas);
    const LayerDataPeak* layer_; 
  };

  class OPENMS_GUI_DLLAPI Painter2DChrom : public Painter2DBase
  {
  public:
    Painter2DChrom(const LayerDataChrom* parent);

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

  protected:
    const LayerDataChrom* layer_; 
  };

  class OPENMS_GUI_DLLAPI Painter2DIonMobility : public Painter2DBase
  {
  public:
    Painter2DIonMobility(const LayerDataIonMobility* parent);

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

  protected:
    const LayerDataIonMobility* layer_; 
  };

  class OPENMS_GUI_DLLAPI Painter2DFeature : public Painter2DBase
  {
  public:
    Painter2DFeature(const LayerDataFeature* parent);

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

    void highlightElement(QPainter* painter, Plot2DCanvas* canvas, const PeakIndex element) override;

  protected:
    void paintTraceConvexHulls_(QPainter* painter, Plot2DCanvas* canvas);

    void paintFeatureConvexHulls_(QPainter* painter, Plot2DCanvas* canvas);

    const LayerDataFeature* layer_; 
  };

  class OPENMS_GUI_DLLAPI Painter2DConsensus : public Painter2DBase
  {
  public:
    Painter2DConsensus(const LayerDataConsensus* parent);

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

    void highlightElement(QPainter* painter, Plot2DCanvas* canvas, const PeakIndex element) override;

  protected:
    void paintConsensusElements_(QPainter* painter, Plot2DCanvas* canvas, Size layer_index);

    void paintConsensusElement_(QPainter* painter, Plot2DCanvas* canvas, Size layer_index, const ConsensusFeature& cf);

    bool isConsensusFeatureVisible_(const Plot2DCanvas* canvas, const ConsensusFeature& cf, Size layer_index);

    const LayerDataConsensus* layer_; 
  };

  class OPENMS_GUI_DLLAPI Painter2DIdent : public Painter2DBase
  {
  public:
    Painter2DIdent(const LayerDataIdent* parent);

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

  protected:
    const LayerDataIdent* layer_; 
  };
  
} // namespace OpenMS