// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
/**
 * @class   vtkTestingInteractor
 * @brief   A RenderWindowInteractor for testing
 *
 * Provides a Start() method that passes arguments to a test for
 * regression testing and returns. This permits programs that
 * run as tests to exit gracefully during the test run without needing
 * interaction.
 * @sa
 * vtkTestingObjectFactory
 */

#ifndef vtkTestingInteractor_h
#define vtkTestingInteractor_h

#include "vtkObjectFactoryCollection.h" // Generated object overrides
#include "vtkRenderWindowInteractor.h"
#include "vtkSmartPointer.h"           // For vtkSmartPointer
#include "vtkTestingRenderingModule.h" // For export macro

#include <string> // STL Header; Required for string

class vtkMultiProcessController;

VTK_ABI_NAMESPACE_BEGIN
class VTKTESTINGRENDERING_EXPORT vtkTestingInteractor : public vtkRenderWindowInteractor
{
public:
  /**
   * Standard object factory instantiation method.
   */
  static vtkTestingInteractor* New();

  ///@{
  /**
   * Type and printing information.
   */
  vtkTypeMacro(vtkTestingInteractor, vtkRenderWindowInteractor);
  void PrintSelf(ostream& os, vtkIndent indent) override;
  ///@}

  void Start() override;

  static int TestReturnStatus;      // Return status of the test
  static double ErrorThreshold;     // Error Threshold
  static std::string ValidBaseline; // Name of the Baseline image
  static std::string TempDirectory; // Location of Testing/Temporary
  static std::string DataDirectory; // Location of VTKData

  ///@{
  /**
   * Get/Set the controller in an MPI environment.
   */
  vtkMultiProcessController* GetController() const;
  void SetController(vtkMultiProcessController* controller);
  ///@}

protected:
  /**
   * The constructor sets up the `Controller` if MPI has been initialized.
   */
  vtkTestingInteractor();

  vtkSmartPointer<vtkMultiProcessController> Controller;

private:
  vtkTestingInteractor(const vtkTestingInteractor&) = delete;
  void operator=(const vtkTestingInteractor&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif
