WGShadeSlider.cpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2020 Mathias Wein <lynx.mw+kde@gmail.com>
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 */
 
#include "WGShadeSlider.h"
 
#include "KoColorDisplayRendererInterface.h"
 
#include <QImage>
#include <QMouseEvent>
#include <QPainter>
#include <QVector4D>
#include <QtMath>
 
struct WGShadeSlider::Private
{
    Private() {}
    QImage background;
    QVector4D range;
    QVector4D offset;
    QVector4D baseValues;
    qreal handleValue {0};
    qreal leftStart {-1};
    qreal leftEnd {0};
    qreal rightStart {0};
    qreal rightEnd {-1};
    KisVisualColorModelSP selectorModel;
    WGSelectorDisplayConfigSP displayConfig;
    int cursorWidth {11};
    int lineWidth {1};
    int numPatches {9};
    bool widgetSizeOk {false};
    bool sliderMode {true};
    bool imageNeedsUpdate {true};
};
 
WGShadeSlider::WGShadeSlider(WGSelectorDisplayConfigSP config, QWidget *parent, KisVisualColorModelSP model)
    : QWidget(parent)
    , m_d(new Private)
{
    m_d->selectorModel = model;
    m_d->displayConfig = config;
    recalculateParameters();
    connect(config.data(), &WGSelectorDisplayConfig::sigDisplayConfigurationChanged,
            this, &WGShadeSlider::slotDisplayConfigurationChanged);
}
 
WGShadeSlider::~WGShadeSlider()
{}
 
void WGShadeSlider::setGradient(const QVector4D &range, const QVector4D &offset)
{
    m_d->range = range;
    m_d->offset = offset;
    m_d->imageNeedsUpdate = true;
    resetHandle();
}
 
void WGShadeSlider::setDisplayMode(bool slider, int numPatches)
{
    if (slider != m_d->sliderMode ||
        (!slider && numPatches != m_d->numPatches)) {
        m_d->sliderMode = slider;
        if (!slider && numPatches > 2) {
            m_d->numPatches = numPatches;
        }
        m_d->widgetSizeOk = sizeRequirementsMet();
        m_d->imageNeedsUpdate = true;
        resetHandle();
    }
}
 
void WGShadeSlider::setModel(KisVisualColorModelSP model)
{
    m_d->selectorModel = model;
    m_d->imageNeedsUpdate = true;
    update();
}
 
QVector4D WGShadeSlider::channelValues() const
{
    return calculateChannelValues(m_d->handleValue);
}
 
const QImage *WGShadeSlider::background()
{
    if (m_d->imageNeedsUpdate) {
        m_d->background = renderBackground();
        m_d->imageNeedsUpdate = false;
    }
    return &m_d->background;
}
 
QSize WGShadeSlider::minimumSizeHint() const
{
    return QSize(50, 8);
}
 
void WGShadeSlider::mousePressEvent(QMouseEvent *event)
{
    if (event->button() == Qt::LeftButton) {
        Q_EMIT sigInteraction(true);
        if (adjustHandleValue(event->localPos())) {
            Q_EMIT sigChannelValuesChanged(channelValues());
            update();
        }
    } else {
        event->ignore();
    }
}
 
void WGShadeSlider::mouseMoveEvent(QMouseEvent *event)
{
    if (event->buttons() & Qt::LeftButton) {
        if (adjustHandleValue(event->localPos())) {
            Q_EMIT sigChannelValuesChanged(channelValues());
            update();
        }
    } else {
        event->ignore();
    }
}
 
void WGShadeSlider::mouseReleaseEvent(QMouseEvent *event)
{
    if (event->button() == Qt::LeftButton) {
        Q_EMIT sigInteraction(false);
    } else {
        event->ignore();
    }
}
 
void WGShadeSlider::paintEvent(QPaintEvent*)
{
    if (m_d->imageNeedsUpdate) {
        m_d->background = renderBackground();
        m_d->imageNeedsUpdate = false;
    }
    QPainter painter(this);
    painter.drawImage(0, 0, m_d->background);
    painter.scale(1.0/devicePixelRatioF(), 1.0/devicePixelRatioF());
    QRectF handleRect;
    if (m_d->sliderMode) {
        QPointF sliderPos = convertSliderValueToWidgetCoordinate(m_d->handleValue);
        int sliderX = qRound(sliderPos.x());
        handleRect = QRectF(sliderX - m_d->cursorWidth/2, 0, m_d->cursorWidth, height());
    } else if (m_d->handleValue >= 0) {
        handleRect = patchRect(m_d->handleValue);
    }
    if (handleRect.isValid()) {
        QPen pen(QColor(175,175,175), m_d->lineWidth, Qt::SolidLine, Qt::SquareCap, Qt::MiterJoin);
        painter.setPen(pen);
        strokeRect(painter, handleRect, devicePixelRatioF(), 0);
        pen.setColor(QColor(75,75,75));
        painter.setPen(pen);
        strokeRect(painter, handleRect, devicePixelRatioF(), 1);
    }
}
 
