OverviewWidget Class Reference

#include <overviewwidget.h>

Inheritance diagram for OverviewWidget:

Public Slots
void	slotThemeChanged ()
void	startUpdateCanvasProjection ()
void	updateThumbnail (QImage pixmap)

Signals
void	signalDraggingFinished ()
void	signalDraggingStarted ()

Public Member Functions
bool	isDragging () const
	OverviewWidget (QWidget *parent=0)
void	setCanvas (KisCanvas2 *canvas) override
	~OverviewWidget () override
Public Member Functions inherited from KisWidgetWithIdleTask< QWidget >
void	hideEvent (QHideEvent *event) override
	KisWidgetWithIdleTask (QWidget *parent=0, Qt::WindowFlags flags=Qt::WindowFlags())
void	showEvent (QShowEvent *event) override
void	triggerCacheUpdate ()
	~KisWidgetWithIdleTask () override=default

Protected Member Functions
void	mouseMoveEvent (QMouseEvent *event) override
void	mousePressEvent (QMouseEvent *event) override
void	mouseReleaseEvent (QMouseEvent *event) override
void	paintEvent (QPaintEvent *event) override
void	resizeEvent (QResizeEvent *event) override
void	wheelEvent (QWheelEvent *event) override

Private Member Functions
QPointF	calculatePreviewOrigin (QSize previewSize)
QTransform	canvasToPreviewTransform ()
void	clearCachedState () override
bool	isPixelArt ()
	isPixelArt checks if the preview is bigger than the image itself
QPolygonF	previewPolygon ()
QTransform	previewToCanvasTransform ()
void	recalculatePreviewDimensions ()
KisIdleTasksManager::TaskGuard	registerIdleTask (KisCanvas2 *canvas) override

Private Attributes
bool	m_dragging {false}
QPointF	m_lastPos {QPointF(0, 0)}
QPixmap	m_oldPixmap
QColor	m_outlineColor
QPixmap	m_pixmap
QPointF	m_previewOrigin
qreal	m_previewScale {1.0}
QSize	m_previewSize {QSize(100, 100)}

Additional Inherited Members
Protected Attributes inherited from KisWidgetWithIdleTask< QWidget >
KisCanvas2 *	m_canvas
KisIdleTasksManager::TaskGuard	m_idleTaskGuard
bool	m_isVisibleState

Detailed Description

Definition at line 22 of file overviewwidget.h.

Constructor & Destructor Documentation

OverviewWidget()

OverviewWidget::OverviewWidget

(

QWidget *

parent = 0

)

Definition at line 30 of file overviewwidget.cc.

    : KisWidgetWithIdleTask<QWidget>(parent)
    , m_dragging(false)
{
    setMouseTracking(true);
    // No context menu here. Setting this avoids long-presses from delaying
    // inputs or dismissing the palette, see KisLongPressEventFilter.cpp.
    setContextMenuPolicy(Qt::PreventContextMenu);
    KisConfig cfg(true);
    slotThemeChanged();
    recalculatePreviewDimensions();
}

References recalculatePreviewDimensions(), and slotThemeChanged().

~OverviewWidget()

OverviewWidget::~OverviewWidget ( )

override

Definition at line 43 of file overviewwidget.cc.

{
}

Member Function Documentation

calculatePreviewOrigin()

QPointF OverviewWidget::calculatePreviewOrigin ( QSize previewSize )

private

Definition at line 115 of file overviewwidget.cc.

{
    return QPointF((width() - previewSize.width()) / 2.0f, (height() - previewSize.height()) / 2.0f);
}

canvasToPreviewTransform()

QTransform OverviewWidget::canvasToPreviewTransform ( )

private

Definition at line 139 of file overviewwidget.cc.

{
    return previewToCanvasTransform().inverted();
}

References previewToCanvasTransform().

clearCachedState()

void OverviewWidget::clearCachedState ( )

overrideprivatevirtual

Implements KisWidgetWithIdleTask< QWidget >.

Definition at line 104 of file overviewwidget.cc.

{
    m_pixmap = QPixmap();
    m_oldPixmap = QPixmap();
}

References m_oldPixmap, and m_pixmap.

isDragging()

bool OverviewWidget::isDragging ( ) const

inline

Definition at line 33 of file overviewwidget.h.

    {
        return m_dragging;
    }

References m_dragging.

isPixelArt()

