kis_shape_layer_canvas.cpp

Go to the documentation of this file.

/*
 *  SPDX-FileCopyrightText: 2007 Boudewijn Rempt <boud@valdyas.org>
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 */
 
#include "kis_shape_layer_canvas.h"
 
#include <QPainter>
#include <QMutexLocker>
 
#include <KoShapeManager.h>
#include <KoSelectedShapesProxySimple.h>
#include <KoViewConverter.h>
#include <KoColorSpace.h>
 
#include <kis_paint_device.h>
#include <kis_image.h>
#include <kis_layer.h>
#include <kis_painter.h>
#include <flake/kis_shape_layer.h>
#include <KoCompositeOpRegistry.h>
#include <KoSelection.h>
#include <KoUnit.h>
#include "kis_image_view_converter.h"
 
#include <kis_debug.h>
 
#include <QThread>
#include <QApplication>
 
#include <kis_spontaneous_job.h>
#include "kis_global.h"
#include "krita_utils.h"
#include "kis_image_view_converter.h"
#include "kis_default_bounds.h"
#include "kis_do_something_command.h"
 
 
KisShapeLayerCanvasBase::KisShapeLayerCanvasBase(KisShapeLayer *parent)
    : KoCanvasBase(0)
    , m_shapeManager(new KoShapeManager(this))
    , m_selectedShapesProxy(new KoSelectedShapesProxySimple(m_shapeManager.data()))
    , m_viewConverter()
{
    m_shapeManager->selection()->setActiveLayer(parent);
}
 
KisShapeLayerCanvasBase::KisShapeLayerCanvasBase(const KisShapeLayerCanvasBase &rhs, KisShapeLayer *parent)
    : KoCanvasBase(0)
    , m_shapeManager(new KoShapeManager(this))
    , m_selectedShapesProxy(new KoSelectedShapesProxySimple(m_shapeManager.data()))
    , m_viewConverter(rhs.m_viewConverter)
{
    m_viewConverter.setImage(nullptr);
    m_shapeManager->selection()->setActiveLayer(parent);
}
 
void KisShapeLayerCanvasBase::setImage(KisImageWSP image)
{
    m_viewConverter.setImage(image);
}
 
KoShapeManager *KisShapeLayerCanvasBase::shapeManager() const
{
    return m_shapeManager.data();
}
 
KoSelectedShapesProxy *KisShapeLayerCanvasBase::selectedShapesProxy() const
{
    return m_selectedShapesProxy.data();
}
 
const KoViewConverter *KisShapeLayerCanvasBase::viewConverter() const
{
    return &m_viewConverter;
}
 
KoViewConverter *KisShapeLayerCanvasBase::viewConverter()
{
    return &m_viewConverter;
}
 
void KisShapeLayerCanvasBase::gridSize(QPointF *offset, QSizeF *spacing) const
{
    KIS_SAFE_ASSERT_RECOVER_NOOP(false); // This should never be called as this canvas should have no tools.
    Q_UNUSED(offset);
    Q_UNUSED(spacing);
}
 
bool KisShapeLayerCanvasBase::snapToGrid() const
{
    KIS_SAFE_ASSERT_RECOVER_NOOP(false); // This should never be called as this canvas should have no tools.
    return false;
}
 
void KisShapeLayerCanvasBase::addCommand(KUndo2Command *)
{
    KIS_SAFE_ASSERT_RECOVER_NOOP(false); // This should never be called as this canvas should have no tools.
}
 
 
KoToolProxy * KisShapeLayerCanvasBase::toolProxy() const
{
//     KIS_SAFE_ASSERT_RECOVER_NOOP(false); // This should never be called as this canvas should have no tools.
    return 0;
}
 
QWidget* KisShapeLayerCanvasBase::canvasWidget()
{
    return 0;
}
 
const QWidget* KisShapeLayerCanvasBase::canvasWidget() const
{
    return 0;
}
 
KoUnit KisShapeLayerCanvasBase::unit() const
{
    KIS_SAFE_ASSERT_RECOVER_NOOP(false); // This should never be called as this canvas should have no tools.
    return KoUnit(KoUnit::Point);
}
 
void KisShapeLayerCanvasBase::prepareForDestroying()
{
    m_isDestroying = true;
}
 
