| OpenMS 2.5.0

Spectrum3DCanvas.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-2020.
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: Cornelia Friedle $
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37 // OpenMS_GUI config
38 #include <OpenMS/VISUAL/OpenMS_GUIConfig.h>
39
40 // OpenMS
41 #include <OpenMS/VISUAL/SpectrumCanvas.h>
42 #include <OpenMS/VISUAL/MultiGradient.h>
43
44
45 class QPainter;
46 class QOpenGLWidget;
47 class QResizeEvent;
48
49 namespace OpenMS
50 {
51 class Spectrum3DOpenGLCanvas;
52
66 class OPENMS_GUI_DLLAPI Spectrum3DCanvas :
67 public SpectrumCanvas
68 {
69 Q_OBJECT
70
71 friend class Spectrum3DOpenGLCanvas;
72
73 public:
74
76 Spectrum3DCanvas(const Param & preferences, QWidget * parent = nullptr);
78 ~Spectrum3DCanvas() override;
79
81 enum ShadeModes
82 {
83 SHADE_FLAT = 0,
84 SHADE_SMOOTH = 1
85 };
86
88 Spectrum3DOpenGLCanvas * openglwidget();
89
91
92 void resizeEvent(QResizeEvent * e) override;
93 void contextMenuEvent(QContextMenuEvent * e) override;
95 bool isLegendShown() const;
98 void showLegend(bool);
100 Spectrum3DOpenGLCanvas * openglcanvas_;
101
102 // docu in base class
103 void showCurrentLayerPreferences() override;
104
105 // Docu in base class
106 void saveCurrentLayer(bool visible) override;
107
108 signals:
109
111 void showCurrentPeaksAs2D();
112
113 public slots:
114
115 // Docu in base class
116 void activateLayer(Size layer_index) override;
117 // Docu in base class
118 void removeLayer(Size layer_index) override;
119 // Docu in base class
120 void updateLayer(Size i) override;
121 // Docu in base class
122 void intensityModeChange_() override;
123
124 protected slots:
125
127 void currentLayerParamtersChanged_();
128
129 protected:
130
131 // Docu in base class
132 bool finishAdding_() override;
133
134 // Reimplementation in order to update the OpenGL widget
135 void update_(const char * caller_name = nullptr) override;
136
138 bool legend_shown_;
139
141 MultiGradient linear_gradient_;
142
143 //docu in base class
144 void translateLeft_(Qt::KeyboardModifiers m) override;
145 //docu in base class
146 void translateRight_(Qt::KeyboardModifiers m) override;
147 //docu in base class
148 void translateForward_() override;
149 //docu in base class
150 void translateBackward_() override;
151 };
152
153 } //namespace
MultiGradient.h
QWidget
OpenMS::Spectrum3DCanvas::ShadeModes
ShadeModes
Different shade modes.
Definition: Spectrum3DCanvas.h:81
OpenMS::Spectrum3DOpenGLCanvas
OpenGL Canvas for 3D-visualization of map data.
Definition: Spectrum3DOpenGLCanvas.h:58
OpenMS::SpectrumCanvas
Base class for visualization canvas classes.
Definition: SpectrumCanvas.h:98
OpenMS::Spectrum3DCanvas::linear_gradient_
MultiGradient linear_gradient_
stores the linear color gradient for non-log modes
Definition: Spectrum3DCanvas.h:141
OpenMS::Spectrum3DCanvas
Canvas for 3D-visualization of peak map data.
Definition: Spectrum3DCanvas.h:66
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
SpectrumCanvas.h
OpenMS::MultiGradient
A gradient of multiple colors and arbitrary distances between colors.
Definition: MultiGradient.h:67
QOpenGLWidget
OpenMS::Spectrum3DCanvas::legend_shown_
bool legend_shown_
whether the legend is shown or not
Definition: Spectrum3DCanvas.h:138
OpenMS::Param
Management and storage of parameters / INI files.
Definition: Param.h:73
OpenMS::Spectrum3DCanvas::openglcanvas_
Spectrum3DOpenGLCanvas * openglcanvas_
pointer to the SpectrumOpenGLCanvas implementation
Definition: Spectrum3DCanvas.h:100
OpenMS::Size
size_t Size
Size type e.g. used as variable which can hold result of size()
Definition: Types.h:127