bool OverviewWidget::isPixelArt ( )

private

isPixelArt checks if the preview is bigger than the image itself

We assume that if the preview is bigger than the image itself, (1) the image is very small, (might not be true if the docker is huge and the user is on 4k display...) (2) the image is pixel art, so they would like to see pixels. In that case we'd like to use a different algorithm (Nearest Neighbour, called "Box") in the OverviewThumbnailStrokeStrategy.

Returns

Definition at line 110 of file overviewwidget.cc.

{
    return m_previewScale > 1;
}

References m_previewScale.

mouseMoveEvent()

void OverviewWidget::mouseMoveEvent ( QMouseEvent * event )

overrideprotected

Definition at line 180 of file overviewwidget.cc.

{
    if (m_dragging) {
        QPointF previewPos = event->pos();
        const QPointF lastCanvasPos = previewToCanvasTransform().map(m_lastPos);
        const QPointF newCanvasPos = previewToCanvasTransform().map(event->pos());
 
        QPointF diff = newCanvasPos - lastCanvasPos;
        m_canvas->canvasController()->pan(diff.toPoint());
        m_lastPos = previewPos;
    }
    event->accept();
}

References KoCanvasBase::canvasController(), KisWidgetWithIdleTask< QWidget >::m_canvas, m_dragging, m_lastPos, KoCanvasController::pan(), and previewToCanvasTransform().

mousePressEvent()

void OverviewWidget::mousePressEvent ( QMouseEvent * event )

overrideprotected

Definition at line 161 of file overviewwidget.cc.

{
    if (m_canvas) {
        QPointF previewPos = event->pos();
 
        if (!previewPolygon().containsPoint(previewPos, Qt::WindingFill)) {
            const QRect& canvasRect = m_canvas->canvasWidget()->rect();
            const QPointF newCanvasPos = previewToCanvasTransform().map(previewPos) -
                    QPointF(canvasRect.width() / 2.0f, canvasRect.height() / 2.0f);
            m_canvas->canvasController()->pan(newCanvasPos.toPoint());
        }
        m_lastPos = previewPos;
        m_dragging = true;
        Q_EMIT signalDraggingStarted();
    }
    event->accept();
    update();
}

References KoCanvasBase::canvasController(), KisCanvas2::canvasWidget, KisWidgetWithIdleTask< QWidget >::m_canvas, m_dragging, m_lastPos, KoCanvasController::pan(), previewPolygon(), previewToCanvasTransform(), and signalDraggingStarted().

mouseReleaseEvent()

void OverviewWidget::mouseReleaseEvent ( QMouseEvent * event )

overrideprotected

Definition at line 194 of file overviewwidget.cc.

{
    if (m_dragging) {
        m_dragging = false;
        Q_EMIT signalDraggingFinished();
    }
    event->accept();
    update();
}

References m_dragging, and signalDraggingFinished().

paintEvent()

void OverviewWidget::paintEvent ( QPaintEvent * event )

overrideprotected

Definition at line 228 of file overviewwidget.cc.

{
    QWidget::paintEvent(event);
 
    if (m_canvas) {
        recalculatePreviewDimensions();
        QPainter p(this);
 
        const QRectF previewRect = QRectF(m_previewOrigin, m_previewSize);
        p.drawPixmap(previewRect.toRect(), m_pixmap);
 
        QRect r = rect();
        QPolygonF outline;
        outline << r.topLeft() << r.topRight() << r.bottomRight() << r.bottomLeft();
 
        QPen pen;
        pen.setColor(m_outlineColor);
        pen.setStyle(Qt::DashLine);
 
        p.setPen(pen);
        p.drawPolygon(outline.intersected(previewPolygon()));
 
        pen.setStyle(Qt::SolidLine);
        p.setPen(pen);
        p.drawPolygon(previewPolygon());
 
    }
}

References KisWidgetWithIdleTask< QWidget >::m_canvas, m_outlineColor, m_pixmap, m_previewOrigin, m_previewSize, p, previewPolygon(), and recalculatePreviewDimensions().

previewPolygon()

QPolygonF OverviewWidget::previewPolygon ( )

private

Definition at line 120 of file overviewwidget.cc.

{
    if (m_canvas) {
        const QRectF &canvasRect = QRectF(m_canvas->canvasWidget()->rect());
        return canvasToPreviewTransform().map(canvasRect);
    }
    return QPolygonF();
}

