KisPixelizeFilter Class Reference

#include <kis_pixelize_filter.h>

Inheritance diagram for KisPixelizeFilter:

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
	KisPixelizeFilter ()
QRect	neededRect (const QRect &rect, const KisFilterConfigurationSP config, int lod) const override
void	processImpl (KisPaintDeviceSP device, const QRect &applyRect, 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 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 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 15 of file kis_pixelize_filter.h.

Constructor & Destructor Documentation

KisPixelizeFilter()

KisPixelizeFilter::KisPixelizeFilter

(

)

Definition at line 45 of file kis_pixelize_filter.cpp.

                                     : KisFilter(id(), FiltersCategoryArtisticId, i18n("&Pixelize..."))
{
    setSupportsPainting(true);
    setSupportsThreading(true);
    setSupportsAdjustmentLayers(true);
    setSupportsLevelOfDetail(true);
    setColorSpaceIndependence(FULLY_INDEPENDENT);
}

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

Member Function Documentation

changedRect()

QRect KisPixelizeFilter::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 130 of file kis_pixelize_filter.cpp.

{
    return neededRect(rect, config, lod);
}

References neededRect().

createConfigurationWidget()

KisConfigWidget * KisPixelizeFilter::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 135 of file kis_pixelize_filter.cpp.

{
    vKisIntegerWidgetParam param;
    param.push_back(KisIntegerWidgetParam(2, 512, 10, i18n("Pixel width"), "pixelWidth" /*"keepAspect"*/));
    param.push_back(KisIntegerWidgetParam(2, 512, 10, i18n("Pixel height"), "pixelHeight", "keepAspect"));
    return new KisMultiIntegerFilterWidget(id().id(),  parent,  id().id(),  param);
}

defaultConfiguration()

KisFilterConfigurationSP KisPixelizeFilter::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 143 of file kis_pixelize_filter.cpp.

{
    KisFilterConfigurationSP config = factoryConfiguration(resourcesInterface);
    config->setProperty("pixelWidth", 10);
    config->setProperty("pixelHeight", 10);
    config->setProperty("keepAspect", true);
    return config;
}

References KisBaseProcessor::factoryConfiguration().

id()

static KoID KisPixelizeFilter::id ( )

inlinestatic

Definition at line 26 of file kis_pixelize_filter.h.

                            {
        return KoID("pixelize", i18n("Pixelize"));
    }

neededRect()

QRect KisPixelizeFilter::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 119 of file kis_pixelize_filter.cpp.

{
    KisLodTransformScalar t(lod);
 
    const int pixelWidth = qCeil(t.scale(config ? qMax(1, config->getInt("pixelWidth", 10)) : 10));
    const int pixelHeight = qCeil(t.scale(config ? qMax(1, config->getInt("pixelHeight", 10)) : 10));
 
    // TODO: make more precise calculation of the rect, including the alignment
    return rect.adjusted(-2*pixelWidth, -2*pixelHeight, 2*pixelWidth, 2*pixelHeight);
}

References KisLodTransformScalar::scale().

processImpl()

void KisPixelizeFilter::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 54 of file kis_pixelize_filter.cpp.

{
    Q_ASSERT(device);
 
    KisLodTransformScalar t(device);
    const int pixelWidth = qCeil(t.scale(config ? qMax(1, config->getInt("pixelWidth", 10)) : 10));
    const int pixelHeight = qCeil(t.scale(config ? qMax(1, config->getInt("pixelHeight", 10)) : 10));
 
    const qint32 pixelSize = device->pixelSize();
 
    const QRect deviceBounds = device->defaultBounds()->bounds();
 
    const int bufferSize = pixelSize * pixelWidth * pixelHeight;
    QScopedArrayPointer<quint8> buffer(new quint8[bufferSize]);
 
    KoColor pixelColor(Qt::black, device->colorSpace());
    KoMixColorsOp *mixOp = device->colorSpace()->mixColorsOp();
 
    using namespace KisAlgebra2D;
    const qint32 firstCol = divideFloor(applyRect.x(), pixelWidth);
    const qint32 firstRow = divideFloor(applyRect.y(), pixelHeight);
 
    const qint32 lastCol = divideFloor(applyRect.x() + applyRect.width() - 1, pixelWidth);
    const qint32 lastRow = divideFloor(applyRect.y() + applyRect.height() - 1, pixelHeight);
 
    progressUpdater->setRange(firstRow, lastRow);
 
    for(qint32 i = firstRow; i <= lastRow; i++) {
        for(qint32 j = firstCol; j <= lastCol; j++) {
            const QRect maxPatchRect(j * pixelWidth, i * pixelHeight,
                                     pixelWidth, pixelHeight);
            const QRect pixelRect = maxPatchRect & deviceBounds;
            const int numColors = pixelRect.width() * pixelRect.height();
 
 
            //read
            KisSequentialConstIterator srcIt(device, pixelRect);
 
            memset(buffer.data(), 0, bufferSize);
            quint8 *bufferPtr = buffer.data();
 
            while (srcIt.nextPixel()) {
                memcpy(bufferPtr, srcIt.oldRawData(), pixelSize);
                bufferPtr += pixelSize;
            }
 
            // mix all the colors
            mixOp->mixColors(buffer.data(), numColors, pixelColor.data());
 
            // write only colors in applyRect
            const QRect writeRect = pixelRect & applyRect;
 
            KisSequentialIterator dstIt(device, writeRect);
            while (dstIt.nextPixel()) {
                memcpy(dstIt.rawData(), pixelColor.data(), pixelSize);
            }
        }
        progressUpdater->setValue(i);
    }
}

References KisDefaultBoundsBase::bounds(), KisPaintDevice::colorSpace(), KoColor::data(), KisPaintDevice::defaultBounds(), KoMixColorsOp::mixColors(), KoColorSpace::mixColorsOp, KisSequentialIteratorBase< IteratorPolicy, SourcePolicy, ProgressPolicy >::nextPixel(), KisSequentialIteratorBase< IteratorPolicy, SourcePolicy, ProgressPolicy >::oldRawData(), KisPaintDevice::pixelSize(), KisSequentialIteratorBase< IteratorPolicy, SourcePolicy, ProgressPolicy >::rawData(), KisLodTransformScalar::scale(), KoUpdater::setRange(), and KoUpdater::setValue().

---

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

• plugins/filters/pixelizefilter/kis_pixelize_filter.h
• plugins/filters/pixelizefilter/kis_pixelize_filter.cpp