#include <KisGradientGenerator.h>

Inheritance diagram for KisGradientGenerator:

Public Member Functions
KisConfigWidget *	createConfigurationWidget (QWidget *parent, const KisPaintDeviceSP dev, bool useForMasks) const override

KisFilterConfigurationSP	defaultConfiguration (KisResourcesInterfaceSP resourcesInterface) const override

KisFilterConfigurationSP	factoryConfiguration (KisResourcesInterfaceSP resourcesInterface) const override

virtual void	generate (KisProcessingInformation dst, const QSize &size, const KisFilterConfigurationSP config) const

virtual void	generate (KisProcessingInformation dst, const QSize &size, const KisFilterConfigurationSP config, KoUpdater *progressUpdater) const override

virtual void	generate (KisProcessingInformation dst, const QSize &size, const KisFilterConfigurationSP config, KoUpdater *progressUpdater) const=0

	KisGradientGenerator ()

Public Member Functions inherited from KisGenerator
virtual bool	allowsSplittingIntoPatches () const

virtual QRect	generatedRect (QRect _imageArea, const KisFilterConfigurationSP=0) const

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

	~KisGenerator () override

Public Member Functions inherited from KisBaseProcessor
KisBookmarkedConfigurationManager *	bookmarkManager ()

const KisBookmarkedConfigurationManager *	bookmarkManager () const

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

Static Public Member Functions
static KoID	id ()

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 KisGenerator
QString	configEntryGroup () const

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

Definition at line 20 of file KisGradientGenerator.h.

Constructor & Destructor Documentation

◆ KisGradientGenerator()

KisGradientGenerator::KisGradientGenerator ( )

Definition at line 20 of file KisGradientGenerator.cpp.

                                           : KisGenerator(id(), KoID("basic"), i18n("&Gradient..."))
{
    setSupportsPainting(true);
}

References KisBaseProcessor::setSupportsPainting().

Member Function Documentation

◆ createConfigurationWidget()

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

overridevirtual

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

Definition at line 71 of file KisGradientGenerator.cpp.

{
    Q_UNUSED(dev);
    return new KisGradientGeneratorConfigWidget(parent);
}

◆ defaultConfiguration()

KisFilterConfigurationSP KisGradientGenerator::defaultConfiguration ( KisResourcesInterfaceSP resourcesInterface ) const

overridevirtual

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

Definition at line 64 of file KisGradientGenerator.cpp.

{
    KisGradientGeneratorConfiguration *config = new KisGradientGeneratorConfiguration(resourcesInterface);
    config->setDefaults();
    return config;
}

References KisGradientGeneratorConfiguration::setDefaults().

◆ factoryConfiguration()

KisFilterConfigurationSP KisGradientGenerator::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.

Definition at line 59 of file KisGradientGenerator.cpp.

{
    return new KisGradientGeneratorConfiguration(resourcesInterface);
}

◆ generate() [1/3]

void KisGenerator::generate	(	KisProcessingInformation	dst,
		const QSize &	size,
		const KisFilterConfigurationSP	config ) const

virtual

Provided for convenience when no progress reporting is needed.

Reimplemented from KisGenerator.

Definition at line 59 of file kis_generator.cpp.

{
    generate(dst, size, config, 0);
}

◆ generate() [2/3]

void KisGradientGenerator::generate	(	KisProcessingInformation	dst,
		const QSize &	size,
		const KisFilterConfigurationSP	config,
		KoUpdater *	progressUpdater ) const

overridevirtual

Override this function with the implementation of your generator.

Parameters

dst	the destination paint device
size	the size of the area that is to be filled
config	the parameters of the filter
progressUpdater	the progress updater

Implements KisGenerator.

Definition at line 25 of file KisGradientGenerator.cpp.

{
    KisPaintDeviceSP device = dst.paintDevice();
    Q_ASSERT(!device.isNull());
 
    KIS_SAFE_ASSERT_RECOVER_RETURN(config);
    const KisGradientGeneratorConfiguration *generatorConfiguration =
        dynamic_cast<const KisGradientGeneratorConfiguration*>(config.data());
    KIS_SAFE_ASSERT_RECOVER_RETURN(generatorConfiguration);
 
 
    QSize imageSize = device->defaultBounds()->imageBorderRect().size();
    QPair<QPointF, QPointF> positions =
        generatorConfiguration->absoluteCartesianPositionsInPixels(imageSize.width(), imageSize.height());
 
    KisGradientPainter painter(device);
    painter.setCompositeOpId(COMPOSITE_COPY);
    painter.setProgress(progressUpdater);
    painter.setGradientShape(generatorConfiguration->shape());
    painter.setGradient(generatorConfiguration->gradient());
    painter.paintGradient(
        positions.first,
        positions.second,
        generatorConfiguration->repeat(),
        generatorConfiguration->antiAliasThreshold(),
        generatorConfiguration->reverse(),
        QRect(dst.topLeft(), size),
        generatorConfiguration->dither()
    );
}

References KisGradientGeneratorConfiguration::absoluteCartesianPositionsInPixels(), KisGradientGeneratorConfiguration::antiAliasThreshold(), COMPOSITE_COPY, KisSharedPtr< T >::data(), KisPaintDevice::defaultBounds(), KisGradientGeneratorConfiguration::dither(), KisGradientGeneratorConfiguration::gradient(), KisDefaultBoundsBase::imageBorderRect(), KisSharedPtr< T >::isNull(), KIS_SAFE_ASSERT_RECOVER_RETURN, KisProcessingInformation::paintDevice(), KisGradientPainter::paintGradient(), KisGradientGeneratorConfiguration::repeat(), KisGradientGeneratorConfiguration::reverse(), KisPainter::setCompositeOpId(), KisPainter::setGradient(), KisGradientPainter::setGradientShape(), KisPainter::setProgress(), KisGradientGeneratorConfiguration::shape(), and KisConstProcessingInformation::topLeft.

◆ generate() [3/3]

virtual void KisGenerator::generate	(	KisProcessingInformation	dst,
		const QSize &	size,
		const KisFilterConfigurationSP	config,
		KoUpdater *	progressUpdater ) const

virtual

Override this function with the implementation of your generator.

Parameters

dst	the destination paint device
size	the size of the area that is to be filled
config	the parameters of the filter
progressUpdater	the progress updater

Implements KisGenerator.

◆ id()

static KoID KisGradientGenerator::id ( )

inlinestatic

Definition at line 32 of file KisGradientGenerator.h.

                            {
        return KoID(KisGradientGeneratorConfiguration::defaultName(), i18n("Gradient"));
    }

References KisGradientGeneratorConfiguration::defaultName().

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

plugins/generators/gradient/KisGradientGenerator.h
plugins/generators/gradient/KisGradientGenerator.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KisGradientGenerator()

Member Function Documentation

◆ createConfigurationWidget()

◆ defaultConfiguration()

◆ factoryConfiguration()

◆ generate() [1/3]

◆ generate() [2/3]

◆ generate() [3/3]

◆ id()