kis_colorize_mask.h

Go to the documentation of this file.

/*
 *  SPDX-FileCopyrightText: 2016 Dmitry Kazakov <dimula73@gmail.com>
 *  SPDX-FileCopyrightText: 2021 L. E. Segovia <amy@amyspark.me>
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 */
 
#ifndef __KIS_COLORIZE_MASK_H
#define __KIS_COLORIZE_MASK_H
 
#include <QScopedPointer>
 
#include "kis_types.h"
#include "kis_effect_mask.h"
#include "kritaimage_export.h"
 
class KoColor;
class KUndo2Command;
 
namespace KisLazyFillTools
{
    struct KeyStroke;
}
 
 
class KRITAIMAGE_EXPORT KisColorizeMask : public KisEffectMask
{
    Q_OBJECT
public:
    struct KeyStrokeColors {
        QVector<KoColor> colors;
        int transparentIndex = -1;
    };
 
public:
    KisColorizeMask(KisImageWSP image, const QString &name);
    ~KisColorizeMask() override;
 
    KisColorizeMask(const KisColorizeMask& rhs);
 
    void initializeCompositeOp();
    const KoColorSpace* colorSpace() const override;
 
    // assign color profile without conversion of pixel data
    void setProfile(const KoColorProfile *profile, KUndo2Command *parentCommand);
 
    KUndo2Command *setColorSpace(const KoColorSpace *dstColorSpace,
                                 KoColorConversionTransformation::Intent renderingIntent = KoColorConversionTransformation::internalRenderingIntent(),
                                 KoColorConversionTransformation::ConversionFlags conversionFlags = KoColorConversionTransformation::internalConversionFlags(),
                                 KoUpdater *progressUpdater = nullptr);
 
    KisPaintDeviceSP paintDevice() const override;
    KisPaintDeviceSP coloringProjection() const;
 
    KisPaintDeviceSP colorSampleSourceDevice() const override;
 
    KisNodeSP clone() const override {
        return KisNodeSP(new KisColorizeMask(*this));
    }
 
    QIcon icon() const override;
 
    void setImage(KisImageWSP image) override;
    bool accept(KisNodeVisitor &v) override;
    void accept(KisProcessingVisitor &visitor, KisUndoAdapter *undoAdapter) override;
 
    QRect decorateRect(KisPaintDeviceSP &src,
                       KisPaintDeviceSP &dst,
                       const QRect & rc,
                       PositionToFilthy maskPos,
                       KisRenderPassFlags flags) const override;
 
    void setCurrentColor(const KoColor &color) override;
    void mergeToLayerThreaded(KisNodeSP layer, KUndo2Command *parentCommand, const KUndo2MagicString &transactionText, int timedID, QVector<KisRunnableStrokeJobData *> *jobs) override;
    void writeMergeData(KisPainter *painter, KisPaintDeviceSP src, const QRect &rc) override;
    bool supportsNonIndirectPainting() const override;
 
    QRect exactBounds() const override;
    QRect extent() const override;
 
    QRect nonDependentExtent() const override;
 
    void setSectionModelProperties(const KisBaseNode::PropertyList &properties) override;
    KisBaseNode::PropertyList sectionModelProperties() const override;
 
    KeyStrokeColors keyStrokesColors() const;
    void setKeyStrokesColors(KeyStrokeColors colors);
 
    void removeKeyStroke(const KoColor &color);
 
    QVector<KisPaintDeviceSP> allPaintDevices() const;
    void resetCache();
 
    void setUseEdgeDetection(bool value);
    bool useEdgeDetection() const;
 
    void setEdgeDetectionSize(qreal value);
    qreal edgeDetectionSize() const;
 
    void setFuzzyRadius(qreal value);
    qreal fuzzyRadius() const;
 
    void setCleanUpAmount(qreal value);
    qreal cleanUpAmount() const;
 
    void setLimitToDeviceBounds(bool value);
    bool limitToDeviceBounds() const;
 
    void testingAddKeyStroke(KisPaintDeviceSP dev, const KoColor &color, bool isTransparent = false);
    KisPaintDeviceSP testingFilteredSource() const;
 
    void forceRegenerateMask();
 
    QList<KisLazyFillTools::KeyStroke> fetchKeyStrokesDirect() const;
    void setKeyStrokesDirect(const QList<KisLazyFillTools::KeyStroke> &strokes);
 
    qint32 x() const override;
    qint32 y() const override;
    void setX(qint32 x) override;
    void setY(qint32 y) override;
 
    KisPaintDeviceList getLodCapableDevices() const override;
 
    void regeneratePrefilteredDeviceIfNeeded();
 
private Q_SLOTS:
    void slotUpdateRegenerateFilling(bool prefilterOnly = false);
    void slotRegenerationFinished(bool prefilterOnly);
    void slotRegenerationCancelled();
 
    void slotUpdateOnDirtyParent();
    void slotRecalculatePrefilteredImage();
 
Q_SIGNALS:
    void sigKeyStrokesListChanged();
    void sigUpdateOnDirtyParent() const;
 
private:
    // NOTE: please access this methods using model properties only!
 
    bool needsUpdate() const;
    void setNeedsUpdate(bool value);
 
    bool showColoring() const;
    void setShowColoring(bool value);
 
    bool showKeyStrokes() const;
    void setShowKeyStrokes(bool value);
 
    void mergeToLayerUnthreaded(KisNodeSP layer, KUndo2Command *parentCommand, const KUndo2MagicString &transactionText, int timedID);
 
private:
    void rerenderFakePaintDevice();
    void moveAllInternalDevices(const QPoint &diff);
 
    template <class DeviceMetricPolicy>
    QRect calculateMaskBounds(DeviceMetricPolicy policy) const;
 
    friend struct SetKeyStrokesColorSpaceCommand;
    friend struct KeyStrokeAddRemoveCommand;
    friend struct SetKeyStrokeColorsCommand;
 
private:
    struct Private;
    const QScopedPointer<Private> m_d;
};
 
#endif /* __KIS_COLORIZE_MASK_H */