quantumvortexplotwidget.h

Go to the documentation of this file.

/**
 * @file quantumvortexplotwidget.h
 * @brief Declares the quantumvortexplotwidget visualization component used by QPE.
 * @ingroup qpe_graphics
 *
 * Source: @c graphics/renderer/quantumvortexplotwidget.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/quantumvortex2d.h"
 
#include <QWidget>
 
class QPaintEvent;
 
/**
 * @brief Qt visualization component for Quantum Vortex Plot Widget.
 *
 * The class presents computed state to the user and does not alter the propagated physical state.
 */
class QuantumVortexPlotWidget final : public QWidget
{
public:
    /**
     * @brief Performs quantum vortex plot widget.
     * @param parent Optional Qt parent object/widget.
     */
    explicit QuantumVortexPlotWidget(QWidget *parent = nullptr);
 
    /**
     * @brief Sets data.
     * @param history The history value used by the operation.
     * @param mass The mass value used by the operation.
     * @param hbar The hbar value used by the operation.
     */
    void setData(const qpe::QuantumVortexHistory2D &history,
                 double mass,
                 double hbar);
    /**
     * @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:
    const qpe::QuantumVortexHistory2D *history_ = nullptr;
    double mass_ = 1.0;
    double hbar_ = 1.0;
};