References canvasToPreviewTransform(), KisCanvas2::canvasWidget, and KisWidgetWithIdleTask< QWidget >::m_canvas.

previewToCanvasTransform()

QTransform OverviewWidget::previewToCanvasTransform ( )

private

Definition at line 129 of file overviewwidget.cc.

{
    QTransform previewToImage =
            QTransform::fromTranslate(-this->width() / 2.0, -this->height() / 2.0) *
            QTransform::fromScale(1.0 / m_previewScale, 1.0 / m_previewScale) *
            QTransform::fromTranslate(m_canvas->image()->width() / 2.0, m_canvas->image()->height() / 2.0);
 
    return previewToImage * m_canvas->coordinatesConverter()->imageToWidgetTransform();
}

References KisCanvas2::coordinatesConverter, KisImage::height(), KisCanvas2::image(), KisCoordinatesConverter::imageToWidgetTransform(), KisWidgetWithIdleTask< QWidget >::m_canvas, m_previewScale, and KisImage::width().

recalculatePreviewDimensions()

void OverviewWidget::recalculatePreviewDimensions ( )

private

Definition at line 63 of file overviewwidget.cc.

{
    if (!m_canvas || !m_canvas->image()) {
        return;
    }
 
    QSize imageSize(m_canvas->image()->bounds().size());
 
    const qreal hScale = 1.0 * this->width() / imageSize.width();
    const qreal vScale = 1.0 * this->height() / imageSize.height();
 
    m_previewScale = qMin(hScale, vScale);
    m_previewSize = imageSize * m_previewScale;
    m_previewOrigin = calculatePreviewOrigin(m_previewSize);
 
}

References KisImage::bounds(), calculatePreviewOrigin(), KisCanvas2::image(), KisWidgetWithIdleTask< QWidget >::m_canvas, m_previewOrigin, m_previewScale, and m_previewSize.

registerIdleTask()

KisIdleTasksManager::TaskGuard OverviewWidget::registerIdleTask ( KisCanvas2 * canvas )

overrideprivatevirtual

Implements KisWidgetWithIdleTask< QWidget >.

Definition at line 80 of file overviewwidget.cc.

{
    return
        canvas->viewManager()->idleTasksManager()->
        addIdleTaskWithGuard([this](KisImageSP image) {
            const KisDisplayConfig config = m_canvas->displayColorConverter()->displayConfig();
 
            // If the widget is presented on a device with a pixel ratio > 1.0, we must compensate for it
            // by increasing the thumbnail's resolution. Otherwise it will appear blurry.
            QSize thumbnailSize = m_previewSize * devicePixelRatioF();
 
            if ((thumbnailSize.width() > image->width()) || (thumbnailSize.height() > image->height())) {
                thumbnailSize.scale(image->size(), Qt::KeepAspectRatio);
            }
 
            KisImageThumbnailStrokeStrategy *strategy =
                new KisImageThumbnailStrokeStrategy(image->projection(), image->bounds(), thumbnailSize, isPixelArt(), config.profile, config.intent, config.conversionFlags);
 
            connect(strategy, SIGNAL(thumbnailUpdated(QImage)), this, SLOT(updateThumbnail(QImage)));
 
            return strategy;
        });
}

References KisImage::bounds(), KisDisplayConfig::conversionFlags, KisCanvas2::displayColorConverter, KisImage::height(), KisViewManager::idleTasksManager(), KisDisplayConfig::intent, isPixelArt(), KisWidgetWithIdleTask< QWidget >::m_canvas, m_previewSize, KisDisplayConfig::profile, KisImage::projection(), KisImage::size(), updateThumbnail(), KisCanvas2::viewManager(), and KisImage::width().

resizeEvent()

void OverviewWidget::resizeEvent ( QResizeEvent * event )

overrideprotected

Definition at line 149 of file overviewwidget.cc.

{
    Q_UNUSED(event);
    if (m_canvas) {
        if (!m_oldPixmap.isNull()) {
            recalculatePreviewDimensions();
            m_pixmap = m_oldPixmap.scaled(m_previewSize, Qt::KeepAspectRatio, Qt::FastTransformation);
        }
        triggerCacheUpdate();
    }
}

References KisWidgetWithIdleTask< QWidget >::m_canvas, m_oldPixmap, m_pixmap, m_previewSize, recalculatePreviewDimensions(), and KisWidgetWithIdleTask< QWidget >::triggerCacheUpdate().

