OpenMS  3.0.0
Annotation1DPeakItem.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2022.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Johannes Veit $
32 // $Authors: Johannes Junker $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
38 
40 
41 #include <QtGui/QColor>
42 
43 namespace OpenMS
44 {
45 
50  public Annotation1DItem
51  {
52 public:
54  Annotation1DPeakItem(const PointType& peak_position, const QString& text, const QColor& color);
55 
58 
60  ~Annotation1DPeakItem() override;
61 
63  void ensureWithinDataRange(Plot1DCanvas* const canvas) override;
64 
66  void draw(Plot1DCanvas* const canvas, QPainter& painter, bool flipped = false) override;
67 
69  void move(const PointType& /*delta*/) override;
70 
72  const PointType& getPeakPosition() const;
73 
75  void setPosition(const PointType& position);
76 
78  const PointType& getPosition() const;
79 
81  void setColor(const QColor& color);
82 
84  const QColor& getColor() const;
85 
88 
90  static QRectF calculateBoundingBox(
91  const PointType & peak_position,
92  const PointType & position,
93  const QString & text,
94  Plot1DCanvas * const canvas,
95  bool flipped,
96  QPoint & position_widget,
97  QPoint & peak_position_widget,
98  double & horizontal_shift,
99  double & vertical_shift);
100 protected:
103 
106 
108  QColor color_;
109  };
110 } // namespace OpenMS
OpenMS::Annotation1DPeakItem::move
void move(const PointType &) override
Docu in base class.
OpenMS::Plot1DCanvas
Canvas for visualization of one or several spectra.
Definition: Plot1DCanvas.h:70
OpenMS::Annotation1DPeakItem::setPosition
void setPosition(const PointType &position)
Sets the position of the label (in MZ/intensity coordinates)
Annotation1DItem.h
OpenMS::Annotation1DPeakItem::position_
PointType position_
The position of the label (in MZ / intensity coordinates)
Definition: Annotation1DPeakItem.h:105
OpenMS::Annotation1DPeakItem::getColor
const QColor & getColor() const
Returns the color of the label.
OpenMS::Annotation1DPeakItem::color_
QColor color_
The color of the label.
Definition: Annotation1DPeakItem.h:108
OpenMS::Annotation1DPeakItem::draw
void draw(Plot1DCanvas *const canvas, QPainter &painter, bool flipped=false) override
Docu in base class.
OpenMS::Annotation1DPeakItem::setColor
void setColor(const QColor &color)
Set the color of the label.
OpenMS::Annotation1DPeakItem::Annotation1DPeakItem
Annotation1DPeakItem(const PointType &peak_position, const QString &text, const QColor &color)
Constructor.
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::Annotation1DPeakItem
A peak annotation item.
Definition: Annotation1DPeakItem.h:49
PeptideHit.h
OpenMS::Annotation1DPeakItem::peak_position_
PointType peak_position_
The position of the anchor (peak) (in MZ / intensity coordinates)
Definition: Annotation1DPeakItem.h:102
OpenMS::Annotation1DPeakItem::getPeakPosition
const PointType & getPeakPosition() const
Returns the position of the label (peak) (in MZ/intensity coordinates)
OpenMS::Annotation1DPeakItem::getPosition
const PointType & getPosition() const
Returns the position of the annotated peak (in MZ/intensity coordinates)
OpenMS::Annotation1DItem
An abstract class acting as an interface for the different 1D annotation items.
Definition: Annotation1DItem.h:59
OpenMS::Annotation1DPeakItem::toPeakAnnotation
PeptideHit::PeakAnnotation toPeakAnnotation() const
Convert the 'text()' to a Peptide::PeakAnnotation.
OpenMS::DPosition< 2 >
OpenMS::Annotation1DPeakItem::ensureWithinDataRange
void ensureWithinDataRange(Plot1DCanvas *const canvas) override
Docu in base class.
OpenMS::Annotation1DPeakItem::~Annotation1DPeakItem
~Annotation1DPeakItem() override
Destructor.
OpenMS::Annotation1DPeakItem::calculateBoundingBox
static QRectF calculateBoundingBox(const PointType &peak_position, const PointType &position, const QString &text, Plot1DCanvas *const canvas, bool flipped, QPoint &position_widget, QPoint &peak_position_widget, double &horizontal_shift, double &vertical_shift)
Calculate bounding box in widget coordinates.
OpenMS::PeptideHit::PeakAnnotation
Contains annotations of a peak.
Definition: PeptideHit.h:83