bool KisShapeLayerCanvasBase::hasChangedWhileBeingInvisible()
{
    return m_hasChangedWhileBeingInvisible;
}
 
 
KisShapeLayerCanvas::KisShapeLayerCanvas(const KoColorSpace *cs, KisDefaultBoundsBaseSP defaultBounds, KisShapeLayer *parent)
        : KisShapeLayerCanvasBase(parent)
        , m_projection(new KisPaintDevice(parent, cs, defaultBounds))
        , m_parentLayer(parent)
        , m_asyncUpdateSignalCompressor(25, KisSignalCompressor::FIRST_ACTIVE)
        , m_safeForcedConnection(std::bind(&KisShapeLayerCanvas::slotStartAsyncRepaint, this))
{
    m_shapeManager->addShape(parent, KoShapeManager::AddWithoutRepaint);
    m_shapeManager->selection()->setActiveLayer(parent);
 
    connect(&m_asyncUpdateSignalCompressor, SIGNAL(timeout()), SLOT(slotStartAsyncRepaint()));
}
 
KisShapeLayerCanvas::KisShapeLayerCanvas(const KisShapeLayerCanvas &rhs, KisShapeLayer *parent)
        : KisShapeLayerCanvasBase(rhs, parent)
        , m_projection(new KisPaintDevice(*rhs.m_projection))
        , m_parentLayer(parent)
        , m_asyncUpdateSignalCompressor(25, KisSignalCompressor::FIRST_ACTIVE)
        , m_safeForcedConnection(std::bind(&KisShapeLayerCanvas::slotStartAsyncRepaint, this))
{
    m_shapeManager->addShape(parent, KoShapeManager::AddWithoutRepaint);
    m_shapeManager->selection()->setActiveLayer(parent);
 
    connect(&m_asyncUpdateSignalCompressor, SIGNAL(timeout()), SLOT(slotStartAsyncRepaint()));
    m_projection->setParentNode(parent);
}
 
KisShapeLayerCanvas::~KisShapeLayerCanvas()
{
    m_shapeManager->remove(m_parentLayer);
}
 
void KisShapeLayerCanvas::setProjection(KisPaintDeviceSP projection)
{
    m_projection = projection;
}
 
KisPaintDeviceSP KisShapeLayerCanvas::projection() const
{
    return m_projection;
}
 
void KisShapeLayerCanvas::setImage(KisImageWSP image)
{
    m_imageConnections.clear();
 
    KisShapeLayerCanvasBase::setImage(image);
    m_image = image;
 
    if (image) {
        m_imageConnections.addUniqueConnection(m_image, SIGNAL(sigSizeChanged(QPointF,QPointF)), this, SLOT(slotImageSizeChanged()));
        m_cachedImageRect = m_image->bounds();
        m_projection->convertTo(image->colorSpace());
    }
    m_projection->setDefaultBounds(new KisDefaultBounds(image));
    if (image && m_hasUpdateOnSetImage) {
        m_hasUpdateOnSetImage = false;
        const QRectF documentRect = viewConverter()->viewToDocument(m_cachedImageRect);
        updateCanvas(documentRect);
    }
}
 
class KisRepaintShapeLayerLayerJob : public KisSpontaneousJob
{
public:
    KisRepaintShapeLayerLayerJob(KisShapeLayerSP layer, KisShapeLayerCanvas *canvas)
        : m_layer(layer),
          m_canvas(canvas)
    {
    }
 
    bool overrides(const KisSpontaneousJob *_otherJob) override {
        const KisRepaintShapeLayerLayerJob *otherJob =
            dynamic_cast<const KisRepaintShapeLayerLayerJob*>(_otherJob);
 
        return otherJob && otherJob->m_canvas == m_canvas;
    }
 
    void run() override {
        m_canvas->repaint();
    }
 
    int levelOfDetail() const override {
        return 0;
    }
 
    QString debugName() const override {
        QString result;
        QDebug dbg(&result);
        dbg << "KisRepaintShapeLayerLayerJob" << m_layer;
        return result;
    }
 
private:
 
    // we store a pointer to the layer just
    // to keep the lifetime of the canvas!
    KisShapeLayerSP m_layer;
 
    KisShapeLayerCanvas *m_canvas;
};
 
 
void KisShapeLayerCanvas::updateCanvas(const QVector<QRectF> &region)
{
    if (!m_image){
        m_hasUpdateOnSetImage = true;
        return;
    }
    if (!m_parentLayer->image() || m_isDestroying) {
        return;
    }
 
    {
        QMutexLocker locker(&m_dirtyRegionMutex);
        Q_FOREACH (const QRectF &rc, region) {
            // grow for antialiasing
            const QRect imageRect = kisGrowRect(viewConverter()->documentToView(rc).toAlignedRect(), 2);
            m_dirtyRegion += imageRect;
        }
    }
 
    m_asyncUpdateSignalCompressor.start();
    m_hasUpdateInCompressor = true;
}
 
 
void KisShapeLayerCanvas::updateCanvas(const QRectF& rc)
{
    updateCanvas(QVector<QRectF>({rc}));
}
 
