KoFilterEffectStack Class Reference

This class manages a stack of filter effects. More...

#include <KoFilterEffectStack.h>

Inheritance diagram for KoFilterEffectStack:

Public Member Functions
void	appendFilterEffect (KoFilterEffect *filter)
QRectF	clipRect () const
	Returns the clipping rectangle used for this filter in bounding box units.
QRectF	clipRectForBoundingRect (const QRectF &boundingRect) const
	Returns the clipping rectangle for the given bounding rect.
bool	deref ()
QList< KoFilterEffect * >	filterEffects () const
void	insertFilterEffect (int index, KoFilterEffect *filter)
bool	isEmpty () const
	KoFilterEffectStack ()
	Creates an empty filter effect stack.
	Private ()
bool	ref ()
void	removeFilterEffect (int index)
QSet< QString >	requiredStandardsInputs () const
	Returns list of required standard inputs.
void	save (KoXmlWriter &writer, const QString &filterId)
void	setClipRect (const QRectF &clipRect)
	Sets the clipping rectangle used for this filter in bounding box units.
KoFilterEffect *	takeFilterEffect (int index)
int	useCount () const
	Return reference counter.
	~KoFilterEffectStack ()
	Destroys the filter effect stack, deleting all filter effects.
	~Private ()

Public Attributes
QRectF	clipRect
QList< KoFilterEffect * >	filterEffects
QAtomicInt	refCount

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 class manages a stack of filter effects.

Definition at line 16 of file KoFilterEffectStack.cpp.

Constructor & Destructor Documentation

~Private()

KoFilterEffectStack::~Private ( )

inline

Definition at line 24 of file KoFilterEffectStack.cpp.

    {
        qDeleteAll(filterEffects);
    }

KoFilterEffectStack()

KoFilterEffectStack::KoFilterEffectStack

(

)

Creates an empty filter effect stack.

Definition at line 34 of file KoFilterEffectStack.cpp.

: d(new Private())
{
}

~KoFilterEffectStack()

KoFilterEffectStack::~KoFilterEffectStack

(

)

Destroys the filter effect stack, deleting all filter effects.

Definition at line 39 of file KoFilterEffectStack.cpp.

{
    delete d;
}

References d.

Member Function Documentation

appendFilterEffect()

void KoFilterEffectStack::appendFilterEffect

(

KoFilterEffect *

filter

)

Appends a new filter at the end of the filter list.

The filter stack take ownership of the appended filter effect.

Parameters

filter

the new filter to append

Definition at line 60 of file KoFilterEffectStack.cpp.

{
    if (filter)
        d->filterEffects.append(filter);
}

References d.

clipRect()

QRectF KoFilterEffectStack::clipRect

(

)

const

Returns the clipping rectangle used for this filter in bounding box units.

clipRectForBoundingRect()

QRectF KoFilterEffectStack::clipRectForBoundingRect

(

const QRectF &

boundingRect

)

const

Returns the clipping rectangle for the given bounding rect.

Definition at line 89 of file KoFilterEffectStack.cpp.

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

References d.

deref()

bool KoFilterEffectStack::deref

(

)

Decrements the use-value. Returns true if the new value is non-zero, false otherwise.

Definition at line 103 of file KoFilterEffectStack.cpp.

{
    return d->refCount.deref();
}

References d.

filterEffects()

QList< KoFilterEffect * > KoFilterEffectStack::filterEffects

(

)

const

The first filter of the list is the first to be applied.

Returns

the list of filter effects applied on the shape when rendering.

insertFilterEffect()

void KoFilterEffectStack::insertFilterEffect	(	int	index,
		KoFilterEffect *	filter )

Inserts a new filter at the given position in the filter list.

The filter stack take ownership of the inserted filter effect.

Parameters

index	the list index to insert the new filter at
filter	the new filter to insert

Definition at line 54 of file KoFilterEffectStack.cpp.

{
    if (filter)
        d->filterEffects.insert(index, filter);
}

References d.

isEmpty()

bool KoFilterEffectStack::isEmpty

(

)

const

Returns if the filter effect stack is empty.

Returns

false if the stack contains filter effects, otherwise true

Definition at line 49 of file KoFilterEffectStack.cpp.

{
    return d->filterEffects.isEmpty();
}

References d.

Private()

KoFilterEffectStack::Private ( )

inline

Definition at line 19 of file KoFilterEffectStack.cpp.

    : clipRect(-0.1, -0.1, 1.2, 1.2) // initialize as per svg spec
    {
    }

