#include <kis_multichannel_filter_base.h>

Inheritance diagram for KisMultiChannelFilterConfiguration:

Public Member Functions
virtual bool	compareTo (const KisPropertiesConfiguration *rhs) const override

const QList< KisCubicCurve > &	curves () const

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

	KisMultiChannelFilterConfiguration (const KisMultiChannelFilterConfiguration &rhs)

	KisMultiChannelFilterConfiguration (int channelCount, const QString &name, qint32 version, KisResourcesInterfaceSP resourcesInterface)

void	setActiveCurve (int value)

void	setCurves (QList< KisCubicCurve > &curves)

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

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

	~KisMultiChannelFilterConfiguration () override

Public Member Functions inherited from KisColorTransformationConfiguration
KisFilterConfigurationSP	clone () const override

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

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 ()

Protected Member Functions
bool	curveIndexFromCurvePropertyName (const QString &name, int &curveIndex) const
	Takes a curve property name with format "curve#", where # is the index of the channel and puts the index on the "curveIndex" parameter.

virtual KisCubicCurve	getDefaultCurve ()=0

void	init ()

void	updateTransfer (int index)

void	updateTransfers ()

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

void	setVersion (qint32 version)

Protected Member Functions inherited from KisShared
	KisShared ()

	~KisShared ()

Protected Attributes
int	m_activeCurve {-1}

int	m_channelCount {0}

QList< KisCubicCurve >	m_curves

QVector< QVector< quint16 > >	m_transfers

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

static QString	extractedPrefixKey ()

static QString	unescapeString (const QString &string)

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

Detailed Description

Base class for configurations of KisMultiChannelFilter subclasses

Definition at line 46 of file kis_multichannel_filter_base.h.

Constructor & Destructor Documentation

◆ KisMultiChannelFilterConfiguration() [1/2]

KisMultiChannelFilterConfiguration::KisMultiChannelFilterConfiguration	(	int	channelCount,
		const QString &	name,
		qint32	version,
		KisResourcesInterfaceSP	resourcesInterface )

Definition at line 70 of file kis_multichannel_filter_base.cpp.

        : KisColorTransformationConfiguration(name, version, resourcesInterface)
        , m_channelCount(channelCount)
{
}

◆ KisMultiChannelFilterConfiguration() [2/2]

KisMultiChannelFilterConfiguration::KisMultiChannelFilterConfiguration ( const KisMultiChannelFilterConfiguration & rhs )

Definition at line 76 of file kis_multichannel_filter_base.cpp.

    : KisColorTransformationConfiguration(rhs),
      m_channelCount(rhs.m_channelCount),
      m_curves(rhs.m_curves),
      m_transfers(rhs.m_transfers)
{
}

◆ ~KisMultiChannelFilterConfiguration()

KisMultiChannelFilterConfiguration::~KisMultiChannelFilterConfiguration ( )

override

Definition at line 84 of file kis_multichannel_filter_base.cpp.

85{}

Member Function Documentation

◆ compareTo()

bool KisMultiChannelFilterConfiguration::compareTo ( const KisPropertiesConfiguration * rhs ) const

overridevirtual

Structural comparison between two instances.

Reimplemented from KisFilterConfiguration.

Reimplemented in KisCrossChannelFilterConfiguration.

Definition at line 305 of file kis_multichannel_filter_base.cpp.

{
    const KisMultiChannelFilterConfiguration *otherConfig = dynamic_cast<const KisMultiChannelFilterConfiguration *>(rhs);
 
    return otherConfig
        && KisFilterConfiguration::compareTo(rhs)
        && m_channelCount == otherConfig->m_channelCount
        && m_curves == otherConfig->m_curves
        && m_transfers == otherConfig->m_transfers
        && m_activeCurve == otherConfig->m_activeCurve;
}

References KisFilterConfiguration::compareTo(), m_activeCurve, m_channelCount, m_curves, and m_transfers.

◆ curveIndexFromCurvePropertyName()

bool KisMultiChannelFilterConfiguration::curveIndexFromCurvePropertyName	(	const QString &	name,
		int &	curveIndex ) const

protected

Takes a curve property name with format "curve#", where # is the index of the channel and puts the index on the "curveIndex" parameter.

Parameters

name	A string with format "curve#"
curveIndex	An int where the decoded channel index is stored

Returns: true if "name" had a valid format; false if "name" had an invalid format

Definition at line 376 of file kis_multichannel_filter_base.cpp.

