Project image decoration support #5200

nirvn · 2024-04-21T10:10:34Z

This PR implements support for projects' image decoration (joining the title and copyright decorations implement in QField 3.2).

To support fill and outline settings, a new ParametizedImage item was added, which relies on SVG and image cache to configure the fill and stroke color of the image. It will probably come in handy in other scenarios too.

As per the two other decorations we have, QField will enforce an harmonious position for the decoration.

In action:

The decoration gives users a simple way to further "brand" their projects.

Relevant QGIS documentation: https://docs.qgis.org/3.34/en/docs/user_manual/map_views/map_view.html#image-decoration

Sponsored by Deutsches Archäologisches Institut (DAI)

github-actions

clang-tidy made some suggestions

There were too many comments to post at once. Showing the first 25 out of 35. Check the log or trigger a new build to see more.

github-actions · 2024-04-21T10:31:12Z

src/core/parametizedimage.cpp

+void ParametizedImage::setSource( const QString &source )
+{
+  if ( mSource == source )
+    return;


warning: statement should be inside braces [readability-braces-around-statements]

Suggested change

return;

if ( mSource == source ) {

return;

}

github-actions · 2024-04-21T10:31:13Z

src/core/parametizedimage.cpp

+  mSource = source;
+  emit sourceChanged();
+
+  QFileInfo fi( mSource );


warning: variable 'fi' of type 'QFileInfo' can be declared 'const' [misc-const-correctness]

Suggested change

QFileInfo fi( mSource );

QFileInfo const fi( mSource );

github-actions · 2024-04-21T10:31:13Z

src/core/parametizedimage.cpp

+  mSource = source;
+  emit sourceChanged();
+
+  QFileInfo fi( mSource );


warning: variable name 'fi' is too short, expected at least 3 characters [readability-identifier-length]

QFileInfo fi( mSource ); ^

github-actions · 2024-04-21T10:31:13Z

src/core/parametizedimage.cpp

+  {
+    if ( mIsRaster )
+    {
+      mSourceSize = QgsApplication::instance()->imageCache()->originalSize( mSource, true );


warning: static member accessed through instance [readability-static-accessed-through-instance]

mSourceSize = QgsApplication::instance()->imageCache()->originalSize( mSource, true ); ^

github-actions · 2024-04-21T10:31:13Z

src/core/parametizedimage.cpp

+    }
+    else
+    {
+      mSourceSize = QgsApplication::instance()->svgCache()->svgViewboxSize( mSource, size().width(), QColor( 0, 0, 0 ), QColor( 255, 0, 0 ), 10, 1, 0, true );


warning: 10 is a magic number; consider replacing it with a named constant [cppcoreguidelines-avoid-magic-numbers]

mSourceSize = QgsApplication::instance()->svgCache()->svgViewboxSize( mSource, size().width(), QColor( 0, 0, 0 ), QColor( 255, 0, 0 ), 10, 1, 0, true ); ^

github-actions · 2024-04-21T10:31:14Z

src/core/parametizedimage.cpp

+    const double devicePixelRatio = window()->screen()->devicePixelRatio();
+    QImage sourceImage = QgsApplication::instance()->imageCache()->pathAsImage( mSource, QSize( drawnWidth * devicePixelRatio, drawnHeight * devicePixelRatio ), true, 1, fitsInCache, true );
+    painter->drawImage( ( size().width() - drawnWidth ) / 2, ( size().height() - drawnHeight ) / 2, sourceImage );
+  }


warning: narrowing conversion from 'double' to 'int' [bugprone-narrowing-conversions]

painter->drawImage( ( size().width() - drawnWidth ) / 2, ( size().height() - drawnHeight ) / 2, sourceImage ); ^

github-actions · 2024-04-21T10:31:14Z

src/core/parametizedimage.cpp

+  {
+    const double drawnWidth = sourceRatio >= itemRatio ? size().width() : size().height() * sourceRatio;
+    QPicture sourcePicture = QgsApplication::instance()->svgCache()->svgAsPicture( mSource, drawnWidth, mFillColor, mStrokeColor, mStrokeWidth, 1, fitsInCache, 0, true );
+    painter->drawPicture( size().width() / 2, size().height() / 2, sourcePicture );


warning: static member accessed through instance [readability-static-accessed-through-instance]

QPicture sourcePicture = QgsApplication::instance()->svgCache()->svgAsPicture( mSource, drawnWidth, mFillColor, mStrokeColor, mStrokeWidth, 1, fitsInCache, 0, true ); ^

github-actions · 2024-04-21T10:31:14Z

src/core/parametizedimage.cpp

+  {
+    const double drawnWidth = sourceRatio >= itemRatio ? size().width() : size().height() * sourceRatio;
+    QPicture sourcePicture = QgsApplication::instance()->svgCache()->svgAsPicture( mSource, drawnWidth, mFillColor, mStrokeColor, mStrokeWidth, 1, fitsInCache, 0, true );
+    painter->drawPicture( size().width() / 2, size().height() / 2, sourcePicture );


warning: variable 'sourcePicture' of type 'QPicture' can be declared 'const' [misc-const-correctness]

Suggested change

painter->drawPicture( size().width() / 2, size().height() / 2, sourcePicture );

QPicture const sourcePicture = QgsApplication::instance()->svgCache()->svgAsPicture( mSource, drawnWidth, mFillColor, mStrokeColor, mStrokeWidth, 1, fitsInCache, 0, true );

github-actions · 2024-04-21T10:31:14Z

src/core/parametizedimage.cpp

+    const double drawnWidth = sourceRatio >= itemRatio ? size().width() : size().height() * sourceRatio;
+    QPicture sourcePicture = QgsApplication::instance()->svgCache()->svgAsPicture( mSource, drawnWidth, mFillColor, mStrokeColor, mStrokeWidth, 1, fitsInCache, 0, true );
+    painter->drawPicture( size().width() / 2, size().height() / 2, sourcePicture );
+  }


warning: narrowing conversion from 'qreal' (aka 'double') to 'int' [bugprone-narrowing-conversions]

painter->drawPicture( size().width() / 2, size().height() / 2, sourcePicture ); ^

github-actions · 2024-04-21T10:31:14Z

src/core/parametizedimage.cpp

+    const double drawnWidth = sourceRatio >= itemRatio ? size().width() : size().height() * sourceRatio;
+    QPicture sourcePicture = QgsApplication::instance()->svgCache()->svgAsPicture( mSource, drawnWidth, mFillColor, mStrokeColor, mStrokeWidth, 1, fitsInCache, 0, true );
+    painter->drawPicture( size().width() / 2, size().height() / 2, sourcePicture );
+  }


warning: narrowing conversion from 'qreal' (aka 'double') to 'int' [bugprone-narrowing-conversions]

painter->drawPicture( size().width() / 2, size().height() / 2, sourcePicture ); ^

github-actions

clang-tidy made some suggestions

There were too many comments to post at once. Showing the first 25 out of 26. Check the log or trigger a new build to see more.

github-actions · 2024-04-21T10:35:12Z

src/core/parametizedimage.cpp

+void ParametizedImage::setFillColor( const QColor &color )
+{
+  if ( mFillColor == color )
+    return;


warning: statement should be inside braces [readability-braces-around-statements]

Suggested change

return;

if ( mFillColor == color ) {

return;

}

github-actions · 2024-04-21T10:35:12Z

src/core/parametizedimage.cpp

+  emit fillColorChanged();
+
+  if ( mIsValid && !mIsRaster )
+    update();


warning: statement should be inside braces [readability-braces-around-statements]

Suggested change

update();

if ( mIsValid && !mIsRaster ) {

update();

}

github-actions · 2024-04-21T10:35:12Z

src/core/parametizedimage.cpp

+void ParametizedImage::setStrokeColor( const QColor &color )
+{
+  if ( mStrokeColor == color )
+    return;


warning: statement should be inside braces [readability-braces-around-statements]

Suggested change

return;

if ( mStrokeColor == color ) {

return;

}

github-actions · 2024-04-21T10:35:12Z

src/core/parametizedimage.cpp

+  emit strokeColorChanged();
+
+  if ( mIsValid && !mIsRaster )
+    update();


warning: statement should be inside braces [readability-braces-around-statements]

Suggested change

update();

if ( mIsValid && !mIsRaster ) {

update();

}

github-actions · 2024-04-21T10:35:12Z

src/core/parametizedimage.cpp

+void ParametizedImage::setStrokeWidth( double width )
+{
+  if ( mStrokeWidth == width )
+    return;


warning: statement should be inside braces [readability-braces-around-statements]

Suggested change

return;

if ( mStrokeWidth == width ) {

return;

}

github-actions · 2024-04-21T10:35:13Z

src/core/parametizedimage.h

+    QSizeF mSourceSize;
+
+    QColor mFillColor = QColor( 0, 0, 0 );
+    QColor mStrokeColor = QColor( 255, 255, 255 );


warning: 255 is a magic number; consider replacing it with a named constant [cppcoreguidelines-avoid-magic-numbers]

QColor mStrokeColor = QColor( 255, 255, 255 ); ^

github-actions · 2024-04-21T10:35:13Z

src/core/parametizedimage.h

+    QSizeF mSourceSize;
+
+    QColor mFillColor = QColor( 0, 0, 0 );
+    QColor mStrokeColor = QColor( 255, 255, 255 );


warning: 255 is a magic number; consider replacing it with a named constant [cppcoreguidelines-avoid-magic-numbers]

QColor mStrokeColor = QColor( 255, 255, 255 ); ^

github-actions · 2024-04-21T10:35:13Z

src/core/parametizedimage.h

+    QSizeF mSourceSize;
+
+    QColor mFillColor = QColor( 0, 0, 0 );
+    QColor mStrokeColor = QColor( 255, 255, 255 );


warning: 255 is a magic number; consider replacing it with a named constant [cppcoreguidelines-avoid-magic-numbers]

QColor mStrokeColor = QColor( 255, 255, 255 ); ^

github-actions · 2024-04-21T10:35:13Z

src/core/projectinfo.cpp

@@ -743,3 +744,39 @@ QVariantMap ProjectInfo::getCopyrightDecorationConfiguration()

  return configuration;
 }
+
+QVariantMap ProjectInfo::getImageDecorationConfiguration()


warning: method 'getImageDecorationConfiguration' can be made static [readability-convert-member-functions-to-static]

src/core/projectinfo.h:187:

- Q_INVOKABLE QVariantMap getImageDecorationConfiguration(); + Q_INVOKABLE static QVariantMap getImageDecorationConfiguration();

github-actions · 2024-04-21T10:35:13Z

src/core/projectinfo.cpp

+      imagePath = QStringLiteral( ":/images/qfield_logo.svg" );
+    }
+
+    QColor fillColor = QgsColorUtils::colorFromString( QgsProject::instance()->readEntry( configurationName, QStringLiteral( "/Color" ), QStringLiteral( "#000000" ) ) );


warning: variable 'fillColor' of type 'QColor' can be declared 'const' [misc-const-correctness]

Suggested change

QColor fillColor = QgsColorUtils::colorFromString( QgsProject::instance()->readEntry( configurationName, QStringLiteral( "/Color" ), QStringLiteral( "#000000" ) ) );

QColor const fillColor = QgsColorUtils::colorFromString( QgsProject::instance()->readEntry( configurationName, QStringLiteral( "/Color" ), QStringLiteral( "#000000" ) ) );

qfield-fairy · 2024-04-21T10:36:57Z

🎉 Ta-daaa, freshly created APKs are available for 99a0586: arm64-android

Other architectures

github-actions

clang-tidy made some suggestions

github-actions · 2024-04-23T02:33:31Z

src/core/projectinfo.cpp

+    }
+
+    QColor fillColor = QgsColorUtils::colorFromString( QgsProject::instance()->readEntry( configurationName, QStringLiteral( "/Color" ), QStringLiteral( "#000000" ) ) );
+    QColor strokeColor = QgsColorUtils::colorFromString( QgsProject::instance()->readEntry( configurationName, QStringLiteral( "/OutlineColor" ), QStringLiteral( "#FFFFFF" ) ) );


warning: variable 'strokeColor' of type 'QColor' can be declared 'const' [misc-const-correctness]

Suggested change

QColor strokeColor = QgsColorUtils::colorFromString( QgsProject::instance()->readEntry( configurationName, QStringLiteral( "/OutlineColor" ), QStringLiteral( "#FFFFFF" ) ) );

QColor const strokeColor = QgsColorUtils::colorFromString( QgsProject::instance()->readEntry( configurationName, QStringLiteral( "/OutlineColor" ), QStringLiteral( "#FFFFFF" ) ) );

domi4484 · 2024-04-26T12:58:49Z

src/core/parametizedimage.cpp

+ parametizedimage.cpp - ParametizedImage
+
+ ---------------------
+ begin                : 21.05.2024


Cool where did you purchased a time machine? I need one as well!

domi4484 · 2024-04-26T13:19:42Z

src/core/projectinfo.cpp

+    }
+    else
+    {
+      imagePath = QStringLiteral( ":/images/qfield_logo.svg" );


Does it mean that if the path is misconfigured or the file did not get to the phone we just show a qfield logo?

@domi4484 , yep, same logic as in QGIS, where there it shows a QGIS logo.

domi4484 · 2024-04-26T13:25:39Z

src/core/projectinfo.cpp

+QVariantMap ProjectInfo::getImageDecorationConfiguration()
+{
+  QVariantMap configuration;
+  const QString configurationName = QStringLiteral( "Image" );


All those literals are defined the same way in QGIS as well? I think ideally they should be some const or are they by purpose not made part of the interface in QGIS?

@domi4484 , correct, they are.

That's in big part because decorations have been living in src/app for as long as they've existed.

nirvn added the ENHANCEMENT label Apr 21, 2024

github-actions bot reviewed Apr 21, 2024

View reviewed changes

nirvn added 3 commits April 23, 2024 09:13

Implement a parametized image item

b59907c

Implement project image decoration support

3be09e7

Make cppcheck happy, add documentation

00d3467

nirvn force-pushed the image_decoration branch from 99a0586 to 00d3467 Compare April 23, 2024 02:13

github-actions bot reviewed Apr 23, 2024

View reviewed changes

domi4484 approved these changes Apr 26, 2024

View reviewed changes

nirvn merged commit ebbc737 into master Apr 26, 2024
21 of 23 checks passed

nirvn deleted the image_decoration branch April 26, 2024 13:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Project image decoration support #5200

Project image decoration support #5200

nirvn commented Apr 21, 2024 •

edited

github-actions bot left a comment

github-actions bot Apr 21, 2024

github-actions bot Apr 21, 2024

github-actions bot Apr 21, 2024

github-actions bot Apr 21, 2024

github-actions bot Apr 21, 2024

github-actions bot Apr 21, 2024

github-actions bot Apr 21, 2024

github-actions bot Apr 21, 2024

github-actions bot Apr 21, 2024

github-actions bot Apr 21, 2024

github-actions bot left a comment

github-actions bot Apr 21, 2024

github-actions bot Apr 21, 2024

github-actions bot Apr 21, 2024

github-actions bot Apr 21, 2024

github-actions bot Apr 21, 2024

github-actions bot Apr 21, 2024

github-actions bot Apr 21, 2024

github-actions bot Apr 21, 2024

github-actions bot Apr 21, 2024

github-actions bot Apr 21, 2024

qfield-fairy commented Apr 21, 2024

github-actions bot left a comment

github-actions bot Apr 23, 2024

domi4484 Apr 26, 2024

domi4484 Apr 26, 2024

nirvn Apr 26, 2024

domi4484 Apr 26, 2024

nirvn Apr 26, 2024

-    return;
+  if ( mSource == source ) {
+    return;
+}

	painter->drawPicture( size().width() / 2, size().height() / 2, sourcePicture );
	QPicture const sourcePicture = QgsApplication::instance()->svgCache()->svgAsPicture( mSource, drawnWidth, mFillColor, mStrokeColor, mStrokeWidth, 1, fitsInCache, 0, true );

-    return;
+  if ( mFillColor == color ) {
+    return;
+}

-    return;
+  if ( mStrokeColor == color ) {
+    return;
+}

-    return;
+  if ( mStrokeWidth == width ) {
+    return;
+}

	QColor fillColor = QgsColorUtils::colorFromString( QgsProject::instance()->readEntry( configurationName, QStringLiteral( "/Color" ), QStringLiteral( "#000000" ) ) );
	QColor const fillColor = QgsColorUtils::colorFromString( QgsProject::instance()->readEntry( configurationName, QStringLiteral( "/Color" ), QStringLiteral( "#000000" ) ) );

	QColor strokeColor = QgsColorUtils::colorFromString( QgsProject::instance()->readEntry( configurationName, QStringLiteral( "/OutlineColor" ), QStringLiteral( "#FFFFFF" ) ) );
	QColor const strokeColor = QgsColorUtils::colorFromString( QgsProject::instance()->readEntry( configurationName, QStringLiteral( "/OutlineColor" ), QStringLiteral( "#FFFFFF" ) ) );

Project image decoration support #5200

Project image decoration support #5200

Conversation

nirvn commented Apr 21, 2024 • edited

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot Apr 21, 2024

Choose a reason for hiding this comment

github-actions bot Apr 21, 2024

Choose a reason for hiding this comment

github-actions bot Apr 21, 2024

Choose a reason for hiding this comment

github-actions bot Apr 21, 2024

Choose a reason for hiding this comment

github-actions bot Apr 21, 2024

Choose a reason for hiding this comment

github-actions bot Apr 21, 2024

Choose a reason for hiding this comment

github-actions bot Apr 21, 2024

Choose a reason for hiding this comment

github-actions bot Apr 21, 2024

Choose a reason for hiding this comment

github-actions bot Apr 21, 2024

Choose a reason for hiding this comment

github-actions bot Apr 21, 2024

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot Apr 21, 2024

Choose a reason for hiding this comment

github-actions bot Apr 21, 2024

Choose a reason for hiding this comment

github-actions bot Apr 21, 2024

Choose a reason for hiding this comment

github-actions bot Apr 21, 2024

Choose a reason for hiding this comment

github-actions bot Apr 21, 2024

Choose a reason for hiding this comment

github-actions bot Apr 21, 2024

Choose a reason for hiding this comment

github-actions bot Apr 21, 2024

Choose a reason for hiding this comment

github-actions bot Apr 21, 2024

Choose a reason for hiding this comment

github-actions bot Apr 21, 2024

Choose a reason for hiding this comment

github-actions bot Apr 21, 2024

Choose a reason for hiding this comment

qfield-fairy commented Apr 21, 2024

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot Apr 23, 2024

Choose a reason for hiding this comment

domi4484 Apr 26, 2024

Choose a reason for hiding this comment

domi4484 Apr 26, 2024

Choose a reason for hiding this comment

nirvn Apr 26, 2024

Choose a reason for hiding this comment

domi4484 Apr 26, 2024

Choose a reason for hiding this comment

nirvn Apr 26, 2024

Choose a reason for hiding this comment

nirvn commented Apr 21, 2024 •

edited