vtkScivisExporter.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause

 
#ifndef vtkScivisExporter_h
#define vtkScivisExporter_h
 
#include "vtkObject.h"
#include "vtkSmartPointer.h"      // For the returned image
#include "vtkViewsScivisModule.h" // For export macro
#include "vtkWeakPointer.h"       // For ivar
 
VTK_ABI_NAMESPACE_BEGIN
class vtkImageData;
class vtkScivisView;
 
class VTKVIEWSSCIVIS_EXPORT vtkScivisExporter : public vtkObject
{
public:
  static vtkScivisExporter* New();
  vtkTypeMacro(vtkScivisExporter, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkSetClampMacro(Magnification, int, 1, VTK_INT_MAX);
  vtkGetMacro(Magnification, int);


  vtkSetMacro(TransparentBackground, bool);
  vtkGetMacro(TransparentBackground, bool);
  vtkBooleanMacro(TransparentBackground, bool);

  bool SaveScreenshot(const char* filename);

  vtkSmartPointer<vtkImageData> CaptureImage();

  bool ExportScene(const char* filename);
 
protected:
  vtkScivisExporter();
  ~vtkScivisExporter() override;
 
private:
  friend class vtkScivisView;
 
  // The view this exports, held weakly: the exporter is reached through the
  // view, but Python can outlive it -- `e = view.exporter; del view` -- and an
  // exporter with nothing to export should say so rather than crash.
  void SetView(vtkScivisView* view);
  vtkWeakPointer<vtkScivisView> View;
 
  vtkScivisExporter(const vtkScivisExporter&) = delete;
  void operator=(const vtkScivisExporter&) = delete;
 
  int Magnification;
  bool TransparentBackground;
};
 
VTK_ABI_NAMESPACE_END
#endif