KisGradientMapFilterConfiguration Class Reference

#include <KisGradientMapFilterConfiguration.h>

Inheritance diagram for KisGradientMapFilterConfiguration:

Public Types
enum	ColorMode { ColorMode_Blend , ColorMode_Nearest , ColorMode_Dither }

Public Member Functions
virtual KisFilterConfigurationSP	clone () const override
int	colorMode () const
QList< KoResourceLoadResult >	embeddedResources (KisResourcesInterfaceSP globalResourcesInterface) const override
KoAbstractGradientSP	gradient (KoAbstractGradientSP fallbackGradient=nullptr) const
	KisGradientMapFilterConfiguration (const KisGradientMapFilterConfiguration &rhs)
	KisGradientMapFilterConfiguration (KisResourcesInterfaceSP resourcesInterface)
	KisGradientMapFilterConfiguration (qint32 version, KisResourcesInterfaceSP resourcesInterface)
QList< KoResourceLoadResult >	linkedResources (KisResourcesInterfaceSP globalResourcesInterface) const override
void	setColorMode (int newColorMode)
void	setDefaults ()
void	setGradient (KoAbstractGradientSP newGradient)
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 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)
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 ()

Static Public Member Functions
static constexpr int	defaultColorMode ()
static KoAbstractGradientSP	defaultGradient (KisResourcesInterfaceSP resourcesInterface)
static QString	defaultName ()
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)

Additional Inherited Members
Public Attributes inherited from KisFilterConfiguration
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 inherited from KisFilterConfiguration
	KisFilterConfiguration (const KisFilterConfiguration &rhs)
void	setVersion (qint32 version)
Protected Member Functions inherited from KisShared
	KisShared ()
	~KisShared ()

Detailed Description

Definition at line 24 of file KisGradientMapFilterConfiguration.h.

Member Enumeration Documentation

ColorMode

enum KisGradientMapFilterConfiguration::ColorMode

Enumerator
ColorMode_Blend
ColorMode_Nearest
ColorMode_Dither

Definition at line 27 of file KisGradientMapFilterConfiguration.h.

    {
        ColorMode_Blend,
        ColorMode_Nearest,
        ColorMode_Dither
    };

Constructor & Destructor Documentation

KisGradientMapFilterConfiguration() [1/3]

KisGradientMapFilterConfiguration::KisGradientMapFilterConfiguration

(

KisResourcesInterfaceSP

resourcesInterface

)

Definition at line 21 of file KisGradientMapFilterConfiguration.cpp.

    : KisFilterConfiguration(defaultName(), defaultVersion(), resourcesInterface)
{}

KisGradientMapFilterConfiguration() [2/3]

KisGradientMapFilterConfiguration::KisGradientMapFilterConfiguration	(	qint32	version,
		KisResourcesInterfaceSP	resourcesInterface )

Definition at line 25 of file KisGradientMapFilterConfiguration.cpp.

    : KisFilterConfiguration(defaultName(), version, resourcesInterface)
{}

KisGradientMapFilterConfiguration() [3/3]

KisGradientMapFilterConfiguration::KisGradientMapFilterConfiguration

(

const KisGradientMapFilterConfiguration &

rhs

)

Definition at line 29 of file KisGradientMapFilterConfiguration.cpp.

    : KisFilterConfiguration(rhs)
{}

Member Function Documentation

clone()

KisFilterConfigurationSP KisGradientMapFilterConfiguration::clone ( ) const

overridevirtual

Returns

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

Reimplemented from KisFilterConfiguration.

Definition at line 33 of file KisGradientMapFilterConfiguration.cpp.

{
    return new KisGradientMapFilterConfiguration(*this);
}

References KisGradientMapFilterConfiguration().

colorMode()

int KisGradientMapFilterConfiguration::colorMode

(

)

const

Definition at line 120 of file KisGradientMapFilterConfiguration.cpp.

{
    return getInt("colorMode", defaultColorMode());
}

References defaultColorMode(), and KisPropertiesConfiguration::getInt().

defaultColorMode()

static constexpr int KisGradientMapFilterConfiguration::defaultColorMode ( )

