Differential D11629 Diff 30670 lib/documentview/svgviewadapter.cpp

Changeset View

Standalone View

View Options

lib/documentview/svgviewadapter.cpp

Show All 20 Lines
21// Self 21​// Self
22#include "svgviewadapter.h" 22​#include "svgviewadapter.h"
23 23​
24// Qt 24​// Qt
25#include <QCursor> 25​#include <QCursor>
26#include <QGraphicsSvgItem> 26​#include <QGraphicsSvgItem>
27#include <QGraphicsTextItem> 27​#include <QGraphicsTextItem>
28#include <QGraphicsWidget> 28​#include <QGraphicsWidget>
29​#include <QPainter>
29#include <QSvgRenderer> 30​#include <QSvgRenderer>
30#include <QDebug> 31​#include <QDebug>
31 32​
32// KDE 33​// KDE
33 34​
34// Local 35​// Local
35#include "document/documentfactory.h" 36​#include "document/documentfactory.h"
36#include <qgraphicssceneevent.h> 37​#include <qgraphicssceneevent.h>
37#include <lib/gvdebug.h> 38​#include <lib/gvdebug.h>
38#include <lib/gwenviewconfig.h> 39​#include <lib/gwenviewconfig.h>
39 40​
40namespace Gwenview 41​namespace Gwenview
41{ 42​{
42 43​
43/// SvgImageView //// 44​/// SvgImageView ////
44SvgImageView::SvgImageView(QGraphicsItem* parent) 45​SvgImageView::SvgImageView(QGraphicsItem* parent)
45: AbstractImageView(parent) 46​: AbstractImageView(parent)
46, mSvgItem(new QGraphicsSvgItem(this)) 47​, mSvgItem(new QGraphicsSvgItem(this))
48​, mAlphaBackgroundMode(AbstractImageView::AlphaBackgroundCheckBoard)
49​, mAlphaBackgroundColor(Qt::black)
47{ 50​{
51​ // So we aren't unnecessarily drawing the background for every paint()
52​ setCacheMode(QGraphicsItem::DeviceCoordinateCache);
rkflxUnsubmitted
Done

You can initialize those member variables the same way it's done for mSvgItem above.

rkflx: You can initialize those member variables the same way it's done for `mSvgItem` above.
48} 53​}
49 54​
50void SvgImageView::loadFromDocument() 55​void SvgImageView::loadFromDocument()
51{ 56​{
52 Document::Ptr doc = document(); 57​ Document::Ptr doc = document();
53 GV_RETURN_IF_FAIL(doc); 58​ GV_RETURN_IF_FAIL(doc);
54 59​
55 if (doc->loadingState() < Document::Loaded) { 60​ if (doc->loadingState() < Document::Loaded) {
Show All 19 Lines69{
75 applyPendingScrollPos(); 80​ applyPendingScrollPos();
76 completed(); 81​ completed();
77} 82​}
78 83​
79void SvgImageView::onZoomChanged() 84​void SvgImageView::onZoomChanged()
80{ 85​{
81 mSvgItem->setScale(zoom()); 86​ mSvgItem->setScale(zoom());
82 adjustItemPos(); 87​ adjustItemPos();
88​ update();
83} 89​}
84 90​
85void SvgImageView::onImageOffsetChanged() 91​void SvgImageView::onImageOffsetChanged()
86{ 92​{
87 adjustItemPos(); 93​ adjustItemPos();
88} 94​}
89 95​
90void SvgImageView::onScrollPosChanged(const QPointF& /* oldPos */) 96​void SvgImageView::onScrollPosChanged(const QPointF& /* oldPos */)
91{ 97​{
92 adjustItemPos(); 98​ adjustItemPos();
93} 99​}
94 100​
95void SvgImageView::adjustItemPos() 101​void SvgImageView::adjustItemPos()
96{ 102​{
97 mSvgItem->setPos(imageOffset() - scrollPos()); 103​ mSvgItem->setPos(imageOffset() - scrollPos());
104​ update();
105​}
106​
107​void SvgImageView::setAlphaBackgroundMode(AbstractImageView::AlphaBackgroundMode mode)
108​{
109​ mAlphaBackgroundMode = mode;
110​ update();
111​}
112​
113​void SvgImageView::setAlphaBackgroundColor(const QColor& color)
114​{
115​ mAlphaBackgroundColor = color;
116​ update();
117​}
118​
119​void SvgImageView::drawAlphaBackground(QPainter* painter)
120​{
121​ const QRectF imageRect = QRectF(imageOffset(), visibleImageSize());
122​ QPixmap background = QPixmap(imageRect.size().toSize());
rkflxUnsubmitted
Done

You missed a spot ;)

rkflx: You missed a spot ;)
123​
124​ switch (mAlphaBackgroundMode) {
125​ case AbstractImageView::AlphaBackgroundCheckBoard: {
126​ painter->drawTiledPixmap(imageRect, alphaBackgroundTexture(), scrollPos());
127​ break;
128​ }
129​ case AbstractImageView::AlphaBackgroundSolid: {
130​ painter->fillRect(imageRect, mAlphaBackgroundColor);
131​ break;
132​ }
133​ default: {
134​ Q_ASSERT(0);
135​ }
rkflxUnsubmitted
Done

After you latest changes you can finally drop those curly braces, which are quite uncommon for switch blocks.

rkflx: After you latest changes you can finally drop those curly braces, which are quite uncommon for…
136​ }
137​}
138​
139​void SvgImageView::paint(QPainter* painter, const QStyleOptionGraphicsItem* /*option*/, QWidget* /*widget*/)
140​{
141​ drawAlphaBackground(painter);
98} 142​}
99 143​
100//// SvgViewAdapter //// 144​//// SvgViewAdapter ////
rkflxUnsubmitted
Done

In the config dialog, Apply has an immediate effect for raster images (good), but for SVGs you have to hit OK for the background to change (bad).

Possibly setAlphaBackgroundMode is called in this case, where for RasterImageView there is update, so you'd need something similar for SVGs?

rkflx: In the config dialog, {nav Apply} has an immediate effect for raster images (good), but for…
101struct SvgViewAdapterPrivate 145​struct SvgViewAdapterPrivate
102{ 146​{
103 SvgImageView* mView; 147​ SvgImageView* mView;
104}; 148​};
105 149​
106SvgViewAdapter::SvgViewAdapter() 150​SvgViewAdapter::SvgViewAdapter()
107: d(new SvgViewAdapterPrivate) 151​: d(new SvgViewAdapterPrivate)
108{ 152​{
109 d->mView = new SvgImageView; 153​ d->mView = new SvgImageView;
110 setWidget(d->mView); 154​ setWidget(d->mView);
111 connect(d->mView, &SvgImageView::zoomChanged, this, &SvgViewAdapter::zoomChanged); 155​ connect(d->mView, &SvgImageView::zoomChanged, this, &SvgViewAdapter::zoomChanged);
112 connect(d->mView, &SvgImageView::zoomToFitChanged, this, &SvgViewAdapter::zoomToFitChanged); 156​ connect(d->mView, &SvgImageView::zoomToFitChanged, this, &SvgViewAdapter::zoomToFitChanged);
113 connect(d->mView, &SvgImageView::zoomToFillChanged, this, &SvgViewAdapter::zoomToFillChanged); 157​ connect(d->mView, &SvgImageView::zoomToFillChanged, this, &SvgViewAdapter::zoomToFillChanged);
rkflxUnsubmitted
Not Done

As mentioned in T8125, I'm not sure hasAlphaChannel makes sense for SVGs. Perhaps only mention that you'll draw the background for every SVG, or even remove the whole comment.

rkflx: As mentioned in T8125, I'm not sure `hasAlphaChannel` makes sense for SVGs. Perhaps only…
rkflxUnsubmitted
Done

In theory, background is needed only for a single case, so it can be moved there. However, we won't need it at all ;)

rkflx: In theory, `background` is needed only for a single `case`, so it can be moved there. However…
114 connect(d->mView, &SvgImageView::zoomInRequested, this, &SvgViewAdapter::zoomInRequested); 158​ connect(d->mView, &SvgImageView::zoomInRequested, this, &SvgViewAdapter::zoomInRequested);
115 connect(d->mView, &SvgImageView::zoomOutRequested, this, &SvgViewAdapter::zoomOutRequested); 159​ connect(d->mView, &SvgImageView::zoomOutRequested, this, &SvgViewAdapter::zoomOutRequested);
116 connect(d->mView, &SvgImageView::scrollPosChanged, this, &SvgViewAdapter::scrollPosChanged); 160​ connect(d->mView, &SvgImageView::scrollPosChanged, this, &SvgViewAdapter::scrollPosChanged);
117 connect(d->mView, &SvgImageView::completed, this, &SvgViewAdapter::completed); 161​ connect(d->mView, &SvgImageView::completed, this, &SvgViewAdapter::completed);
rkflxUnsubmitted
Done

As you are using this variable only a single time and it is constructed by a simple function call, you could just use the function inline, saving an extra copy.

rkflx: As you are using this variable only a single time and it is constructed by a simple function…
118 connect(d->mView, &SvgImageView::previousImageRequested, this, &SvgViewAdapter::previousImageRequested); 162​ connect(d->mView, &SvgImageView::previousImageRequested, this, &SvgViewAdapter::previousImageRequested);
rkflxUnsubmitted
Done

Why write this complicated construct when you could simply write scrollPos() inline?

rkflx: Why write this complicated construct when you could simply write `scrollPos()` inline?
119 connect(d->mView, &SvgImageView::nextImageRequested, this, &SvgViewAdapter::nextImageRequested); 163​ connect(d->mView, &SvgImageView::nextImageRequested, this, &SvgViewAdapter::nextImageRequested);
120 connect(d->mView, &SvgImageView::toggleFullScreenRequested, this, &SvgViewAdapter::toggleFullScreenRequested); 164​ connect(d->mView, &SvgImageView::toggleFullScreenRequested, this, &SvgViewAdapter::toggleFullScreenRequested);
121} 165​}
rkflxUnsubmitted
Done

Why do you need the second painter? The following works just fine for me:

painter->drawTiledPixmap(imageRect, alphaBackgroundTexture(), scrollPos());
rkflx: Why do you need the second painter? The following works just fine for me: painter…
huoniAuthorUnsubmitted
Not Done

All the above was a result of copying a similar structure from I believe RasterImageView. At the time of course I'm just trying to get things to work, and not thinking too deeply. Luckily your awesome reviews catch it!
I think I'll try to review my own work so to speak before submitting in future, to hopefully catch a lot of these things.

huoni: All the above was a result of copying a similar structure from I believe `RasterImageView`. At…
122 166​
123SvgViewAdapter::~SvgViewAdapter() 167​SvgViewAdapter::~SvgViewAdapter()
124{ 168​{
125 delete d; 169​ delete d;
126} 170​}
127 171​
128QCursor SvgViewAdapter::cursor() const 172​QCursor SvgViewAdapter::cursor() const
129{ 173​{
130 return widget()->cursor(); 174​ return widget()->cursor();
131} 175​}
132 176​
rkflxUnsubmitted
Done

I'm afraid neither the compiler nor the machine running the code will care much about your comment ;)

In general for situations which "should never happen" you can Q_ASSERT(0); which kills Gwenview (at least in Debug mode) and thus makes the problem visible.

rkflx: I'm afraid neither the compiler nor the machine running the code will care much about your…
huoniAuthorUnsubmitted
Done

I thought it was good practice to always have a default clause, to communicate that you've considered all cases.

Would it be preferable to put Q_ASSERT(0) here instead, or just take out default?

huoni: I thought it was good practice to always have a `default` clause, to communicate that you've…
rkflxUnsubmitted
Done

Well, assume you add an entry to the enum. Now both the compiler and static analysis tools will see your default and assume this was a deliberate choice, i.e. you'll not get notified that probably you should add the new case here too.

When testing I expected to get a compiler warning when there were unhandled cases (i.e. when removing all but the first case in your example), but this somehow did not work for me (not sure why).

In other places in Gwenview the ASSERT is used inside the default, so I'd say just do it this way.

rkflx: Well, assume you add an entry to the `enum`. Now both the compiler and static analysis tools…
133void SvgViewAdapter::setCursor(const QCursor& cursor) 177​void SvgViewAdapter::setCursor(const QCursor& cursor)
134{ 178​{
135 widget()->setCursor(cursor); 179​ widget()->setCursor(cursor);
136} 180​}
rkflxUnsubmitted
Done

Adding qDebug(), this method and thus SvgImageView::drawAlphaBackground is called a crazy number of times compared to RasterImageView::updateFromScaler, i.e. very often when displaying the image for the first time and also each time the cursor enters the viewport.

I wonder what's done differently for raster images to prevent this (perhaps via QGraphicsView's architecture?). Also, glancing at the API docs I discovered paint and setCacheMode for QGraphicsItem, not sure if this will help.

rkflx: Adding `qDebug()`, this method and thus `SvgImageView::drawAlphaBackground` is called a crazy…
huoniAuthorUnsubmitted
Not Done

Looks like caching works here, as long as we manually call update() when the background needs changing (on zoom/pan).

Note that RasterImageView::paint is also called numerous times, but it's only drawing mCurrentBuffer. We might be able to copy that behaviour, and implement a buffer here, but I think caching is the better option.

huoni: Looks like caching works here, as long as we manually call `update()` when the background needs…
rkflxUnsubmitted
Not Done

I'd assume that drawTilePixmap is not that much more expensive than drawPixmap of a potential SvgImageView::mCurrentBuffer, so the current version with single occasional repaints should be fine. Great setCacheMode is working out for us, it was quite a long shot…

rkflx: I'd assume that `drawTilePixmap` is not that much more expensive than `drawPixmap` of a…
137 181​
138void SvgViewAdapter::setDocument(Document::Ptr doc) 182​void SvgViewAdapter::setDocument(Document::Ptr doc)
139{ 183​{
140 d->mView->setDocument(doc); 184​ d->mView->setDocument(doc);
141} 185​}
142 186​
143Document::Ptr SvgViewAdapter::document() const 187​Document::Ptr SvgViewAdapter::document() const
144{ 188​{
145 return d->mView->document(); 189​ return d->mView->document();
146} 190​}
147 191​
148void SvgViewAdapter::loadConfig() 192​void SvgViewAdapter::loadConfig()
149{ 193​{
194​ d->mView->setAlphaBackgroundMode(GwenviewConfig::alphaBackgroundMode());
195​ d->mView->setAlphaBackgroundColor(GwenviewConfig::alphaBackgroundColor());
150 d->mView->setEnlargeSmallerImages(GwenviewConfig::enlargeSmallerImages()); 196​ d->mView->setEnlargeSmallerImages(GwenviewConfig::enlargeSmallerImages());
151} 197​}
152 198​
153void SvgViewAdapter::setZoomToFit(bool on) 199​void SvgViewAdapter::setZoomToFit(bool on)
154{ 200​{
155 d->mView->setZoomToFit(on); 201​ d->mView->setZoomToFit(on);
156} 202​}
157 203​
▲ Show 20 Lines • Show All 46 Lines • Show Last 20 Lines