#include <kis_color_transformation_filter.h>

Inheritance diagram for KisColorTransformationFilter:

Public Member Functions
virtual KoColorTransformation *	createTransformation (const KoColorSpace *cs, const KisFilterConfigurationSP config) const =0

KisFilterConfigurationSP	factoryConfiguration (KisResourcesInterfaceSP resourcesInterface) const override

	KisColorTransformationFilter (const KoID &id, const KoID &category, const QString &entry)

void	processImpl (KisPaintDeviceSP device, const QRect &applyRect, const KisFilterConfigurationSP config, KoUpdater *progressUpdater) const override

	~KisColorTransformationFilter () override

Public Member Functions inherited from KisFilter
virtual QRect	changedRect (const QRect &rect, const KisFilterConfigurationSP config, int lod) const

virtual bool	configurationAllowedForMask (KisFilterConfigurationSP config) const

virtual void	fixLoadedFilterConfigurationForMasks (KisFilterConfigurationSP config) const

	KisFilter (const KoID &id, const KoID &category, const QString &entry)

virtual QRect	neededRect (const QRect &rect, const KisFilterConfigurationSP config, int lod) const

virtual bool	needsTransparentPixels (const KisFilterConfigurationSP config, const KoColorSpace *cs) const

void	process (const KisPaintDeviceSP src, KisPaintDeviceSP dst, KisSelectionSP selection, const QRect &applyRect, const KisFilterConfigurationSP config, KoUpdater *progressUpdater=0) const

void	process (KisPaintDeviceSP device, const QRect &applyRect, const KisFilterConfigurationSP config, KoUpdater *progressUpdater=0) const

virtual bool	supportsLevelOfDetail (const KisFilterConfigurationSP config, int lod) const

	~KisFilter () override

Public Member Functions inherited from KisBaseProcessor
KisBookmarkedConfigurationManager *	bookmarkManager ()

const KisBookmarkedConfigurationManager *	bookmarkManager () const

ColorSpaceIndependence	colorSpaceIndependence () const

virtual KisConfigWidget *	createConfigurationWidget (QWidget *parent, const KisPaintDeviceSP dev, bool useForMasks) const

virtual KisFilterConfigurationSP	defaultConfiguration (KisResourcesInterfaceSP resourcesInterface) const

QString	id () const

	KisBaseProcessor (const KoID &id, const KoID &category, const QString &entry)

KoID	menuCategory () const

QString	menuEntry () const

QString	name () const

	Private ()

QKeySequence	shortcut () const

bool	showConfigurationWidget ()
	If true, the filter wants to show a configuration widget.

bool	supportsAdjustmentLayers () const
	This filter can be used in adjustment layers.

bool	supportsPainting () const

bool	supportsThreading () const

virtual	~KisBaseProcessor ()

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

Public Member Functions inherited from KisShared
bool	deref ()

bool	ref ()

int	refCount ()

QAtomicInt *	sharedWeakReference ()

Additional Inherited Members
Public Attributes inherited from KisBaseProcessor
KisBookmarkedConfigurationManager *	bookmarkManager

KoID	category

ColorSpaceIndependence	colorSpaceIndependence

QString	entry

KoID	id

QKeySequence	shortcut

bool	showConfigurationWidget

bool	supportsAdjustmentLayers

bool	supportsPainting

bool	supportsThreading

Public Attributes inherited from Private
KisCanvas2 *	canvas

int	displayedFrame

int	intendedFrame

Protected Member Functions inherited from KisFilter
QString	configEntryGroup () const

void	setSupportsLevelOfDetail (bool value)

Protected Member Functions inherited from KisBaseProcessor
void	init (const QString &configEntryGroup)

void	setColorSpaceIndependence (ColorSpaceIndependence v)

void	setShortcut (const QKeySequence &shortcut)

void	setShowConfigurationWidget (bool v)

void	setSupportsAdjustmentLayers (bool v)

void	setSupportsPainting (bool v)

void	setSupportsThreading (bool v)

Protected Member Functions inherited from KisShared
	KisShared ()

	~KisShared ()

Detailed Description

This is a base class for filters that implement a filter for KoColorTransformationFactory based filters.

Definition at line 17 of file kis_color_transformation_filter.h.

Constructor & Destructor Documentation

◆ KisColorTransformationFilter()