inlinestaticconstexpr

Definition at line 75 of file KisGradientMapFilterConfiguration.h.

    {
        return ColorMode_Blend;
    }

References ColorMode_Blend.

defaultGradient()

static KoAbstractGradientSP KisGradientMapFilterConfiguration::defaultGradient ( KisResourcesInterfaceSP resourcesInterface )

inlinestatic

Definition at line 53 of file KisGradientMapFilterConfiguration.h.

    {
        KoAbstractGradientSP gradient;
        KoAbstractGradientSP resourceGradient = resourcesInterface->source<KoAbstractGradient>(ResourceType::Gradients).fallbackResource();
        if (resourceGradient) {
            gradient = resourceGradient->clone().dynamicCast<KoAbstractGradient>();
        } else {
            KoStopGradientSP stopGradient(new KoStopGradient);
            stopGradient->setStops(
                QList<KoGradientStop>()
                << KoGradientStop(0.0, KoColor(Qt::black, KoColorSpaceRegistry::instance()->rgb8(0)), FOREGROUNDSTOP)
                << KoGradientStop(1.0, KoColor(Qt::white, KoColorSpaceRegistry::instance()->rgb8(0)), BACKGROUNDSTOP)
            );
            gradient = stopGradient.staticCast<KoAbstractGradient>();
        }
        if (gradient) {
            gradient->setName(i18nc("Default gradient name for the gradient generator", "Unnamed"));
            gradient->setValid(true);
        }
        return gradient;
    }

References BACKGROUNDSTOP, FOREGROUNDSTOP, gradient(), ResourceType::Gradients, KoColorSpaceRegistry::instance(), and KisFilterConfiguration::resourcesInterface.

defaultName()

static QString KisGradientMapFilterConfiguration::defaultName ( )

inlinestatic

Definition at line 43 of file KisGradientMapFilterConfiguration.h.

    {
        return "gradientmap";
    }

defaultVersion()

static constexpr qint32 KisGradientMapFilterConfiguration::defaultVersion ( )

inlinestaticconstexpr

Definition at line 48 of file KisGradientMapFilterConfiguration.h.

    {
        return 2;
    }

embeddedResources()

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

overridevirtual

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 from KisFilterConfiguration.

Definition at line 60 of file KisGradientMapFilterConfiguration.cpp.

{
    QList<KoResourceLoadResult> resources;
 
    // the second version of the filter embeds the gradient
    if (version() > 1) {
        KoAbstractGradientSP gradient = this->gradient();
 
        // TODO: check if it is okay to resave the gradient on loading
        QBuffer buffer;
        buffer.open(QBuffer::WriteOnly);
        gradient->saveToDevice(&buffer);
 
        resources << KoEmbeddedResource(KoResourceSignature(ResourceType::Gradients, KoMD5Generator::generateHash(buffer.data()), gradient->filename(), gradient->name()), buffer.data());
    }
 
    return resources;
}

References KoMD5Generator::generateHash(), gradient(), ResourceType::Gradients, and KisFilterConfiguration::version.

gradient()

KoAbstractGradientSP KisGradientMapFilterConfiguration::gradient

(

KoAbstractGradientSP

fallbackGradient = nullptr

)

const

Definition at line 79 of file KisGradientMapFilterConfiguration.cpp.

{
    if (version() == 1) {
 
        QString md5sum = this->getString("md5sum");
        QString gradientName = this->getString("gradientName");
        auto source = resourcesInterface()->source<KoAbstractGradient>(ResourceType::Gradients);
 
        KoAbstractGradientSP resourceGradient = source.bestMatch(md5sum, "", gradientName);
 
        if (resourceGradient) {
            KoStopGradientSP gradient = KisGradientConversion::toStopGradient(resourceGradient);
            gradient->setValid(true);
            return gradient;
        } else {
            qWarning() << "Could not find gradient" << getString("md5sum") << getString("gradientName");
        }
    } else if (version() == 2) {
        QDomDocument document;
        if (document.setContent(getString("gradientXML", ""))) {
            const QDomElement gradientElement = document.firstChildElement();
            if (!gradientElement.isNull()) {
                const QString gradientType = gradientElement.attribute("type");
                KoAbstractGradientSP gradient = nullptr;
                if (gradientType == "stop") {
                    gradient = KoStopGradient::fromXML(gradientElement).clone().dynamicCast<KoAbstractGradient>();
                } else if (gradientType == "segment") {
                    gradient = KoSegmentGradient::fromXML(gradientElement).clone().dynamicCast<KoAbstractGradient>();
                }
                if (gradient) {
                    gradient->setName(gradientElement.attribute("name", ""));
                    gradient->setFilename(gradient->name() + gradient->defaultFileExtension());
                    gradient->setValid(true);
                    return gradient;
                }
            }
        }
    }
    return fallbackGradient ? fallbackGradient : defaultGradient(resourcesInterface());
}

