#include <KisLevelsFilterConfiguration.h>

Inheritance diagram for KisLevelsFilterConfiguration:

Public Member Functions
KisFilterConfigurationSP	clone () const override

virtual void	fromLegacyXML (const QDomElement &)

void	fromLegacyXML (const QDomElement &root) override

void	fromXML (const QDomElement &) override

void	fromXML (const QDomElement &) override

void	fromXML (const QDomElement &e) override

bool	fromXML (const QString &xml, bool clear=true) override

bool	isCompatible (const KisPaintDeviceSP) const override

	KisLevelsFilterConfiguration (const KisLevelsFilterConfiguration &rhs)

	KisLevelsFilterConfiguration (int channelCount, KisResourcesInterfaceSP resourcesInterface)

	KisLevelsFilterConfiguration (int channelCount, qint32 version, KisResourcesInterfaceSP resourcesInterface)

const QVector< KisLevelsCurve >	levelsCurves () const

const KisLevelsCurve	lightnessLevelsCurve () const

const QVector< quint16 > &	lightnessTransfer () const

void	setDefaults ()

void	setLevelsCurves (const QVector< KisLevelsCurve > &newLevelsCurves)

void	setLightnessLevelsCurve (const KisLevelsCurve &newLightnessLevelsCurve)

void	setProperty (const QString &name, const QVariant &value) override

void	setShowLogarithmicHistogram (bool newShowLogarithmicHistogram)

void	setUseLightnessMode (bool newUseLightnessMode)

bool	showLogarithmicHistogram () const

QString	toXML () const override

void	toXML (QDomDocument &, QDomElement &) const override

void	toXML (QDomDocument &, QDomElement &) const override

void	toXML (QDomDocument &doc, QDomElement &root) const override

const QVector< QVector< quint16 > > &	transfers () const

bool	useLightnessMode () const

Public Member Functions inherited from KisColorTransformationConfiguration
KoColorTransformation *	colorTransformation (const KoColorSpace cs, const KisColorTransformationFilter filter) const

void	destroyCache ()

void	invalidateColorTransformationCache ()
	Manually invalidate the cache. By default setProperty invalidates the cache but this method can be used in subclasses when setProperty is not used to set options. This forces the regeneration of the color transforms.

	KisColorTransformationConfiguration (const KisColorTransformationConfiguration &rhs)

	KisColorTransformationConfiguration (const QString &name, qint32 version, KisResourcesInterfaceSP resourcesInterface)

	Private ()

	~KisColorTransformationConfiguration () override

	~Private ()

Public Member Functions inherited from Private
	Private (KisCanvas2 *c)

Public Member Functions inherited from KisFilterConfiguration
QBitArray	channelFlags () const

KisFilterConfigurationSP	cloneWithResourcesSnapshot (KisResourcesInterfaceSP globalResourcesInterface=nullptr) const

virtual bool	compareTo (const KisPropertiesConfiguration *rhs) const override

void	createLocalResourcesSnapshot (KisResourcesInterfaceSP globalResourcesInterface=nullptr)

virtual QList< KoResourceLoadResult >	embeddedResources (KisResourcesInterfaceSP globalResourcesInterface) const

bool	hasLocalResourcesSnapshot () const

	KisFilterConfiguration (const QString &name, qint32 version, KisResourcesInterfaceSP resourcesInterface)

virtual QList< KoResourceLoadResult >	linkedResources (KisResourcesInterfaceSP globalResourcesInterface) const

const QString &	name () const

	Private (const Private &rhs)

	Private (const QString &_name, qint32 _version, KisResourcesInterfaceSP _resourcesInterface)

QList< KoResourceLoadResult >	requiredResources (KisResourcesInterfaceSP globalResourcesInterface) const

KisResourcesInterfaceSP	resourcesInterface () const

void	setChannelFlags (QBitArray channelFlags)

virtual void	setResourcesInterface (KisResourcesInterfaceSP resourcesInterface)

qint32	version () const

	~KisFilterConfiguration () override

Public Member Functions inherited from KisPropertiesConfiguration
void	clearProperties ()
	Clear the map of properties.

virtual void	dump () const

void	fromXML (const QDomElement &) override

bool	fromXML (const QString &xml, bool clear=true) override

bool	getBool (const QString &name, bool def=false) const

KoColor	getColor (const QString &name, const KoColor &color=KoColor()) const
	getColor fetch the given property as a KoColor.

KisCubicCurve	getCubicCurve (const QString &name, const KisCubicCurve &curve=KisCubicCurve()) const

double	getDouble (const QString &name, double def=0.0) const

float	getFloat (const QString &name, float def=0.0) const

int	getInt (const QString &name, int def=0) const

void	getPrefixedProperties (const QString &prefix, KisPropertiesConfiguration *config) const

void	getPrefixedProperties (const QString &prefix, KisPropertiesConfigurationSP config) const

virtual QMap< QString, QVariant >	getProperties () const

virtual QList< QString >	getPropertiesKeys () const