{
    QRegExp rx("curve(\\d+)");
    if (rx.indexIn(name, 0) == -1) {
        return false;
    }
 
    curveIndex = rx.cap(1).toUShort();
    return true;
}

References KisFilterConfiguration::name.

◆ curves()

const QList< KisCubicCurve > & KisMultiChannelFilterConfiguration::curves ( ) const

Definition at line 163 of file kis_multichannel_filter_base.cpp.

{
    return m_curves;
}

References m_curves.

◆ 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 KisMultiChannelFilterConfiguration::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 168 of file kis_multichannel_filter_base.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 KisMultiChannelFilterConfiguration::fromXML ( const QDomElement & )

overridevirtual

Fill the object from the XML encoded representation in s.

In Krita 2.9 we stored alpha channel under a separate tag, so we should addend it separately if present

Reimplemented from KisFilterConfiguration.

Definition at line 173 of file kis_multichannel_filter_base.cpp.

{
    QList<KisCubicCurve> curves;
    quint16 numTransfers = 0;
    quint16 numTransfersWithAlpha = 0;
    int activeCurve = -1;
    int version;
    version = root.attribute("version").toInt();
 
    QDomElement e = root.firstChild().toElement();
    QString attributeName;
    KisCubicCurve curve;
    quint16 index;
    QRegExp curveRegexp("curve(\\d+)");
 
    while (!e.isNull()) {
        if ((attributeName = e.attribute("name")) == "activeCurve") {
            activeCurve = e.text().toInt();
        } else if ((attributeName = e.attribute("name")) == "nTransfers") {
            numTransfers = e.text().toUShort();
        } else if ((attributeName = e.attribute("name")) == "nTransfersWithAlpha") {
            numTransfersWithAlpha = e.text().toUShort();
        } else {
            if (curveRegexp.indexIn(attributeName, 0) != -1) {
 
                index = curveRegexp.cap(1).toUShort();
                index = qMin(index, quint16(curves.count()));
 
                if (!e.text().isEmpty()) {
                    curve = KisCubicCurve(e.text());
                }
                curves.insert(index, curve);
            }
        }
        e = e.nextSiblingElement();
    }
 
    if (numTransfersWithAlpha > numTransfers) {
        e = root.firstChild().toElement();
        while (!e.isNull()) {
            if ((attributeName = e.attribute("name")) == "alphaCurve") {
                if (!e.text().isEmpty()) {
                    curves.append(KisCubicCurve(e.text()));
                }
            }
            e = e.nextSiblingElement();
        }
    }
 
    //prepend empty curves for the brightness contrast filter.
    if(getString("legacy") == "brightnesscontrast") {
        if (getString("colorModel") == LABAColorModelID.id()) {
            curves.append(KisCubicCurve());
            curves.append(KisCubicCurve());
            curves.append(KisCubicCurve());
        } else {
            int extraChannels = 5;
            if (getString("colorModel") == CMYKAColorModelID.id()) {
                extraChannels = 6;
            } else if (getString("colorModel") == GrayAColorModelID.id()) {
                extraChannels = 0;
            }
            for(int c = 0; c < extraChannels; c ++) {
                curves.insert(0, KisCubicCurve());
            }
        }
    }
    if (!numTransfers)
        return;
 
    setVersion(version);
    setCurves(curves);
    setActiveCurve(activeCurve);
}

References CMYKAColorModelID, curves(), KisPropertiesConfiguration::getString(), GrayAColorModelID, KoID::id(), LABAColorModelID, setActiveCurve(), setCurves(), KisFilterConfiguration::setVersion(), 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;
}

◆ getDefaultCurve()

virtual KisCubicCurve KisMultiChannelFilterConfiguration::getDefaultCurve ( )

protectedpure virtual

Implemented in KisCrossChannelFilterConfiguration, and KisPerChannelFilterConfiguration.

◆ init()

void KisMultiChannelFilterConfiguration::init ( )

protected

Definition at line 87 of file kis_multichannel_filter_base.cpp.

{
    m_curves.clear();
    
    KisColorTransformationConfiguration::setProperty("nTransfers", m_channelCount);
 
    for (int i = 0; i < m_channelCount; ++i) {
        m_curves.append(getDefaultCurve());
 
        const QString name = QLatin1String("curve") + QString::number(i);
        const QString value = m_curves.last().toString();
        KisColorTransformationConfiguration::setProperty(name, value);
    }
 
    updateTransfers();
}

