File indexing completed on 2024-05-12 15:58:41

 /*
  *  SPDX-FileCopyrightText: 2002 Patrick Julien <freak@codepimps.org>
  *  SPDX-FileCopyrightText: 2005 C. Boemann <cbo@boemann.dk>
  *  SPDX-FileCopyrightText: 2009 Dmitry Kazakov <dimula73@gmail.com>
  *
  *  SPDX-License-Identifier: GPL-2.0-or-later
  */
 
 #include "kis_selection_based_layer.h"
 
 #include <klocalizedstring.h>
 #include "kis_debug.h"
 
 #include <KoCompositeOpRegistry.h>
 
 #include "kis_image.h"
 #include "kis_painter.h"
 #include "kis_default_bounds.h"
 
 #include "kis_selection.h"
 #include "kis_pixel_selection.h"
 #include "filter/kis_filter_configuration.h"
 #include "filter/kis_filter_registry.h"
 #include "filter/kis_filter.h"
 #include "kis_signal_auto_connection.h"
 
 #include "kis_raster_keyframe_channel.h"
 
 
 struct Q_DECL_HIDDEN KisSelectionBasedLayer::Private
 {
 public:
     Private() : useSelectionInProjection(true) {}
     Private(const Private &rhs) : useSelectionInProjection(rhs.useSelectionInProjection) {}
 
     KisSelectionSP selection;
     KisPaintDeviceSP paintDevice;
     bool useSelectionInProjection;
     KisSignalAutoConnectionsStore imageConnections;
 };
 
 
 KisSelectionBasedLayer::KisSelectionBasedLayer(KisImageWSP image,
         const QString &name,
         KisSelectionSP selection,
         KisFilterConfigurationSP filterConfig)
         : KisLayer(image.data(), name, OPACITY_OPAQUE_U8),
           KisNodeFilterInterface(filterConfig),
           m_d(new Private())
 {
     if (!selection) {
         initSelection();
     } else {
         setInternalSelection(selection);
     }
 
     KisImageSP imageSP = image.toStrongRef();
     if (!imageSP) {
         return;
     }
     m_d->paintDevice = KisPaintDeviceSP(new KisPaintDevice(this, imageSP->colorSpace(), KisDefaultBoundsSP(new KisDefaultBounds(image))));
     m_d->imageConnections.addConnection(imageSP.data(), SIGNAL(sigSizeChanged(QPointF,QPointF)), this, SLOT(slotImageSizeChanged()));
 }
 
 KisSelectionBasedLayer::KisSelectionBasedLayer(const KisSelectionBasedLayer& rhs)
         : KisLayer(rhs)
         , KisIndirectPaintingSupport()
         , KisNodeFilterInterface(rhs)
         , m_d(new Private(*rhs.m_d))
 {
     setInternalSelection(rhs.m_d->selection);
 
     m_d->paintDevice = new KisPaintDevice(*rhs.m_d->paintDevice.data());
 }
 
 
 KisSelectionBasedLayer::~KisSelectionBasedLayer()
 {
     delete m_d;
 }
 
 void KisSelectionBasedLayer::initSelection()
 {
     m_d->selection = KisSelectionSP(new KisSelection(KisDefaultBoundsSP(new KisDefaultBounds(image()))));
     m_d->selection->pixelSelection()->setDefaultPixel(KoColor(Qt::white, m_d->selection->pixelSelection()->colorSpace()));
     m_d->selection->setParentNode(this);
     m_d->selection->updateProjection();
 }
 
 void KisSelectionBasedLayer::slotImageSizeChanged()
 {
     if (m_d->selection) {
         /**
          * Make sure exactBounds() of the selection got recalculated after
          * the image changed
          */
         m_d->selection->pixelSelection()->setDirty();
         setDirty();
     }
 }
 
 void KisSelectionBasedLayer::setImage(KisImageWSP image)
 {
     m_d->imageConnections.clear();
     m_d->paintDevice->setDefaultBounds(KisDefaultBoundsSP(new KisDefaultBounds(image)));
     m_d->selection->pixelSelection()->setDefaultBounds(KisDefaultBoundsSP(new KisDefaultBounds(image)));
     KisLayer::setImage(image);
 
     if (image) {
         m_d->imageConnections.addConnection(image.data(), SIGNAL(sigSizeChanged(QPointF,QPointF)), this, SLOT(slotImageSizeChanged()));
     }
 }
 
 bool KisSelectionBasedLayer::allowAsChild(KisNodeSP node) const
 {
     return node->inherits("KisMask");
 }
 
 
 KisPaintDeviceSP KisSelectionBasedLayer::original() const
 {
     return m_d->paintDevice;
 }
 KisPaintDeviceSP KisSelectionBasedLayer::paintDevice() const
 {
     return m_d->selection->pixelSelection();
 }
 
 
 bool KisSelectionBasedLayer::needProjection() const
 {
     return m_d->selection;
 }
 
 void KisSelectionBasedLayer::setUseSelectionInProjection(bool value) const
 {
     m_d->useSelectionInProjection = value;
 }
 
 KisSelectionSP KisSelectionBasedLayer::fetchComposedInternalSelection(const QRect &rect) const
 {
     if (!m_d->selection) return KisSelectionSP();
     m_d->selection->updateProjection(rect);
 
     KisSelectionSP tempSelection = m_d->selection;
 
     KisIndirectPaintingSupport::ReadLocker l(this);
 
     if (hasTemporaryTarget()) {
         /**
          * WARNING: we don't try to clone the selection entirely, because
          *          it might be unsafe for shape selections.
          *
          * TODO: make cloning of vector selections safe! See a comment in
          *       KisShapeSelection::clone().
          */
         tempSelection = new KisSelection();
 
         KisPainter::copyAreaOptimized(rect.topLeft(), m_d->selection->pixelSelection(), tempSelection->pixelSelection(), rect);
 
         KisPainter gc2(tempSelection->pixelSelection());
         setupTemporaryPainter(&gc2);
         gc2.bitBlt(rect.topLeft(), temporaryTarget(), rect);
     }
 
     return tempSelection;
 }
 
 void KisSelectionBasedLayer::copyOriginalToProjection(const KisPaintDeviceSP original,
         KisPaintDeviceSP projection,
         const QRect& rect) const
 {
     KisSelectionSP tempSelection;
 
     if (m_d->useSelectionInProjection) {
         tempSelection = fetchComposedInternalSelection(rect);
 
         /**
          * When we paint with a selection, the deselected areas will *not* be
          * overwritten by copyAreaOptimized(), so we need to clear them beforehand
          */
         projection->clear(rect);
     }
 
     KisPainter::copyAreaOptimized(rect.topLeft(), original, projection, rect, tempSelection);
 }
 
 QRect KisSelectionBasedLayer::cropChangeRectBySelection(const QRect &rect) const
 {
     return m_d->selection ?
         rect & m_d->selection->selectedRect() :
         rect;
 }
 
 QRect KisSelectionBasedLayer::needRect(const QRect &rect, PositionToFilthy pos) const
 {
     Q_UNUSED(pos);
     return rect;
 }
 
 void KisSelectionBasedLayer::resetCache()
 {
     KisImageSP imageSP = image().toStrongRef();
     if (!imageSP) {
         return;
     }
 
     if (!m_d->paintDevice) {
         m_d->paintDevice = KisPaintDeviceSP(new KisPaintDevice(KisNodeWSP(this), imageSP->colorSpace(), new KisDefaultBounds(image())));
     } else if (*m_d->paintDevice->colorSpace() != *imageSP->colorSpace()) {
         m_d->paintDevice->clear();
         m_d->paintDevice->convertTo(imageSP->colorSpace());
     } else {
         m_d->paintDevice->clear();
     }
 }
 
 KisSelectionSP KisSelectionBasedLayer::internalSelection() const
 {
     return m_d->selection;
 }
 
 void KisSelectionBasedLayer::setInternalSelection(KisSelectionSP selection)
 {
     if (selection) {
         m_d->selection = new KisSelection(*selection.data());
         m_d->selection->setParentNode(this);
         m_d->selection->setDefaultBounds(new KisDefaultBounds(image()));
         m_d->selection->updateProjection();
 
         KisPixelSelectionSP pixelSelection = m_d->selection->pixelSelection();
         if (pixelSelection->framesInterface()) {
             addKeyframeChannel(pixelSelection->keyframeChannel());
             enableAnimation();
         }
 
         KisImageSP imageSP = image().toStrongRef();
         if (imageSP) {
             /**
              * Sanity check for the case when the image is present
              */
             if (m_d->selection->pixelSelection()->defaultBounds()->bounds() != imageSP->bounds()) {
                 qWarning() << "WARNING: KisSelectionBasedLayer::setInternalSelection"
                            << "New selection has suspicious default bounds";
                 qWarning() << "WARNING:" << ppVar(m_d->selection->pixelSelection()->defaultBounds()->bounds());
                 qWarning() << "WARNING:" << ppVar(imageSP->bounds());
             }
         }
 
     } else {
         m_d->selection = 0;
     }
 }
 
 qint32 KisSelectionBasedLayer::x() const
 {
     return m_d->selection ? m_d->selection->x() : 0;
 }
 
 qint32 KisSelectionBasedLayer::y() const
 {
     return m_d->selection ? m_d->selection->y() : 0;
 }
 
 void KisSelectionBasedLayer::setX(qint32 x)
 {
     if (m_d->selection) {
         m_d->selection->setX(x);
     }
 }
 
 void KisSelectionBasedLayer::setY(qint32 y)
 {
     if (m_d->selection) {
         m_d->selection->setY(y);
     }
 }
 
 bool KisSelectionBasedLayer::supportsLodPainting() const
 {
     return !m_d->selection || !m_d->selection->hasShapeSelection();
 }
 
 KisKeyframeChannel *KisSelectionBasedLayer::requestKeyframeChannel(const QString &id)
 {
     if (id == KisKeyframeChannel::Raster.id()) {
         KisRasterKeyframeChannel *contentChannel = m_d->selection->pixelSelection()->createKeyframeChannel(KisKeyframeChannel::Raster);
         contentChannel->setFilenameSuffix(".pixelselection");
         return contentChannel;
     }
 
     return KisLayer::requestKeyframeChannel(id);
 }
 
 bool KisSelectionBasedLayer::supportsKeyframeChannel(const QString &id)
 {
     if (id == KisKeyframeChannel::Raster.id()) {
         return true;
     }
 
     return KisLayer::supportsKeyframeChannel(id);
 }
 
 void KisSelectionBasedLayer::setDirty()
 {
     Q_ASSERT(image());
     KisImageSP imageSP = image().toStrongRef();
     if (!imageSP) {
         return;
     }
     setDirty(imageSP->bounds());
 }
 
 QRect KisSelectionBasedLayer::extent() const
 {
     QRect resultRect;
 
     if (m_d->selection) {
         resultRect = m_d->selection->selectedRect();
 
         // copy for thread safety!
         KisPaintDeviceSP temporaryTarget = this->temporaryTarget();
 
         if (temporaryTarget) {
             resultRect |= temporaryTarget->extent();
         }
 
     } else {
         KisImageSP image = this->image().toStrongRef();
         KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(image, QRect());
         resultRect = image->bounds();
     }
 
     return resultRect;
 }
 
 QRect KisSelectionBasedLayer::exactBounds() const
 {
     QRect resultRect;
 
     if (m_d->selection) {
         resultRect = m_d->selection->selectedExactRect();
 
         // copy for thread safety!
         KisPaintDeviceSP temporaryTarget = this->temporaryTarget();
 
         if (temporaryTarget) {
             resultRect |= temporaryTarget->exactBounds();
         }
 
     } else {
         KisImageSP image = this->image().toStrongRef();
         KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(image, QRect());
         resultRect = image->bounds();
     }
 
     return resultRect;
 }
 
 QImage KisSelectionBasedLayer::createThumbnail(qint32 w, qint32 h, Qt::AspectRatioMode aspectRatioMode)
 {
     KisSelectionSP originalSelection = internalSelection();
     KisPaintDeviceSP originalDevice = original();
 
     return originalDevice && originalSelection ?
            originalDevice->createThumbnail(w, h, aspectRatioMode, 1,
                                            KoColorConversionTransformation::internalRenderingIntent(),
                                            KoColorConversionTransformation::internalConversionFlags()) :
            QImage();
 }