vtkSMSaveScreenshotProxy.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkSMSaveScreenshotProxy_h
#define vtkSMSaveScreenshotProxy_h
 
#include "vtkPVSession.h"           // needed for vtkPVSession::ServerFlags
#include "vtkRemotingViewsModule.h" // needed for exports
#include "vtkSMProxy.h"
#include "vtkSmartPointer.h" // needed for vtkSmartPointer.
#include "vtkVector.h"       // needed for vtkVector2i.
 
class vtkImageData;
class vtkPVXMLElement;
class vtkSMViewLayoutProxy;
class vtkSMViewProxy;
 
class VTKREMOTINGVIEWS_EXPORT vtkSMSaveScreenshotProxy : public vtkSMProxy
{
public:
  static vtkSMSaveScreenshotProxy* New();
  vtkTypeMacro(vtkSMSaveScreenshotProxy, vtkSMProxy);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  bool WriteImage(const char* filename, vtkTypeUInt32 location = vtkPVSession::CLIENT,
    vtkPVXMLElement* stateXMLRoot = nullptr);
 
  vtkSmartPointer<vtkImageData> CaptureImage();
 
  virtual void UpdateDefaultsAndVisibilities(const char* filename);
 
  static vtkSmartPointer<vtkImageData> CaptureImage(vtkSMViewProxy* view, const vtkVector2i& size);
 
  static vtkSmartPointer<vtkImageData> CaptureImage(
    vtkSMViewLayoutProxy* view, const vtkVector2i& size);
 
  static vtkVector2i GetScaleFactorsAndSize(
    const vtkVector2i& targetSize, vtkVector2i& size, bool* approximate = nullptr);
 
  static int ComputeMagnification(const vtkVector2i& targetSize, vtkVector2i& size);
 
 
  std::string GetFileFormatFilters();
 
protected:
  vtkSMSaveScreenshotProxy();
  ~vtkSMSaveScreenshotProxy() override;
 
  std::pair<vtkSmartPointer<vtkImageData>, vtkSmartPointer<vtkImageData>> CapturePreppedImages();
 
  virtual bool Prepare();
 
  virtual bool Cleanup();
 
  vtkSMViewLayoutProxy* GetLayout();
  vtkSMViewProxy* GetView();
 
  vtkSMProxy* GetFormatProxy(const std::string& filename);
 
  std::string GetStereoFileName(const std::string& filename, bool left);
 
  // vtkSMRecolorableImageExtractWriterProxy uses experimental API
  // SetUseFloatingPointBuffers.
  friend class vtkSMRecolorableImageExtractWriterProxy;
  vtkSetMacro(UseFloatingPointBuffers, bool);
 
private:
  vtkSMSaveScreenshotProxy(const vtkSMSaveScreenshotProxy&) = delete;
  void operator=(const vtkSMSaveScreenshotProxy&) = delete;
 
  class vtkState;
  class vtkStateView;
  class vtkStateLayout;
  vtkState* State;
  bool UseFloatingPointBuffers;
};
 
#endif