virtual QVariant	getProperty (const QString &name) const

virtual bool	getProperty (const QString &name, QVariant &value) const

QString	getPropertyLazy (const QString &name, const char *defaultValue) const

QStringList	getPropertyLazy (const QString &name, const QStringList &defaultValue) const

template<typename T >
T	getPropertyLazy (const QString &name, const T &defaultValue) const

QString	getString (const QString &name, const QString &def=QString()) const

QStringList	getStringList (const QString &name, const QStringList &defaultValue=QStringList()) const

virtual bool	hasProperty (const QString &name) const

	KisPropertiesConfiguration ()

	KisPropertiesConfiguration (const KisPropertiesConfiguration &rhs)

KisPropertiesConfiguration &	operator= (const KisPropertiesConfiguration &rhs)

void	removeProperty (const QString &name)

void	setPrefixedProperties (const QString &prefix, const KisPropertiesConfiguration *config)

void	setPrefixedProperties (const QString &prefix, const KisPropertiesConfigurationSP config)

void	setProperty (const QString &name, const QStringList &value)

void	setPropertyNotSaved (const QString &name)
	Marks a property that should not be saved by toXML.

QString	toXML () const override

void	toXML (QDomDocument &, QDomElement &) const override

	~KisPropertiesConfiguration () override

Public Member Functions inherited from KisSerializableConfiguration
	KisSerializableConfiguration ()

	KisSerializableConfiguration (const KisSerializableConfiguration &rhs)

virtual	~KisSerializableConfiguration ()

Public Member Functions inherited from KisShared
bool	deref ()

bool	ref ()

int	refCount ()

QAtomicInt *	sharedWeakReference ()

Static Public Member Functions
static KisLevelsCurve	defaultLevelsCurve ()

static QString	defaultName ()

static constexpr bool	defaultShowLogarithmicHistogram ()

static constexpr bool	defaultUseLightnessMode ()

static constexpr qint32	defaultVersion ()

Static Public Member Functions inherited from KisPropertiesConfiguration
static QString	escapeString (const QString &string)

static QString	extractedPrefixKey ()

static QString	unescapeString (const QString &string)

Private Member Functions
int	channelCount () const

void	setChannelCount (int newChannelCount)

void	setLegacyValuesFromLightnessLevelsCurve ()

void	setLightessLevelsCurveFromLegacyValues ()

void	updateLightnessTransfer ()

void	updateTransfers ()

Private Attributes
QVector< quint16 >	m_lightnessTransfer

QVector< QVector< quint16 > >	m_transfers

Additional Inherited Members
Public Attributes inherited from KisColorTransformationConfiguration
QMap< QThread , KoColorTransformation >	colorTransformation

QMutex	mutex

Public Attributes inherited from Private
KisCanvas2 *	canvas

int	displayedFrame

int	intendedFrame

Public Attributes inherited from KisFilterConfiguration
QBitArray	channelFlags

QString	name

KisResourcesInterfaceSP	resourcesInterface = 0

qint32	version

Public Attributes inherited from KisPropertiesConfiguration
QSet< QString >	notSavedProperties

QMap< QString, QVariant >	properties

Protected Member Functions inherited from KisFilterConfiguration
	KisFilterConfiguration (const KisFilterConfiguration &rhs)

void	setVersion (qint32 version)

Protected Member Functions inherited from KisShared
	KisShared ()

	~KisShared ()

Detailed Description

Definition at line 16 of file KisLevelsFilterConfiguration.h.

Constructor & Destructor Documentation

◆ KisLevelsFilterConfiguration() [1/3]

KisLevelsFilterConfiguration::KisLevelsFilterConfiguration	(	int	channelCount,
		qint32	version,
		KisResourcesInterfaceSP	resourcesInterface )

Definition at line 15 of file KisLevelsFilterConfiguration.cpp.

    : KisColorTransformationConfiguration(defaultName(), version, resourcesInterface)
{
    setChannelCount(channelCount);
    setDefaults();
 
}

References channelCount(), setChannelCount(), and setDefaults().

◆ KisLevelsFilterConfiguration() [2/3]

KisLevelsFilterConfiguration::KisLevelsFilterConfiguration	(	int	channelCount,
		KisResourcesInterfaceSP	resourcesInterface )

Definition at line 23 of file KisLevelsFilterConfiguration.cpp.

24 : KisLevelsFilterConfiguration(channelCount, defaultVersion(), resourcesInterface)

25{}

KisLevelsFilterConfiguration::defaultVersion

static constexpr qint32 defaultVersion()

Definition KisLevelsFilterConfiguration.h:26

KisLevelsFilterConfiguration::KisLevelsFilterConfiguration

KisLevelsFilterConfiguration(int channelCount, qint32 version, KisResourcesInterfaceSP resourcesInterface)

Definition KisLevelsFilterConfiguration.cpp:15

◆ KisLevelsFilterConfiguration() [3/3]

KisLevelsFilterConfiguration::KisLevelsFilterConfiguration ( const KisLevelsFilterConfiguration & rhs )

Definition at line 27 of file KisLevelsFilterConfiguration.cpp.

    : KisColorTransformationConfiguration(rhs)
    , m_transfers(rhs.m_transfers)
    , m_lightnessTransfer(rhs.m_lightnessTransfer)
{}

Member Function Documentation

◆ channelCount()

int KisLevelsFilterConfiguration::channelCount ( ) const

private

Definition at line 198 of file KisLevelsFilterConfiguration.cpp.

{
    return getInt("number_of_channels", 0);
}

References KisPropertiesConfiguration::getInt().

◆ clone()

KisFilterConfigurationSP KisLevelsFilterConfiguration::clone ( ) const

overridevirtual

Returns: an exact copy of the filter configuration. Resources interface is becomes shared between two configuration objects.

Reimplemented from KisColorTransformationConfiguration.

Definition at line 33 of file KisLevelsFilterConfiguration.cpp.

{
    return new KisLevelsFilterConfiguration(*this);
}

References KisLevelsFilterConfiguration().

◆ defaultLevelsCurve()

static KisLevelsCurve KisLevelsFilterConfiguration::defaultLevelsCurve ( )

inlinestatic

Definition at line 27 of file KisLevelsFilterConfiguration.h.

27{ return KisLevelsCurve(); }

KisLevelsCurve

This class holds the parameters for a levels adjustment. It is modeled after KisCubicCurve and has si...

Definition KisLevelsCurve.h:22

◆ defaultName()

static QString KisLevelsFilterConfiguration::defaultName ( )

inlinestatic

Definition at line 25 of file KisLevelsFilterConfiguration.h.

25{ return "levels"; }

◆ defaultShowLogarithmicHistogram()

static constexpr bool KisLevelsFilterConfiguration::defaultShowLogarithmicHistogram ( )

inlinestaticconstexpr

Definition at line 29 of file KisLevelsFilterConfiguration.h.

29{ return false; }

◆ defaultUseLightnessMode()

static constexpr bool KisLevelsFilterConfiguration::defaultUseLightnessMode ( )

inlinestaticconstexpr

Definition at line 28 of file KisLevelsFilterConfiguration.h.

28{ return true; }

◆ defaultVersion()

static constexpr qint32 KisLevelsFilterConfiguration::defaultVersion ( )

inlinestaticconstexpr

Definition at line 26 of file KisLevelsFilterConfiguration.h.

26{ return 2; }

◆ fromLegacyXML() [1/2]

void KisFilterConfiguration::fromLegacyXML ( const QDomElement & root )

virtual

This function is use to convert from legacy XML as used in .kra file.

Reimplemented from KisFilterConfiguration.

Definition at line 72 of file kis_filter_configuration.cc.

{
    clearProperties();
    d->name = root.attribute("name");
    d->version = root.attribute("version").toInt();
 
    QDomElement e;
    for (e = root.firstChildElement("property"); !e.isNull(); e = e.nextSiblingElement()) {
        QString name = e.attribute("name");
        QString type = e.attribute("type");
        QString value = e.text();
 
        // XXX: Convert the variant pro-actively to the right type?
        setProperty(name, QVariant(value));
    }
}

◆ fromLegacyXML() [2/2]

void KisLevelsFilterConfiguration::fromLegacyXML ( const QDomElement & root )

overridevirtual

This function is use to convert from legacy XML as used in .kra file.

Reimplemented from KisFilterConfiguration.

Definition at line 208 of file KisLevelsFilterConfiguration.cpp.

{
    fromXML(root);
}

References fromXML().

◆ fromXML() [1/4]

void KisPropertiesConfiguration::fromXML ( const QDomElement & root )

overridevirtual

Fill the properties configuration object from the XML encoded representation in s. This function use the "Legacy" style XML of the 1.x .kra file format.

Note: the existing properties will not be cleared

Reimplemented from KisFilterConfiguration.

Definition at line 74 of file kis_properties_configuration.cc.

{
    QDomElement e;
    for (e = root.firstChildElement("param"); !e.isNull(); e = e.nextSiblingElement("param")) {
        QString name = e.attribute("name");
        QString value = e.text();
 
        // Older versions didn't have a "type" parameter,
        // so fall back to the old behavior if it's missing.
        if (!e.hasAttribute("type")) {
            d->properties[name] = QVariant(value);
        } else if (e.attribute("type") == "bytearray") {
            d->properties[name] = QVariant(QByteArray::fromBase64(value.toLatin1()));
        } else {
            d->properties[name] = value;
        }
    }
}

◆ fromXML() [2/4]

void KisFilterConfiguration::fromXML ( const QDomElement & )

overridevirtual

Fill the object from the XML encoded representation in s.

Reimplemented from KisFilterConfiguration.

Definition at line 77 of file kis_filter_configuration.cc.

{
    d->version = elt.attribute("version").toInt();
    KisPropertiesConfiguration::fromXML(elt);
}

◆ fromXML() [3/4]

void KisLevelsFilterConfiguration::fromXML ( const QDomElement & )

overridevirtual

Fill the object from the XML encoded representation in s.

Reimplemented from KisFilterConfiguration.

Definition at line 213 of file KisLevelsFilterConfiguration.cpp.

{
    int version;
    version = root.attribute("version").toInt();
 
    QDomElement e = root.firstChild().toElement();
    QString attributeName;
    KisLevelsCurve lightnessLevelsCurve;
    QVector<KisLevelsCurve> levelsCurves;
    bool lightnessMode = defaultUseLightnessMode();
    bool logarithmicHistogram = defaultShowLogarithmicHistogram();
 
    if (version == 1) {
        while (!e.isNull()) {
            attributeName = e.attribute("name");
            if (attributeName == "gammavalue") {
                const double value = KisDomUtils::toDouble(e.text());
                lightnessLevelsCurve.setInputGamma(value);
            } else {
                const double value = KisDomUtils::toDouble(e.text()) / 255.0;
                if (attributeName == "blackvalue") {
                    lightnessLevelsCurve.setInputBlackPoint(value);
                } else if (attributeName == "whitevalue") {
                    lightnessLevelsCurve.setInputWhitePoint(value);
                } else if (attributeName == "outblackvalue") {
                    lightnessLevelsCurve.setOutputBlackPoint(value);
                } else if (attributeName == "outwhitevalue") {
                    lightnessLevelsCurve.setOutputWhitePoint(value);
                }
            }
            e = e.nextSiblingElement();
        }
    } else if (version == 2) {
        int numChannels = 0;
        QHash<int, KisLevelsCurve> unsortedLevelsCurves;
        KisLevelsCurve levelsCurve;
 
        while (!e.isNull()) {
            attributeName = e.attribute("name");
            if (attributeName == "mode") {
                lightnessMode = e.text() != "channels";
            } else if (attributeName == "histogram_mode") {
                logarithmicHistogram = e.text() == "logarithmic";
            } else if (attributeName == "lightness") {
                lightnessLevelsCurve.fromString(e.text());
            } else if (attributeName == "number_of_channels") {
                numChannels = e.text().toInt();
            } else {
                const QRegularExpression rx("channel_(\\d+)");
                const QRegularExpressionMatch match = rx.match(attributeName);
                if (match.hasMatch()) {
                    const int index = match.captured(1).toInt();
                    if (!e.text().isEmpty()) {
                        levelsCurve.fromString(e.text());
                        unsortedLevelsCurves[index] = levelsCurve;
                    }
                }
            }
            e = e.nextSiblingElement();
        }
 
        for (int i = 0; i < numChannels; ++i) {
            if (unsortedLevelsCurves.contains(i)) {
                levelsCurves.append(unsortedLevelsCurves[i]);
            } else {
                levelsCurves.append(defaultLevelsCurve());
            }
        }
    }
 
    setVersion(defaultVersion());
    setLevelsCurves(levelsCurves);
    setLightnessLevelsCurve(lightnessLevelsCurve);
    setUseLightnessMode(lightnessMode);
    setShowLogarithmicHistogram(logarithmicHistogram);
}

References defaultLevelsCurve(), defaultShowLogarithmicHistogram(), defaultUseLightnessMode(), defaultVersion(), KisLevelsCurve::fromString(), levelsCurves(), lightnessLevelsCurve(), KisLevelsCurve::setInputBlackPoint(), KisLevelsCurve::setInputGamma(), KisLevelsCurve::setInputWhitePoint(), setLevelsCurves(), setLightnessLevelsCurve(), KisLevelsCurve::setOutputBlackPoint(), KisLevelsCurve::setOutputWhitePoint(), setShowLogarithmicHistogram(), setUseLightnessMode(), KisFilterConfiguration::setVersion(), KisDomUtils::toDouble(), value(), and KisFilterConfiguration::version.

◆ fromXML() [4/4]

bool KisPropertiesConfiguration::fromXML	(	const QString &	xml,
		bool	clear = true )

overridevirtual

Fill the properties configuration object from the XML encoded representation in s. This function use the "Legacy" style XML of the 1.x .kra file format.

Parameters

xml	the string that will be parsed as xml
clear	if true, the properties map will be emptied.

Returns: true is the xml document could be parsed

Reimplemented from KisFilterConfiguration.

Definition at line 74 of file kis_properties_configuration.cc.

{
    if (clear) {
        clearProperties();
    }
 
    QDomDocument doc;
    bool retval = bool(doc.setContent(xml));
    if (retval) {
        QDomElement e = doc.documentElement();
        fromXML(e);
    }
    return retval;
}

◆ isCompatible()

bool KisLevelsFilterConfiguration::isCompatible ( const KisPaintDeviceSP ) const

overridevirtual

Check if that configuration is compatible with this paint device. The default implementation always return true.

Reimplemented from KisFilterConfiguration.

Definition at line 38 of file KisLevelsFilterConfiguration.cpp.

