KoPatternBackground Class Reference

A pattern shape background. More...

#include <KoPatternBackground.h>

Inheritance diagram for KoPatternBackground:

Classes
class	Private

Public Types
enum	PatternRepeat { Original , Tiled , Stretched }
	Pattern rendering style. More...
enum	ReferencePoint {   TopLeft , Top , TopRight , Left ,   Center , Right , BottomLeft , Bottom ,   BottomRight }
	Pattern reference point. More...

Public Member Functions
bool	compareTo (const KoShapeBackground *other) const override
	KoPatternBackground ()
	KoPatternBackground (const KoPatternBackground &)
KoPatternBackground &	operator= (const KoPatternBackground &)
void	paint (QPainter &painter, const QPainterPath &fillPath) const override
	reimplemented from KoShapeBackground
QImage	pattern () const
	Returns the pattern.
QSizeF	patternDisplaySize () const
	Returns the pattern display size.
QSizeF	patternOriginalSize () const
	Returns the original image size.
QRectF	patternRectFromFillSize (const QSizeF &size)
	Returns the bounding rect of the pattern image based on the given fill size.
ReferencePoint	referencePoint () const
	Returns the pattern reference point identifier.
QPointF	referencePointOffset () const
	Returns reference point offset in percent of the pattern display size.
PatternRepeat	repeat () const
	Returns the pattern repeat.
void	setPattern (const QImage &pattern)
	Sets a new pattern.
void	setPatternDisplaySize (const QSizeF &size)
	Sets pattern display size.
void	setReferencePoint (ReferencePoint referencePoint)
	Sets the pattern reference point.
void	setReferencePointOffset (const QPointF &offset)
	Sets the reference point offset in percent of the pattern display size.
void	setRepeat (PatternRepeat repeat)
	Sets the pattern repeatgfl.
void	setTileRepeatOffset (const QPointF &offset)
	Sets the tile repeat offset in percent of the pattern display size.
void	setTransform (const QTransform &matrix)
	Sets the transform matrix.
QPointF	tileRepeatOffset () const
	Returns tile repeat offset in percent of the pattern display size.
QTransform	transform () const
	Returns the transform matrix.
	~KoPatternBackground () override
Public Member Functions inherited from KoShapeBackground
virtual bool	hasTransparency () const
	Returns if the background has some transparency.
	KoShapeBackground ()
virtual	operator bool () const
virtual	~KoShapeBackground ()

Private Attributes
QSharedDataPointer< Private >	d

Detailed Description

A pattern shape background.

Definition at line 23 of file KoPatternBackground.h.

Member Enumeration Documentation

PatternRepeat

enum KoPatternBackground::PatternRepeat

Pattern rendering style.

Enumerator
Original
Tiled
Stretched

Definition at line 27 of file KoPatternBackground.h.

                       {
        Original,
        Tiled,
        Stretched
    };

ReferencePoint

enum KoPatternBackground::ReferencePoint

Pattern reference point.

Enumerator
TopLeft
Top
TopRight
Left
Center
Right
BottomLeft
Bottom
BottomRight

Definition at line 33 of file KoPatternBackground.h.

                        {
        TopLeft,
        Top,
        TopRight,
        Left,
        Center,
        Right,
        BottomLeft,
        Bottom,
        BottomRight
    };

Constructor & Destructor Documentation

KoPatternBackground() [1/2]

KoPatternBackground::KoPatternBackground ( )

explicit

Definition at line 110 of file KoPatternBackground.cpp.

    : KoShapeBackground()
    , d(new Private)
{
}

~KoPatternBackground()

KoPatternBackground::~KoPatternBackground ( )

override

Definition at line 116 of file KoPatternBackground.cpp.

{
}

KoPatternBackground() [2/2]

KoPatternBackground::KoPatternBackground

(

const KoPatternBackground &

rhs

)

Definition at line 120 of file KoPatternBackground.cpp.

    : d(new Private(*rhs.d))
{
}

Member Function Documentation

