KisLensBlurFilter Class Reference

#include <kis_lens_blur_filter.h>

Inheritance diagram for KisLensBlurFilter:

Public Member Functions
QRect	changedRect (const QRect &rect, const KisFilterConfigurationSP _config, int lod) const override
KisConfigWidget *	createConfigurationWidget (QWidget *parent, const KisPaintDeviceSP dev, bool useForMasks) const override
KisFilterConfigurationSP	defaultConfiguration (KisResourcesInterfaceSP resourcesInterface) const override
	KisLensBlurFilter ()
QRect	neededRect (const QRect &rect, const KisFilterConfigurationSP _config, int lod) const override
void	processImpl (KisPaintDeviceSP src, const QRect &size, const KisFilterConfigurationSP config, KoUpdater *progressUpdater) const override
Public Member Functions inherited from KisFilter
virtual bool	configurationAllowedForMask (KisFilterConfigurationSP config) const
virtual void	fixLoadedFilterConfigurationForMasks (KisFilterConfigurationSP config) const
	KisFilter (const KoID &id, const KoID &category, const QString &entry)
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 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 ()

Static Public Member Functions
static QSize	getKernelHalfSize (const KisFilterConfigurationSP config, int lod)
static KoID	id ()

Static Private Member Functions
static QPolygonF	getIrisPolygon (const KisFilterConfigurationSP config, int lod)

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

Definition at line 18 of file kis_lens_blur_filter.h.

Constructor & Destructor Documentation

KisLensBlurFilter()

KisLensBlurFilter::KisLensBlurFilter

(

)

Definition at line 33 of file kis_lens_blur_filter.cpp.

                                     : KisFilter(id(), FiltersCategoryBlurId, i18n("&Lens Blur..."))
{
    setSupportsPainting(true);
    setSupportsAdjustmentLayers(true);
    setSupportsLevelOfDetail(true);
    setColorSpaceIndependence(FULLY_INDEPENDENT);
 
}

References FULLY_INDEPENDENT, KisBaseProcessor::setColorSpaceIndependence(), KisBaseProcessor::setSupportsAdjustmentLayers(), KisFilter::setSupportsLevelOfDetail(), and KisBaseProcessor::setSupportsPainting().

Member Function Documentation

changedRect()

QRect KisLensBlurFilter::changedRect ( const QRect & rect, const KisFilterConfigurationSP config, int lod ) const

overridevirtual

Similar to neededRect : some filters will alter a lot of pixels that are near to each other at the same time. So when you changed a single rectangle in a device, the actual rectangle that will feel the influence of this change might be bigger. Use this function to determine that rect.

Reimplemented from KisFilter.

Definition at line 181 of file kis_lens_blur_filter.cpp.

{
    KisLodTransformScalar t(lod);
 
    QVariant value;
    const int halfWidth = t.scale(_config->getProperty("halfWidth", value) ? value.toUInt() : 5);
    const int halfHeight = t.scale(_config->getProperty("halfHeight", value) ? value.toUInt() : 5);
 
    return rect.adjusted(-halfWidth, -halfHeight, halfWidth, halfHeight);
}

References KisLodTransformScalar::scale(), and value().

createConfigurationWidget()

KisConfigWidget * KisLensBlurFilter::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 42 of file kis_lens_blur_filter.cpp.

{
    return new KisWdgLensBlur(parent);
}

defaultConfiguration()

KisFilterConfigurationSP KisLensBlurFilter::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 58 of file kis_lens_blur_filter.cpp.

{
    KisFilterConfigurationSP config = factoryConfiguration(resourcesInterface);
    config->setProperty("irisShape", "Pentagon (5)");
    config->setProperty("irisRadius", 5);
    config->setProperty("irisRotation", 0);
 
    QSize halfSize = getKernelHalfSize(config, 0);
    config->setProperty("halfWidth", halfSize.width());
    config->setProperty("halfHeight", halfSize.height());
 
    return config;
}

References KisBaseProcessor::factoryConfiguration(), and getKernelHalfSize().

getIrisPolygon()

QPolygonF KisLensBlurFilter::getIrisPolygon ( const KisFilterConfigurationSP config, int lod )

staticprivate

Definition at line 72 of file kis_lens_blur_filter.cpp.

{
    KIS_ASSERT_RECOVER(config) { return QPolygonF(); }
 
    KisLodTransformScalar t(lod);
 
    QVariant value;
    config->getProperty("irisShape", value);
    QString irisShape = value.toString();
    config->getProperty("irisRadius", value);
    uint irisRadius = t.scale(value.toUInt());
    config->getProperty("irisRotation", value);
    uint irisRotation = value.toUInt();
 
    if (irisRadius < 1)
        return QPolygon();
 
    QPolygonF irisShapePoly;
 
    int sides = 1;
    qreal angle = 0;
 
    if (irisShape == "Triangle") sides = 3;
    else if (irisShape == "Quadrilateral (4)") sides = 4;
    else if (irisShape == "Pentagon (5)") sides = 5;
    else if (irisShape == "Hexagon (6)") sides = 6;
    else if (irisShape == "Heptagon (7)") sides = 7;
    else if (irisShape == "Octagon (8)") sides = 8;
    else return QPolygonF();
 
    for (int i = 0; i < sides; ++i) {
        irisShapePoly << QPointF(0.5 * cos(angle), 0.5 * sin(angle));
        angle += 2 * M_PI / sides;
    }
 
    QTransform transform;
    transform.rotate(irisRotation);
    transform.scale(irisRadius * 2, irisRadius * 2);
 
    QPolygonF transformedIris = transform.map(irisShapePoly);
 
    return transformedIris;
}

