vtkResizingWindowToImageFilter.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 vtkResizingWindowToImageFilter_h
#define vtkResizingWindowToImageFilter_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 vtkResizingWindowToImageFilter : public vtkAlgorithm
{
public:
  static vtkResizingWindowToImageFilter* New();
 
  vtkTypeMacro(vtkResizingWindowToImageFilter, vtkAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void SetInput(vtkWindow* input);


  vtkGetObjectMacro(Input, vtkWindow);


  vtkGetVector2Macro(Size, int);
  vtkSetVector2Macro(Size, int);


  vtkGetMacro(SizeLimit, int);
  vtkSetMacro(SizeLimit, int);


  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:
  vtkResizingWindowToImageFilter();
  ~vtkResizingWindowToImageFilter() override;
 
  // vtkWindow is not a vtkDataObject, so we need our own ivar.
  vtkWindow* Input;
  // requested size of the screenshot in pixels.
  int Size[2];
  // window size limit for using this filter. If the target resolution is higher we switch to
  // vtkWindowToImageFilter with tiling
  int SizeLimit;
 
  int InputBufferType;
 
  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();

  void GetScaleFactorsAndSize(
    const int requestedSize[2], int actualSize[2], int scale[2], bool* approximate);
 
private:
  vtkResizingWindowToImageFilter(const vtkResizingWindowToImageFilter&) = delete;
  void operator=(const vtkResizingWindowToImageFilter&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif