quantumkleinheightscanplotwidget.h

Go to the documentation of this file.

/**
 * @file quantumkleinheightscanplotwidget.h
 * @brief Declares the quantumkleinheightscanplotwidget visualization component used by QPE.
 * @ingroup qpe_graphics
 *
 * Source: @c graphics/renderer/quantumkleinheightscanplotwidget.h. This file is part of Quantum Phenomena Explorer (QPE),
 * maintained by Officina Turini. See LICENSE_IT.txt / LICENSE.txt for the
 * QPE freeware source-available terms and THIRD_PARTY_NOTICES.txt for
 * third-party components.
 */
 
#pragma once
 
#include <QWidget>
#include "core/quantum/quantumkleinheightscan2d.h"
 
/**
 * @brief Qt visualization component for Quantum Klein Height Scan Plot Widget.
 *
 * The class presents computed state to the user and does not alter the propagated physical state.
 */
class QuantumKleinHeightScanPlotWidget : public QWidget
{
public:
    /**
     * @brief Performs quantum klein height scan plot widget.
     * @param parent Optional Qt parent object/widget.
     */
    explicit QuantumKleinHeightScanPlotWidget(QWidget *parent = nullptr);
    /**
     * @brief Sets data.
     * @param scan The scan value used by the operation.
     * @param currentBarrierHeight The current barrier height value used by the operation.
     * @param packetTransmission The packet transmission value used by the operation.
     */
    void setData(const qpe::QuantumKleinHeightScan2DResult &scan,
                 double currentBarrierHeight,
                 double packetTransmission = -1.0);
    /**
     * @brief Performs clear.
     */
    void clear();
    /**
     * @brief Performs minimum size hint.
     */
    QSize minimumSizeHint() const override;
 
protected:
    /**
     * @brief Paints event.
     * @param event Qt event being handled.
     */
    void paintEvent(QPaintEvent *event) override;
 
private:
    qpe::QuantumKleinHeightScan2DResult scan_;
    double currentBarrierHeight_ = 0.0;
    double packetTransmission_ = -1.0;
};