#include <KisTextureMaskInfo.h>

Inheritance diagram for KisTextureMaskInfo:

Public Member Functions
bool	fillProperties (const KisPropertiesConfiguration *setting, KisResourcesInterfaceSP resourcesInterface, bool invertAdditionally)

bool	hasAlpha ()

bool	hasMask () const

bool	isValid () const

	KisTextureMaskInfo (const KisTextureMaskInfo &rhs)

	KisTextureMaskInfo (int levelOfDetail, bool preserveAlpha)

int	levelOfDetail () const

KisPaintDeviceSP	mask ()

QRect	maskBounds () const

KisTextureMaskInfo &	operator= (const KisTextureMaskInfo &rhs)

void	recalculateMask ()

	~KisTextureMaskInfo ()

Private Attributes
qreal	m_brightness = 0.0

qreal	m_contrast = 1.0

int	m_cutoffLeft = 0

int	m_cutoffPolicy = 0

int	m_cutoffRight = 255

bool	m_invert = false

int	m_levelOfDetail = 0

KisPaintDeviceSP	m_mask

QRect	m_maskBounds

qreal	m_neutralPoint = 0.5

KoPatternSP	m_pattern = 0

bool	m_preserveAlpha = false

qreal	m_scale = 1.0

Friends
bool	operator== (const KisTextureMaskInfo &lhs, const KisTextureMaskInfo &rhs)

Detailed Description

Definition at line 23 of file KisTextureMaskInfo.h.

Constructor & Destructor Documentation

◆ KisTextureMaskInfo() [1/2]

KisTextureMaskInfo::KisTextureMaskInfo	(	int	levelOfDetail,
		bool	preserveAlpha )

Definition at line 29 of file KisTextureMaskInfo.cpp.

    : m_levelOfDetail(levelOfDetail)
    , m_preserveAlpha(preserveAlpha)
{
}

◆ KisTextureMaskInfo() [2/2]

KisTextureMaskInfo::KisTextureMaskInfo ( const KisTextureMaskInfo & rhs )

Definition at line 35 of file KisTextureMaskInfo.cpp.

    : m_levelOfDetail(rhs.m_levelOfDetail)
    , m_preserveAlpha(rhs.m_preserveAlpha)
    , m_pattern(rhs.m_pattern)
    , m_scale(rhs.m_scale)
    , m_brightness(rhs.m_brightness)
    , m_contrast(rhs.m_contrast)
    , m_neutralPoint(rhs.m_neutralPoint)
    , m_invert(rhs.m_invert)
    , m_cutoffLeft(rhs.m_cutoffLeft)
    , m_cutoffRight(rhs.m_cutoffRight)
    , m_cutoffPolicy(rhs.m_cutoffPolicy)
 
{
}

◆ ~KisTextureMaskInfo()

KisTextureMaskInfo::~KisTextureMaskInfo ( )

Definition at line 51 of file KisTextureMaskInfo.cpp.

52{

53}

Member Function Documentation

◆ fillProperties()

bool KisTextureMaskInfo::fillProperties	(	const KisPropertiesConfiguration *	setting,
		KisResourcesInterfaceSP	resourcesInterface,
		bool	invertAdditionally )

Definition at line 111 of file KisTextureMaskInfo.cpp.

{
    KisTextureOptionData data;
    data.read(setting);
 
    if (!data.isEnabled || data.textureData.isNull()) {
        return false;
    }
 
    m_pattern = data.textureData.loadLinkedPattern(resourcesInterface).resource<KoPattern>();
 
    if (!m_pattern) {
        qWarning() << "WARNING: Couldn't load the pattern for a stroke (KisTextureMaskInfo)";
        return false;
    }
 
    m_scale = data.scale;
    m_brightness = data.brightness;
    m_contrast = data.contrast;
    m_neutralPoint = data.neutralPoint;
    m_invert = data.invert != invertAdditionally;
    m_cutoffLeft = data.cutOffLeft;
    m_cutoffRight = data.cutOffRight;
    m_cutoffPolicy = data.cutOffPolicy;
 
    return true;
}

