quantumboundstateplotwidget.h

Go to the documentation of this file.

/**
 * @file quantumboundstateplotwidget.h
 * @brief Declares the quantumboundstateplotwidget visualization component used by QPE.
 * @ingroup qpe_graphics
 *
 * Source: @c graphics/renderer/quantumboundstateplotwidget.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 "core/quantum/boundstates1d.h"
 
#include <QWidget>
 
class QPaintEvent;
 
/**
 * @brief Qt visualization component for Quantum Bound State Plot Widget.
 *
 * The class presents computed state to the user and does not alter the propagated physical state.
 */
class QuantumBoundStatePlotWidget final : public QWidget
{
public:
    /**
     * @brief Performs quantum bound state plot widget.
     * @param parent Optional Qt parent object/widget.
     */
    explicit QuantumBoundStatePlotWidget(QWidget *parent = nullptr);
 
    /**
     * @brief Sets spectrum.
     * @param spectrum The spectrum value used by the operation.
     * @param selectedStateIndex Zero-based index used to select the requested item.
     */
    void setSpectrum(const qpe::BoundStateSpectrum1D &spectrum, int selectedStateIndex);
    /**
     * @brief Clears spectrum.
     */
    void clearSpectrum();
 
    /**
     * @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::BoundStateSpectrum1D spectrum_;
    int selectedStateIndex_ = -1;
};