KoShapePainter Class Reference

#include <KoShapePainter.h>

Inheritance diagram for KoShapePainter:

Public Member Functions
QRectF	contentRect () const
	Returns the bounding rect of the shapes to paint.
KoShapeManager *	internalShapeManager () const
	internalShapeManager KoShapePainter has an internal shape manager that is used to paint the shapes.
	KoShapePainter ()
void	paint (QImage &image)
void	paint (QPainter &painter)
void	paint (QPainter &painter, const QRect &painterRect, const QRectF &documentRect)
	Private ()
void	setShapes (const QList< KoShape * > &shapes)
void	setUpdateFunction (std::function< void(const QRectF &)> function)
	~KoShapePainter ()
	~Private ()

Public Attributes
SimpleCanvas *	canvas

Private Attributes
QScopedPointer< Private >	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

A utility class to paint a subset of shapes onto a QPainter. Notice that using setShapes repeatedly is very expensive, as it populates the shapeManager and all its caching every time. If at all possible use a shapeManager directly and avoid losing the cache between usages.

Definition at line 110 of file KoShapePainter.cpp.

Constructor & Destructor Documentation

~Private()

KoShapePainter::~Private ( )

inline

Definition at line 118 of file KoShapePainter.cpp.

{ delete canvas; }

KoShapePainter()

KoShapePainter::KoShapePainter ( )

explicit

Definition at line 122 of file KoShapePainter.cpp.

    : d(new Private())
{
}

~KoShapePainter()

KoShapePainter::~KoShapePainter

(

)

Definition at line 127 of file KoShapePainter.cpp.

{
}

Member Function Documentation

contentRect()

QRectF KoShapePainter::contentRect

(

)

const

Returns the bounding rect of the shapes to paint.

Definition at line 195 of file KoShapePainter.cpp.

{
    QRectF bound;
    foreach (KoShape *shape, d->canvas->shapeManager()->shapes()) {
        if (!shape->isVisible())
            continue;
        if (dynamic_cast<KoShapeGroup*>(shape))
            continue;
 
        QRectF shapeRect = shape->boundingRect();
 
        if (bound.isEmpty())
            bound = shapeRect;
        else
            bound = bound.united(shapeRect);
    }
    return bound;
}

References KoShape::boundingRect(), d, and KoShape::isVisible().

internalShapeManager()

KoShapeManager * KoShapePainter::internalShapeManager

(

)

const

internalShapeManager KoShapePainter has an internal shape manager that is used to paint the shapes.

Returns

the internal shape manager.

Definition at line 214 of file KoShapePainter.cpp.

{
    return d->canvas->shapeManager();
}

References KoShapeManager::canvas, d, and KoCanvasBase::shapeManager().

paint() [1/3]

void KoShapePainter::paint

(

QImage &

image

)

Paints shapes to the given image, so that all shapes fit onto it.

Parameters

image

the image to paint into

Returns

false if image is empty, else true

Definition at line 185 of file KoShapePainter.cpp.

{
    if (image.isNull())
        return;
 
    QPainter painter(&image);
 
    paint(painter, image.rect(), contentRect());
}

References contentRect(), and paint().

paint() [2/3]

void KoShapePainter::paint

(

QPainter &

painter

)

Paints the shapes on the given painter and using the zoom handler.

Parameters

painter	the painter to paint on
converter	the view converter defining the zoom to use

Definition at line 136 of file KoShapePainter.cpp.

{
    foreach (KoShape *shape, d->canvas->shapeManager()->shapes()) {
        shape->waitUntilReady(false);
    }
 
    d->canvas->shapeManager()->paint(painter);
}

References d, and KoShape::waitUntilReady().

paint() [3/3]

void KoShapePainter::paint	(	QPainter &	painter,
		const QRect &	painterRect,
		const QRectF &	documentRect )

Paints the shapes on the given painter. The given document rectangle is painted to fit into the given painter rectangle.

Parameters

painter	the painter to paint on
painterRect	the destination rectangle on the painter
documentRect	the document region to paint

Definition at line 145 of file KoShapePainter.cpp.

{
    if (documentRect.width() == 0.0f || documentRect.height() == 0.0f)
        return;
 
    KoViewConverter converter;
    // calculate the painter destination rectangle size in document coordinates
    QRectF paintBox = converter.viewToDocument(QRectF(QPointF(), painterRect.size()));
 
    // compute the zoom factor based on the bounding rects in document coordinates
    // so that the content fits into the image
    qreal zoomW = paintBox.width() / documentRect.width();
    qreal zoomH = paintBox.height() / documentRect.height();
    qreal zoom = qMin(zoomW, zoomH);
 
    // now set the zoom into the zoom handler used for painting the shape
    converter.setZoom(zoom);
 
    painter.save();
 
    // initialize painter
    painter.setPen(QPen(Qt::NoPen));
    painter.setBrush(Qt::NoBrush);
    painter.setRenderHint(QPainter::Antialiasing);
    painter.setClipRect(painterRect.adjusted(-1,-1,1,1));
 
    // convert document rectangle to view coordinates
    QRectF zoomedBound = converter.documentToView(documentRect);
    // calculate offset between painter rectangle and converted document rectangle
    QPointF offset = QRectF(painterRect).center() - zoomedBound.center();
    // center content in painter rectangle
    painter.translate(offset.x(), offset.y());
    painter.setTransform(converter.documentToView(), true);
 
    // finally paint the shapes
    paint(painter);
 
    painter.restore();
}

References KoViewConverter::documentToView(), paint(), KoViewConverter::setZoom(), and KoViewConverter::viewToDocument().

Private()

KoShapePainter::Private ( )

inline

Definition at line 113 of file KoShapePainter.cpp.

        : canvas(new SimpleCanvas())
    {
    }

setShapes()

void KoShapePainter::setShapes

(

const QList< KoShape * > &

shapes

)

Sets the shapes to be painted.

Parameters

shapes

the shapes to paint

Definition at line 131 of file KoShapePainter.cpp.

{
    d->canvas->shapeManager()->setShapes(shapes, KoShapeManager::AddWithoutRepaint);
}

References KoShapeManager::AddWithoutRepaint, and d.

setUpdateFunction()

void KoShapePainter::setUpdateFunction

(

std::function< void(const QRectF &)>

function

)

Definition at line 219 of file KoShapePainter.cpp.

{
    d->canvas->setUpdateFunction(function);
}

References KoShapeManager::canvas, and d.

Member Data Documentation

canvas

SimpleCanvas* KoShapePainter::canvas

Definition at line 119 of file KoShapePainter.cpp.

d

QScopedPointer<Private> KoShapePainter::d

private

Definition at line 77 of file KoShapePainter.h.

---

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

• libs/flake/svg/KoShapePainter.cpp
• libs/flake/svg/KoShapePainter.h