vtkWindowToImageFilter.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 vtkWindowToImageFilter_h
#define vtkWindowToImageFilter_h
 
#include "vtkAlgorithm.h"
#include "vtkImageData.h"           // makes things a bit easier
#include "vtkRenderingCoreModule.h" // For export macro
#include "vtkWrappingHints.h"       // For VTK_MARSHALAUTO
 
// VTK_RGB and VTK_RGBA are defined in system includes
#define VTK_ZBUFFER 5
 
VTK_ABI_NAMESPACE_BEGIN
class vtkWindow;
 
class vtkWTI2DHelperClass;
class VTKRENDERINGCORE_EXPORT VTK_MARSHALAUTO vtkWindowToImageFilter : public vtkAlgorithm
{
public:
  static vtkWindowToImageFilter* New();
 
  vtkTypeMacro(vtkWindowToImageFilter, vtkAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void SetInput(vtkWindow* input);


  vtkGetObjectMacro(Input, vtkWindow);


  vtkSetVector2Macro(Scale, int);
  vtkGetVector2Macro(Scale, int);

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  void SetScale(int scale) { this->SetScale(scale, scale); }


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


  vtkBooleanMacro(ReadFrontBuffer, vtkTypeBool);
  vtkGetMacro(ReadFrontBuffer, vtkTypeBool);
  vtkSetMacro(ReadFrontBuffer, vtkTypeBool);


  vtkBooleanMacro(ShouldRerender, vtkTypeBool);
  vtkSetMacro(ShouldRerender, vtkTypeBool);
  vtkGetMacro(ShouldRerender, vtkTypeBool);


  void SetViewport(double, double, double, double);
  void SetViewport(double*);
  vtkGetVectorMacro(Viewport, double, 4);


  vtkSetMacro(InputBufferType, int);
  vtkGetMacro(InputBufferType, int);
  void SetInputBufferTypeToRGB() { this->SetInputBufferType(VTK_RGB); }
  void SetInputBufferTypeToRGBA() { this->SetInputBufferType(VTK_RGBA); }
  void SetInputBufferTypeToZBuffer() { this->SetInputBufferType(VTK_ZBUFFER); }

  vtkImageData* GetOutput();

  vtkTypeBool ProcessRequest(
    vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
 
protected:
  vtkWindowToImageFilter();
  ~vtkWindowToImageFilter() override;
 
  // vtkWindow is not a vtkDataObject, so we need our own ivar.
  vtkWindow* Input;
  int Scale[2];
  vtkTypeBool ReadFrontBuffer;
  vtkTypeBool ShouldRerender;
  double Viewport[4];
  int InputBufferType;
  bool FixBoundary;
 
  void RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*);
 
  virtual void RequestInformation(vtkInformation*, vtkInformationVector**, vtkInformationVector*);
 
  // see algorithm for more info
  int FillOutputPortInformation(int port, vtkInformation* info) override;

  virtual void Render();
 
  // The following was extracted from vtkRenderLargeImage, and patch to handle viewports
  void Rescale2DActors();
  void Shift2DActors(int x, int y);
  void Restore2DActors();
  vtkWTI2DHelperClass* StoredData;
 
private:
  vtkWindowToImageFilter(const vtkWindowToImageFilter&) = delete;
  void operator=(const vtkWindowToImageFilter&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif