#include <KoFilterEffect.h>

Inheritance diagram for KoFilterEffect:

Public Member Functions
void	addInput (const QString &input)
	Adds a new input at the end of the input list.

QRectF	filterRect () const
	Returns the region this filter is applied to in bounding box units.

QRectF	filterRectForBoundingRect (const QRectF &boundingRect) const
	Returns the region this filter is applied to for the given bounding rect.

QString	id () const
	Returns the unique id of the filter.

QList< QString >	inputs () const

void	insertInput (int index, const QString &input)
	Inserts an input at the given position in the input list.

	KoFilterEffect (const QString &id, const QString &name)

virtual bool	load (const QDomElement &element, const KoFilterEffectLoadingContext &context)=0

int	maximalInputCount () const

QString	name () const
	Returns the user visible name of the filter.

QString	output () const
	Returns the name of the output image.

	Private ()

virtual QImage	processImage (const QImage &image, const KoFilterEffectRenderContext &context) const =0

virtual QImage	processImages (const QList< QImage > &images, const KoFilterEffectRenderContext &context) const

void	removeInput (int index)
	Removes an input from the given position in the input list.

int	requiredInputCount () const

virtual void	save (KoXmlWriter &writer)=0

void	setFilterRect (const QRectF &filterRect)
	Sets the region the filter is applied to in bounding box units.

void	setInput (int index, const QString &input)
	Sets an existing input to a new value.

void	setOutput (const QString &output)

virtual	~KoFilterEffect ()

Public Attributes
QRectF	filterRect

QString	id

QList< QString >	inputs

int	maximalInputCount

QString	name

QString	output

int	requiredInputCount

Protected Member Functions
void	saveCommonAttributes (KoXmlWriter &writer)

void	setMaximalInputCount (int count)
	Sets the maximal number of input images.

void	setRequiredInputCount (int count)
	Sets the required number of input images.

Private Attributes
Private *const	d

Private Attributes inherited from Private
KisCanvas2 *	canvas

int	displayedFrame

int	intendedFrame

Additional Inherited Members
Private Member Functions inherited from Private
	Private (KisCanvas2 *c)

Detailed Description

This is the base for filter effect (blur, invert...) that can be applied on a shape. All sizes and coordinates of the filter effect are stored in object bounding box coordinates, where (0,0) refers to the top-left corner of a shapes bounding rect and (1,1) refers to the bottom-right corner. When loading, a transformation matrix is given to convert from user space coordinates. Another transformation matrix is given via the render context to convert back to user space coordinates when applying the effect. Using object bounding box coordinates internally makes it easy to share effects between shapes or even between users via the filter effect resources.

Definition at line 15 of file KoFilterEffect.cpp.

Constructor & Destructor Documentation

◆ KoFilterEffect()

KoFilterEffect::KoFilterEffect	(	const QString &	id,
		const QString &	name )

Definition at line 35 of file KoFilterEffect.cpp.

    : d(new Private)
{
    d->id = id;
    d->name = name;
}

References d, id, and name.

◆ ~KoFilterEffect()

KoFilterEffect::~KoFilterEffect ( )

virtual

Definition at line 42 of file KoFilterEffect.cpp.

{
    delete d;
}

References d.

Member Function Documentation

◆ addInput()

void KoFilterEffect::addInput ( const QString & input )

Adds a new input at the end of the input list.

Definition at line 81 of file KoFilterEffect.cpp.

{
    if (d->inputs.count() < d->maximalInputCount)
        d->inputs.append(input);
}

References d.

◆ filterRect()

QRectF KoFilterEffect::filterRect ( ) const

Returns the region this filter is applied to in bounding box units.

◆ filterRectForBoundingRect()

QRectF KoFilterEffect::filterRectForBoundingRect ( const QRectF & boundingRect ) const

Returns the region this filter is applied to for the given bounding rect.

Definition at line 67 of file KoFilterEffect.cpp.

