KisDitherUtil Class Reference

#include <KisDitherUtil.h>

Public Types
enum	PatternValueMode { Auto , Lightness , Alpha }
enum	ThresholdMode { Pattern , Noise }

Public Member Functions
	KisDitherUtil ()
void	setConfiguration (const KisFilterConfiguration &config, const QString &prefix="")
qreal	threshold (const QPoint &pos)

Private Member Functions
void	setNoiseSeed (const quint64 &noiseSeed)
void	setPattern (const QString &md5sum, const QString &patternName, const PatternValueMode valueMode, KisResourcesInterfaceSP resourcesInterface)
void	setSpread (const qreal &spread)
void	setThresholdMode (const ThresholdMode thresholdMode)

Private Attributes
quint64	m_noiseSeed
KoPatternSP	m_pattern
bool	m_patternUseAlpha
PatternValueMode	m_patternValueMode
qreal	m_spread
ThresholdMode	m_thresholdMode

Detailed Description

Definition at line 20 of file KisDitherUtil.h.

Member Enumeration Documentation

PatternValueMode

enum KisDitherUtil::PatternValueMode

Enumerator
Auto
Lightness
Alpha

Definition at line 27 of file KisDitherUtil.h.

                          {
        Auto,
        Lightness,
        Alpha
    };

ThresholdMode

enum KisDitherUtil::ThresholdMode

Enumerator
Pattern
Noise

Definition at line 23 of file KisDitherUtil.h.

                       {
        Pattern,
        Noise
    };

Constructor & Destructor Documentation

KisDitherUtil()

KisDitherUtil::KisDitherUtil

(

)

Definition at line 15 of file KisDitherUtil.cpp.

    : m_thresholdMode(ThresholdMode::Pattern), m_patternValueMode(PatternValueMode::Auto)
    , m_noiseSeed(0), m_patternUseAlpha(false), m_spread(1.0)
{
}

Member Function Documentation

setConfiguration()

void KisDitherUtil::setConfiguration	(	const KisFilterConfiguration &	config,
		const QString &	prefix = "" )

Definition at line 85 of file KisDitherUtil.cpp.

{
    setThresholdMode(ThresholdMode(config.getInt(prefix + "thresholdMode")));
    setPattern(config.getString(prefix + "md5sum"), config.getString(prefix + "pattern"), PatternValueMode(config.getInt(prefix + "patternValueMode")), config.resourcesInterface());
    setNoiseSeed(quint64(config.getInt(prefix + "noiseSeed")));
    setSpread(config.getDouble(prefix + "spread"));
}

References KisPropertiesConfiguration::getDouble(), KisPropertiesConfiguration::getInt(), KisPropertiesConfiguration::getString(), KisFilterConfiguration::resourcesInterface, setNoiseSeed(), setPattern(), setSpread(), and setThresholdMode().

setNoiseSeed()

void KisDitherUtil::setNoiseSeed ( const quint64 & noiseSeed )

private

Definition at line 58 of file KisDitherUtil.cpp.

{
    m_noiseSeed = noiseSeed;
}

References m_noiseSeed.

setPattern()

void KisDitherUtil::setPattern ( const QString & md5sum, const QString & patternName, const PatternValueMode valueMode, KisResourcesInterfaceSP resourcesInterface )

private

Definition at line 26 of file KisDitherUtil.cpp.

{
    m_patternValueMode = valueMode;
 
    auto source = resourcesInterface->source<KoPattern>(ResourceType::Patterns);
    m_pattern = source.bestMatch(md5sum, "", patternName);
 
    if (m_pattern && m_thresholdMode == ThresholdMode::Pattern && m_patternValueMode == PatternValueMode::Auto) {
        // Automatically pick between lightness-based and alpha-based patterns by whichever has maximum range
 
        // FIXME QT6: remove after we derecate Qt5 (and use float all the time)
        using float_type = decltype(std::declval<QColor>().alphaF());
 
        float_type lightnessMin = 1.0, lightnessMax = 0.0;
        float_type alphaMin = 1.0, alphaMax = 0.0;
        const QImage &image = m_pattern->pattern();
        for (int y = 0; y < image.height(); ++y) {
            for (int x = 0; x < image.width(); ++x) {
                const QColor pixel = image.pixelColor(x, y);
                lightnessMin = std::min(lightnessMin, pixel.lightnessF());
                lightnessMax = std::max(lightnessMax, pixel.lightnessF());
                alphaMin = std::min(alphaMin, pixel.alphaF());
                alphaMax = std::max(alphaMax, pixel.alphaF());
            }
        }
        m_patternUseAlpha = (alphaMax - alphaMin > lightnessMax - lightnessMin);
    }
    else {
        m_patternUseAlpha = (m_patternValueMode == PatternValueMode::Alpha);
    }
}

References Alpha, Auto, m_pattern, m_patternUseAlpha, m_patternValueMode, m_thresholdMode, Pattern, ResourceType::Patterns, and source().

setSpread()

void KisDitherUtil::setSpread ( const qreal & spread )

private

Definition at line 63 of file KisDitherUtil.cpp.

{
    m_spread = spread;
}

References m_spread.

setThresholdMode()

void KisDitherUtil::setThresholdMode ( const ThresholdMode thresholdMode )

private

Definition at line 21 of file KisDitherUtil.cpp.

{
    m_thresholdMode = thresholdMode;
}

References m_thresholdMode.

threshold()

qreal KisDitherUtil::threshold

(

const QPoint &

pos

)

Definition at line 68 of file KisDitherUtil.cpp.

{
    qreal threshold;
    if (m_thresholdMode == ThresholdMode::Pattern && m_pattern) {
        const QImage &image = m_pattern->pattern();
        const QColor color = image.pixelColor(pos.x() % image.width(), pos.y() % image.height());
        threshold = (m_patternUseAlpha ? color.alphaF() : color.lightnessF());
    }
    else if (m_thresholdMode == ThresholdMode::Noise) {
        KisRandomGenerator2D random(m_noiseSeed);
        threshold = random.doubleRandomAt(pos.x(), pos.y());
    }
    else threshold = 0.5;
 
    return 0.5 - (m_spread / 2.0) + threshold * m_spread;
}

References m_noiseSeed, m_pattern, m_patternUseAlpha, m_spread, m_thresholdMode, Noise, Pattern, and threshold().

Member Data Documentation

m_noiseSeed

quint64 KisDitherUtil::m_noiseSeed

private

Definition at line 49 of file KisDitherUtil.h.

m_pattern

KoPatternSP KisDitherUtil::m_pattern

private

Definition at line 48 of file KisDitherUtil.h.

m_patternUseAlpha

bool KisDitherUtil::m_patternUseAlpha

private

Definition at line 50 of file KisDitherUtil.h.

m_patternValueMode

PatternValueMode KisDitherUtil::m_patternValueMode

private

Definition at line 47 of file KisDitherUtil.h.

m_spread

qreal KisDitherUtil::m_spread

private

Definition at line 51 of file KisDitherUtil.h.

m_thresholdMode

ThresholdMode KisDitherUtil::m_thresholdMode

private

Definition at line 46 of file KisDitherUtil.h.

---

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

• libs/ui/utils/KisDitherUtil.h
• libs/ui/utils/KisDitherUtil.cpp