void WGShadeSlider::resizeEvent(QResizeEvent *)
{
    recalculateParameters();
}
 
void WGShadeSlider::slotSetChannelValues(const QVector4D &values)
{
    m_d->baseValues = values;
    m_d->imageNeedsUpdate = true;
    resetHandle();
}
 
void WGShadeSlider::resetHandle()
{
    m_d->handleValue = m_d->sliderMode ? 0 : -1;
    update();
}
 
void WGShadeSlider::slotDisplayConfigurationChanged()
{
    m_d->imageNeedsUpdate = true;
    update();
}
 
bool WGShadeSlider::adjustHandleValue(const QPointF &widgetPos)
{
    if (!m_d->widgetSizeOk) {
        return false;
    }
 
    if (m_d->sliderMode) {
        qreal sliderPos = convertWidgetCoordinateToSliderValue(widgetPos);
        if (!qFuzzyIsNull(m_d->handleValue - sliderPos)) {
            m_d->handleValue = sliderPos;
            return true;
        }
    } else {
        int patchNum = getPatch(widgetPos);
        if (patchNum >= 0 && patchNum != (int)m_d->handleValue) {
            m_d->handleValue = patchNum;
            return true;
        }
    }
    return false;
}
 
QPointF WGShadeSlider::convertSliderValueToWidgetCoordinate(qreal value)
{
    QPointF pos(0.0, 0.0);
    if (value < 0) {
        pos.setX(m_d->leftStart - value * (m_d->leftEnd - m_d->leftStart));
    }
    else if (value > 0) {
        pos.setX(m_d->rightStart + value * (m_d->rightEnd - m_d->rightStart));
    }
    else {
        pos.setX((width() - 1) / 2);
    }
    return pos;
}
 
qreal WGShadeSlider::convertWidgetCoordinateToSliderValue(QPointF coordinate)
{
    qreal x = coordinate.x();
    if (x < m_d->leftEnd) {
        return -1.0;
    }
    else if (x < m_d->leftStart) {
        return  (m_d->leftStart - x) / (m_d->leftEnd - m_d->leftStart);
    }
    else if (x < m_d->rightStart) {
        return 0.0;
    }
    else if (x < m_d->rightEnd) {
        return (x - m_d->rightStart) / (m_d->rightEnd - m_d->rightStart);
    }
    return 1.0;
}
 
QVector4D WGShadeSlider::calculateChannelValues(qreal sliderPos) const
{
    float delta = 0.0f;
    if (m_d->sliderMode) {
        delta = (float)sliderPos;
    } else if (sliderPos >= 0 || m_d->numPatches > 1) {
        delta = 2.0f * float(sliderPos)/(m_d->numPatches - 1.0f) - 1.0f;
    }
 
    QVector4D channelVec = m_d->baseValues + m_d->offset + delta * m_d->range;
    // Hue wraps around
    if (m_d->selectorModel->isHSXModel()) {
        channelVec[0] = (float)fmod(channelVec[0], 1.0);
        if (channelVec[0] < 0) {
            channelVec[0] += 1.f;
        }
    }
    else {
        channelVec[0] = qBound(0.f, channelVec[0], 1.f);
    }
 
    for (int i = 1; i < 3; i++) {
        channelVec[i] = qBound(0.f, channelVec[i], 1.f);
    }
    return channelVec;
}
 
int WGShadeSlider::getPatch(const QPointF pos) const
{
    int patch = m_d->numPatches * pos.x() / width();
    if (patch >= 0 && patch < m_d->numPatches) {
        return patch;
    }
    return -1;
}
 
QRectF WGShadeSlider::patchRect(int index) const
{
    qreal patchWidth = width() / qreal(m_d->numPatches);
    qreal margin = 1.5;
    QPointF topLeft(index * patchWidth + margin, 0);
    QPointF bottomRight((index+1) * patchWidth - margin, height());
    return QRectF(topLeft, bottomRight);
}
 
