QCustomDial.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Widgets
File: QCustomDial
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/String.h>
#include <NDEVR/RGBColor.h>
#include <QDial>
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief An icon along with defined behavior describing how that icon should interact with a parent
        QCustomDial object.
    **/
    struct DialIcon
    {
        String image_id;
        QPixmap pixmap;
        QPixmap scaled_pixmap;//used to cache the last scaled pixmap to avoid calling scale again when the size is still at the same
        bool fullsize = false;
        bool rotate = false;
        bool make_shadow = false;
        Angle<fltp08> rotation_offset = Angle<fltp08>(0);
        fltp08 size = 1.0;
        void setImageID(const String& id)
        {
            image_id = id;
            pixmap = QPixmap();
            scaled_pixmap = QPixmap();
        }
    };
    class QCustomLineEdit;
    /**--------------------------------------------------------------------------------------------------
    \brief Provides a rounded range control (like a speedometer or potentiometer).
 
    QCustomDial is used when the user needs to control a value within a program-definable range, 
        and the range either wraps around (for example, with angles measured from 0 to 359 degrees) 
        or the dialog layout needs a square widget.
 
    Contains logic for adding one or more images to the dial that may or may not rotate with the dial.
    **/
    class NDEVR_WIDGETS_API QCustomDial : public QDial
    {
        Q_OBJECT
    public:
        QCustomDial(QWidget* parent = nullptr);
        ~QCustomDial();
 
        //based on the implementation of QLabel::paintEvent
        void paintEvent(QPaintEvent *event) override;
        int heightForWidth(int w) const override { return w; }
        void mouseMoveEvent(QMouseEvent *event) override;
        void mouseReleaseEvent(QMouseEvent *event) override;
        void mousePressEvent(QMouseEvent *event) override;
        void keyPressEvent(QKeyEvent* event) override;
        void wheelEvent(QWheelEvent* e) override;
        void resizeEvent(QResizeEvent *event) override;
        void setIcon(const QPixmap& map, bool show_full_icon, bool rotate_icon);
        void addIcon(const String& icon, bool show_full_icon, bool rotate_icon);
        void addIcon(const DialIcon& icon);
        const Buffer<DialIcon>& icons() const { return m_icons; };
        void setIcons(const Buffer<DialIcon>& icons);
        void clearIcons();
        void setColor(const RGBColor& color);
        bool event(QEvent* event) override;
        QSize sizeHint() const override;
        QSize minimumSizeHint() const override;
        void setGrip(fltp04 grip_size)
        {
            m_grip_size = grip_size;
        }
        void setMaxValue(fltp08 max);
        void setMinValue(fltp08 min);
        void showLineEdit(bool show);
        void tieToLineEdit(QCustomLineEdit* edit, bool is_offset = false);
        QCustomLineEdit* centerLineEdit();
        fltp08 getValue();
    protected slots:
        void onValueChanged();
    public slots:
        void setValue(fltp08 value);
    signals:
        void edited();
    private:
        void _setValue(fltp08 value, bool emit_edit = false);
        void updateCenterLineEditLocation();
        fltp08 pixSize(const DialIcon& icon) const;
        void cacheScaledPixmap(DialIcon& icon);
    private:
        Buffer<DialIcon> m_icons;
        fltp08 m_grip_size;
        QCustomLineEdit* m_center_edit;
 
        fltp08 m_max_value;
        fltp08 m_min_value;
        //key for the currently cached QImage and QPixmap
        //used to make sure the label was not set to another QPixmap
        qint64 cacheKey{ 0 };
        RGBColor m_color;
        bool m_is_editing;
        bool m_has_user_focus;
        void modifyValue(QMouseEvent* event);
    };
}