References getDefaultCurve(), m_channelCount, m_curves, KisFilterConfiguration::name, KisColorTransformationConfiguration::setProperty(), updateTransfers(), and value().

◆ isCompatible()

bool KisMultiChannelFilterConfiguration::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 104 of file kis_multichannel_filter_base.cpp.

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

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

◆ setActiveCurve()

void KisMultiChannelFilterConfiguration::setActiveCurve ( int value )

Definition at line 136 of file kis_multichannel_filter_base.cpp.

{
    m_activeCurve = value;
    KisColorTransformationConfiguration::setProperty("activeCurve", value);
}

References m_activeCurve, KisColorTransformationConfiguration::setProperty(), and value().

◆ setCurves()

void KisMultiChannelFilterConfiguration::setCurves ( QList< KisCubicCurve > & curves )

Definition at line 109 of file kis_multichannel_filter_base.cpp.

{
    // Clean unused properties
    if (curves.size() < m_curves.size()) {
        for (int i = curves.size(); i < m_curves.size(); ++i) {
            const QString name = QLatin1String("curve") + QString::number(i);
            KisColorTransformationConfiguration::removeProperty(name);
        }
    }
 
    m_curves.clear();
    m_curves = curves;
    m_channelCount = curves.size();
    m_activeCurve = qMin(m_activeCurve, m_channelCount - 1);
 
    updateTransfers();
 
    // Update properties for python
    KisColorTransformationConfiguration::setProperty("nTransfers", m_channelCount);
 
    for (int i = 0; i < m_curves.size(); ++i) {
        const QString name = QLatin1String("curve") + QString::number(i);
        const QString value = m_curves[i].toString();
        KisColorTransformationConfiguration::setProperty(name, value);
    }
}

References curves(), m_activeCurve, m_channelCount, m_curves, KisFilterConfiguration::name, KisPropertiesConfiguration::removeProperty(), KisColorTransformationConfiguration::setProperty(), updateTransfers(), and value().

◆ setProperty()

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

overridevirtual

Invalidate the cache by default when setProperty is called. This forces regenerating the color transforms also when a property of this object changes, not only when the object is copied

Reimplemented from KisColorTransformationConfiguration.

Definition at line 317 of file kis_multichannel_filter_base.cpp.

{
    if (name == "nTransfers") {
        KIS_SAFE_ASSERT_RECOVER_RETURN(value.canConvert<int>());
 
        const qint32 newChannelCount = value.toInt();
 
        if (newChannelCount == m_channelCount) {
            return;
        }
 
        KisColorTransformationConfiguration::setProperty(name, value);
 
        m_transfers.resize(newChannelCount);
        if (newChannelCount > m_channelCount) {
            for (qint32 i = m_channelCount; i < newChannelCount; ++i) {
                m_curves.append(getDefaultCurve());
                updateTransfer(i);
 
                const QString name = QLatin1String("curve") + QString::number(i);
                const QString value = m_curves.last().toString();
                KisColorTransformationConfiguration::setProperty(name, value);
            }
        } else {
            for (qint32 i = newChannelCount; i < m_channelCount; ++i) {
                m_curves.removeLast();
 
                const QString name = QLatin1String("curve") + QString::number(i);
                KisColorTransformationConfiguration::removeProperty(name);
            }
        }
 
        m_channelCount = newChannelCount;
        invalidateColorTransformationCache();
 
 
        return;
    }
 
    if (name == "activeCurve") {
        setActiveCurve(qBound(0, value.toInt(), m_channelCount));
    }
 
    int curveIndex;
    if (!curveIndexFromCurvePropertyName(name, curveIndex) ||
        curveIndex < 0 || curveIndex >= m_channelCount) {
        return;
    }
 
    KIS_SAFE_ASSERT_RECOVER_RETURN(value.canConvert<QString>());
 
    m_curves[curveIndex] = KisCubicCurve(value.toString());
    updateTransfer(curveIndex);
    invalidateColorTransformationCache();
 
    // Query the curve instead of using the value directly, in case of not valid curve string
    KisColorTransformationConfiguration::setProperty(name, m_curves[curveIndex].toString());
}

References curveIndexFromCurvePropertyName(), getDefaultCurve(), KisColorTransformationConfiguration::invalidateColorTransformationCache(), KIS_SAFE_ASSERT_RECOVER_RETURN, m_channelCount, m_curves, m_transfers, KisFilterConfiguration::name, KisPropertiesConfiguration::removeProperty(), setActiveCurve(), KisColorTransformationConfiguration::setProperty(), updateTransfer(), and value().