KisColorTransformationFilter::KisColorTransformationFilter	(	const KoID &	id,
		const KoID &	category,
		const QString &	entry )

Definition at line 22 of file kis_color_transformation_filter.cc.

                                                                                                                       : KisFilter(id, category, entry)
{
    setSupportsLevelOfDetail(true);
}

References KisFilter::setSupportsLevelOfDetail().

◆ ~KisColorTransformationFilter()

KisColorTransformationFilter::~KisColorTransformationFilter ( )

override

Definition at line 27 of file kis_color_transformation_filter.cc.

28{

29}

Member Function Documentation

◆ createTransformation()

virtual KoColorTransformation * KisColorTransformationFilter::createTransformation	(	const KoColorSpace *	cs,
		const KisFilterConfigurationSP	config ) const

pure virtual

Create the color transformation that will be applied on the device.

Implemented in KisFilterASCCDL, KisColorBalanceFilter, KisCrossChannelFilter, KisDesaturateFilter, KisHSVAdjustmentFilter, KisPerChannelFilter, KisFilterDodgeBurn, KisFilterInvert, KisFilterIndexColors, KisLevelsFilter, KisFilterNormalize, and KisFilterPosterize.

◆ factoryConfiguration()

KisFilterConfigurationSP KisColorTransformationFilter::factoryConfiguration ( KisResourcesInterfaceSP resourcesInterface ) const

overridevirtual

Returns: the default configuration object as defined by whoever wrote the plugin. This object must be filled in with fromXML after that.

Reimplemented from KisBaseProcessor.

Reimplemented in KisCrossChannelFilter, KisPerChannelFilter, and KisLevelsFilter.

Definition at line 65 of file kis_color_transformation_filter.cc.

{
    return new KisColorTransformationConfiguration(id(), 0, resourcesInterface);
}

◆ processImpl()

void KisColorTransformationFilter::processImpl	(	KisPaintDeviceSP	device,
		const QRect &	applyRect,
		const KisFilterConfigurationSP	config,
		KoUpdater *	progressUpdater ) const

overridevirtual

Override this function with the implementation of your filter.

This is a low level function that expects all the conditions for the

Parameters

device	be met. Use usual process() methods instead.
device	the paint device to filter
applyRect	the rectangle where the filter is applied
config	the parameters of the filter
progressUpdater	to pass on the progress the filter is making

Implements KisFilter.

Definition at line 31 of file kis_color_transformation_filter.cc.

{
    Q_ASSERT(!device.isNull());
 
    const KoColorSpace * cs = device->colorSpace();
    KoColorTransformation * colorTransformation = 0;
    // Ew, casting
    KisColorTransformationConfigurationSP colorTransformationConfiguration(dynamic_cast<KisColorTransformationConfiguration*>(const_cast<KisFilterConfiguration*>(config.data())));
    if (colorTransformationConfiguration) {
        colorTransformation = colorTransformationConfiguration->colorTransformation(cs, this);
    }
    else {
        colorTransformation = createTransformation(cs, config);
    }
    if (!colorTransformation) return;
 
    KisSequentialIteratorProgress it(device, applyRect, progressUpdater);
 
    int conseq = it.nConseqPixels();
    while (it.nextPixels(conseq)) {
        conseq = it.nConseqPixels();
        colorTransformation->transform(it.oldRawData(), it.rawData(), conseq);
    }
 
    if (!colorTransformationConfiguration) {
        delete colorTransformation;
    }
 
}

References KisPaintDevice::colorSpace(), createTransformation(), KisSharedPtr< T >::data(), KisSharedPtr< T >::isNull(), KisSequentialIteratorBase< IteratorPolicy, SourcePolicy, ProgressPolicy >::nConseqPixels(), KisSequentialIteratorBase< IteratorPolicy, SourcePolicy, ProgressPolicy >::nextPixels(), KisSequentialIteratorBase< IteratorPolicy, SourcePolicy, ProgressPolicy >::oldRawData(), KisSequentialIteratorBase< IteratorPolicy, SourcePolicy, ProgressPolicy >::rawData(), and KoColorTransformation::transform().

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

libs/image/filter/kis_color_transformation_filter.h
libs/image/filter/kis_color_transformation_filter.cc

Public Member Functions

Additional Inherited Members