KoFilterEffect.h

Go to the documentation of this file.

/* This file is part of the KDE project
 * SPDX-FileCopyrightText: 2009 Cyrille Berger <cberger@cberger.net>
 * SPDX-FileCopyrightText: 2009 Jan Hambrecht <jaham@gmx.net>
 *
 * SPDX-License-Identifier: LGPL-2.1-or-later
 */
 
#ifndef _KO_FILTER_EFFECT_H_
#define _KO_FILTER_EFFECT_H_
 
class QImage;
class QString;
class QRectF;
class KoXmlWriter;
class KoFilterEffectRenderContext;
class KoFilterEffectLoadingContext;
 
#include <QDomDocument>
 
#include "kritaflake_export.h"
#include <QList>
 
class KRITAFLAKE_EXPORT KoFilterEffect
{
public:
    KoFilterEffect(const QString &id, const QString &name);
    virtual ~KoFilterEffect();
 
    QString name() const;
 
    QString id() const;
 
    void setFilterRect(const QRectF &filterRect);
 
    QRectF filterRect() const;
 
    QRectF filterRectForBoundingRect(const QRectF &boundingRect) const;
 
    void setOutput(const QString &output);
 
    QString output() const;
 
    QList<QString> inputs() const;
 
    void addInput(const QString &input);
 
    void insertInput(int index, const QString &input);
 
    void setInput(int index, const QString &input);
 
    void removeInput(int index);
 
    int requiredInputCount() const;
 
    int maximalInputCount() const;
 
    virtual QImage processImage(const QImage &image, const KoFilterEffectRenderContext &context) const = 0;
 
    virtual QImage processImages(const QList<QImage> &images, const KoFilterEffectRenderContext &context) const;
 
    virtual bool load(const QDomElement &element, const KoFilterEffectLoadingContext &context) = 0;
 
    virtual void save(KoXmlWriter &writer) = 0;
 
protected:
    void setRequiredInputCount(int count);
 
    void setMaximalInputCount(int count);
 
    void saveCommonAttributes(KoXmlWriter &writer);
 
private:
    class Private;
    Private* const d;
};
 
#endif // _KO_FILTER_EFFECT_H_