#include <kis_filter_configuration.h>

Inheritance diagram for KisFilterConfiguration:

Public Member Functions
QBitArray	channelFlags () const

virtual KisFilterConfigurationSP	clone () 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

virtual void	fromLegacyXML (const QDomElement &)

void	fromXML (const QDomElement &) override

void	fromXML (const QDomElement &) override

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

bool	hasLocalResourcesSnapshot () const

virtual bool	isCompatible (const KisPaintDeviceSP) 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)

QString	toXML () const override

void	toXML (QDomDocument &, QDomElement &) const override

void	toXML (QDomDocument &, QDomElement &) const override

qint32	version () const

	~KisFilterConfiguration () override

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

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)

virtual void	setProperty (const QString &name, const QVariant &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 ()

Public Attributes
QBitArray	channelFlags

QString	name

KisResourcesInterfaceSP	resourcesInterface = 0

qint32	version

Public Attributes inherited from Private
KisCanvas2 *	canvas

int	displayedFrame

int	intendedFrame

Public Attributes inherited from KisPropertiesConfiguration
QSet< QString >	notSavedProperties

QMap< QString, QVariant >	properties

Protected Member Functions
	KisFilterConfiguration (const KisFilterConfiguration &rhs)

void	setVersion (qint32 version)

Protected Member Functions inherited from KisShared
	KisShared ()

	~KisShared ()

Private Member Functions
int	sanityDerefUsageCounter ()

int	sanityRefUsageCounter ()

Private Attributes
Private *const	d

Friends
class	KisNodeFilterInterface

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)

Detailed Description

A KisFilterConfiguration is the serializable representation of the filter parameters. Filters can subclass this class to implement direct accessors to properties, but properties not in the map will not be serialized.

XXX: Use KoProperties here!

Definition at line 25 of file kis_filter_configuration.cc.

Constructor & Destructor Documentation

◆ KisFilterConfiguration() [1/2]

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

Create a new filter config.

Definition at line 51 of file kis_filter_configuration.cc.

    : d(new Private(name, version, resourcesInterface))
{
}

◆ KisFilterConfiguration() [2/2]

KisFilterConfiguration::KisFilterConfiguration ( const KisFilterConfiguration & rhs )

protected

Deep copy the filter configFile

Definition at line 61 of file kis_filter_configuration.cc.

    : KisPropertiesConfiguration(rhs)
    , d(new Private(*rhs.d))
{
}

◆ ~KisFilterConfiguration()

KisFilterConfiguration::~KisFilterConfiguration ( )

override

Definition at line 67 of file kis_filter_configuration.cc.

{
    delete d;
}

References d.

Member Function Documentation

◆ channelFlags()

QBitArray KisFilterConfiguration::channelFlags ( ) const

Returns: an array with each colorspace channel a true/false bit that indicates whether the channel should be filtered or left alone. It is up to the filter to decide whether channels that are to be left alone are copied to the dest file or not.

◆ clone()

KisFilterConfigurationSP KisFilterConfiguration::clone ( ) const

virtual

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

Reimplemented in KisColorTransformationConfiguration, KisCrossChannelFilterConfiguration, KisPerChannelFilterConfiguration, KisGradientMapFilterConfiguration, KisHalftoneFilterConfiguration, KisLevelsFilterConfiguration, KisFilterPalettizeConfiguration, KisPropagateColorsFilterConfiguration, KisGradientGeneratorConfiguration, PatternGeneratorConfiguration, KisScreentoneGeneratorConfiguration, and KisSeExprGeneratorConfiguration.

Definition at line 56 of file kis_filter_configuration.cc.

{
    return new KisFilterConfiguration(*this);
}

References KisFilterConfiguration().

◆ cloneWithResourcesSnapshot()

KisFilterConfigurationSP KisFilterConfiguration::cloneWithResourcesSnapshot ( KisResourcesInterfaceSP globalResourcesInterface = nullptr ) const

See also: KisRequiredResourcesOperators::cloneWithResourcesSnapshot

Definition at line 137 of file kis_filter_configuration.cc.

{
    return KisRequiredResourcesOperators::cloneWithResourcesSnapshot<KisFilterConfigurationSP>(this, globalResourcesInterface);
}

◆ compareTo()

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

overridevirtual

Structural comparison between two instances.

Reimplemented from KisPropertiesConfiguration.

Reimplemented in KisCrossChannelFilterConfiguration, and KisMultiChannelFilterConfiguration.

Definition at line 164 of file kis_filter_configuration.cc.

{
    const KisFilterConfiguration *otherConfig = dynamic_cast<const KisFilterConfiguration *>(rhs);
 
    return otherConfig
            && KisPropertiesConfiguration::compareTo(rhs)
            && name() == otherConfig->name()
            && version() == otherConfig->version()
            && channelFlags() == otherConfig->channelFlags();
}

References channelFlags, KisPropertiesConfiguration::compareTo(), name, and version.

◆ createLocalResourcesSnapshot()

void KisFilterConfiguration::createLocalResourcesSnapshot ( KisResourcesInterfaceSP globalResourcesInterface = nullptr )