ref()

bool KoFilterEffectStack::ref

(

)

Increments the use-value. Returns true if the new value is non-zero, false otherwise.

Definition at line 98 of file KoFilterEffectStack.cpp.

{
    return d->refCount.ref();
}

References d.

removeFilterEffect()

void KoFilterEffectStack::removeFilterEffect

(

int

index

)

Removes the filter with the given index from the filter list.

The filter gets deleted after removal from the list.

Parameters

index

the index of the filter to remove

Definition at line 66 of file KoFilterEffectStack.cpp.

{
    KoFilterEffect * filter = takeFilterEffect(index);
    delete filter;
}

References takeFilterEffect().

requiredStandardsInputs()

QSet< QString > KoFilterEffectStack::requiredStandardsInputs

(

)

const

Returns list of required standard inputs.

Definition at line 131 of file KoFilterEffectStack.cpp.

{
    static QSet<QString> stdInputs = QSet<QString>()
        << "SourceGraphic"
        << "SourceAlpha"
        << "BackgroundImage"
        << "BackgroundAlpha"
        << "FillPaint"
        << "StrokePaint";
 
    QSet<QString> requiredInputs;
    if (isEmpty())
        return requiredInputs;
 
    if (d->filterEffects.first()->inputs().contains(QString()))
        requiredInputs.insert("SourceGraphic");
 
    Q_FOREACH (KoFilterEffect *effect, d->filterEffects) {
        Q_FOREACH (const QString &input, effect->inputs()) {
            if (stdInputs.contains(input))
                requiredInputs.insert(input);
        }
    }
 
    return requiredInputs;
}

References d, KoFilterEffect::inputs, and isEmpty().

save()

void KoFilterEffectStack::save	(	KoXmlWriter &	writer,
		const QString &	filterId )

Saves filter stack using given xml writer.

Parameters

writer	the xml writer to write data to
id	the filter id to write, used for referencing the filter

Definition at line 113 of file KoFilterEffectStack.cpp.

{
    writer.startElement("filter");
    writer.addAttribute("id", filterId);
    writer.addAttribute("filterUnits", "objectBoundingBox");
    writer.addAttribute("primitiveUnits", "objectBoundingBox");
    writer.addAttribute("x", d->clipRect.x());
    writer.addAttribute("y", d->clipRect.y());
    writer.addAttribute("width", d->clipRect.width());
    writer.addAttribute("height", d->clipRect.height());
 
    Q_FOREACH (KoFilterEffect *effect, d->filterEffects) {
        effect->save(writer);
    }
 
    writer.endElement();
}

References KoXmlWriter::addAttribute(), d, KoXmlWriter::endElement(), KoFilterEffect::save(), and KoXmlWriter::startElement().

setClipRect()

void KoFilterEffectStack::setClipRect

(

const QRectF &

clipRect

)

Sets the clipping rectangle used for this filter in bounding box units.

Definition at line 79 of file KoFilterEffectStack.cpp.

{
    d->clipRect = clipRect;
}

References clipRect, and d.

takeFilterEffect()

KoFilterEffect * KoFilterEffectStack::takeFilterEffect

(

int

index

)

Take filter effect with given index from the stack and returns it.

Parameters

index

the index of the filter to take

Returns

the filter effect, of 0 if no filter effect with the given index exists

Definition at line 72 of file KoFilterEffectStack.cpp.

{
    if (index >= d->filterEffects.size())
        return 0;
    return d->filterEffects.takeAt(index);
}

References d.

useCount()

int KoFilterEffectStack::useCount

(

)

const

Return reference counter.

Definition at line 108 of file KoFilterEffectStack.cpp.

{
    return d->refCount;
}

References d.

Member Data Documentation

clipRect

QRectF KoFilterEffectStack::clipRect

Definition at line 30 of file KoFilterEffectStack.cpp.

d

Private* const KoFilterEffectStack::d

private

Definition at line 112 of file KoFilterEffectStack.h.

filterEffects

QList< KoFilterEffect * > KoFilterEffectStack::filterEffects

Definition at line 29 of file KoFilterEffectStack.cpp.

refCount

QAtomicInt KoFilterEffectStack::refCount

Definition at line 31 of file KoFilterEffectStack.cpp.

---

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

• libs/flake/KoFilterEffectStack.cpp
• libs/flake/KoFilterEffectStack.h