References KIS_ASSERT_RECOVER, M_PI, KisLodTransformScalar::scale(), and value().

getKernelHalfSize()

QSize KisLensBlurFilter::getKernelHalfSize ( const KisFilterConfigurationSP config, int lod )

static

Definition at line 47 of file kis_lens_blur_filter.cpp.

{
    QPolygonF iris = getIrisPolygon(config, lod);
    QRect rect = iris.boundingRect().toAlignedRect();
 
    int w = std::ceil(qreal(rect.width()) / 2.0);
    int h = std::ceil(qreal(rect.height()) / 2.0);
 
    return QSize(w, h);
}

References getIrisPolygon().

id()

static KoID KisLensBlurFilter::id ( )

inlinestatic

Definition at line 29 of file kis_lens_blur_filter.h.

                            {
        return KoID("lens blur", i18n("Lens Blur"));
    }

neededRect()

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

overridevirtual

Some filters need pixels outside the current processing rect to compute the new value (for instance, convolution filters)

Reimplemented from KisFilter.

Definition at line 170 of file kis_lens_blur_filter.cpp.

{
    KisLodTransformScalar t(lod);
 
    QVariant value;
    const int halfWidth = t.scale(_config->getProperty("halfWidth", value) ? value.toUInt() : 5);
    const int halfHeight = t.scale(_config->getProperty("halfHeight", value) ? value.toUInt() : 5);
 
    return rect.adjusted(-halfWidth * 2, -halfHeight * 2, halfWidth * 2, halfHeight * 2);
}

References KisLodTransformScalar::scale(), and value().

processImpl()

void KisLensBlurFilter::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 116 of file kis_lens_blur_filter.cpp.

{
    QPoint srcTopLeft = rect.topLeft();
 
    Q_ASSERT(device != 0);
    KIS_SAFE_ASSERT_RECOVER_RETURN(config);
 
    QBitArray channelFlags = config->channelFlags();
    if (channelFlags.isEmpty()) {
        channelFlags = QBitArray(device->colorSpace()->channelCount(), true);
    }
 
    const int lod = device->defaultBounds()->currentLevelOfDetail();
    QPolygonF transformedIris = getIrisPolygon(config, lod);
    if (transformedIris.isEmpty()) return;
 
    QRectF boundingRect = transformedIris.boundingRect();
 
    int kernelWidth = boundingRect.toAlignedRect().width();
    int kernelHeight = boundingRect.toAlignedRect().height();
 
    QImage kernelRepresentation(kernelWidth, kernelHeight, QImage::Format_RGB32);
    kernelRepresentation.fill(0);
 
    QPainter imagePainter(&kernelRepresentation);
    imagePainter.setRenderHint(QPainter::Antialiasing);
    imagePainter.setBrush(QColor::fromRgb(255, 255, 255));
 
    QTransform offsetTransform;
    offsetTransform.translate(-boundingRect.x(), -boundingRect.y());
    imagePainter.setTransform(offsetTransform);
    imagePainter.drawPolygon(transformedIris, Qt::WindingFill);
 
    // construct kernel from image
    Eigen::Matrix<qreal, Eigen::Dynamic, Eigen::Dynamic> irisKernel(kernelHeight, kernelWidth);
    for (int j = 0; j < kernelHeight; ++j) {
        for (int i = 0; i < kernelWidth; ++i) {
            irisKernel(j, i) = qRed(kernelRepresentation.pixel(i, j));
        }
    }
 
    // apply convolution
    KisConvolutionPainter painter(device);
    painter.setChannelFlags(channelFlags);
    painter.setProgress(progressUpdater);
 
    KisConvolutionKernelSP kernel = KisConvolutionKernel::fromMatrix(irisKernel, 0, irisKernel.sum());
    painter.applyMatrix(kernel, device, srcTopLeft, srcTopLeft, rect.size(), BORDER_REPEAT);
}

References KisConvolutionPainter::applyMatrix(), BORDER_REPEAT, KoColorSpace::channelCount(), KisPaintDevice::colorSpace(), KisDefaultBoundsBase::currentLevelOfDetail(), KisPaintDevice::defaultBounds(), KisConvolutionKernel::fromMatrix(), getIrisPolygon(), KIS_SAFE_ASSERT_RECOVER_RETURN, KisPainter::setChannelFlags(), and KisPainter::setProgress().

---

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

• plugins/filters/blur/kis_lens_blur_filter.h
• plugins/filters/blur/kis_lens_blur_filter.cpp