OpenMS
Annotation1DTextItem.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-2023.
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: Timo Sachsenberg $
32 // $Authors: Johannes Junker, Timo Sachsenberg $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
39 
40 namespace OpenMS
41 {
46  public Annotation1DItem
47  {
48 public:
49 
51  Annotation1DTextItem(const PointXYType& position, const QString& text, const int flags = Qt::AlignCenter)
52  : Annotation1DItem(text), position_(position), flags_(flags)
53  {
54  }
57 
59  ~Annotation1DTextItem() override = default;
60 
61  // Docu in base class
62  void ensureWithinDataRange(Plot1DCanvas* const canvas, const int layer_index) override;
63 
64  // Docu in base class
65  void draw(Plot1DCanvas* const canvas, QPainter& painter, bool flipped = false) override;
66 
67  // Docu in base class
68  void move(const PointXYType delta, const Gravitator& gr, const DimMapper<2>& dim_mapper) override;
69 
71  void setPosition(const PointXYType& position)
72  {
73  position_ = position;
74  }
75 
77  const PointXYType& getPosition() const
78  {
79  return position_;
80  }
81 
83  void setFlags(int flags)
84  {
85  flags_ = flags;
86  }
87 
89  int getFlags() const
90  {
91  return flags_;
92  }
93 
94  // Docu in base class
95  Annotation1DItem* clone() const override
96  {
97  return new Annotation1DTextItem(*this);
98  }
99 
100  protected:
103 
104  int flags_;
105  };
106 } // namespace OpenMS
107 
An abstract class acting as an interface for the different 1D annotation items.
Definition: Annotation1DItem.h:62
An annotation item which represents an arbitrary text on the canvas.
Definition: Annotation1DTextItem.h:47
Annotation1DItem * clone() const override
Creates a copy of the item on the heap and returns a pointer.
Definition: Annotation1DTextItem.h:95
void setFlags(int flags)
Set Qt flags (default: Qt::AlignCenter)
Definition: Annotation1DTextItem.h:83
Annotation1DTextItem(const Annotation1DTextItem &rhs)=default
Copy constructor.
int flags_
Definition: Annotation1DTextItem.h:104
void draw(Plot1DCanvas *const canvas, QPainter &painter, bool flipped=false) override
Draws the item on painter.
void ensureWithinDataRange(Plot1DCanvas *const canvas, const int layer_index) override
Ensures that the item has coordinates within the visible area of the canvas.
int getFlags() const
Get Qt flags.
Definition: Annotation1DTextItem.h:89
PointXYType position_
The position of the item as a datatype, e.g. Peak1D.
Definition: Annotation1DTextItem.h:102
const PointXYType & getPosition() const
Returns the position of the item (in X-Y coordinates)
Definition: Annotation1DTextItem.h:77
~Annotation1DTextItem() override=default
Destructor.
void move(const PointXYType delta, const Gravitator &gr, const DimMapper< 2 > &dim_mapper) override
Moves the item on the drawing canvas; behavior depends on item type and is implemented in the subclas...
void setPosition(const PointXYType &position)
Sets the position of the item (in X-Y coordinates)
Definition: Annotation1DTextItem.h:71
Annotation1DTextItem(const PointXYType &position, const QString &text, const int flags=Qt::AlignCenter)
Constructor.
Definition: Annotation1DTextItem.h:51
Manipulates X or Y component of points in the X-Y plane, by assuming one axis (either X or Y axis) ha...
Definition: Plot1DCanvas.h:68
Canvas for visualization of one or several spectra.
Definition: Plot1DCanvas.h:321
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48