◆ 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 KisMultiChannelFilterConfiguration::toXML	(	QDomDocument &	,
		QDomElement &	) const

overridevirtual

Create a serialized version of this object

<params version=1>
      <param name="nTransfers">3</param>
      <param name="curve0">0,0;0.5,0.5;1,1;</param>
      <param name="curve1">0,0;1,1;</param>
      <param name="curve2">0,0;1,1;</param>
</params>

Reimplemented from KisFilterConfiguration.

Definition at line 269 of file kis_multichannel_filter_base.cpp.

{
    root.setAttribute("version", version());
 
    QDomText text;
    QDomElement t;
 
    addParamNode(doc, root, "nTransfers", QString::number(m_channelCount));
 
    if (m_activeCurve >= 0) {
        // save active curve if only it has non-default value
        addParamNode(doc, root, "activeCurve", QString::number(m_activeCurve));
    }
 
    KisCubicCurve curve;
    QString paramName;
 
    for (int i = 0; i < m_curves.size(); ++i) {
        QString name = QLatin1String("curve") + QString::number(i);
        QString value = m_curves[i].toString();
 
        addParamNode(doc, root, name, value);
    }
}

References addParamNode(), m_activeCurve, m_channelCount, m_curves, KisFilterConfiguration::name, value(), and KisFilterConfiguration::version.

◆ transfers()

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

Definition at line 157 of file kis_multichannel_filter_base.cpp.

{
    return m_transfers;
}

References m_transfers.

◆ updateTransfer()

void KisMultiChannelFilterConfiguration::updateTransfer ( int index )

protected

Definition at line 142 of file kis_multichannel_filter_base.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_RETURN(index >= 0 && index < m_curves.size());
    m_transfers[index] = m_curves[index].uint16Transfer();
}

References KIS_SAFE_ASSERT_RECOVER_RETURN, m_curves, and m_transfers.

◆ updateTransfers()

void KisMultiChannelFilterConfiguration::updateTransfers ( )

protected

Definition at line 148 of file kis_multichannel_filter_base.cpp.

{
    m_transfers.resize(m_channelCount);
    for (int i = 0; i < m_channelCount; i++) {
        m_transfers[i] = m_curves[i].uint16Transfer();
    }
}

References m_channelCount, m_curves, and m_transfers.

Member Data Documentation

◆ m_activeCurve

int KisMultiChannelFilterConfiguration::m_activeCurve {-1}

protected

Definition at line 75 of file kis_multichannel_filter_base.h.

75{-1};

◆ m_channelCount

int KisMultiChannelFilterConfiguration::m_channelCount {0}

protected

Definition at line 74 of file kis_multichannel_filter_base.h.

74{0};

◆ m_curves

QList<KisCubicCurve> KisMultiChannelFilterConfiguration::m_curves

protected

Definition at line 76 of file kis_multichannel_filter_base.h.

◆ m_transfers

QVector<QVector<quint16> > KisMultiChannelFilterConfiguration::m_transfers

protected

Definition at line 77 of file kis_multichannel_filter_base.h.

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

plugins/filters/colorsfilters/kis_multichannel_filter_base.h
plugins/filters/colorsfilters/kis_multichannel_filter_base.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KisMultiChannelFilterConfiguration() [1/2]

◆ KisMultiChannelFilterConfiguration() [2/2]

◆ ~KisMultiChannelFilterConfiguration()

Member Function Documentation

◆ compareTo()

◆ curveIndexFromCurvePropertyName()

◆ curves()

◆ fromLegacyXML() [1/2]

◆ fromLegacyXML() [2/2]

◆ fromXML() [1/4]

◆ fromXML() [2/4]

◆ fromXML() [3/4]

◆ fromXML() [4/4]

◆ getDefaultCurve()

◆ init()

◆ isCompatible()

◆ setActiveCurve()

◆ setCurves()

◆ setProperty()

◆ toXML() [1/4]

◆ toXML() [2/4]

◆ toXML() [3/4]

◆ toXML() [4/4]

◆ transfers()

◆ updateTransfer()

◆ updateTransfers()

Member Data Documentation

◆ m_activeCurve

◆ m_channelCount

◆ m_curves

◆ m_transfers