{
    qreal x = boundingRect.x() + d->filterRect.x() * boundingRect.width();
    qreal y = boundingRect.y() + d->filterRect.y() * boundingRect.height();
    qreal w = d->filterRect.width() * boundingRect.width();
    qreal h = d->filterRect.height() * boundingRect.height();
    return QRectF(x, y, w, h);
}

References d.

◆ id()

QString KoFilterEffect::id ( ) const

Returns the unique id of the filter.

◆ inputs()

QList< QString > KoFilterEffect::inputs ( ) const

Returns list of named input images of this filter effect.

These names identify the input images for this filter effect. These can be one of the keywords SourceGraphic, SourceAlpha, BackgroundImage, BackgroundAlpha, FillPaint or StrokePaint, as well as a named output of another filter effect in the stack. An empty input list of the first effect in the stack default to SourceGraphic, whereas on subsequent effects it defaults to the result of the previous filter effect.

◆ insertInput()

void KoFilterEffect::insertInput	(	int	index,
		const QString &	input )

Inserts an input at the given position in the input list.

Definition at line 87 of file KoFilterEffect.cpp.

{
    if (d->inputs.count() < d->maximalInputCount)
        d->inputs.insert(index, input);
}

References d.

◆ load()

virtual bool KoFilterEffect::load	(	const QDomElement &	element,
		const KoFilterEffectLoadingContext &	context )

pure virtual

Loads data from given xml element.

Parameters

element	the xml element to load data from
context	the loading context providing additional data

Returns: true if loading was successful, else false

◆ maximalInputCount()

int KoFilterEffect::maximalInputCount ( ) const

Returns the maximal number of input images. The default maximal number of input images is 1. Derived classes should call setMaximalInputCount to set a different number.

◆ name()

QString KoFilterEffect::name ( ) const

Returns the user visible name of the filter.

◆ output()

QString KoFilterEffect::output ( ) const

Returns the name of the output image.

◆ Private()

KoFilterEffect::Private ( )

inline

Definition at line 18 of file KoFilterEffect.cpp.

        : filterRect(0, 0, 1, 1)
        , requiredInputCount(1), maximalInputCount(1)
    {
        // add the default input
        inputs.append(QString());
    }

◆ processImage()

virtual QImage KoFilterEffect::processImage	(	const QImage &	image,
		const KoFilterEffectRenderContext &	context ) const

pure virtual

Apply the effect on an image.

Parameters

image	the image the filter should be applied to
context	the render context providing additional data

◆ processImages()

QImage KoFilterEffect::processImages	(	const QList< QImage > &	images,
		const KoFilterEffectRenderContext &	context ) const

virtual

Apply the effect on a list of images.

Parameters

images	the images the filter should be applied to
context	the render context providing additional data

Definition at line 125 of file KoFilterEffect.cpp.

{
    Q_ASSERT(images.count());
    return images.first();
}

◆ removeInput()

void KoFilterEffect::removeInput ( int index )

Removes an input from the given position in the input list.

Definition at line 99 of file KoFilterEffect.cpp.

{
    if (d->inputs.count() > d->requiredInputCount)
        d->inputs.removeAt(index);
}

References d.

◆ requiredInputCount()

int KoFilterEffect::requiredInputCount ( ) const

Return the required number of input images. The default required number of input images is 1. Derived classes should call setRequiredInputCount to set a different number.

◆ save()

virtual void KoFilterEffect::save ( KoXmlWriter & writer )

pure virtual

Writes custom data to given xml element.

Parameters

writer the xml writer to write data to

◆ saveCommonAttributes()

void KoFilterEffect::saveCommonAttributes ( KoXmlWriter & writer )

protected

Saves common filter attributes

Saves result, subregion and input attributes. The input attribute is only saved if required, maximal and actual input count equals 1. All other filters have to write inputs on their own.

Definition at line 148 of file KoFilterEffect.cpp.

