Filter Class Reference

#include <Filter.h>

Inheritance diagram for Filter:

Classes
struct	Private

Public Slots
bool	apply (Node *node, int x, int y, int w, int h)
	Apply the filter to the given node.
InfoObject *	configuration () const
QString	name () const
	name the internal name of this filter.
void	setConfiguration (InfoObject *value)
	setConfiguration set the configuration object for the filter
void	setName (const QString &name)
	setName set the filter's name to the given name.
bool	startFilter (Node *node, int x, int y, int w, int h)
	startFilter starts the given filter on the given node.

Public Member Functions
	Filter ()
	Filter: create an empty filter object. Until a name is set, the filter cannot be applied.
bool	operator!= (const Filter &other) const
bool	operator== (const Filter &other) const
	~Filter () override

Private Member Functions
KisFilterConfigurationSP	filterConfig ()

Private Attributes
Private *const	d

Friends
class	FilterLayer
class	FilterMask

Detailed Description

Filter: represents a filter and its configuration. A filter is identified by an internal name. The configuration for each filter is defined as an InfoObject: a map of name and value pairs.

Currently available filters are:

'autocontrast', 'blur', 'bottom edge detections', 'brightnesscontrast', 'burn', 'colorbalance', 'colortoalpha', 'colortransfer', 'desaturate', 'dodge', 'emboss', 'emboss all directions', 'emboss horizontal and vertical', 'emboss horizontal only', 'emboss laplascian', 'emboss vertical only', 'gaussian blur', 'gaussiannoisereducer', 'gradientmap', 'halftone', 'hsvadjustment', 'indexcolors', 'invert', 'left edge detections', 'lens blur', 'levels', 'maximize', 'mean removal', 'minimize', 'motion blur', 'noise', 'normalize', 'oilpaint', 'perchannel', 'phongbumpmap', 'pixelize', 'posterize', 'raindrops', 'randompick', 'right edge detections', 'roundcorners', 'sharpen', 'smalltiles', 'sobel', 'threshold', 'top edge detections', 'unsharp', 'wave', 'waveletnoisereducer']

Definition at line 30 of file Filter.h.

Constructor & Destructor Documentation

Filter()

Filter::Filter ( )

explicit

Filter: create an empty filter object. Until a name is set, the filter cannot be applied.

Definition at line 37 of file Filter.cpp.

    : QObject(0)
    , d(new Private)
{
}

~Filter()

Filter::~Filter ( )

override

Definition at line 43 of file Filter.cpp.

{
    delete d->configuration;
    delete d;
}

References Filter::Private::configuration, and d.

Member Function Documentation

apply

bool Filter::apply ( Node * node, int x, int y, int w, int h )

slot

Apply the filter to the given node.

Parameters

node	the node to apply the filter to
x
y
w
h	describe the rectangle the filter should be apply. This is always in image pixel coordinates and not relative to the x, y of the node.

Returns

true if the filter was applied successfully, or false if the filter could not be applied because the node is locked or does not have an editable paint device.

Definition at line 85 of file Filter.cpp.

{
    if (node->locked()) return false;
 
    KisFilterSP filter = KisFilterRegistry::instance()->value(d->name);
    if (!filter) return false;
 
    KisPaintDeviceSP dev = node->paintDevice();
    if (!dev) return false;
 
    QRect applyRect = QRect(x, y, w, h);
    KisFilterConfigurationSP config = static_cast<KisFilterConfiguration*>(d->configuration->configuration().data());
    filter->process(dev, applyRect, config->cloneWithResourcesSnapshot());
    return true;
}

References Filter::Private::configuration, InfoObject::configuration(), d, KisSharedPtr< T >::data(), KisFilterRegistry::instance(), Node::locked(), Filter::Private::name, Node::paintDevice(), KisFilter::process(), and KoGenericRegistry< T >::value().

configuration

InfoObject * Filter::configuration ( ) const

slot

Returns

the configuration object for the filter

Definition at line 75 of file Filter.cpp.

{
    return d->configuration;
}

References Filter::Private::configuration, and d.

filterConfig()

KisFilterConfigurationSP Filter::filterConfig ( )

private

Definition at line 152 of file Filter.cpp.

{
    KisFilterConfigurationSP config = KisFilterRegistry::instance()->get(d->name)->factoryConfiguration(KisGlobalResourcesInterface::instance());
    Q_FOREACH(const QString property, d->configuration->properties().keys()) {
        config->setProperty(property, d->configuration->property(property));
    }
    return config;
}

References Filter::Private::configuration, d, KisBaseProcessor::factoryConfiguration(), KoGenericRegistry< T >::get(), KisFilterRegistry::instance(), KisGlobalResourcesInterface::instance(), Filter::Private::name, InfoObject::properties(), and InfoObject::property().