compareTo()

bool KoPatternBackground::compareTo ( const KoShapeBackground * other ) const

overridevirtual

Implements KoShapeBackground.

Definition at line 131 of file KoPatternBackground.cpp.

{
    Q_UNUSED(other);
    return false;
}

operator=()

KoPatternBackground & KoPatternBackground::operator=

(

const KoPatternBackground &

rhs

)

Definition at line 125 of file KoPatternBackground.cpp.

{
    d = rhs.d;
    return *this;
}

References d.

paint()

void KoPatternBackground::paint ( QPainter & painter, const QPainterPath & fillPath ) const

overridevirtual

reimplemented from KoShapeBackground

Implements KoShapeBackground.

Definition at line 216 of file KoPatternBackground.cpp.

{
    if (d->pattern.isNull()) {
        return;
    }
 
    painter.save();
    if (d->repeat == Tiled) {
        // calculate scaling of pixmap
        QSizeF targetSize = d->targetSize();
        QSizeF imageSize = d->pattern.size();
        qreal scaleX = targetSize.width() / imageSize.width();
        qreal scaleY = targetSize.height() / imageSize.height();
 
        QRectF targetRect = fillPath.boundingRect();
        // undo scaling on target rectangle
        targetRect.setWidth(targetRect.width() / scaleX);
        targetRect.setHeight(targetRect.height() / scaleY);
 
        // determine pattern offset
        QPointF offset = d->offsetFromRect(targetRect, imageSize);
 
        // create matrix for pixmap scaling
        QTransform matrix;
        matrix.scale(scaleX, scaleY);
 
        painter.setClipPath(fillPath);
        painter.setWorldTransform(matrix, true);
        painter.drawTiledPixmap(targetRect, QPixmap::fromImage(d->pattern), -offset);
    } else if (d->repeat == Original) {
        QRectF sourceRect(QPointF(0, 0), d->pattern.size());
        QRectF targetRect(QPoint(0, 0), d->targetSize());
        targetRect.moveCenter(fillPath.boundingRect().center());
        painter.setClipPath(fillPath);
        painter.drawPixmap(targetRect, QPixmap::fromImage(d->pattern).scaled(sourceRect.size().toSize()), sourceRect);
    } else if (d->repeat == Stretched) {
        painter.setClipPath(fillPath);
        // undo conversion of the scaling so that we can use a nicely scaled image of the correct size
        qWarning() << "WARNING: stretched KoPatternBackground painting code is abandoned. The result might be not correct";
        const QRectF targetRect = fillPath.boundingRect();
        painter.drawPixmap(targetRect.topLeft(), QPixmap::fromImage(d->pattern).scaled(targetRect.size().toSize()));
    }
 
    painter.restore();
}

References d, Original, Stretched, and Tiled.

pattern()

QImage KoPatternBackground::pattern

(

)

const

Returns the pattern.

Definition at line 152 of file KoPatternBackground.cpp.

{
    return d->pattern;
}

References d.

patternDisplaySize()

QSizeF KoPatternBackground::patternDisplaySize

(

)

const

Returns the pattern display size.

Definition at line 200 of file KoPatternBackground.cpp.

{
    return d->targetSize();
}

References d.

patternOriginalSize()

QSizeF KoPatternBackground::patternOriginalSize

(

)

const

Returns the original image size.

Definition at line 211 of file KoPatternBackground.cpp.

{
    return d->pattern.size();
}

References d.

patternRectFromFillSize()

QRectF KoPatternBackground::patternRectFromFillSize

(

const QSizeF &

size

)

Returns the bounding rect of the pattern image based on the given fill size.

Definition at line 263 of file KoPatternBackground.cpp.