See also: KisRequiredResourcesOperators::createLocalResourcesSnapshot

Definition at line 127 of file kis_filter_configuration.cc.

{
    KisRequiredResourcesOperators::createLocalResourcesSnapshot(this, globalResourcesInterface);
}

References KisRequiredResourcesOperators::createLocalResourcesSnapshot().

◆ embeddedResources()

QList< KoResourceLoadResult > KisFilterConfiguration::embeddedResources ( KisResourcesInterfaceSP globalResourcesInterface ) const

virtual

Returns: all the resources that were embedded into (*this) filter. If the resources were already added to the global database, then they are fetched from globalResourcesInterface to save time/memory.

Reimplemented in KisGradientMapFilterConfiguration, and KisHalftoneFilterConfiguration.

Definition at line 153 of file kis_filter_configuration.cc.

{
    Q_UNUSED(globalResourcesInterface);
    return {};
}

◆ fromLegacyXML()

void KisFilterConfiguration::fromLegacyXML ( const QDomElement & root )

virtual

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

Reimplemented in KisMultiChannelFilterConfiguration, KisLevelsFilterConfiguration, KisMultiChannelFilterConfiguration, and KisLevelsFilterConfiguration.

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));
    }
}

References KisPropertiesConfiguration::clearProperties(), and d.

◆ fromXML() [1/3]

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

Implements KisSerializableConfiguration.

Reimplemented in KisMultiChannelFilterConfiguration, KisMultiChannelFilterConfiguration, KisLevelsFilterConfiguration, KisLevelsFilterConfiguration, KisMultiChannelFilterConfiguration, and KisLevelsFilterConfiguration.

Definition at line 70 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/3]

void KisFilterConfiguration::fromXML ( const QDomElement & )

overridevirtual

Fill the object from the XML encoded representation in s.

Implements KisSerializableConfiguration.

Reimplemented in KisMultiChannelFilterConfiguration, KisMultiChannelFilterConfiguration, KisLevelsFilterConfiguration, KisLevelsFilterConfiguration, KisMultiChannelFilterConfiguration, and KisLevelsFilterConfiguration.

Definition at line 89 of file kis_filter_configuration.cc.

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

References d, and KisPropertiesConfiguration::fromXML().

◆ fromXML() [3/3]

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 KisSerializableConfiguration.

Reimplemented in KisMultiChannelFilterConfiguration, and KisLevelsFilterConfiguration.

Definition at line 62 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;
}

◆ hasLocalResourcesSnapshot()

bool KisFilterConfiguration::hasLocalResourcesSnapshot ( ) const

See also: KisRequiredResourcesOperators::hasLocalResourcesSnapshot

Definition at line 132 of file kis_filter_configuration.cc.

{
    return KisRequiredResourcesOperators::hasLocalResourcesSnapshot(this);
}

References KisRequiredResourcesOperators::hasLocalResourcesSnapshot().

◆ isCompatible()

bool KisFilterConfiguration::isCompatible ( const KisPaintDeviceSP ) const

virtual

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

Reimplemented in KisMultiChannelFilterConfiguration, and KisLevelsFilterConfiguration.

Definition at line 159 of file kis_filter_configuration.cc.

{
    return true;
}

◆ linkedResources()

QList< KoResourceLoadResult > KisFilterConfiguration::linkedResources ( KisResourcesInterfaceSP globalResourcesInterface ) const

virtual

Returns: all the resources that are needed but (*this) filter and are not embedded into it. The resources are fetched from globalResourcesInterface. If fetching of some resources is failed, then (*this) filter is invalid.

Reimplemented in KisGradientMapFilterConfiguration, KisHalftoneFilterConfiguration, KisFilterPalettizeConfiguration, and PatternGeneratorConfiguration.

Definition at line 147 of file kis_filter_configuration.cc.

{
    Q_UNUSED(globalResourcesInterface);
    return {};
}

◆ name()

const QString & KisFilterConfiguration::name ( ) const

Get the unique, language independent name of the filter.

◆ Private() [1/2]

KisFilterConfiguration::Private ( const Private & rhs )

inline

Definition at line 38 of file kis_filter_configuration.cc.

        : name(rhs.name),
          version(rhs.version),
          channelFlags(rhs.channelFlags),
          resourcesInterface(rhs.resourcesInterface)
    {
    }

◆ Private() [2/2]

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

inline

Definition at line 31 of file kis_filter_configuration.cc.

        : name(_name),
          version(_version),
          resourcesInterface(_resourcesInterface)
    {
    }

◆ requiredResources()

QList< KoResourceLoadResult > KisFilterConfiguration::requiredResources ( KisResourcesInterfaceSP globalResourcesInterface ) const

Loads all the required resources either from globalResourcesInterface or from embedded data. The filter first tries to fetch the required resource from the global source, and only if it fails, tries to load it from the embedded data. One can check if the loaded resource is embedded by checking its resourceId().

The set of resources returned is basically: linkedResources() + embeddedResources()