◆ hasAlpha()

bool KisTextureMaskInfo::hasAlpha ( )

Definition at line 246 of file KisTextureMaskInfo.cpp.

                                  {
    return m_pattern->hasAlpha();
}

References m_pattern.

◆ hasMask()

bool KisTextureMaskInfo::hasMask ( ) const

Definition at line 99 of file KisTextureMaskInfo.cpp.

                                       {
    return m_mask;
}

References m_mask.

◆ isValid()

bool KisTextureMaskInfo::isValid ( ) const

Definition at line 90 of file KisTextureMaskInfo.cpp.

{
    return (m_mask && m_maskBounds.isValid());
}

References m_mask, and m_maskBounds.

◆ levelOfDetail()

int KisTextureMaskInfo::levelOfDetail ( ) const

Definition at line 95 of file KisTextureMaskInfo.cpp.

                                            {
    return m_levelOfDetail;
}

References m_levelOfDetail.

◆ mask()

KisPaintDeviceSP KisTextureMaskInfo::mask ( )

Definition at line 103 of file KisTextureMaskInfo.cpp.

                                          {
    return m_mask;
}

References m_mask.

◆ maskBounds()

QRect KisTextureMaskInfo::maskBounds ( ) const

Definition at line 107 of file KisTextureMaskInfo.cpp.

                                           {
    return m_maskBounds;
}

References m_maskBounds.

◆ operator=()

KisTextureMaskInfo & KisTextureMaskInfo::operator= ( const KisTextureMaskInfo & rhs )

Definition at line 73 of file KisTextureMaskInfo.cpp.

{
    m_levelOfDetail = rhs.m_levelOfDetail;
    m_pattern = rhs.m_pattern;
    m_scale = rhs.m_scale;
    m_brightness = rhs.m_brightness;
    m_contrast = rhs.m_contrast;
    m_neutralPoint = rhs.m_neutralPoint;
    m_invert = rhs.m_invert;
    m_cutoffLeft = rhs.m_cutoffLeft;
    m_cutoffRight = rhs.m_cutoffRight;
    m_cutoffPolicy = rhs.m_cutoffPolicy;
    m_preserveAlpha = rhs.m_preserveAlpha;
 
    return *this;
}

References m_brightness, m_contrast, m_cutoffLeft, m_cutoffPolicy, m_cutoffRight, m_invert, m_levelOfDetail, m_neutralPoint, m_pattern, m_preserveAlpha, and m_scale.

◆ recalculateMask()

void KisTextureMaskInfo::recalculateMask ( )

Definition at line 139 of file KisTextureMaskInfo.cpp.