name

QString Filter::name ( ) const

slot

name the internal name of this filter.

Returns

the name.

Definition at line 61 of file Filter.cpp.

{
    return d->name;
}

References d, and Filter::Private::name.

operator!=()

bool Filter::operator!=

(

const Filter &

other

)

const

Definition at line 55 of file Filter.cpp.

{
    return !(operator==(other));
}

References operator==().

operator==()

bool Filter::operator==

(

const Filter &

other

)

const

Definition at line 49 of file Filter.cpp.

{
    return (d->name == other.d->name
            && d->configuration == other.d->configuration);
}

References Filter::Private::configuration, d, and Filter::Private::name.

setConfiguration

void Filter::setConfiguration ( InfoObject * value )

slot

setConfiguration set the configuration object for the filter

Definition at line 80 of file Filter.cpp.

{
    d->configuration = value;
}

References Filter::Private::configuration, d, and value().

setName

void Filter::setName ( const QString & name )

slot

setName set the filter's name to the given name.

Definition at line 66 of file Filter.cpp.

{
    d->name = name;
    delete d->configuration;
 
    KisFilterSP filter = KisFilterRegistry::instance()->value(d->name);
    d->configuration = new InfoObject(filter->defaultConfiguration(KisGlobalResourcesInterface::instance()));
}

References Filter::Private::configuration, d, KisBaseProcessor::defaultConfiguration(), KisFilterRegistry::instance(), KisGlobalResourcesInterface::instance(), Filter::Private::name, name(), and KoGenericRegistry< T >::value().

startFilter

bool Filter::startFilter ( Node * node, int x, int y, int w, int h )

slot

startFilter starts the given filter on the given node.

Parameters

node	the node to apply the filter to
x
y
w
h	describe the rectangle the filter should be apply. This is always in image pixel coordinates and not relative to the x, y of the node.

Definition at line 101 of file Filter.cpp.

{
    if (node->locked()) return false;
 
    KisFilterSP filter = KisFilterRegistry::instance()->value(d->name);
    if (!filter) return false;
 
    KisImageWSP image = node->image();
    if (!image) return false;
 
    KisFilterConfigurationSP filterConfig = static_cast<KisFilterConfiguration*>(d->configuration->configuration().data());
 
    image->waitForDone();
    QRect initialApplyRect = QRect(x, y, w, h);
 
    QRect applyRect = initialApplyRect;
 
    KisPaintDeviceSP paintDevice = node->paintDevice();
    if (paintDevice && filter->needsTransparentPixels(filterConfig.data(), paintDevice->colorSpace())) {
        applyRect |= image->bounds();
    }
 
    KisResourcesSnapshotSP resources = new KisResourcesSnapshot(image, node->node());
 
    Document *document = Krita::instance()->activeDocument();
    if (document && KisPart::instance()->viewCount(document->document()) > 0) {
        Q_FOREACH (QPointer<KisView> view, KisPart::instance()->views()) {
            if (view && view->document() == document->document()) {
                resources = new KisResourcesSnapshot(image, node->node(), view->resourceProvider()->resourceManager());
                break;
            }
        }
    }
    delete document;
 
    KisStrokeId currentStrokeId = image->startStroke(new KisFilterStrokeStrategy(filter,
                                                                                 KisFilterConfigurationSP(filterConfig),
                                                                                 resources));
 
    QRect processRect = filter->changedRect(applyRect, filterConfig.data(), 0);
    processRect &= image->bounds();
 
    image->addJob(currentStrokeId, new KisFilterStrokeStrategy::FilterJobData());
 
 
    image->endStroke(currentStrokeId);
    image->waitForDone();
 
    return true;
}

References Krita::activeDocument(), KisImage::addJob(), KisImage::bounds(), KisFilter::changedRect(), KisPaintDevice::colorSpace(), Filter::Private::configuration, InfoObject::configuration(), d, KisSharedPtr< T >::data(), KisImage::endStroke(), filterConfig(), Node::image(), KisFilterRegistry::instance(), Krita::instance(), KisPart::instance(), Node::locked(), Filter::Private::name, KisFilter::needsTransparentPixels(), Node::node(), Node::paintDevice(), KisImage::startStroke(), KoGenericRegistry< T >::value(), and KisImage::waitForDone().

Friends And Related Symbol Documentation

FilterLayer

friend class FilterLayer

friend

Definition at line 98 of file Filter.h.

FilterMask

friend class FilterMask

friend

Definition at line 99 of file Filter.h.

Member Data Documentation

d

Private* const Filter::d

private

Definition at line 102 of file Filter.h.

---

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

• libs/libkis/Filter.h
• libs/libkis/Filter.cpp
• libs/metadata/kis_meta_data_filter.cc