void WGShadeSlider::recalculateParameters()
{
    int center = (width() - 1) / 2;
    int halfCursor = m_d->cursorWidth / 2;
 
    m_d->leftEnd = halfCursor;
    m_d->leftStart = center - halfCursor;
 
    m_d->rightStart = center + halfCursor;
    m_d->rightEnd = 2 * center  - halfCursor;
 
    m_d->lineWidth = qRound(devicePixelRatioF() - 0.1);
    m_d->widgetSizeOk = sizeRequirementsMet();
    m_d->imageNeedsUpdate = true;
}
 
bool WGShadeSlider::sizeRequirementsMet() const
{
    if (m_d->sliderMode) {
        return m_d->leftStart - m_d->leftEnd > 0 &&  m_d->rightEnd - m_d->rightStart > 0;
    } else {
        return width() > m_d->numPatches;
    }
}
 
QImage WGShadeSlider::renderBackground()
{
    if (!m_d->widgetSizeOk || !m_d->selectorModel || !m_d->selectorModel->colorSpace()) {
        return QImage();
    }
 
    // Hi-DPI aware rendering requires that we determine the device pixel dimension;
    // actual widget size in device pixels is not accessible unfortunately, it might be 1px smaller...
    const qreal deviceDivider = 1.0 / devicePixelRatioF();
    const int deviceWidth = qCeil(width() * devicePixelRatioF());
    const int deviceHeight = qCeil(height() * devicePixelRatioF());
    if (m_d->sliderMode) {
        const KoColorSpace *currentCS = m_d->selectorModel->colorSpace();
        const quint32 pixelSize = currentCS->pixelSize();
        quint32 imageSize = deviceWidth * pixelSize;
        QScopedArrayPointer<quint8> raw(new quint8[imageSize] {});
        quint8 *dataPtr = raw.data();
 
        for (int x = 0; x < deviceWidth; x++, dataPtr += pixelSize) {
            qreal sliderVal = convertWidgetCoordinateToSliderValue(QPointF(x, 0) * deviceDivider);
            QVector4D coordinates = calculateChannelValues(sliderVal);
            KoColor c = m_d->selectorModel->convertChannelValuesToKoColor(coordinates);
            memcpy(dataPtr, c.data(), pixelSize);
        }
 
        QImage image = m_d->displayConfig->displayConverter()->toQImage(currentCS, raw.data(), {deviceWidth, 1},
                                                                        m_d->displayConfig->previewInPaintingCS());
        image = image.scaled(QSize(deviceWidth, deviceHeight));
 
        QPainter painter(&image);
        QPen pen(QColor(175,175,175), m_d->lineWidth, Qt::SolidLine, Qt::SquareCap, Qt::MiterJoin);
        painter.setPen(pen);
        strokeRect(painter, QRectF(m_d->leftStart, 0, m_d->cursorWidth, height()), devicePixelRatioF(), 0);
        pen.setColor(QColor(75,75,75));
        painter.setPen(pen);
        strokeRect(painter, QRectF(m_d->leftStart, 0, m_d->cursorWidth, height()), devicePixelRatioF(), 1);
 
        image.setDevicePixelRatio(devicePixelRatioF());
        return image;
    } else {
        QImage image(deviceWidth, deviceHeight, QImage::Format_ARGB32);
        image.fill(Qt::transparent);
        image.setDevicePixelRatio(devicePixelRatioF());
        QPainter painter(&image);
        painter.setPen(Qt::NoPen);
 
        for (int i = 0; i < m_d->numPatches; i++) {
            QVector4D values = calculateChannelValues(i);
            KoColor col = m_d->selectorModel->convertChannelValuesToKoColor(values);
            QColor qCol = m_d->displayConfig->displayConverter()->toQColor(col, m_d->displayConfig->previewInPaintingCS());
            painter.setBrush(qCol);
            painter.drawRect(patchRect(i));
        }
        return image;
    }
}
 
void WGShadeSlider::strokeRect(QPainter &painter, const QRectF &rect, qreal pixelSize, qreal shrinkX)
{
    qreal lineWidth = painter.pen().widthF();
    QPointF topLeft(qRound(rect.left() * pixelSize) + (shrinkX + 0.5) * lineWidth,
                    qRound(rect.top() * pixelSize) + 0.5 * lineWidth);
    QPointF bottomRight(qRound(rect.right() * pixelSize) - (shrinkX + 0.5) * lineWidth,
                        qRound(rect.bottom() * pixelSize) - 0.5 * lineWidth);
    painter.drawRect(QRectF(topLeft, bottomRight));
}