AxisWidget.h

Go to the documentation of this file.

// --------------------------------------------------------------------------
//                   OpenMS -- Open-Source Mass Spectrometry
// --------------------------------------------------------------------------
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
// ETH Zurich, and Freie Universitaet Berlin 2002-2023.
//
// This software is released under a three-clause BSD license:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of any author or any participating institution
//    may be used to endorse or promote products derived from this software
//    without specific prior written permission.
// For a full list of authors, refer to the file AUTHORS.
// --------------------------------------------------------------------------
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
// INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg$
// $Authors: Marc Sturm $
// --------------------------------------------------------------------------
 
#pragma once
 
// OpenMS_GUI config
#include <OpenMS/VISUAL/OpenMS_GUIConfig.h>
 
// QT
#include <QtWidgets>
class QPaintEvent;
 
// OpenMS
#include <OpenMS/CONCEPT/Types.h>
#include <OpenMS/DATASTRUCTURES/String.h>
#include <OpenMS/MATH/MISC/MathFunctions.h>
#include <OpenMS/VISUAL/AxisPainter.h>
 
namespace OpenMS
{
  class OPENMS_GUI_DLLAPI AxisWidget :
    public QWidget
  {
    Q_OBJECT
 
public:
 
    typedef std::vector<std::vector<double> > GridVector;
 
    AxisWidget(const AxisPainter::Alignment alignment, const char * legend = "", QWidget * parent = nullptr);
 
    ~AxisWidget() override;
 
    void setMargin(UInt size);
 
    UInt margin() const;
 
    void showLegend(bool show_legend);
 
    bool isLegendShown() const;
 
    void setLegend(const String & legend);
 
    const String & getLegend() const;
 
    const GridVector & gridLines() const;
 
    void setLogScale(bool is_log);
 
    bool isLogScale() const;
 
    void setInverseOrientation(bool inverse_orientation);
 
    bool hasInverseOrientation() const;
 
    void setAllowShortNumbers(bool short_nums);
 
    double getAxisMinimum() const;
 
    double getAxisMaximum() const;
 
    void paint(QPainter * painter, QPaintEvent * e);
 
public slots:
 
    void setAxisBounds(double min, double max);
 
    void setTickLevel(UInt level);
 
protected:
    GridVector grid_line_;
 
    bool is_log_;
 
    bool show_legend_;
 
    AxisPainter::Alignment alignment_;
 
    bool is_inverse_orientation_;
 
    UInt margin_;
 
    double min_;
 
    double max_;
 
    String legend_;
 
    UInt tick_level_;
 
    bool allow_short_numbers_;
 
    void paintEvent(QPaintEvent *) override;
  };
} // namespace OpenMS