#include <KisPropagateColorsFilterConfiguration.h>

Inheritance diagram for KisPropagateColorsFilterConfiguration:

Public Types
enum	AlphaChannelMode { AlphaChannelMode_Preserve , AlphaChannelMode_Expand }

enum	DistanceMetric { DistanceMetric_Chessboard , DistanceMetric_CityBlock , DistanceMetric_Euclidean }

enum	ExpansionMode { ExpansionMode_Bounded , ExpansionMode_Unbounded }

Public Member Functions
AlphaChannelMode	alphaChannelMode () const

KisFilterConfigurationSP	clone () const override

DistanceMetric	distanceMetric () const

qreal	expansionAmount () const

ExpansionMode	expansionMode () const

	KisPropagateColorsFilterConfiguration (const KisPropagateColorsFilterConfiguration &rhs)

	KisPropagateColorsFilterConfiguration (KisResourcesInterfaceSP resourcesInterface)

void	setAlphaChannelMode (AlphaChannelMode newAlphaChannelMode)

void	setDefaults ()

void	setDistanceMetric (DistanceMetric newDistanceMetric)

void	setExpansionAmount (qreal newExpansionAmount)

void	setExpansionMode (ExpansionMode newExpansionMode)

	~KisPropagateColorsFilterConfiguration () override

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

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

Static Public Member Functions
static constexpr AlphaChannelMode	defaultAlphaChannelMode ()

static constexpr DistanceMetric	defaultDistanceMetric ()

static constexpr qreal	defaultExpansionAmount ()

static constexpr ExpansionMode	defaultExpansionMode ()

static QString	defaultId ()

static QString	defaultMenuName ()

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 17 of file KisPropagateColorsFilterConfiguration.h.

Member Enumeration Documentation

◆ AlphaChannelMode

enum KisPropagateColorsFilterConfiguration::AlphaChannelMode

Enumerator
AlphaChannelMode_Preserve
AlphaChannelMode_Expand

Definition at line 33 of file KisPropagateColorsFilterConfiguration.h.

    {
        AlphaChannelMode_Preserve,
        AlphaChannelMode_Expand
    };

◆ DistanceMetric

enum KisPropagateColorsFilterConfiguration::DistanceMetric

Enumerator
DistanceMetric_Chessboard
DistanceMetric_CityBlock
DistanceMetric_Euclidean

Definition at line 20 of file KisPropagateColorsFilterConfiguration.h.

    {
        DistanceMetric_Chessboard,
        DistanceMetric_CityBlock,
        DistanceMetric_Euclidean
    };

◆ ExpansionMode

enum KisPropagateColorsFilterConfiguration::ExpansionMode

Enumerator
ExpansionMode_Bounded
ExpansionMode_Unbounded

Definition at line 27 of file KisPropagateColorsFilterConfiguration.h.

    {
        ExpansionMode_Bounded,
        ExpansionMode_Unbounded
    };

Constructor & Destructor Documentation

◆ KisPropagateColorsFilterConfiguration() [1/2]

KisPropagateColorsFilterConfiguration::KisPropagateColorsFilterConfiguration ( KisResourcesInterfaceSP resourcesInterface )

Definition at line 11 of file KisPropagateColorsFilterConfiguration.cpp.

    : KisFilterConfiguration(defaultId(), defaultVersion(), resourcesInterface)
{
    setDefaults();
}

References setDefaults().

◆ KisPropagateColorsFilterConfiguration() [2/2]

KisPropagateColorsFilterConfiguration::KisPropagateColorsFilterConfiguration ( const KisPropagateColorsFilterConfiguration & rhs )

Definition at line 17 of file KisPropagateColorsFilterConfiguration.cpp.

20 : KisFilterConfiguration(rhs)

21{}

◆ ~KisPropagateColorsFilterConfiguration()

KisPropagateColorsFilterConfiguration::~KisPropagateColorsFilterConfiguration ( )

override

Definition at line 23 of file KisPropagateColorsFilterConfiguration.cpp.

24{}

Member Function Documentation

◆ alphaChannelMode()

KisPropagateColorsFilterConfiguration::AlphaChannelMode KisPropagateColorsFilterConfiguration::alphaChannelMode ( ) const

Definition at line 60 of file KisPropagateColorsFilterConfiguration.cpp.

