#include <kis_base_processor.h>

Inheritance diagram for KisBaseProcessor:

Public Member Functions
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

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

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

Private Attributes
Private *const	d

Friends
class	KisBaseProcessorConfigurationFactory

Detailed Description

Base class for classes that process areas of pixels. Processors can either read in pixels and write out pixels or just write out pixels, using a certain set of configuration pixels.

in-out processing is typically filtering:

See also: KisFilter. out-only processing is typically generating:; KisGenerator.

Information about the area that needs to be processed is contained

See also: KisProcessingInformation and; KisConstProcessingInformation.

Definition at line 36 of file kis_base_processor.cpp.

Constructor & Destructor Documentation

◆ KisBaseProcessor()

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

Definition at line 59 of file kis_base_processor.cpp.

        : d(new Private)
{
    d->id = id;
    d->category = category;
    d->entry = entry;
}

References category, d, entry, and id.

◆ ~KisBaseProcessor()

KisBaseProcessor::~KisBaseProcessor ( )

virtual

Definition at line 72 of file kis_base_processor.cpp.

{
    delete d->bookmarkManager;
    delete d;
}

References d.

Member Function Documentation

◆ bookmarkManager() [1/2]

KisBookmarkedConfigurationManager * KisBaseProcessor::bookmarkManager ( )

Returns: the bookmark manager for this processor

◆ bookmarkManager() [2/2]

const KisBookmarkedConfigurationManager * KisBaseProcessor::bookmarkManager ( ) const

Returns: the bookmark manager for this processor

◆ colorSpaceIndependence()

ColorSpaceIndependence KisBaseProcessor::colorSpaceIndependence ( ) const

Determine the colorspace independence of this filter.

See also: ColorSpaceIndependence

Returns: the degree of independence

◆ createConfigurationWidget()

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

virtual

Create the configuration widget for this processor.

Parameters

parent	the Qt owner widget of this widget
dev	the paintdevice this filter will act on
useForMasks	shown if the filer is going to be used in a mask. Some filters may provide limited options when applied as a mask (e.g. Gaussian Blur)

Reimplemented in KisFilterASCCDL, KisBlurFilter, KisGaussianBlurFilter, KisLensBlurFilter, KisMotionBlurFilter, KisFilterColorToAlpha, KisFilterFastColorOverlay, KisColorBalanceFilter, KisCrossChannelFilter, KisDesaturateFilter, KisHSVAdjustmentFilter, KisPerChannelFilter, KisConvertHeightToNormalMapFilter, KisFilterDodgeBurn, KisEdgeDetectionFilter, KisEmbossFilter, KisFilterFastColorTransfer, KisGaussianHighPassFilter, KisGradientMapFilter, KisHalftoneFilter, KisSimpleNoiseReducer, KisWaveletNoiseReduction, KisFilterIndexColors, KisLevelsFilter, KisFilterNoise, KisOilPaintFilter, KisFilterPalettize, KisFilterPhongBumpmap, KisPixelizeFilter, KisFilterPosterize, KisPropagateColorsFilter, KisRainDropsFilter, KisFilterRandomPick, KisRoundCornersFilter, KisSmallTilesFilter, KisFilterThreshold, KisUnsharpFilter, KisFilterWave, KisGradientGenerator, KisMultigridPatternGenerator, PatternGenerator, KisScreentoneGenerator, KisSeExprGenerator, KisSimplexNoiseGenerator, and KisColorGenerator.

Definition at line 88 of file kis_base_processor.cpp.

{
    return 0;
}

◆ defaultConfiguration()

KisFilterConfigurationSP KisBaseProcessor::defaultConfiguration ( KisResourcesInterfaceSP resourcesInterface ) const

virtual

Return the configuration set as the default by the user or the default configuration from the filter writer as returned by factoryConfiguration.

This configuration is used by default for the configuration widget and given to the process function if there is no configuration widget.

Returns: the default configuration of this widget