{
    writer.addAttribute("result", output());
    if (requiredInputCount() == 1 && maximalInputCount() == 1 && d->inputs.count() == 1) {
        writer.addAttribute("in", d->inputs[0]);
    }
    writer.addAttribute("x", d->filterRect.x());
    writer.addAttribute("y", d->filterRect.y());
    writer.addAttribute("width", d->filterRect.width());
    writer.addAttribute("height", d->filterRect.height());
}

References KoXmlWriter::addAttribute(), d, maximalInputCount, output, and requiredInputCount.

◆ setFilterRect()

void KoFilterEffect::setFilterRect ( const QRectF & filterRect )

Sets the region the filter is applied to in bounding box units.

Definition at line 57 of file KoFilterEffect.cpp.

{
    d->filterRect = filterRect;
}

References d, and filterRect.

◆ setInput()

void KoFilterEffect::setInput	(	int	index,
		const QString &	input )

Sets an existing input to a new value.

Definition at line 93 of file KoFilterEffect.cpp.

{
    if (index < d->inputs.count())
        d->inputs[index] = input;
}

References d, and inputs.

◆ setMaximalInputCount()

void KoFilterEffect::setMaximalInputCount ( int count )

protected

Sets the maximal number of input images.

Definition at line 138 of file KoFilterEffect.cpp.

{
    d->maximalInputCount = qMax(0,count);
    if (d->inputs.count() > maximalInputCount()) {
        int removeCount = d->inputs.count()-maximalInputCount();
        for (int i = 0; i < removeCount; ++i)
            d->inputs.pop_back();
    }
}

References d, and maximalInputCount.

◆ setOutput()

void KoFilterEffect::setOutput ( const QString & output )

Sets the name of the output image

The name is used so that other effects can reference the output of this effect as one of their input images.

Parameters

output the output image name

Definition at line 105 of file KoFilterEffect.cpp.

{
    d->output = output;
}

References d, and output.

◆ setRequiredInputCount()

void KoFilterEffect::setRequiredInputCount ( int count )

protected

Sets the required number of input images.

Definition at line 131 of file KoFilterEffect.cpp.

{
    d->requiredInputCount = qMax(0, count);
    for (int i = d->inputs.count(); i < d->requiredInputCount; ++i)
        d->inputs.append(QString());
}

References d.

Member Data Documentation

◆ d

Private* const KoFilterEffect::d

private

Definition at line 155 of file KoFilterEffect.h.

◆ filterRect

QRectF KoFilterEffect::filterRect

Definition at line 28 of file KoFilterEffect.cpp.

◆ id

QString KoFilterEffect::id

Definition at line 26 of file KoFilterEffect.cpp.

◆ inputs

QList< QString > KoFilterEffect::inputs

Definition at line 29 of file KoFilterEffect.cpp.

◆ maximalInputCount

int KoFilterEffect::maximalInputCount

Definition at line 32 of file KoFilterEffect.cpp.

◆ name

QString KoFilterEffect::name

Definition at line 27 of file KoFilterEffect.cpp.

◆ output

QString KoFilterEffect::output

Definition at line 30 of file KoFilterEffect.cpp.

◆ requiredInputCount

int KoFilterEffect::requiredInputCount

Definition at line 31 of file KoFilterEffect.cpp.

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

libs/flake/KoFilterEffect.cpp
libs/flake/KoFilterEffect.h

Public Member Functions

Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KoFilterEffect()

◆ ~KoFilterEffect()

Member Function Documentation

◆ addInput()

◆ filterRect()

◆ filterRectForBoundingRect()

◆ id()

◆ inputs()

◆ insertInput()

◆ load()

◆ maximalInputCount()

◆ name()

◆ output()

◆ Private()

◆ processImage()

◆ processImages()

◆ removeInput()

◆ requiredInputCount()

◆ save()

◆ saveCommonAttributes()

◆ setFilterRect()

◆ setInput()

◆ setMaximalInputCount()

◆ setOutput()

◆ setRequiredInputCount()

Member Data Documentation

◆ d

◆ filterRect

◆ id

◆ inputs

◆ maximalInputCount

◆ name

◆ output

◆ requiredInputCount