KisSeExprGenerator Class Reference

#include <generator.h>

Inheritance diagram for KisSeExprGenerator:

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
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
	KisSeExprGenerator ()
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 37 of file generator.h.

Constructor & Destructor Documentation

KisSeExprGenerator()

KisSeExprGenerator::KisSeExprGenerator

(

)

Definition at line 71 of file generator.cpp.

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

References FULLY_INDEPENDENT, KisBaseProcessor::setColorSpaceIndependence(), and KisBaseProcessor::setSupportsPainting().

Member Function Documentation

createConfigurationWidget()

KisConfigWidget * KisSeExprGenerator::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 93 of file generator.cpp.

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

defaultConfiguration()

KisFilterConfigurationSP KisSeExprGenerator::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 83 of file generator.cpp.

{
    KisFilterConfigurationSP config = factoryConfiguration(resourcesInterface);
 
    QVariant v;
    v.setValue(QString("Disney_noisecolor2"));
    config->setProperty("pattern", v);
    return config;
}

References factoryConfiguration(), and v.

factoryConfiguration()

KisFilterConfigurationSP KisSeExprGenerator::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 78 of file generator.cpp.

{
    return new KisSeExprGeneratorConfiguration(id().id(), 1, 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 KisSeExprGenerator::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 99 of file generator.cpp.

{
    KisPaintDeviceSP device = dstInfo.paintDevice();
 
    Q_ASSERT(!device.isNull());
    Q_ASSERT(config);
 
    if (config) {
        QString script = config->getString("script");
 
        QRect bounds = QRect(dstInfo.topLeft(), size);
        QRect whole_image_bounds = device->defaultBounds()->bounds();
 
        SeExprExpressionContext expression(script);
 
        expression.m_vars["u"] = new SeExprVariable();
        expression.m_vars["v"] = new SeExprVariable();
        expression.m_vars["w"] = new SeExprVariable(whole_image_bounds.width());
        expression.m_vars["h"] = new SeExprVariable(whole_image_bounds.height());
 
        if (expression.isValid() && expression.returnType().isFP(3)) {
            double pixel_stride_x = 1. / whole_image_bounds.width();
            double pixel_stride_y = 1. / whole_image_bounds.height();
            double &u = expression.m_vars["u"]->m_value;
            double &v = expression.m_vars["v"]->m_value;
 
            // SeExpr already outputs floating-point RGB
            const KoColorSpace *dst = device->colorSpace();
            const KoColorSpace *src = KoColorSpaceRegistry::instance()->colorSpace(RGBAColorModelID.id(), Float32BitsColorDepthID.id(), KoColorSpaceRegistry::instance()->p709SRGBProfile());
            auto conv = KoColorSpaceRegistry::instance()->createColorConverter(src, dst, KoColorConversionTransformation::internalRenderingIntent(), KoColorConversionTransformation::internalConversionFlags());
 
            KisSequentialIteratorProgress it(device, bounds, progressUpdater);
 
            while (it.nextPixel()) {
                u = pixel_stride_x * (it.x() + .5);
                v = pixel_stride_y * (it.y() + .5);
 
                const double *value = expression.evalFP();
 
                KoColor c(src);
                reinterpret_cast<float *>(c.data())[0] = value[0];
                reinterpret_cast<float *>(c.data())[1] = value[1];
                reinterpret_cast<float *>(c.data())[2] = value[2];
                c.setOpacity(OPACITY_OPAQUE_F);
 
                conv->transform(c.data(), it.rawData(), 1);
            }
            delete conv;
        }
    }
}

References KisDefaultBoundsBase::bounds(), bounds, KisPaintDevice::colorSpace(), KoColorSpaceRegistry::colorSpace(), KoColorSpaceRegistry::createColorConverter(), KoColor::data(), KisPaintDevice::defaultBounds(), Float32BitsColorDepthID, KoID::id(), KoColorSpaceRegistry::instance(), KoColorConversionTransformation::internalConversionFlags(), KoColorConversionTransformation::internalRenderingIntent(), KisSharedPtr< T >::isNull(), SeExprExpressionContext::m_vars, KisSequentialIteratorBase< IteratorPolicy, SourcePolicy, ProgressPolicy >::nextPixel(), OPACITY_OPAQUE_F, KoColorSpaceRegistry::p709SRGBProfile(), KisProcessingInformation::paintDevice(), KisSequentialIteratorBase< IteratorPolicy, SourcePolicy, ProgressPolicy >::rawData(), RGBAColorModelID, KoColor::setOpacity(), KisConstProcessingInformation::topLeft, u, v, value(), KisSequentialIteratorBase< IteratorPolicy, SourcePolicy, ProgressPolicy >::x(), and KisSequentialIteratorBase< IteratorPolicy, SourcePolicy, ProgressPolicy >::y().

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 KisSeExprGenerator::id ( )

inlinestatic

Definition at line 50 of file generator.h.

    {
        return KoID("seexpr", i18n("SeExpr"));
    }

---

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

• plugins/generators/seexpr/generator.h
• plugins/generators/seexpr/generator.cpp