{
    if (!m_pattern) return;
 
    const KoColorSpace* cs;
    const bool useAlpha = m_pattern->hasAlpha() && m_preserveAlpha;
 
    if (useAlpha) {
        cs = KoColorSpaceRegistry::instance()->rgb8();
    } else {
        cs = KoColorSpaceRegistry::instance()->alpha8();
    }
    if (!m_mask) {
        m_mask = new KisPaintDevice(cs);
    }
 
    QImage mask = m_pattern->pattern();
 
    if ((mask.format() != QImage::Format_RGB32)
        || (mask.format() != QImage::Format_ARGB32)) {
        mask.convertTo(QImage::Format_ARGB32);
    }
 
    qreal scale = m_scale * KisLodTransform::lodToScale(m_levelOfDetail);
 
    if (!qFuzzyCompare(scale, 0.0) && !qFuzzyCompare(scale, 1.0)) {
        QTransform tf;
        tf.scale(scale, scale);
        QRect rc = KisAlgebra2D::ensureRectNotSmaller(tf.mapRect(mask.rect()), QSize(2,2));
        mask = mask.scaled(rc.size(), Qt::KeepAspectRatio, Qt::SmoothTransformation);
    } else {
        // detach the mask from the file loaded from the storage
        mask = QImage(mask);
    }
 
    QRgb* pixel = reinterpret_cast<QRgb*>(mask.bits());
    const int width = mask.width();
    const int height = mask.height();
 
    KisHLineIteratorSP iter = m_mask->createHLineIteratorNG(0, 0, width);
 
    for (int row = 0; row < height; ++row) {
        for (int col = 0; col < width; ++col) {
            const QRgb currentPixel = pixel[row * width + col];
 
            const int red = qRed(currentPixel);
            const int green = qGreen(currentPixel);
            const int blue = qBlue(currentPixel);
            float alpha = qAlpha(currentPixel) / 255.0;
 
            const int grayValue = (red * 11 + green * 16 + blue * 5) / 32;
            float maskValue = (grayValue / 255.0) * alpha + (1 - alpha);
 
            maskValue = maskValue - m_brightness;
 
            maskValue = ((maskValue - 0.5)*m_contrast)+0.5;
 
            if (maskValue > 1.0) {maskValue = 1;}
            else if (maskValue < 0) {maskValue = 0;}
 
            if (m_invert) {
                maskValue = 1 - maskValue;
            }
 
            maskValue = qBound(0.0f, maskValue, 1.0f);
 
            float neutralAdjustedValue;
 
            //Adjust neutral point in linear fashion.  Uses separate linear equations from 0 to neutralPoint, and neutralPoint to 1,
            //to prevent loss of detail (clipping).
            if (m_neutralPoint == 1 || (m_neutralPoint != 0 && maskValue <= m_neutralPoint)) {
                neutralAdjustedValue = maskValue / (2 * m_neutralPoint);
            } else {
                neutralAdjustedValue = 0.5 +  (maskValue - m_neutralPoint) / (2 - 2 * m_neutralPoint);
            }
 
            if (m_cutoffPolicy == 1 && (neutralAdjustedValue < (m_cutoffLeft / 255.0) || neutralAdjustedValue >(m_cutoffRight / 255.0))) {
                // mask out the dab if it's outside the pattern's cutoff points
                alpha = OPACITY_TRANSPARENT_F;
                if (!useAlpha) {
                    neutralAdjustedValue = alpha;
                }
            } else if (m_cutoffPolicy == 2 && (neutralAdjustedValue < (m_cutoffLeft / 255.0) || neutralAdjustedValue >(m_cutoffRight / 255.0))) {
                alpha = OPACITY_OPAQUE_F;
                if (!useAlpha) {
                    neutralAdjustedValue = alpha;
                }
            }
 
            if (useAlpha) {
                int finalValue = qRound(neutralAdjustedValue * 255.0);
                pixel[row * width + col] = QColor(finalValue, finalValue, finalValue, qRound(alpha * 255.0)).rgba();
            } else {
                cs->setOpacity(iter->rawData(), neutralAdjustedValue, 1);
                iter->nextPixel();
            }
        }
        if (!useAlpha) {
            iter->nextRow();
        }
    }
    if (useAlpha) {
        m_mask->convertFromQImage(mask, 0);
    }
    m_maskBounds = QRect(0, 0, width, height);
}

References KoColorSpaceRegistry::alpha8(), KisPaintDevice::convertFromQImage(), KisPaintDevice::createHLineIteratorNG(), KisAlgebra2D::ensureRectNotSmaller(), KoColorSpaceRegistry::instance(), KisLodTransformBase::lodToScale(), m_brightness, m_contrast, m_cutoffLeft, m_cutoffPolicy, m_cutoffRight, m_invert, m_levelOfDetail, m_mask, m_maskBounds, m_neutralPoint, m_pattern, m_preserveAlpha, m_scale, mask(), OPACITY_OPAQUE_F, OPACITY_TRANSPARENT_F, qFuzzyCompare(), KoColorSpaceRegistry::rgb8(), and KoColorSpace::setOpacity().

Friends And Related Symbol Documentation

◆ operator==

bool operator==	(	const KisTextureMaskInfo &	lhs,
		const KisTextureMaskInfo &	rhs )

friend

