pqCoreTestUtility.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-FileCopyrightText: Copyright (c) Sandia Corporation
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef pqCoreTestUtility_h
#define pqCoreTestUtility_h
 
#include "pqCoreModule.h"
#include "pqTestUtility.h"
#include <QSize>
#include <QStringList>
#include <vtkIOStream.h>
 
class pqEventPlayer;
class pqEventTranslator;
class pqView;
class QString;
class vtkImageData;
class vtkRenderWindow;
 
class PQCORE_EXPORT pqCoreTestUtility : public pqTestUtility
{
  Q_OBJECT
  typedef pqTestUtility Superclass;
 
public:
  pqCoreTestUtility(QObject* parent = nullptr);
  ~pqCoreTestUtility() override;
 
  static QString fixPath(const QString& path);
 
  static QString DataRoot();
 
  static QString TestDirectory();
 
  static QString BaselineDirectory();
 
  static bool SaveScreenshot(vtkRenderWindow* RenderWindow, const QString& File);
 
  static bool CompareImage(vtkRenderWindow* renderWindow, const QString& referenceImage,
    double threshold, ostream& output, const QString& tempDirectory,
    const QSize& size = QSize(300, 300));
 
  static bool CompareImage(vtkImageData* testImage, const QString& ReferenceImage, double Threshold,
    ostream& Output, const QString& TempDirectory);
 
  static bool CompareImage(const QString& testPNGImage, const QString& ReferenceImage,
    double Threshold, ostream& Output, const QString& TempDirectory);
 
  static bool CompareImage(QWidget* widget, const QString& referenceImage, double threshold,
    ostream& output, const QString& tempDirectory, const QSize& size = QSize(300, 300));
 
  static bool CompareView(pqView* curView, const QString& referenceImage, double threshold,
    const QString& tempDirectory, const QSize& size = QSize());
 
  static const char* PQ_COMPAREVIEW_PROPERTY_NAME;
 
  static bool CompareTile(QWidget* widget, int rank, int tdx, int tdy, const QString& baseline,
    double threshold, ostream& output, const QString& tempDirectory);
  static bool CompareTile(pqView* widget, int rank, int tdx, int tdy, const QString& baseline,
    double threshold, ostream& output, const QString& tempDirectory);
 
  static QString cleanPath(const QString&);
 
  bool supportsDashboardMode() override { return true; };
 
public Q_SLOTS: // NOLINT(readability-redundant-access-specifiers)
  void setDashboardMode(bool value) override;
 
  void updatePlayers() override;
 
  void updateTranslators() override;
 
private:
  QStringList TestFilenames;
};
 
#endif // !pqCoreTestUtility_h