/usr/include/qgis/qgsmultirenderchecker.h is in libqgis-dev 2.14.11+dfsg-3+deb9u1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 | /***************************************************************************
qgsmultirenderchecker.h
--------------------------------------
Date : 6.11.2014
Copyright : (C) 2014 Matthias Kuhn
Email : matthias at opengis dot ch
***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#ifndef QGSMULTIRENDERCHECKER_H
#define QGSMULTIRENDERCHECKER_H
#include "qgsrenderchecker.h"
/**
* This class allows checking rendered images against comparison images.
* Its main purpose is for the unit testing framework.
*
* It will either
* <ul>
* <li>take an externally rendered image (setRenderedImage())</li>
* <li>render the image based on provided mapSettings (setMapSettings())</li>
* </ul>
*
* This image will then be compared against one or several images in a folder inside
* the control directory (tests/testdata/control_images/{controlName}).
*
* There are modes for single and for multiple reference images.
* <ul>
* <li>If there are no subfolders in the control directory, it will assume an image
* with the name {controlImage}.png in the control directory itself.</li>
*
* <li>If there are subfolders inside the control directory, it will search for images
* with the name {controlImage}.png in every subfolder.</li>
* </ul>
*
* For every control image there may be one or several randomly named anomaly images defining
* allowed anomalies.
* For every control image, the allowed mismatch and color tolerance values will be calculated
* individually.
*
* @note added in 2.8
*/
class CORE_EXPORT QgsMultiRenderChecker
{
public:
QgsMultiRenderChecker();
/**
* Base directory name for the control image (with control image path
* suffixed) the path to the image will be constructed like this:
* controlImagePath + '/' + mControlName + '/' + mControlName + '.png'
*/
void setControlName( const QString& theName );
void setControlPathPrefix( const QString& prefix );
/**
* Set the path to the rendered image. If this is not set or set to QString::Null, an image
* will be rendered based on the provided mapsettings
*
* @param renderedImagePath A path to the rendered image with which control images will be compared
*/
void setRenderedImage( const QString& renderedImagePath ) { mRenderedImage = renderedImagePath; }
/**
* Set the map settings to use to render the image
*
* @param mapSettings The map settings
*/
void setMapSettings( const QgsMapSettings& mapSettings );
/**
* Set tolerance for color components used by runTest()
* Default value is 0.
*
* @param theColorTolerance The maximum difference for each color component
* including alpha to be considered correct.
*/
void setColorTolerance( unsigned int theColorTolerance ) { mColorTolerance = theColorTolerance; }
/**
* Test using renderer to generate the image to be compared.
*
* @param theTestName - to be used as the basis for writing a file to
* e.g. /tmp/theTestName.png
*
* @param theMismatchCount - defaults to 0 - the number of pixels that
* are allowed to be different from the control image. In some cases
* rendering may be non-deterministic. This parameter allows you to account
* for that by providing a tolerance.
*
* @note make sure to call setExpectedImage and setMapSettings first
*/
bool runTest( const QString& theTestName, unsigned int theMismatchCount = 0 );
/**
* Returns a report for this test
*
* @return A report
*/
QString report() const { return mReport; }
/**
* @brief controlImagePath
* @return
*/
QString controlImagePath() const;
/** Draws a checkboard pattern for image backgrounds, so that transparency is visible
* without requiring a transparent background for the image
*/
static void drawBackground( QImage* image ) { QgsRenderChecker::drawBackground( image ); }
private:
QString mReport;
QString mRenderedImage;
QString mControlName;
QString mControlPathPrefix;
unsigned int mColorTolerance;
QgsMapSettings mMapSettings;
};
#endif // QGSMULTIRENDERCHECKER_H
|