OpenMS
Plot3DWidget.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: Cornelia Friedle $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
37 // OpenMS_GUI config
38 #include <OpenMS/VISUAL/OpenMS_GUIConfig.h>
39 
42 
43 namespace OpenMS
44 {
45  class Plot3DCanvas;
53  class OPENMS_GUI_DLLAPI Plot3DWidget :
54  public PlotWidget
55  {
56  Q_OBJECT
57 
58 public:
60  Plot3DWidget(const Param & preferences, QWidget * parent = nullptr);
61 
63  ~Plot3DWidget() override;
64 
65  // docu in base class
66  Plot3DCanvas* canvas() const override
67  {
68  return static_cast<Plot3DCanvas*>(canvas_);
69  }
70 
71  // Docu in base class
72  void setMapper(const DimMapper<2>& /*mapper*/) override
73  { // 3D widget currently only handles MSExperiment. That's it.
74  throw Exception::NotImplemented(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION);
75  }
76 
77  // Docu in base class
78  void recalculateAxes_() override;
79 
80  //docu in base class
81  bool isLegendShown() const override;
82  //docu in base class
83  void showLegend(bool show) override;
84 
85 signals:
88 
89 public slots:
90  // Docu in base class
91  void showGoToDialog() override;
92  };
93 
94 } //namespace
95 
Not implemented exception.
Definition: Exception.h:430
Management and storage of parameters / INI files.
Definition: Param.h:70
Canvas for 3D-visualization of peak map data.
Definition: Plot3DCanvas.h:68
Widget for 3D-visualization of map data.
Definition: Plot3DWidget.h:55
void recalculateAxes_() override
recalculates the Axis ticks
~Plot3DWidget() override
Destructor.
void showCurrentPeaksAs2D()
Requests to display all spectra in 2D plot.
void setMapper(const DimMapper< 2 > &) override
Set a new mapper for the canvas and axis. Internally, all dependent components are updated (e....
Definition: Plot3DWidget.h:72
bool isLegendShown() const override
Returns if the axis labels are shown.
void showGoToDialog() override
Plot3DCanvas * canvas() const override
Returns a pointer to canvas object.
Definition: Plot3DWidget.h:66
void showLegend(bool show) override
Shows/hides axis labels.
Plot3DWidget(const Param &preferences, QWidget *parent=nullptr)
Constructor.
Base class for spectrum widgets.
Definition: PlotWidget.h:83
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:48