{
    return useLightnessMode() || (int)dev->compositionSourceColorSpace()->channelCount() == channelCount();
}

References channelCount(), KoColorSpace::channelCount(), KisPaintDevice::compositionSourceColorSpace(), and useLightnessMode().

◆ levelsCurves()

const QVector< KisLevelsCurve > KisLevelsFilterConfiguration::levelsCurves ( ) const

Definition at line 43 of file KisLevelsFilterConfiguration.cpp.

{
    QVector<KisLevelsCurve> levelsCurves_;
    for (qint32 i = 0; i < channelCount(); ++i) {
        const QString levelsCurveStr = getString(QString("channel_") + KisDomUtils::toString(i), "");
        levelsCurves_.append(levelsCurveStr.isEmpty() ? KisLevelsCurve() : KisLevelsCurve(levelsCurveStr));
    }
    return levelsCurves_;
}

References channelCount(), KisPropertiesConfiguration::getString(), and KisDomUtils::toString().

◆ lightnessLevelsCurve()

const KisLevelsCurve KisLevelsFilterConfiguration::lightnessLevelsCurve ( ) const

Definition at line 53 of file KisLevelsFilterConfiguration.cpp.

{
    const QString levelsCurveStr = getString("lightness", "");
    return levelsCurveStr.isEmpty() ? KisLevelsCurve() : KisLevelsCurve(levelsCurveStr);
}

References KisPropertiesConfiguration::getString().

◆ lightnessTransfer()

const QVector< quint16 > & KisLevelsFilterConfiguration::lightnessTransfer ( ) const

Definition at line 94 of file KisLevelsFilterConfiguration.cpp.

{
    return m_lightnessTransfer;
}

References m_lightnessTransfer.

◆ setChannelCount()

void KisLevelsFilterConfiguration::setChannelCount ( int newChannelCount )

private

Definition at line 203 of file KisLevelsFilterConfiguration.cpp.

{
    setProperty("number_of_channels", newChannelCount);
}

References setProperty().

◆ setDefaults()

void KisLevelsFilterConfiguration::setDefaults ( )

Definition at line 358 of file KisLevelsFilterConfiguration.cpp.

{
    setUseLightnessMode(defaultUseLightnessMode());
    setShowLogarithmicHistogram(defaultShowLogarithmicHistogram());
    setLightnessLevelsCurve(defaultLevelsCurve());
 
    QVector<KisLevelsCurve> levelsCurves_;
    for (int i = 0; i < channelCount(); ++i) {
        levelsCurves_.append(defaultLevelsCurve());
    }
    setLevelsCurves(levelsCurves_);
 
    updateTransfers();
    updateLightnessTransfer();
}

References channelCount(), defaultLevelsCurve(), defaultShowLogarithmicHistogram(), defaultUseLightnessMode(), setLevelsCurves(), setLightnessLevelsCurve(), setShowLogarithmicHistogram(), setUseLightnessMode(), updateLightnessTransfer(), and updateTransfers().

◆ setLegacyValuesFromLightnessLevelsCurve()

void KisLevelsFilterConfiguration::setLegacyValuesFromLightnessLevelsCurve ( )

private

The purpose of this function is to copy the values of the new and compact "lightness" option, that correspond to the lightness levels adjustment, to the legacy options that where used before version 2 of the filter. Storing the legacy options as well as the new ones improves backwards compatibility of documents. Note that the "blackvalue", "whitevalue", "outblackvalue" and "outwhitevalue" legacy properties span the range [0, 255] while the values in the "lightness" property span the range [0, 1]

Definition at line 163 of file KisLevelsFilterConfiguration.cpp.

{
    KisLevelsCurve lightnessLevelsCurve_ = lightnessLevelsCurve();
    KisColorTransformationConfiguration::setProperty("blackvalue", static_cast<int>(qRound(lightnessLevelsCurve_.inputBlackPoint() * 255.0)));
    KisColorTransformationConfiguration::setProperty("whitevalue", static_cast<int>(qRound(lightnessLevelsCurve_.inputWhitePoint() * 255.0)));
    KisColorTransformationConfiguration::setProperty("gammavalue", lightnessLevelsCurve_.inputGamma());
    KisColorTransformationConfiguration::setProperty("outblackvalue", static_cast<int>(qRound(lightnessLevelsCurve_.outputBlackPoint() * 255.0)));
    KisColorTransformationConfiguration::setProperty("outwhitevalue", static_cast<int>(qRound(lightnessLevelsCurve_.outputWhitePoint() * 255.0)));
}

References KisLevelsCurve::inputBlackPoint(), KisLevelsCurve::inputGamma(), KisLevelsCurve::inputWhitePoint(), lightnessLevelsCurve(), KisLevelsCurve::outputBlackPoint(), KisLevelsCurve::outputWhitePoint(), and KisColorTransformationConfiguration::setProperty().

◆ setLevelsCurves()

void KisLevelsFilterConfiguration::setLevelsCurves ( const QVector< KisLevelsCurve > & newLevelsCurves )

