ImageView.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: ImageView
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/QTTools.h>
#include <QWidget>
#include <QStyle>
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief A widget that shows a raster image or icon.
    *-----------------------------------------------------------------------------------------------**/
    class NDEVR_WIDGETS_API ImageView : public QWidget
    {
    public:
        enum ViewMode
        {
              e_keep//no size adjustment
            , e_zoom_in//crop image frame
            , e_zoom_out//Keep entire image in frame
            , e_stretch//stretch image to frame
        };
        ImageView(const String& image, QWidget* parent = nullptr);
        ImageView(QWidget* parent = nullptr);
        ~ImageView();
        void setImageID(const String& image, bool force_refresh = false);
        void setIconID(const String& image, bool force_refresh = false);
        void clearImage();
        void paintEvent(QPaintEvent* event) override;
        void setImage(const QPixmap& pixmap);
        void setAlignment(Qt::Alignment alignment);
        void setSizeHintPixelMetric(QStyle::PixelMetric metric);
        void setSmoothResize(bool smooth_resize)
        {
            m_smooth_transform = smooth_resize;
        }
        void setImage(const QImage& image);
        void setIcon(const QIcon& image, QIcon::Mode mode = QIcon::Mode::Normal);
        void setIconMode(QIcon::Mode mode);
        QSize sizeHint() const override;
        QSize minimumSizeHint() const override
        {
            return QSize(0, 0);
        }
        void setAutoResize(bool auto_resize)
        {
            m_auto_resize = auto_resize;
        }
        void setViewMode(ViewMode mode)
        {
            m_view_mode = mode;
        }
        //0% = no blend, 100%=only blend_image
        void setBlendFactor(fltp04 blend_factor);
        void setBlendImage(const QPixmap& blend_image);
        void resizeEvent(QResizeEvent* resize_event) override;
        void setImageScale(fltp08 scale)
        {
            m_icon_scale = scale;
        }
        void setIgnoreDPR(bool ignore);
        void setForceAspectRatioH(bool force);
        void setForceAspectRatioW(bool force);
        QIcon icon() { return m_icon; };
    private:
        void setupIconListener();
        QRect alignRect(QSize size, QSize preferred_size) const;
    private:
        ViewMode m_view_mode = ViewMode::e_zoom_out;
        bool m_auto_resize = true;
        bool m_smooth_transform = true;
        bool m_force_aspect_ratio_width = false;
        bool m_force_aspect_ratio_height = false;
        bool m_ignore_device_pixel_ratio = false;
        fltp08 m_icon_scale;
        fltp04 m_blend_factor;
        QPixmap m_image;
        QPixmap m_blend_image;
        QIcon m_icon;
        String m_image_path;
        String m_icon_path;
        QIcon::Mode m_icon_mode;
        QStyle::PixelMetric m_size_hint_pixel_metric;
        Qt::Alignment m_alignment;
        QTResourceListener* m_theme_listener;
    };
 
    
}