{
    QRectF rect;
 
    switch (d->repeat) {
    case Tiled:
        rect.setTopLeft(d->offsetFromRect(QRectF(QPointF(), size), d->targetSize()));
        rect.setSize(d->targetSize());
        break;
    case Original:
        rect.setLeft(0.5 * (size.width() - d->targetSize().width()));
        rect.setTop(0.5 * (size.height() - d->targetSize().height()));
        rect.setSize(d->targetSize());
        break;
    case Stretched:
        rect.setTopLeft(QPointF(0.0, 0.0));
        rect.setSize(size);
        break;
    }
 
    return rect;
}

References d, Original, Stretched, and Tiled.

referencePoint()

KoPatternBackground::ReferencePoint KoPatternBackground::referencePoint

(

)

const

Returns the pattern reference point identifier.

Definition at line 167 of file KoPatternBackground.cpp.

{
    return d->refPoint;
}

References d.

referencePointOffset()

QPointF KoPatternBackground::referencePointOffset

(

)

const

Returns reference point offset in percent of the pattern display size.

Definition at line 177 of file KoPatternBackground.cpp.

{
    return d->refPointOffsetPercent;
}

References d.

repeat()

KoPatternBackground::PatternRepeat KoPatternBackground::repeat

(

)

const

Returns the pattern repeat.

Definition at line 162 of file KoPatternBackground.cpp.

{
    return d->repeat;
}

References d.

setPattern()

void KoPatternBackground::setPattern

(

const QImage &

pattern

)

Sets a new pattern.

Definition at line 147 of file KoPatternBackground.cpp.

{
    d->pattern = pattern;
}

References d, and pattern().

setPatternDisplaySize()

void KoPatternBackground::setPatternDisplaySize

(

const QSizeF &

size

)

Sets pattern display size.

Definition at line 205 of file KoPatternBackground.cpp.

{
    d->targetImageSizePercent = QSizeF();
    d->targetImageSize = size;
}

References d.

setReferencePoint()

void KoPatternBackground::setReferencePoint

(

ReferencePoint

referencePoint

)

Sets the pattern reference point.

Definition at line 172 of file KoPatternBackground.cpp.

{
    d->refPoint = referencePoint;
}

References d, and referencePoint().

setReferencePointOffset()

void KoPatternBackground::setReferencePointOffset

(

const QPointF &

offset

)

Sets the reference point offset in percent of the pattern display size.

Definition at line 182 of file KoPatternBackground.cpp.

{
    qreal ox = qMax(qreal(0.0), qMin(qreal(100.0), offset.x()));
    qreal oy = qMax(qreal(0.0), qMin(qreal(100.0), offset.y()));
 
    d->refPointOffsetPercent = QPointF(ox, oy);
}

References d.

setRepeat()

void KoPatternBackground::setRepeat

(

PatternRepeat

repeat

)

Sets the pattern repeatgfl.

Definition at line 157 of file KoPatternBackground.cpp.

{
    d->repeat = repeat;
}

References d, and repeat().

setTileRepeatOffset()

void KoPatternBackground::setTileRepeatOffset

(

const QPointF &

offset

)

Sets the tile repeat offset in percent of the pattern display size.

Definition at line 195 of file KoPatternBackground.cpp.

{
    d->tileRepeatOffsetPercent = offset;
}

References d.

setTransform()

void KoPatternBackground::setTransform

(

const QTransform &

matrix

)

Sets the transform matrix.

Definition at line 137 of file KoPatternBackground.cpp.

{
    d->matrix = matrix;
}

References d.

tileRepeatOffset()

QPointF KoPatternBackground::tileRepeatOffset

(

)

const

Returns tile repeat offset in percent of the pattern display size.

Definition at line 190 of file KoPatternBackground.cpp.

{
    return d->tileRepeatOffsetPercent;
}

References d.

transform()

QTransform KoPatternBackground::transform

(

)

const

Returns the transform matrix.

Definition at line 142 of file KoPatternBackground.cpp.

{
    return d->matrix;
}

References d.

Member Data Documentation

d

QSharedDataPointer<Private> KoPatternBackground::d

private

Definition at line 107 of file KoPatternBackground.h.

---

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

• libs/flake/KoPatternBackground.h
• libs/flake/KoPatternBackground.cpp