File: ConvolveMatrixEffect.h

package info (click to toggle)
calligra 1%3A3.2.1%2Bdfsg-6
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 261,632 kB
  • sloc: cpp: 650,836; xml: 27,662; python: 6,044; perl: 2,724; yacc: 1,817; ansic: 1,325; sh: 1,277; lex: 1,107; ruby: 1,010; javascript: 495; makefile: 17
file content (106 lines) | stat: -rw-r--r-- 3,386 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
/* This file is part of the KDE project
 * Copyright (c) 2010 Jan Hambrecht <jaham@gmx.net>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; see the file COPYING.LIB.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 */

#ifndef CONVOLVEMATRIXEFFECT_H
#define CONVOLVEMATRIXEFFECT_H

#include "KoFilterEffect.h"
#include <QPointF>
#include <QVector>

#define ConvolveMatrixEffectId "feConvolveMatrix"

class KoFilterEffectLoadingContext;

/// A convolve matrix effect
class ConvolveMatrixEffect : public KoFilterEffect
{
public:
    /// Edge mode, i.e. how the kernel behaves at image edges
    enum EdgeMode {
        Duplicate, ///< duplicates colors at the edges
        Wrap,      ///< takes the colors at the opposite edge
        None       ///< uses values of zero for each color channel
    };

    ConvolveMatrixEffect();

    /// Returns the order of the kernel matrix
    QPoint order() const;

    /// Sets the order of the kernel matrix
    void setOrder(const QPoint &order);

    /// Returns the kernel matrix
    QVector<qreal> kernel() const;

    /// Sets the kernel matrix
    void setKernel(const QVector<qreal> &kernel);

    /// Returns the divisor
    qreal divisor() const;

    /// Sets the divisor
    void setDivisor(qreal divisor);

    /// Returns the bias
    qreal bias() const;

    /// Sets the bias
    void setBias(qreal bias);

    /// Returns the target cell within the kernel
    QPoint target() const;

    /// Sets the target cell within the kernel
    void setTarget(const QPoint &target);

    /// Returns edge mode
    EdgeMode edgeMode() const;

    /// Sets the edge mode
    void setEdgeMode(EdgeMode edgeMode);

    /// Returns if alpha values are preserved
    bool isPreserveAlphaEnabled() const;

    /// Enables/disables preserving alpha values
    void enablePreserveAlpha(bool on);

    /// reimplemented from KoFilterEffect
    QImage processImage(const QImage &image, const KoFilterEffectRenderContext &context) const override;
    /// reimplemented from KoFilterEffect
    bool load(const KoXmlElement &element, const KoFilterEffectLoadingContext &context) override;
    /// reimplemented from KoFilterEffect
    void save(KoXmlWriter &writer) override;

private:
    void setDefaults();

    QPoint m_order;          ///< the dimension of the kernel
    QVector<qreal> m_kernel; ///< the kernel
    qreal m_divisor;         ///< the divisor
    qreal m_bias;            ///< the bias
    QPoint m_target;         ///< target cell within the kernel
    EdgeMode m_edgeMode;     ///< the edge mode
    QPointF m_kernelUnitLength; ///< the kernel unit length
    bool m_preserveAlpha;    ///< indicates if original alpha values are left intact
};

#endif // CONVOLVEMATRIXEFFECT_H