{
    const QString alphaChannelModeStr = getString("alphaChannelMode", "expand");
    if (alphaChannelModeStr == "preserve") {
        return AlphaChannelMode_Preserve;
    } else if (alphaChannelModeStr == "expand") {
        return AlphaChannelMode_Expand;
    }
    return defaultAlphaChannelMode();
}

References AlphaChannelMode_Expand, AlphaChannelMode_Preserve, defaultAlphaChannelMode(), and KisPropertiesConfiguration::getString().

◆ clone()

KisFilterConfigurationSP KisPropagateColorsFilterConfiguration::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 26 of file KisPropagateColorsFilterConfiguration.cpp.

{
    return new KisPropagateColorsFilterConfiguration(*this);
}

References KisPropagateColorsFilterConfiguration().

◆ defaultAlphaChannelMode()

static constexpr AlphaChannelMode KisPropagateColorsFilterConfiguration::defaultAlphaChannelMode ( )

inlinestaticconstexpr

Definition at line 53 of file KisPropagateColorsFilterConfiguration.h.

53{ return AlphaChannelMode_Expand; }

References AlphaChannelMode_Expand.

◆ defaultDistanceMetric()

static constexpr DistanceMetric KisPropagateColorsFilterConfiguration::defaultDistanceMetric ( )

inlinestaticconstexpr

Definition at line 50 of file KisPropagateColorsFilterConfiguration.h.

50{ return DistanceMetric_Euclidean; }

References DistanceMetric_Euclidean.

◆ defaultExpansionAmount()

static constexpr qreal KisPropagateColorsFilterConfiguration::defaultExpansionAmount ( )

inlinestaticconstexpr

Definition at line 52 of file KisPropagateColorsFilterConfiguration.h.

52{ return 10.0; }

◆ defaultExpansionMode()

static constexpr ExpansionMode KisPropagateColorsFilterConfiguration::defaultExpansionMode ( )

inlinestaticconstexpr

Definition at line 51 of file KisPropagateColorsFilterConfiguration.h.

51{ return ExpansionMode_Unbounded; }

References ExpansionMode_Unbounded.

◆ defaultId()

static QString KisPropagateColorsFilterConfiguration::defaultId ( )

inlinestatic

Definition at line 46 of file KisPropagateColorsFilterConfiguration.h.

46{ return "propagatecolors"; }

◆ defaultMenuName()

static QString KisPropagateColorsFilterConfiguration::defaultMenuName ( )

inlinestatic

Definition at line 48 of file KisPropagateColorsFilterConfiguration.h.

48{ return i18n("&Propagate Colors..."); }

◆ defaultName()

static QString KisPropagateColorsFilterConfiguration::defaultName ( )

inlinestatic

Definition at line 47 of file KisPropagateColorsFilterConfiguration.h.

47{ return i18n("Propagate Colors"); }

◆ defaultVersion()

static constexpr qint32 KisPropagateColorsFilterConfiguration::defaultVersion ( )

inlinestaticconstexpr

Definition at line 49 of file KisPropagateColorsFilterConfiguration.h.

49{ return 1; }

◆ distanceMetric()

KisPropagateColorsFilterConfiguration::DistanceMetric KisPropagateColorsFilterConfiguration::distanceMetric ( ) const

Definition at line 31 of file KisPropagateColorsFilterConfiguration.cpp.

{
    const QString distanceMetricStr = getString("distanceMetric", "");
    if (distanceMetricStr == "chessboard") {
        return DistanceMetric_Chessboard;
    } else if (distanceMetricStr == "cityBlock") {
        return DistanceMetric_CityBlock;
    } else if (distanceMetricStr == "euclidean") {
        return DistanceMetric_Euclidean;
    }
    return defaultDistanceMetric();
}

References defaultDistanceMetric(), DistanceMetric_Chessboard, DistanceMetric_CityBlock, DistanceMetric_Euclidean, and KisPropertiesConfiguration::getString().

◆ expansionAmount()

qreal KisPropagateColorsFilterConfiguration::expansionAmount ( ) const

Definition at line 55 of file KisPropagateColorsFilterConfiguration.cpp.

{
    return getDouble("expansionAmount", defaultExpansionAmount());
}

References defaultExpansionAmount(), and KisPropertiesConfiguration::getDouble().

◆ expansionMode()

KisPropagateColorsFilterConfiguration::ExpansionMode KisPropagateColorsFilterConfiguration::expansionMode ( ) const