void KisShapeLayerCanvas::slotStartAsyncRepaint()
{
    KisImageSP image = m_image;
    if (!image || !m_parentLayer->image()) {
        return;
    }
 
    if (image->locked()) {
        m_asyncUpdateSignalCompressor.start();
        return;
    }
 
    QRect repaintRect;
    QRect uncroppedRepaintRect;
    bool forceUpdateHiddenAreasOnly = false;
    const qint32 MASK_IMAGE_WIDTH = 256;
    const qint32 MASK_IMAGE_HEIGHT = 256;
    {
        QMutexLocker locker(&m_dirtyRegionMutex);
 
        repaintRect = m_dirtyRegion.boundingRect();
        forceUpdateHiddenAreasOnly = m_forceUpdateHiddenAreasOnly;
 
        Q_FOREACH (const KoShapeManager::PaintJob &job, m_paintJobsOrder.jobs) {
            repaintRect |= viewConverter()->documentToView().mapRect(job.docUpdateRect).toAlignedRect();
        }
        m_paintJobsOrder.clear();
 
        m_dirtyRegion = QRegion();
        m_forceUpdateHiddenAreasOnly = false;
    }
 
    if (!forceUpdateHiddenAreasOnly) {
        if (repaintRect.isEmpty()) {
            return;
        }
 
        // Crop the update rect by the image bounds. We keep the cache consistent
        // by tracking the size of the image in slotImageSizeChanged()
        uncroppedRepaintRect = repaintRect;
        repaintRect = repaintRect.intersected(image->bounds());
    } else {
        const QRectF shapesBounds = KoShape::boundingRect(m_shapeManager->shapes());
        repaintRect |= kisGrowRect(viewConverter()->documentToView(shapesBounds).toAlignedRect(), 2);
        uncroppedRepaintRect = repaintRect;
    }
 
    const QVector<QRect> updateRects =
        KritaUtils::splitRectIntoPatchesTight(repaintRect,
                                              QSize(MASK_IMAGE_WIDTH, MASK_IMAGE_HEIGHT));
 
    KoShapeManager::PaintJobsOrder jobsOrder;
    Q_FOREACH (const QRect &viewUpdateRect, updateRects) {
        jobsOrder.jobs << KoShapeManager::PaintJob(viewConverter()->viewToDocument().mapRect(QRectF(viewUpdateRect)),
                                              viewUpdateRect);
    }
    jobsOrder.uncroppedViewUpdateRect = uncroppedRepaintRect;
 
    m_shapeManager->preparePaintJobs(jobsOrder, m_parentLayer);
 
    {
        QMutexLocker locker(&m_dirtyRegionMutex);
 
        // check if it is still empty! It should be true, because GUI thread is
        // the only actor that can add stuff to it.
        KIS_SAFE_ASSERT_RECOVER_NOOP(m_paintJobsOrder.isEmpty());
        m_paintJobsOrder = jobsOrder;
    }
 
    m_hasUpdateInCompressor = false;
    image->addSpontaneousJob(new KisRepaintShapeLayerLayerJob(m_parentLayer, this));
}
 
void KisShapeLayerCanvas::slotImageSizeChanged()
{
    QRegion dirtyCacheRegion;
    dirtyCacheRegion += m_image->bounds();
    dirtyCacheRegion += m_cachedImageRect;
    dirtyCacheRegion -= m_image->bounds() & m_cachedImageRect;
 
    QVector<QRectF> dirtyRects;
    auto rc = dirtyCacheRegion.begin();
    while (rc != dirtyCacheRegion.end()) {
        dirtyRects.append(viewConverter()->viewToDocument(*rc));
        rc++;
    }
    updateCanvas(dirtyRects);
 
    m_cachedImageRect = m_image->bounds();
}
 
