ParaView
pqCoreTestUtility.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: ParaView
4  Module: pqCoreTestUtility.h
5 
6  Copyright (c) 2005-2008 Sandia Corporation, Kitware Inc.
7  All rights reserved.
8 
9  ParaView is a free software; you can redistribute it and/or modify it
10  under the terms of the ParaView license version 1.2.
11 
12  See License_v1.2.txt for the full ParaView license.
13  A copy of this license can be obtained by contacting
14  Kitware Inc.
15  28 Corporate Drive
16  Clifton Park, NY 12065
17  USA
18 
19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR
23 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 
31 =========================================================================*/
32 
33 #ifndef _pqCoreTestUtility_h
34 #define _pqCoreTestUtility_h
35 
36 #include "pqCoreModule.h"
37 #include "pqTestUtility.h"
38 #include <QSize>
39 #include <QStringList>
40 #include <vtkIOStream.h>
41 
42 class pqEventPlayer;
43 class pqEventTranslator;
44 class pqView;
45 class QString;
46 class vtkImageData;
47 class vtkRenderWindow;
48 
52 class PQCORE_EXPORT pqCoreTestUtility : public pqTestUtility
53 {
54  Q_OBJECT
55  typedef pqTestUtility Superclass;
56 
57 public:
58  pqCoreTestUtility(QObject* parent = 0);
60 
61 public:
66  static QString DataRoot();
67 
72  static QString TestDirectory();
73 
78  static QString BaselineDirectory();
79 
84  static bool SaveScreenshot(vtkRenderWindow* RenderWindow, const QString& File);
85 
90  static bool CompareImage(vtkRenderWindow* RenderWindow, const QString& ReferenceImage,
91  double Threshold, ostream& Output, const QString& TempDirectory);
92 
97  static bool CompareImage(vtkImageData* testImage, const QString& ReferenceImage, double Threshold,
98  ostream& Output, const QString& TempDirectory);
99 
100  static bool CompareImage(const QString& testPNGImage, const QString& ReferenceImage,
101  double Threshold, ostream& Output, const QString& TempDirectory);
102 
107  static bool CompareImage(QWidget* widget, const QString& referenceImage, double threshold,
108  ostream& output, const QString& tempDirectory, const QSize& size = QSize(300, 300));
109 
110  static bool CompareView(pqView* curView, const QString& referenceImage, double threshold,
111  const QString& tempDirectory, const QSize& size = QSize());
112 
113  static const char* PQ_COMPAREVIEW_PROPERTY_NAME;
114 
115 private:
116  QStringList TestFilenames;
117 };
118 
119 #endif // !_pqCoreTestUtility_h
This is a PQ abstraction of a generic view module.
Definition: pqView.h:56
static const char * PQ_COMPAREVIEW_PROPERTY_NAME
Provides ParaView-specific functionality for regression testing.