Definition at line 44 of file KisPropagateColorsFilterConfiguration.cpp.

{
    const QString expansionModeStr = getString("expansionMode", "");
    if (expansionModeStr == "bounded") {
        return ExpansionMode_Bounded;
    } else if (expansionModeStr == "unbounded") {
        return ExpansionMode_Unbounded;
    }
    return defaultExpansionMode();
}

References defaultExpansionMode(), ExpansionMode_Bounded, ExpansionMode_Unbounded, and KisPropertiesConfiguration::getString().

◆ setAlphaChannelMode()

void KisPropagateColorsFilterConfiguration::setAlphaChannelMode ( AlphaChannelMode newAlphaChannelMode )

Definition at line 96 of file KisPropagateColorsFilterConfiguration.cpp.

{
    if (newAlphaChannelMode == AlphaChannelMode_Preserve) {
        setProperty("alphaChannelMode", "preserve");
    } else {
        setProperty("alphaChannelMode", "expand");
    }
}

References AlphaChannelMode_Preserve, and KisPropertiesConfiguration::setProperty().

◆ setDefaults()

void KisPropagateColorsFilterConfiguration::setDefaults ( )

Definition at line 105 of file KisPropagateColorsFilterConfiguration.cpp.

{
    setDistanceMetric(defaultDistanceMetric());
    setExpansionMode(defaultExpansionMode());
    setExpansionAmount(defaultExpansionAmount());
    setAlphaChannelMode(defaultAlphaChannelMode());
}

References defaultAlphaChannelMode(), defaultDistanceMetric(), defaultExpansionAmount(), defaultExpansionMode(), setAlphaChannelMode(), setDistanceMetric(), setExpansionAmount(), and setExpansionMode().

◆ setDistanceMetric()

void KisPropagateColorsFilterConfiguration::setDistanceMetric ( DistanceMetric newDistanceMetric )

Definition at line 71 of file KisPropagateColorsFilterConfiguration.cpp.

{
    if (newDistanceMetric == DistanceMetric_Chessboard) {
        setProperty("distanceMetric", "chessboard");
    } else if (newDistanceMetric == DistanceMetric_CityBlock) {
        setProperty("distanceMetric", "cityBlock");
    } else {
        setProperty("distanceMetric", "euclidean");
    }
}

References DistanceMetric_Chessboard, DistanceMetric_CityBlock, and KisPropertiesConfiguration::setProperty().

◆ setExpansionAmount()

void KisPropagateColorsFilterConfiguration::setExpansionAmount ( qreal newExpansionAmount )

Definition at line 91 of file KisPropagateColorsFilterConfiguration.cpp.

{
    setProperty("expansionAmount", newExpansionAmount);
}

References KisPropertiesConfiguration::setProperty().

◆ setExpansionMode()

void KisPropagateColorsFilterConfiguration::setExpansionMode ( ExpansionMode newExpansionMode )

Definition at line 82 of file KisPropagateColorsFilterConfiguration.cpp.

{
    if (newExpansionMode == ExpansionMode_Bounded) {
        setProperty("expansionMode", "bounded");
    } else {
        setProperty("expansionMode", "unbounded");
    }
}

References ExpansionMode_Bounded, and KisPropertiesConfiguration::setProperty().

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

plugins/filters/propagatecolors/KisPropagateColorsFilterConfiguration.h
plugins/filters/propagatecolors/KisPropagateColorsFilterConfiguration.cpp

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ AlphaChannelMode

◆ DistanceMetric

◆ ExpansionMode

Constructor & Destructor Documentation

◆ KisPropagateColorsFilterConfiguration() [1/2]

◆ KisPropagateColorsFilterConfiguration() [2/2]

◆ ~KisPropagateColorsFilterConfiguration()

Member Function Documentation

◆ alphaChannelMode()

◆ clone()

◆ defaultAlphaChannelMode()

◆ defaultDistanceMetric()

◆ defaultExpansionAmount()

◆ defaultExpansionMode()

◆ defaultId()

◆ defaultMenuName()

◆ defaultName()

◆ defaultVersion()

◆ distanceMetric()

◆ expansionAmount()

◆ expansionMode()

◆ setAlphaChannelMode()

◆ setDefaults()

◆ setDistanceMetric()

◆ setExpansionAmount()

◆ setExpansionMode()