Definition at line 55 of file KisTextureMaskInfo.cpp.

                                                                              {
    return
            lhs.m_levelOfDetail == rhs.m_levelOfDetail &&
            (lhs.m_pattern == rhs.m_pattern ||
             (lhs.m_pattern &&
              rhs.m_pattern &&
              lhs.m_pattern->md5Sum() == rhs.m_pattern->md5Sum())) &&
            qFuzzyCompare(lhs.m_scale, rhs.m_scale) &&
            qFuzzyCompare(lhs.m_brightness, rhs.m_brightness) &&
            qFuzzyCompare(lhs.m_contrast, rhs.m_contrast) &&
            qFuzzyCompare(lhs.m_neutralPoint, rhs.m_neutralPoint) &&
            lhs.m_invert == rhs.m_invert &&
            lhs.m_cutoffLeft == rhs.m_cutoffLeft &&
            lhs.m_cutoffRight == rhs.m_cutoffRight &&
            lhs.m_cutoffPolicy == rhs.m_cutoffPolicy &&
            lhs.m_preserveAlpha == rhs.m_preserveAlpha;
}

Member Data Documentation

◆ m_brightness

qreal KisTextureMaskInfo::m_brightness = 0.0

private

Definition at line 58 of file KisTextureMaskInfo.h.

◆ m_contrast

qreal KisTextureMaskInfo::m_contrast = 1.0

private

Definition at line 59 of file KisTextureMaskInfo.h.

◆ m_cutoffLeft

int KisTextureMaskInfo::m_cutoffLeft = 0

private

Definition at line 63 of file KisTextureMaskInfo.h.

◆ m_cutoffPolicy

int KisTextureMaskInfo::m_cutoffPolicy = 0

private

Definition at line 65 of file KisTextureMaskInfo.h.

◆ m_cutoffRight

int KisTextureMaskInfo::m_cutoffRight = 255

private

Definition at line 64 of file KisTextureMaskInfo.h.

◆ m_invert

bool KisTextureMaskInfo::m_invert = false

private

Definition at line 61 of file KisTextureMaskInfo.h.

◆ m_levelOfDetail

int KisTextureMaskInfo::m_levelOfDetail = 0

private

Definition at line 52 of file KisTextureMaskInfo.h.

◆ m_mask

KisPaintDeviceSP KisTextureMaskInfo::m_mask

private

Definition at line 67 of file KisTextureMaskInfo.h.

◆ m_maskBounds

QRect KisTextureMaskInfo::m_maskBounds

private

Definition at line 68 of file KisTextureMaskInfo.h.

◆ m_neutralPoint

qreal KisTextureMaskInfo::m_neutralPoint = 0.5

private

Definition at line 60 of file KisTextureMaskInfo.h.

◆ m_pattern

KoPatternSP KisTextureMaskInfo::m_pattern = 0

private

Definition at line 55 of file KisTextureMaskInfo.h.

◆ m_preserveAlpha

bool KisTextureMaskInfo::m_preserveAlpha = false

private

Definition at line 53 of file KisTextureMaskInfo.h.

◆ m_scale

qreal KisTextureMaskInfo::m_scale = 1.0

private

Definition at line 57 of file KisTextureMaskInfo.h.

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

plugins/paintops/libpaintop/KisTextureMaskInfo.h
plugins/paintops/libpaintop/KisTextureMaskInfo.cpp

Public Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ KisTextureMaskInfo() [1/2]

◆ KisTextureMaskInfo() [2/2]

◆ ~KisTextureMaskInfo()

Member Function Documentation

◆ fillProperties()

◆ hasAlpha()

◆ hasMask()

◆ isValid()

◆ levelOfDetail()

◆ mask()

◆ maskBounds()

◆ operator=()

◆ recalculateMask()

Friends And Related Symbol Documentation

◆ operator==

Member Data Documentation

◆ m_brightness

◆ m_contrast

◆ m_cutoffLeft

◆ m_cutoffPolicy

◆ m_cutoffRight

◆ m_invert

◆ m_levelOfDetail

◆ m_mask

◆ m_maskBounds

◆ m_neutralPoint

◆ m_pattern

◆ m_preserveAlpha

◆ m_scale