mirror of
https://github.com/qgis/QGIS.git
synced 2025-10-31 00:06:02 -04:00
86 lines
3.4 KiB
Plaintext
86 lines
3.4 KiB
Plaintext
|
|
/** Render checker for tests in python */
|
|
|
|
class QgsRenderChecker
|
|
{
|
|
%TypeHeaderCode
|
|
#include <qgsrenderchecker.h>
|
|
%End
|
|
public:
|
|
|
|
QgsRenderChecker();
|
|
|
|
//! Destructor
|
|
~QgsRenderChecker();
|
|
|
|
QString controlImagePath() const;
|
|
|
|
QString report();
|
|
float matchPercent();
|
|
unsigned int mismatchCount();
|
|
unsigned int matchTarget();
|
|
//only records time for actual render part
|
|
int elapsedTime();
|
|
void setElapsedTimeTarget( int theTarget );
|
|
/** 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 );
|
|
/** Prefix where the control images are kept.
|
|
* This will be appended to controlImagePath
|
|
*/
|
|
void setControlPathPrefix( const QString theName );
|
|
/** Get an md5 hash that uniquely identifies an image */
|
|
QString imageToHash( QString theImageFile );
|
|
|
|
void setRenderedImage( QString theImageFileName );
|
|
//! @deprecated since 2.4 - use setMapSettings()
|
|
void setMapRenderer( QgsMapRenderer * thepMapRenderer ) /Deprecated/;
|
|
|
|
//! @note added in 2.4
|
|
void setMapSettings( const QgsMapSettings& mapSettings );
|
|
|
|
/** Set tolerance for color components used by runTest() and compareImages().
|
|
* Default value is 0.
|
|
* @param theColorTolerance is maximum difference for each color component
|
|
* including alpha to be considered correct.
|
|
* @note added in 2.1
|
|
*/
|
|
void setColorTolerance( unsigned int 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 setMapRenderer first
|
|
*/
|
|
bool runTest( QString theTestName, unsigned int theMismatchCount = 0 );
|
|
|
|
/**
|
|
* Test using two arbitary images (map renderer will not be used)
|
|
* @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.
|
|
* @param theRenderedImageFile to optionally override the output filename
|
|
* @note: make sure to call setExpectedImage and setRenderedImage first.
|
|
*/
|
|
bool compareImages( QString theTestName, unsigned int theMismatchCount = 0, QString theRenderedImageFile = "" );
|
|
/** Get a list of all the anomalies. An anomaly is a rendered difference
|
|
* file where there is some red pixel content (indicating a render check
|
|
* mismatch), but where the output was still acceptible. If the render
|
|
* diff matches one of these anomalies we will still consider it to be
|
|
* acceptible.
|
|
* @return a bool indicating if the diff matched one of the anomaly files
|
|
*/
|
|
bool isKnownAnomaly( QString theDiffImageFile );
|
|
|
|
QString expectedImageFile();
|
|
};
|