Definition at line 59 of file KisLevelsFilterConfiguration.cpp.

{
    for (int i = 0; i < newLevelsCurves.size(); ++i) {
        setProperty(QString("channel_") + KisDomUtils::toString(i), newLevelsCurves[i].toString());
    }
    setChannelCount(newLevelsCurves.size());
    updateTransfers();
}

References setChannelCount(), setProperty(), KisDomUtils::toString(), and updateTransfers().

◆ setLightessLevelsCurveFromLegacyValues()

void KisLevelsFilterConfiguration::setLightessLevelsCurveFromLegacyValues ( )

private

The purpose of this function is to copy the values of the legacy options (levels filter version < 2), that correspond to the lightness levels adjustment, to the new and compact "lightness" option which is used now. Note that the "blackvalue", "whitevalue", "outblackvalue" and "outwhitevalue" legacy properties span the range [0, 255] while the values in the "lightness" property span the range [0, 1]

Definition at line 140 of file KisLevelsFilterConfiguration.cpp.

{
    const double inputBlackPoint = static_cast<double>(getInt("blackvalue", 0)) / 255.0;
    const double inputWhitePoint = static_cast<double>(getInt("whitevalue", 255)) / 255.0;
    const double inputGamma = getDouble("gammavalue", 1.0);
    const double outputBlackPoint = static_cast<double>(getInt("outblackvalue", 0)) / 255.0;
    const double outputWhitePoint = static_cast<double>(getInt("outwhitevalue", 255)) / 255.0;
    KisColorTransformationConfiguration::setProperty(
        "lightness",
        KisLevelsCurve(inputBlackPoint, inputWhitePoint, inputGamma, outputBlackPoint, outputWhitePoint).toString()
    );
}

References KisPropertiesConfiguration::getDouble(), KisPropertiesConfiguration::getInt(), and KisColorTransformationConfiguration::setProperty().

◆ setLightnessLevelsCurve()

void KisLevelsFilterConfiguration::setLightnessLevelsCurve ( const KisLevelsCurve & newLightnessLevelsCurve )

Definition at line 68 of file KisLevelsFilterConfiguration.cpp.

{
    setProperty("lightness", newLightnessLevelsCurve.toString());
}

References setProperty(), and KisLevelsCurve::toString().

◆ setProperty()

void KisLevelsFilterConfiguration::setProperty	(	const QString &	name,
		const QVariant &	value )

overridevirtual

The options may be changed directly using the "setProperty" method of the "KisPropertiesConfiguration". In this case we must intercept the action to update the transfer function luts after setting the property. if some legacy property is set (lightness levels properties prior to version 2) then the legacy properties are copied to the new and compact "lightness" property. Conversely, if the "lightness" property is set, its values are copied to the legacy properties.

Reimplemented from KisColorTransformationConfiguration.

Definition at line 182 of file KisLevelsFilterConfiguration.cpp.

{
    KisColorTransformationConfiguration::setProperty(name, value);
 
    if (name == "lightness") {
        setLegacyValuesFromLightnessLevelsCurve();
        updateLightnessTransfer();
    } else if (name == "blackvalue" || name == "whitevalue" || name == "gammavalue" ||
               name == "outblackvalue" || name == "outwhitevalue") {
        setLightessLevelsCurveFromLegacyValues();
        updateLightnessTransfer();
    } else if (QRegularExpression("channel_\\d+").match(name).hasMatch()) {
        updateTransfers();
    }
}

References KisFilterConfiguration::name, setLegacyValuesFromLightnessLevelsCurve(), setLightessLevelsCurveFromLegacyValues(), KisColorTransformationConfiguration::setProperty(), updateLightnessTransfer(), updateTransfers(), and value().

◆ setShowLogarithmicHistogram()

void KisLevelsFilterConfiguration::setShowLogarithmicHistogram ( bool newShowLogarithmicHistogram )

Definition at line 126 of file KisLevelsFilterConfiguration.cpp.

{
    setProperty("histogram_mode", newShowLogarithmicHistogram ? "logarithmic" : "linear");
}

References setProperty().

◆ setUseLightnessMode()

void KisLevelsFilterConfiguration::setUseLightnessMode ( bool newUseLightnessMode )

Definition at line 121 of file KisLevelsFilterConfiguration.cpp.

{
    setProperty("mode", newUseLightnessMode ? "lightness" : "channels");
}

References setProperty().

◆ showLogarithmicHistogram()

bool KisLevelsFilterConfiguration::showLogarithmicHistogram ( ) const

Definition at line 110 of file KisLevelsFilterConfiguration.cpp.

{
    const QString mode = getString("histogram_mode", "");
    if (mode == "logarithmic") {
        return true;
    } else if (mode == "linear") {
        return false;
    }
    return defaultShowLogarithmicHistogram();
}

References defaultShowLogarithmicHistogram(), and KisPropertiesConfiguration::getString().

◆ toXML() [1/4]

