mitkRenderingTestHelper.h

Go to the documentation of this file.

/*============================================================================

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.

Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.

============================================================================*/

#ifndef mitkRenderingTestHelper_h
#define mitkRenderingTestHelper_h

#include <mitkDataStorage.h>
#include <mitkRenderWindow.h>
#include <vtkSmartPointer.h>

#include <MitkTestingHelperExports.h>
#include <mitkIOUtil.h>

class vtkRenderWindow;
class vtkRenderer;

namespace mitk
{
  class MITKTESTINGHELPER_EXPORT RenderingTestHelper
  {
  public:
    RenderingTestHelper(
      int width,
      int height,
      int argc,
      char *argv[],
      AntiAliasing antiAliasing = AntiAliasing::None);

    RenderingTestHelper(
      int width,
      int height,
      AntiAliasing antiAliasing = AntiAliasing::None);

    ~RenderingTestHelper();

    vtkRenderer *GetVtkRenderer();

    vtkRenderWindow *GetVtkRenderWindow();

    void SaveAsPNG(std::string fileName);

    void SetAutomaticallyCloseRenderWindow(bool automaticallyCloseRenderWindow);

    void SetImageProperty(const char *propertyKey, mitk::BaseProperty *property);

    void SetViewDirection(mitk::SliceNavigationController::ViewDirection viewDirection);

    void ReorientSlices(mitk::Point3D origin, mitk::Vector3D rotation);

    void Render();

    mitk::DataStorage::Pointer GetDataStorage();

    void SetMapperID(mitk::BaseRenderer::StandardMapperSlot id);

    void AddNodeToStorage(mitk::DataNode::Pointer node);

    void SetMapperIDToRender3D();

    void SetMapperIDToRender2D();

    void SaveReferenceScreenShot(std::string fileName);

    bool CompareRenderWindowAgainstReference(int argc, char *argv[], double threshold = 10.0);

    class ArgcHelperClass
    {
    private:
      std::vector<char *> argv;
      std::vector<std::vector<char>> argvec;

    public:
      ArgcHelperClass(const std::vector<std::string> &argstrings)
        : argv(argstrings.size() + 1), argvec(argstrings.size() + 1)
      {
        std::vector<std::string> cmdArgs;
        cmdArgs.push_back(mitk::IOUtil::GetProgramPath());
        cmdArgs.insert(cmdArgs.end(), argstrings.begin(), argstrings.end());
        for (std::size_t i = 0; i < cmdArgs.size(); ++i)
        {
          argvec[i].assign(cmdArgs[i].begin(), cmdArgs[i].end());
          argvec[i].push_back('\0');
          argv[i] = &argvec[i][0];
        }
      }
      char **GetArgv() { return &argv[0]; }
      int GetArgc() { return argv.size(); }
    };

  protected:
    void Initialize(
      int width,
      int height,
      AntiAliasing antiAliasing = AntiAliasing::None);

    void AddToStorage(const std::string &filename);

    void SetInputFileNames(int argc, char *argv[]);

    mitk::RenderWindow::Pointer m_RenderWindow; //<< Contains the mitkRenderWindow into which the test renders the data
    mitk::DataStorage::Pointer m_DataStorage;   //<< Contains the mitkDataStorage which contains the data to be rendered
    bool
      m_AutomaticallyCloseRenderWindow; //<< Flag indicating whether the renderwindow should automatically close (true,
                                        // default) or stay open (false). Usefull for debugging.
  };
} // namespace mitk
#endif