Definition at line 142 of file kis_filter_configuration.cc.

{
    return linkedResources(globalResourcesInterface) + embeddedResources(globalResourcesInterface);
}

References embeddedResources(), and linkedResources().

◆ resourcesInterface()

KisResourcesInterfaceSP KisFilterConfiguration::resourcesInterface ( ) const

Returns: resource interface that is used by KisFilterConfiguration object for loading linked resources

◆ sanityDerefUsageCounter()

int KisFilterConfiguration::sanityDerefUsageCounter ( )

private

◆ sanityRefUsageCounter()

int KisFilterConfiguration::sanityRefUsageCounter ( )

private

◆ setChannelFlags()

void KisFilterConfiguration::setChannelFlags ( QBitArray channelFlags )

Set the channel flags. An empty array is allowed; that means that all channels are to be filtered. Filters can optimize on that. The array must be in the order of the pixel layout.

Definition at line 180 of file kis_filter_configuration.cc.

{
    d->channelFlags = channelFlags;
}

References channelFlags, and d.

◆ setResourcesInterface()

void KisFilterConfiguration::setResourcesInterface ( KisResourcesInterfaceSP resourcesInterface )

virtual

Set resource interface that will be used by KisFilterConfiguration object for loading linked resources

Reimplemented in KisHalftoneFilterConfiguration.

Definition at line 122 of file kis_filter_configuration.cc.

{
    d->resourcesInterface = resourcesInterface;
}

References d, and resourcesInterface.

◆ setVersion()

void KisFilterConfiguration::setVersion ( qint32 version )

protected

Definition at line 112 of file kis_filter_configuration.cc.

{
    d->version = version;
}

References d, and version.

◆ toXML() [1/3]

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 KisSerializableConfiguration.

Reimplemented in KisMultiChannelFilterConfiguration, and KisLevelsFilterConfiguration.

Definition at line 82 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/3]

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.

Implements KisSerializableConfiguration.

Reimplemented in KisMultiChannelFilterConfiguration, KisMultiChannelFilterConfiguration, KisLevelsFilterConfiguration, KisLevelsFilterConfiguration, KisMultiChannelFilterConfiguration, and KisLevelsFilterConfiguration.

Definition at line 76 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);
    }
}

References KisPropertiesConfiguration::d, and value().

◆ toXML() [3/3]

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

overridevirtual

Create a serialized version of this object

Implements KisSerializableConfiguration.

Reimplemented in KisMultiChannelFilterConfiguration, KisMultiChannelFilterConfiguration, KisLevelsFilterConfiguration, KisLevelsFilterConfiguration, KisMultiChannelFilterConfiguration, and KisLevelsFilterConfiguration.

Definition at line 95 of file kis_filter_configuration.cc.

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

References d, and KisPropertiesConfiguration::toXML().

◆ version()

qint32 KisFilterConfiguration::version ( ) const

Get the version of the filter that has created this config

Friends And Related Symbol Documentation

◆ KisNodeFilterInterface

friend class KisNodeFilterInterface

friend

Definition at line 169 of file kis_filter_configuration.h.

Member Data Documentation

◆ channelFlags

QBitArray KisFilterConfiguration::channelFlags

Definition at line 28 of file kis_filter_configuration.cc.

◆ d

Private* const KisFilterConfiguration::d

private

Definition at line 179 of file kis_filter_configuration.h.

◆ name

const QString & KisFilterConfiguration::name

Definition at line 26 of file kis_filter_configuration.cc.

◆ resourcesInterface

KisResourcesInterfaceSP KisFilterConfiguration::resourcesInterface = 0

Definition at line 29 of file kis_filter_configuration.cc.

◆ version

qint32 KisFilterConfiguration::version

Definition at line 27 of file kis_filter_configuration.cc.

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

libs/image/filter/kis_filter_configuration.cc
libs/image/filter/kis_filter_configuration.h

Public Member Functions

Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KisFilterConfiguration() [1/2]

◆ KisFilterConfiguration() [2/2]

◆ ~KisFilterConfiguration()

Member Function Documentation

◆ channelFlags()

◆ clone()

◆ cloneWithResourcesSnapshot()

◆ compareTo()

◆ createLocalResourcesSnapshot()

◆ embeddedResources()

◆ fromLegacyXML()

◆ fromXML() [1/3]

◆ fromXML() [2/3]

◆ fromXML() [3/3]

◆ hasLocalResourcesSnapshot()

◆ isCompatible()

◆ linkedResources()

◆ name()

◆ Private() [1/2]

◆ Private() [2/2]

◆ requiredResources()

◆ resourcesInterface()

◆ sanityDerefUsageCounter()

◆ sanityRefUsageCounter()

◆ setChannelFlags()

◆ setResourcesInterface()

◆ setVersion()

◆ toXML() [1/3]

◆ toXML() [2/3]

◆ toXML() [3/3]

◆ version()

Friends And Related Symbol Documentation

◆ KisNodeFilterInterface

Member Data Documentation

◆ channelFlags

◆ d

◆ name

◆ resourcesInterface

◆ version