QString KisPropertiesConfiguration::toXML ( ) const

overridevirtual

Create a serialized version of this properties config This function use the "Legacy" style XML of the 1.x .kra file format.

Reimplemented from KisFilterConfiguration.

Definition at line 75 of file kis_properties_configuration.cc.

{
    QDomDocument doc = QDomDocument("params");
    QDomElement root = doc.createElement("params");
    doc.appendChild(root);
    toXML(doc, root);
    return doc.toString();
}

◆ toXML() [2/4]

void KisFilterConfiguration::toXML	(	QDomDocument &	,
		QDomElement &	) const

overridevirtual

Create a serialized version of this object

Reimplemented from KisFilterConfiguration.

Definition at line 78 of file kis_filter_configuration.cc.

{
    elt.setAttribute("version", d->version);
    KisPropertiesConfiguration::toXML(doc, elt);
}

◆ toXML() [3/4]

void KisPropertiesConfiguration::toXML	(	QDomDocument &	doc,
		QDomElement &	root ) const

overridevirtual

Create a serialized version of this properties config This function use the "Legacy" style XML of the 1.x .kra file format.

Reimplemented from KisFilterConfiguration.

Definition at line 75 of file kis_properties_configuration.cc.

{
    QMap<QString, QVariant>::ConstIterator it;
    for (it = d->properties.constBegin(); it != d->properties.constEnd(); ++it) {
        if (d->notSavedProperties.contains(it.key())) {
            continue;
        }
 
        QDomElement e = doc.createElement("param");
        e.setAttribute("name", QString(it.key().toLatin1()));
        QString type = "string";
        QVariant v = it.value();
        QDomText text;
        if (v.type() == QVariant::UserType && v.userType() == qMetaTypeId<KisCubicCurve>()) {
            text = doc.createCDATASection(v.value<KisCubicCurve>().toString());
        } else if (v.type() == QVariant::UserType && v.userType() == qMetaTypeId<KoColor>()) {
            QDomDocument cdataDoc = QDomDocument("color");
            QDomElement cdataRoot = cdataDoc.createElement("color");
            cdataDoc.appendChild(cdataRoot);
            v.value<KoColor>().toXML(cdataDoc, cdataRoot);
            text = cdataDoc.createCDATASection(cdataDoc.toString());
            type = "color";
        } else if(v.type() == QVariant::String ) {
            text = doc.createCDATASection(v.toString());  // XXX: Unittest this!
            type = "string";
        } else if(v.type() == QVariant::ByteArray ) {
            text = doc.createTextNode(QString::fromLatin1(v.toByteArray().toBase64())); // Arbitrary Data
            type = "bytearray";
        } else {
            text = doc.createTextNode(v.toString());
            type = "internal";
        }
        e.setAttribute("type", type);
        e.appendChild(text);
        root.appendChild(e);
    }
}

◆ toXML() [4/4]

void KisLevelsFilterConfiguration::toXML	(	QDomDocument &	,
		QDomElement &	) const

overridevirtual

Create a serialized version of this object

levels curve param follows this format: "input_black_point;input_white_point;input_gamma;output_black_point;output_white_point"

For backwards compatibility, the "blackvalue" etc. values are also saved. Those contain the values of the lightness mode levels.

<params version=2>
     <param name="mode">lightness</param>
     <param name="histogram_mode">logarithmic</param>
     <param name="lightness">0;1;0.4;0;1</param>
     <param name="number_of_channels">3</param>
     <param name="channel_0">0;1;1;0;1</param>
     <param name="channel_1">0.2;0.8;1.2;0.25;0.75</param>
     <param name="channel_2">0;1;0.6;0;1</param>
 
     <param type="internal" name="blackvalue">0</param>
     <param type="internal" name="whitevalue">255</param>
     <param type="internal" name="gammavalue">1</param>
     <param type="internal" name="outblackvalue">0</param>
     <param type="internal" name="outwhitevalue">255</param>
</params>

Reimplemented from KisFilterConfiguration.

Definition at line 306 of file KisLevelsFilterConfiguration.cpp.

{
    root.setAttribute("version", version());
 
    QDomText text;
    QDomElement t;
 
    addParamNode(doc, root, "mode", useLightnessMode() ? "lightness" : "channels");
    addParamNode(doc, root, "histogram_mode", showLogarithmicHistogram() ? "logarithmic" : "linear");
    addParamNode(doc, root, "lightness", lightnessLevelsCurve().toString());
    addParamNode(doc, root, "number_of_channels", KisDomUtils::toString(channelCount()));
 
    const QVector<KisLevelsCurve> levelsCurves_ = levelsCurves();
    for (int i = 0; i < levelsCurves_.size(); ++i) {
        const QString name = QString("channel_") + KisDomUtils::toString(i);
        const QString value = levelsCurves_[i].toString();
        addParamNode(doc, root, name, value);
    }
    const KisLevelsCurve lightnessCurve_ = lightnessLevelsCurve();
    addParamNode(doc, root, "blackvalue", KisDomUtils::toString(static_cast<int>(qRound(lightnessCurve_.inputBlackPoint() * 255.0))), true);
    addParamNode(doc, root, "whitevalue", KisDomUtils::toString(static_cast<int>(qRound(lightnessCurve_.inputWhitePoint() * 255.0))), true);
    addParamNode(doc, root, "gammavalue", KisDomUtils::toString(lightnessCurve_.inputGamma()), true);
    addParamNode(doc, root, "outblackvalue", KisDomUtils::toString(static_cast<int>(qRound(lightnessCurve_.outputBlackPoint() * 255.0))), true);
    addParamNode(doc, root, "outwhitevalue", KisDomUtils::toString(static_cast<int>(qRound(lightnessCurve_.outputWhitePoint() * 255.0))), true);
}