References KoSegmentGradient::clone(), KoStopGradient::clone(), defaultGradient(), KoSegmentGradient::fromXML(), KoStopGradient::fromXML(), KisPropertiesConfiguration::getString(), gradient(), ResourceType::Gradients, KisFilterConfiguration::resourcesInterface, source(), KisGradientConversion::toStopGradient(), and KisFilterConfiguration::version.

linkedResources()

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

overridevirtual

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 from KisFilterConfiguration.

Definition at line 38 of file KisGradientMapFilterConfiguration.cpp.

{
    QList<KoResourceLoadResult> resources;
 
    // only the first version of the filter loaded the gradient by name
    if (version() == 1) {
        KoAbstractGradientSP gradient = this->gradient();
        if (gradient) {
            resources << gradient;
        } else {
            QString md5sum = this->getString("md5sum");
            QString gradientName = this->getString("gradientName");
 
            resources << KoResourceSignature(ResourceType::Gradients, md5sum, "", gradientName);
        }
    }
 
    resources << KisDitherWidget::prepareLinkedResources(*this, "dither/", globalResourcesInterface);
 
    return resources;
}

References KisPropertiesConfiguration::getString(), gradient(), ResourceType::Gradients, KisDitherWidget::prepareLinkedResources(), and KisFilterConfiguration::version.

setColorMode()

void KisGradientMapFilterConfiguration::setColorMode

(

int

newColorMode

)

Definition at line 149 of file KisGradientMapFilterConfiguration.cpp.

{
    setProperty("colorMode", newColorMode);
}

References KisPropertiesConfiguration::setProperty().

setDefaults()

void KisGradientMapFilterConfiguration::setDefaults

(

)

Definition at line 154 of file KisGradientMapFilterConfiguration.cpp.

{
    setGradient(nullptr);
    setColorMode(defaultColorMode());
    KisDitherWidget::factoryConfiguration(*this, "dither/");
}

References defaultColorMode(), KisDitherWidget::factoryConfiguration(), setColorMode(), and setGradient().

setGradient()

void KisGradientMapFilterConfiguration::setGradient

(

KoAbstractGradientSP

newGradient

)

Definition at line 125 of file KisGradientMapFilterConfiguration.cpp.

{
    if (!newGradient) {
        setProperty("gradientXML", "");
        return;
    }
 
    QDomDocument document;
    QDomElement gradientElement = document.createElement("gradient");
    gradientElement.setAttribute("name", newGradient->name());
    gradientElement.setAttribute("md5sum", newGradient->md5Sum());
 
    if (newGradient.dynamicCast<KoStopGradient>()) {
        KoStopGradient *gradient = static_cast<KoStopGradient*>(newGradient.data());
        gradient->toXML(document, gradientElement);
    } else if (newGradient.dynamicCast<KoSegmentGradient>()) {
        KoSegmentGradient *gradient = static_cast<KoSegmentGradient*>(newGradient.data());
        gradient->toXML(document, gradientElement);
    }
 
    document.appendChild(gradientElement);
    setProperty("gradientXML", document.toString());
}

References gradient(), and KisPropertiesConfiguration::setProperty().

---

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

• plugins/filters/gradientmap/KisGradientMapFilterConfiguration.h
• plugins/filters/gradientmap/KisGradientMapFilterConfiguration.cpp