void KisShapeLayerCanvas::repaint()
{
 
    KoShapeManager::PaintJobsOrder paintJobsOrder;
 
    {
        QMutexLocker locker(&m_dirtyRegionMutex);
        std::swap(paintJobsOrder, m_paintJobsOrder);
    }
 
    if (paintJobsOrder.isEmpty()) return;
 
    const qint32 MASK_IMAGE_WIDTH = 256;
    const qint32 MASK_IMAGE_HEIGHT = 256;
 
    QImage image(MASK_IMAGE_WIDTH, MASK_IMAGE_HEIGHT, QImage::Format_ARGB32);
    QPainter tempPainter(&image);
 
    if(m_parentLayer->antialiased()) {
        tempPainter.setRenderHint(QPainter::Antialiasing);
        tempPainter.setRenderHint(QPainter::TextAntialiasing);
    }
 
    quint8 * dstData = new quint8[MASK_IMAGE_WIDTH * MASK_IMAGE_HEIGHT * m_projection->pixelSize()];
 
    QRect repaintRect = paintJobsOrder.uncroppedViewUpdateRect;
    m_projection->clear(repaintRect);
 
    Q_FOREACH (const KoShapeManager::PaintJob &job, paintJobsOrder.jobs) {
        if (job.isEmpty()) {
            m_projection->clear(job.viewUpdateRect);
            continue;
        }
 
        KIS_SAFE_ASSERT_RECOVER(job.viewUpdateRect.width() <= MASK_IMAGE_WIDTH &&
                                job.viewUpdateRect.height() <= MASK_IMAGE_HEIGHT) {
            continue;
        }
 
        image.fill(0);
 
        tempPainter.setTransform(QTransform());
        tempPainter.setClipRect(QRect(0,0,job.viewUpdateRect.width(), job.viewUpdateRect.height()));
        tempPainter.setTransform(viewConverter()->documentToView() *
                                 QTransform::fromTranslate(-job.viewUpdateRect.x(), -job.viewUpdateRect.y()));
 
        m_shapeManager->paintJob(tempPainter, job);
 
        if (image.size() != job.viewUpdateRect.size()) {
            const quint8 *imagePtr = image.constBits();
            const int imageRowStride = 4 * image.width();
 
            for (int y = 0; y < job.viewUpdateRect.height(); y++) {
 
                KoColorSpaceRegistry::instance()->rgb8()
                        ->convertPixelsTo(imagePtr, dstData, m_projection->colorSpace(),
                                          job.viewUpdateRect.width(),
                                          KoColorConversionTransformation::internalRenderingIntent(),
                                          KoColorConversionTransformation::internalConversionFlags());
 
                m_projection->writeBytes(dstData,
                                         job.viewUpdateRect.x(),
                                         job.viewUpdateRect.y() + y,
                                         job.viewUpdateRect.width(),
                                         1);
 
                imagePtr += imageRowStride;
            }
        } else {
            KoColorSpaceRegistry::instance()->rgb8()
                    ->convertPixelsTo(image.constBits(), dstData, m_projection->colorSpace(),
                                      MASK_IMAGE_WIDTH * MASK_IMAGE_HEIGHT,
                                      KoColorConversionTransformation::internalRenderingIntent(),
                                      KoColorConversionTransformation::internalConversionFlags());
 
            m_projection->writeBytes(dstData,
                                     job.viewUpdateRect.x(),
                                     job.viewUpdateRect.y(),
                                     MASK_IMAGE_WIDTH,
                                     MASK_IMAGE_HEIGHT);
 
        }
        repaintRect |= job.viewUpdateRect;
    }
 
    delete[] dstData;
    m_projection->purgeDefaultPixels();
    m_parentLayer->setDirty(repaintRect);
 
    m_hasChangedWhileBeingInvisible |= !m_parentLayer->visible(true);
}
 
void KisShapeLayerCanvas::forceRepaint()
{
    if (hasPendingUpdates()) {
        m_asyncUpdateSignalCompressor.stop();
        m_safeForcedConnection.start();
    }
}
 
bool KisShapeLayerCanvas::hasPendingUpdates() const
{
    return m_hasUpdateInCompressor;
}
 
void KisShapeLayerCanvas::forceRepaintWithHiddenAreas()
{
    KIS_SAFE_ASSERT_RECOVER_RETURN(m_image);
    KIS_SAFE_ASSERT_RECOVER_RETURN(m_parentLayer->image());
    KIS_SAFE_ASSERT_RECOVER_RETURN(!m_isDestroying);
 
    {
        QMutexLocker locker(&m_dirtyRegionMutex);
        m_forceUpdateHiddenAreasOnly = true;
    }
 
    m_asyncUpdateSignalCompressor.stop();
    m_safeForcedConnection.start();
}
 
void KisShapeLayerCanvas::resetCache(const KoColorSpace *colorSpace)
{
    Q_UNUSED(colorSpace);
    m_projection->clear();
 
    QList<KoShape*> shapes = m_shapeManager->shapes();
    Q_FOREACH (const KoShape* shape, shapes) {
        shape->update();
    }
}
 
void KisShapeLayerCanvas::rerenderAfterBeingInvisible()
{
    KIS_SAFE_ASSERT_RECOVER_RETURN(m_parentLayer->visible(true));
 
    m_hasChangedWhileBeingInvisible = false;
    resetCache();
}