References addParamNode(), channelCount(), KisLevelsCurve::inputBlackPoint(), KisLevelsCurve::inputGamma(), KisLevelsCurve::inputWhitePoint(), levelsCurves(), lightnessLevelsCurve(), KisFilterConfiguration::name, KisLevelsCurve::outputBlackPoint(), KisLevelsCurve::outputWhitePoint(), showLogarithmicHistogram(), KisDomUtils::toString(), useLightnessMode(), value(), and KisFilterConfiguration::version.

◆ transfers()

const QVector< QVector< quint16 > > & KisLevelsFilterConfiguration::transfers ( ) const

Definition at line 89 of file KisLevelsFilterConfiguration.cpp.

{
    return m_transfers;
}

References m_transfers.

◆ updateLightnessTransfer()

void KisLevelsFilterConfiguration::updateLightnessTransfer ( )

private

Definition at line 82 of file KisLevelsFilterConfiguration.cpp.

{
    const KisLevelsCurve lightnessLevelsCurve_ = lightnessLevelsCurve();
 
    m_lightnessTransfer = lightnessLevelsCurve_.uint16Transfer();
}

References lightnessLevelsCurve(), m_lightnessTransfer, and KisLevelsCurve::uint16Transfer().

◆ updateTransfers()

void KisLevelsFilterConfiguration::updateTransfers ( )

private

Definition at line 73 of file KisLevelsFilterConfiguration.cpp.

{
    const QVector<KisLevelsCurve> lc = levelsCurves();
    m_transfers.resize(lc.size());
    for (int i = 0; i < lc.size(); i++) {
        m_transfers[i] = lc[i].uint16Transfer();
    }
}

References levelsCurves(), and m_transfers.

◆ useLightnessMode()

bool KisLevelsFilterConfiguration::useLightnessMode ( ) const

Definition at line 99 of file KisLevelsFilterConfiguration.cpp.

{
    const QString mode = getString("mode", "");
    if (mode == "lightness") {
        return true;
    } else if (mode == "channels") {
        return false;
    }
    return defaultUseLightnessMode();
}

References defaultUseLightnessMode(), and KisPropertiesConfiguration::getString().

Member Data Documentation

◆ m_lightnessTransfer

QVector<quint16> KisLevelsFilterConfiguration::m_lightnessTransfer

private

Definition at line 59 of file KisLevelsFilterConfiguration.h.

◆ m_transfers

QVector<QVector<quint16> > KisLevelsFilterConfiguration::m_transfers

private

Definition at line 58 of file KisLevelsFilterConfiguration.h.

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

plugins/filters/levelfilter/KisLevelsFilterConfiguration.h
plugins/filters/levelfilter/KisLevelsFilterConfiguration.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KisLevelsFilterConfiguration() [1/3]

◆ KisLevelsFilterConfiguration() [2/3]

◆ KisLevelsFilterConfiguration() [3/3]

Member Function Documentation

◆ channelCount()

◆ clone()

◆ defaultLevelsCurve()

◆ defaultName()

◆ defaultShowLogarithmicHistogram()

◆ defaultUseLightnessMode()

◆ defaultVersion()

◆ fromLegacyXML() [1/2]

◆ fromLegacyXML() [2/2]

◆ fromXML() [1/4]

◆ fromXML() [2/4]

◆ fromXML() [3/4]

◆ fromXML() [4/4]

◆ isCompatible()

◆ levelsCurves()

◆ lightnessLevelsCurve()

◆ lightnessTransfer()

◆ setChannelCount()

◆ setDefaults()

◆ setLegacyValuesFromLightnessLevelsCurve()

◆ setLevelsCurves()

◆ setLightessLevelsCurveFromLegacyValues()

◆ setLightnessLevelsCurve()

◆ setProperty()

◆ setShowLogarithmicHistogram()

◆ setUseLightnessMode()

◆ showLogarithmicHistogram()

◆ toXML() [1/4]

◆ toXML() [2/4]

◆ toXML() [3/4]

◆ toXML() [4/4]

◆ transfers()

◆ updateLightnessTransfer()

◆ updateTransfers()

◆ useLightnessMode()

Member Data Documentation

◆ m_lightnessTransfer

◆ m_transfers