Reimplemented in KisFilterASCCDL, KisBlurFilter, KisGaussianBlurFilter, KisLensBlurFilter, KisMotionBlurFilter, KisFilterColorToAlpha, KisFilterFastColorOverlay, KisColorBalanceFilter, KisDesaturateFilter, KisHSVAdjustmentFilter, KisConvertHeightToNormalMapFilter, KisFilterDodgeBurn, KisEdgeDetectionFilter, KisEmbossFilter, KisFilterFastColorTransfer, KisGaussianHighPassFilter, KisGradientMapFilter, KisHalftoneFilter, KisSimpleNoiseReducer, KisWaveletNoiseReduction, KisFilterIndexColors, KisFilterNoise, KisOilPaintFilter, KisFilterPalettize, KisFilterPhongBumpmap, KisPixelizeFilter, KisFilterPosterize, KisRainDropsFilter, KisFilterRandomPick, KisRoundCornersFilter, KisSmallTilesFilter, KisFilterThreshold, KisUnsharpFilter, KisFilterWave, KisGradientGenerator, KisMultigridPatternGenerator, PatternGenerator, KisScreentoneGenerator, KisSeExprGenerator, KisSimplexNoiseGenerator, and KisColorGenerator.

Definition at line 83 of file kis_base_processor.cpp.

{
    return factoryConfiguration(resourcesInterface);
}

References factoryConfiguration().

◆ factoryConfiguration()

KisFilterConfigurationSP KisBaseProcessor::factoryConfiguration ( KisResourcesInterfaceSP resourcesInterface ) const

virtual

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

Reimplemented in KisColorTransformationFilter, KisCrossChannelFilter, KisPerChannelFilter, KisGradientMapFilter, KisHalftoneFilter, KisLevelsFilter, KisFilterPalettize, KisPropagateColorsFilter, KisGradientGenerator, PatternGenerator, KisScreentoneGenerator, and KisSeExprGenerator.

Definition at line 78 of file kis_base_processor.cpp.

{
    return new KisFilterConfiguration(id(), 1, resourcesInterface);
}

◆ id()

QString KisBaseProcessor::id ( ) const

Returns: Unique identification for this processor

◆ init()

void KisBaseProcessor::init ( const QString & configEntryGroup )

protected

Definition at line 67 of file kis_base_processor.cpp.

{
    d->bookmarkManager = new KisBookmarkedConfigurationManager(configEntryGroup, new KisBaseProcessorConfigurationFactory(this));
}

References d, and KisBaseProcessorConfigurationFactory.

◆ menuCategory()

KoID KisBaseProcessor::menuCategory ( ) const

Returns: the submenu in the filters menu does processor want to go?

Definition at line 113 of file kis_base_processor.cpp.

{
    return d->category;
}

References d.

◆ menuEntry()

QString KisBaseProcessor::menuEntry ( ) const

Returns: the i18n'ed string this filter wants to show itself in the menu

Definition at line 118 of file kis_base_processor.cpp.

{
    return d->entry;
}

References d.

◆ name()

QString KisBaseProcessor::name ( ) const

Returns: User-visible identification for this processor

Definition at line 108 of file kis_base_processor.cpp.

{
    return d->id.name();
}

References d.

◆ Private()

KisBaseProcessor::Private ( )

inline

Definition at line 37 of file kis_base_processor.cpp.

            : bookmarkManager(0)
            , supportsPainting(false)
            , supportsAdjustmentLayers(true)
            , supportsThreading(true)
            , showConfigurationWidget(true)
            , colorSpaceIndependence(FULLY_INDEPENDENT) {
    }

◆ setColorSpaceIndependence()

void KisBaseProcessor::setColorSpaceIndependence ( ColorSpaceIndependence v )

protected

Definition at line 168 of file kis_base_processor.cpp.

{
    d->colorSpaceIndependence = v;
}

References d, and v.

◆ setShortcut()

void KisBaseProcessor::setShortcut ( const QKeySequence & shortcut )

protected

Set the default shortcut for activation of this filter.

Definition at line 128 of file kis_base_processor.cpp.

{
    d->shortcut = shortcut;
}

References d, and shortcut.

◆ setShowConfigurationWidget()

void KisBaseProcessor::setShowConfigurationWidget ( bool v )

protected

Definition at line 178 of file kis_base_processor.cpp.

{
    d->showConfigurationWidget = v;
}

References d, and v.

◆ setSupportsAdjustmentLayers()

void KisBaseProcessor::setSupportsAdjustmentLayers ( bool v )

protected

Definition at line 158 of file kis_base_processor.cpp.

{
    d->supportsAdjustmentLayers = v;
}

References d, and v.

