OpenMS  3.0.0
AxisPainter.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: Timo Sachsenberg $
32 // $Authors: Timo Sachsenberg $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
37 // OpenMS_GUI config
38 #include <OpenMS/VISUAL/OpenMS_GUIConfig.h>
39 
40 #include <vector>
41 #include <OpenMS/CONCEPT/Types.h>
43 
44 #include <QPaintEvent>
45 #include <QPainter>
46 
47 
48 namespace OpenMS
49 {
55  class OPENMS_GUI_DLLAPI AxisPainter
56  {
57 public:
59  typedef std::vector<std::vector<double> > GridVector;
60 
62  enum Alignment
63  {
64  TOP,
67  RIGHT
68  };
69 
71  static void paint(QPainter * painter, QPaintEvent * e, const double & min, const double & max, const GridVector & grid,
72  const Int width, const Int height, const Alignment alignment, const UInt margin,
73  const bool show_legend, const String legend, const bool shorten_number,
74  const bool is_log, const bool is_inverse_orientation);
75 private:
77  AxisPainter();
78 
80  static void getShortenedNumber_(QString & short_num, double number);
81 
83  static double scale_(double x, bool is_log);
84  };
85 }
OpenMS::AxisPainter::TOP
Definition: AxisPainter.h:64
Types.h
OpenMS::AxisPainter::BOTTOM
Definition: AxisPainter.h:65
OpenMS::String
A more convenient string class.
Definition: String.h:58
OpenMS::AxisPainter::LEFT
Definition: AxisPainter.h:66
OpenMS::Int
int Int
Signed integer type.
Definition: Types.h:102
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
OpenMS::UInt
unsigned int UInt
Unsigned integer type.
Definition: Types.h:94
OpenMS::AxisPainter
Draws a coordinate axis. It has only static methods, that's why the constructor is private.
Definition: AxisPainter.h:55
OpenMS::StringUtils::number
static String number(double d, UInt n)
Definition: StringUtils.h:196
String.h
OpenMS::AxisPainter::GridVector
std::vector< std::vector< double > > GridVector
Typedef for the grid vector.
Definition: AxisPainter.h:59
OpenMS::AxisPainter::Alignment
Alignment
Where the axis is placed.
Definition: AxisPainter.h:62