setCanvas()

void OverviewWidget::setCanvas ( KisCanvas2 * canvas )

overridevirtual

Reimplemented from KisWidgetWithIdleTask< QWidget >.

Definition at line 47 of file overviewwidget.cc.

{
    if (m_canvas) {
        m_canvas->image()->disconnect(this);
        m_canvas->displayColorConverter()->disconnect(this);
    }
 
    KisWidgetWithIdleTask<QWidget>::setCanvas(canvas);
 
    if (m_canvas) {
        connect(m_canvas->displayColorConverter(), SIGNAL(displayConfigurationChanged()), SLOT(startUpdateCanvasProjection()));
        connect(m_canvas->canvasController()->proxyObject, SIGNAL(canvasStateChanged()), this, SLOT(update()), Qt::UniqueConnection);
        connect(m_canvas->viewManager()->mainWindow(), SIGNAL(themeChanged()), this, SLOT(slotThemeChanged()), Qt::UniqueConnection);
    }
}

References KoCanvasBase::canvasController(), KisCanvas2::displayColorConverter, KisCanvas2::image(), KisWidgetWithIdleTask< QWidget >::m_canvas, KisViewManager::mainWindow(), KoCanvasController::proxyObject, KisWidgetWithIdleTask< BaseWidget >::setCanvas(), slotThemeChanged(), startUpdateCanvasProjection(), and KisCanvas2::viewManager().

signalDraggingFinished

void OverviewWidget::signalDraggingFinished ( )

signal

signalDraggingStarted

void OverviewWidget::signalDraggingStarted ( )

signal

slotThemeChanged

void OverviewWidget::slotThemeChanged ( )

slot

Definition at line 222 of file overviewwidget.cc.

{
    m_outlineColor = qApp->palette().color(QPalette::Highlight);
}

References m_outlineColor.

startUpdateCanvasProjection

void OverviewWidget::startUpdateCanvasProjection ( )

slot

Definition at line 144 of file overviewwidget.cc.

{
    triggerCacheUpdate();
}

References KisWidgetWithIdleTask< QWidget >::triggerCacheUpdate().

updateThumbnail

void OverviewWidget::updateThumbnail ( QImage pixmap )

slot

Definition at line 215 of file overviewwidget.cc.

{
    m_pixmap = QPixmap::fromImage(pixmap);
    m_oldPixmap = m_pixmap.copy();
    update();
}

References m_oldPixmap, and m_pixmap.

wheelEvent()

void OverviewWidget::wheelEvent ( QWheelEvent * event )

overrideprotected

Definition at line 204 of file overviewwidget.cc.

{
    if (m_canvas) {
        if (event->angleDelta().y() > 0) {
            m_canvas->canvasController()->zoomIn();
        } else {
            m_canvas->canvasController()->zoomOut();
        }
    }
}

References KoCanvasBase::canvasController(), KisWidgetWithIdleTask< QWidget >::m_canvas, KoCanvasController::zoomIn(), and KoCanvasController::zoomOut().

Member Data Documentation

m_dragging

bool OverviewWidget::m_dragging {false}

private

Definition at line 85 of file overviewwidget.h.

{false};

m_lastPos

QPointF OverviewWidget::m_lastPos {QPointF(0, 0)}

private

Definition at line 86 of file overviewwidget.h.

{QPointF(0, 0)};

m_oldPixmap

QPixmap OverviewWidget::m_oldPixmap

private

Definition at line 79 of file overviewwidget.h.

m_outlineColor

QColor OverviewWidget::m_outlineColor

private

Definition at line 88 of file overviewwidget.h.

m_pixmap

QPixmap OverviewWidget::m_pixmap

private

Definition at line 80 of file overviewwidget.h.

m_previewOrigin

QPointF OverviewWidget::m_previewOrigin

private

Definition at line 82 of file overviewwidget.h.

m_previewScale

qreal OverviewWidget::m_previewScale {1.0}

private

Definition at line 78 of file overviewwidget.h.

{1.0};

m_previewSize

QSize OverviewWidget::m_previewSize {QSize(100, 100)}

private

Definition at line 83 of file overviewwidget.h.

{QSize(100, 100)};

---

The documentation for this class was generated from the following files:

• plugins/dockers/overview/overviewwidget.h
• plugins/dockers/overview/overviewwidget.cc