◆ setSupportsPainting()

void KisBaseProcessor::setSupportsPainting ( bool v )

protected

Definition at line 153 of file kis_base_processor.cpp.

{
    d->supportsPainting = v;
}

References d, and v.

◆ setSupportsThreading()

void KisBaseProcessor::setSupportsThreading ( bool v )

protected

Definition at line 163 of file kis_base_processor.cpp.

{
    d->supportsThreading = v;
}

References d, and v.

◆ shortcut()

QKeySequence KisBaseProcessor::shortcut ( ) const

Return the default keyboard shortcut for activation of this filter

Returns: the shortcut

◆ showConfigurationWidget()

bool KisBaseProcessor::showConfigurationWidget ( )

If true, the filter wants to show a configuration widget.

◆ supportsAdjustmentLayers()

bool KisBaseProcessor::supportsAdjustmentLayers ( ) const

This filter can be used in adjustment layers.

◆ supportsPainting()

bool KisBaseProcessor::supportsPainting ( ) const

If true, this filter can be used in painting tools as a paint operation

◆ supportsThreading()

bool KisBaseProcessor::supportsThreading ( ) const

This filter supports cutting up the work area and filtering each chunk in a separate thread. Filters that need access to the whole area for correct computations should return false.

Friends And Related Symbol Documentation

◆ KisBaseProcessorConfigurationFactory

friend class KisBaseProcessorConfigurationFactory

friend

Definition at line 50 of file kis_base_processor.h.

Member Data Documentation

◆ bookmarkManager

const KisBookmarkedConfigurationManager * KisBaseProcessor::bookmarkManager

Definition at line 46 of file kis_base_processor.cpp.

◆ category

KoID KisBaseProcessor::category

Definition at line 49 of file kis_base_processor.cpp.

◆ colorSpaceIndependence

ColorSpaceIndependence KisBaseProcessor::colorSpaceIndependence

Definition at line 56 of file kis_base_processor.cpp.

◆ d

Private* const KisBaseProcessor::d

private

Definition at line 159 of file kis_base_processor.h.

◆ entry

QString KisBaseProcessor::entry

Definition at line 50 of file kis_base_processor.cpp.

◆ id

QString KisBaseProcessor::id

Definition at line 48 of file kis_base_processor.cpp.

◆ shortcut

QKeySequence KisBaseProcessor::shortcut

Definition at line 51 of file kis_base_processor.cpp.

◆ showConfigurationWidget

bool KisBaseProcessor::showConfigurationWidget

Definition at line 55 of file kis_base_processor.cpp.

◆ supportsAdjustmentLayers

bool KisBaseProcessor::supportsAdjustmentLayers

Definition at line 53 of file kis_base_processor.cpp.

◆ supportsPainting

bool KisBaseProcessor::supportsPainting

Definition at line 52 of file kis_base_processor.cpp.

◆ supportsThreading

bool KisBaseProcessor::supportsThreading

Definition at line 54 of file kis_base_processor.cpp.

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

libs/image/kis_base_processor.cpp
libs/image/kis_base_processor.h

Public Member Functions

Public Attributes

Protected Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ KisBaseProcessor()

◆ ~KisBaseProcessor()

Member Function Documentation

◆ bookmarkManager() [1/2]

◆ bookmarkManager() [2/2]

◆ colorSpaceIndependence()

◆ createConfigurationWidget()

◆ defaultConfiguration()

◆ factoryConfiguration()

◆ id()

◆ init()

◆ menuCategory()

◆ menuEntry()

◆ name()

◆ Private()

◆ setColorSpaceIndependence()

◆ setShortcut()

◆ setShowConfigurationWidget()

◆ setSupportsAdjustmentLayers()

◆ setSupportsPainting()

◆ setSupportsThreading()

◆ shortcut()

◆ showConfigurationWidget()

◆ supportsAdjustmentLayers()

◆ supportsPainting()

◆ supportsThreading()

Friends And Related Symbol Documentation

◆ KisBaseProcessorConfigurationFactory

Member Data Documentation

◆ bookmarkManager

◆ category

◆ colorSpaceIndependence

◆ d

◆ entry

◆ id

◆ shortcut

◆ showConfigurationWidget

◆ supportsAdjustmentLayers

◆ supportsPainting

◆ supportsThreading